For more info please refer to
- Express (Back end web application framework)
- Agenda (Job scheduling)
- Winston (Logging framework)
- Nodemon (Automatically restarts application when code files are updated)
- Compression (Enabling gzip compression in Express.js)
- Swagger (API docs)
- Loggly (Cloud-based logging solutions)
These are ongoing techdebt that needed to be fixed
- [] REMOVE all CommonJS require('...') to use ES6 modules ( import ... from '...' )
See the open issues for a full list of proposed features (and known issues).
This is an example of how to list things you need to use the software and how to install them.
Docker Desktop
One time command
- docker build -t techscrum:lastest .
- cp .env.example .env
- Update the value in .env (https://1drv.ms/w/s!AjTqzZQqiCqtgdM7QigoxTePfKaQow?e=L8oUz1), Ask Kitman for password
- npm run build
- npm run init-app
- Go to chrome paste this http://localhost:8000/api/v2/healthcheck
docker run -p 8000:8000 -d -v ${pwd}/.:/app techscrum:lastest (WINDOW ONLY)
localhost:8000
The generate the latest api docs you can run the following command
- npm run swagger-autogen
Once the docs is generated you can visit the via
To know more about this package you can visit https://www.npmjs.com/package/swagger-autogen
- npm run test
Logs file help developers/devops to address server or code issues when application crashes, you would need to ask email and password from Kitman.
- Local: /storage/logs/logger.log. This file will only generate when there are errors
- Production: https://techscrumapp.loggly.com/search?terms=tag:heroku&from=-20m&until=now&source_group=&newtab=1#terms=tag:*&from=2023-08-12T06:55:41.477Z&until=2023-08-12T07:15:41.477Z&source_group=
Kitman Yiu - Kitman Yiu Emil (Junqian Su) Implement Register, Login, Forgetpassword, board, tasks, account setting, email sende. Jest testing: forgetPassword
basic docker command
-
go into docker docker ps (find your container id) docker exec -it <container_id> bash
-
kill all unused docker images docker system prune
cat filename
//history | grep run
docker run -p 8000:8080 -d -v ${pwd}/.:/app techscrum:lastest