This repository is a Typescript & Javascript skeleton with Vue, designed for quickly getting started developing a web application. Check the Getting Started for full details.
Within the Makefile you can handle the entire flow to get everything up & running:
- Install
makeon your computer, if you do not already have it. - Install the Yarn dependencies:
make deps - Start the application:
make up
As you could see on the Makefile script, you could just avoid those steps and just execute make up, as
deps are dependant of it.
Once these steps are finished, you could access to the application navigating into http://localhost:3000.
In case you don't want to install make but still run with docker follow the below instructions:
- Docker build -t
- Docker run -it -p 3000:3000
This version is meant to be run on prod environments and listens to all IP adressess. You can change this inside the package.json. You can change as well the exposed port inside the Dockerfile and package.json
This skeleton is based on a Clean Architecture approach, so you could find the first basic elements:
You could find here an amazing Dev.to article explaining this Clean Architecture on frontend! (credits to @bespoyasov_).
This folder contains the basic UI elements. You should add any UI element inside this folder, with the respective CSS file module.
This layer is the one in charge of the different use cases of the application. A Use Case it's a workflow of what should it happen to a concrete Domain entity once interacts with the application.
This is the layer which would use any external service and communicate with the world (ie. APIs, databases, etc...)
As we said, this is the layer that communicates the application with the outer world, and the one that would be coupled with almost any 3rd party provider, framework, etc...
If you are having problems or need anything else, please let us know by raising a new issue.
This project is licensed with the MIT license.