With our application we want to create a platform that offers tiffin/meal prep plans that are healthy and delivered to the doorstep of our customers. Customers would be able to select from a wide range of meal plans and subscribe to them. Food service vendors can advertise their meal plans that are composed of multiple containerized and portioned meals which are delivered on a weekly basis to their customers. 🎉🎊🎈🎈
For a collection of high fidelity design artifacts, you can access the following link: Design Artifacts
This section lists the major frameworks/libraries used to bootstrap the project.
Table of Contents
This is an example of how to list things you need to use the software and how to install them.
- npm
npm install npm@latest -g
From root run following commands in sequence:
docker-compose up -d mysql-master
docker-compose up -d server
Commands:
- Go into app folder run
npm install
- Open two terminals, run node server on one terminal and run typescript compiler on the other.
- Command to compile Ts code to JS
npm run compile
- Command to run node server
npm run nodemon
- Swagger UI
http://localhost:3000/api-docs/#/
- Sample .env
meal-dash-business/.env.development.local
meal-dash-business/.env.production.local
meal-dash-business/.env.development.local
meal-dash-business/.env.test.local
-
PORT
PORT = 3000
-
DATABASE
DB_HOST = localhost
DB_PORT = 3306
DB_USER = YOUR_USER
DB_PASSWORD = YOUR_USER
DB_DATABASE = meal-dash
-
TOKEN
SECRET_KEY = secretKey
-
LOG
LOG_FORMAT = dev
LOG_DIR = ../../../logs
- CORS
ORIGIN = *
CREDENTIALS = true