Web App
After cloning the repository, you need to install the dependencies described in package.json by running the command:
$ npm i
Whenever package.json gets modified, you should run npm i to install new dependencies or update existing ones.
Make a copy of of sample.env and rename it to .env ; this is a file containing Server Environment directory used by the scripts.
At the same file directory level as '/aps-app' and '/web' :
$ mkdir storage //serves as storage directory
To run the web app, run the command:
$ npm start
By default, the web server will run on port 3000. Hence when you visit http://localhost:3000/, you should see the web app responding.
If you're in development environment and would like the app to restart whenever you make changes (the changes to the app will not be reflected unless the app is restarted), you can use a library called nodemon to help you do this. Install nodemon globally by running the command:
$ npm i -g nodemon
After installing nodemon, you can use nodemon instead of npm start to monitor and restart the web app as needed.
To run tests, run the command:
$ npm test
We're writing unit tests using Mocha unit testing framework. Test files are found in the test folder.
To run code linting, run the command:
$ npm run lint
Code linting tool we're using is ESLint.