It is a Restaurant application where users can order food from different restaurants.
- Vscode
- Nodejs v20.16.0+
- Mongodb
- Stripe CLI // Necessary only for development environment
- Clone the repository:
git clone https://github.com/iam-abin/Restaurant.git
- Navigate to the project directory:
cd Restaurant
- Install the dependencies:
- Install all dependencies from root directory
npm run install-all
or
- Install dependencies seperately
Install some dev dependencies in the root directory,
npm install
cd backend
npm install
- open another tab in vscode terminal and run
cd frontend
npm install
- Setup stripe
- Install stripe cli in local system (refer stripe website's webhook section)
- Login to stripe cli in local system
- Set up the required environment variables.
- In the frontend folder create
.env
file and setup variables using.env.example
file. - In the backend folder create
.env.development
,.env.production
,.env.test
files based on need and setup variables using.env.example
file.
- Start server (Running the app):
- We can run all the start command from root directory using
npm run dev
or
- In both frontend and backend terminal tabs, run
npm run dev
- Run stript webhook (for payment confirmation) in backend terminal
npm run stripe
- Access the application from browser using:
For user
http://localhost:5000
For restaurant
http://localhost:5000/auth/restaurant
For admin
http://localhost:5000/auth/admin
- docker
- docker componse
- makefile
-
For docker compose commands check Makefile
or
-
Run the following command in the root directory of project
make
This project is licensed under the MIT License - see the LICENSE.md file for details.