Versed

Versed is the framework that helps you develop scalable application fast, with quality and maintainability.

Setup

Have docker, docker-compose installed. You don't need to install node.js. If you are using Docker for Mac, please set your VM for docker to have at least 3 GB of RAM.

git clone [the project]   # clone project
mkdir -p config/local
mkdir -p config/secret
vi config/local/.env      # Override the variable for your local environment
./scripts/init.sh         # Init the project (setup `j`, docker containers, download libraries, migrate database) 
j docker                  # get into the main container
j dev                     # start the development server

Notes for j docker: Versed only support developing using docker. The command will only setup a development environment that is closes to the production environment, but it will not start the application. Instead, you need to get into the container and run j dev to start develop.

If you are not using WebStorm, you may found j: command not found error. You can run j by adding yarn before j: yarn j. We recommend using WebStorm, so you can skip some steps.