QR Menu (Server) · In Progress...

This project represents the server-side code for a QR-Code-based menu system. The server is built using Node.js and utilizes various libraries for functionality.

Table of Contents

• Folder Structure
• Usage
• Contributing
• Dependencies

Folder Structure

• certificates: Stores SSL certificate files for securing the server.
• controllers: Contains controller functions for handling different routes.
• middlewares: Contains middleware functions for route authentication and authorization.
• models: Contains MongoDB schema models for data storage.
• routes: Contains route handlers for admin and user functionalities.
• service: Contains service functions for interacting with the database.
• .env: Environment variables configuration.

Usage

1. Clone the repository:

git clone https://github.com/HEAD0223/qr-menu-node.git
cd qr-menu-node

2. Install dependencies:

npm install

3. Add .env:

STORE_NAME=QR MENU
API_URL=http://localhost:8080
CLIENT_URL=http://localhost:3000
DB_LINK='MONGODBLINK'
GMAIL_USER=USER
GMAIL_PASS=PASSWORD
JWT_ACCESS_SECRET=jwt-secret-key
JWT_REFRESH_SECRET=jwt-refresh-secret-key

4. Start the Node.js server:

npm start

5. The server should be running on the specified port (default is 8080).

Contributing

If you would like to contribute to this project, please follow these steps:

1. Fork the repository.
2. Create a new branch for your feature: git checkout -b feature-name
3. Commit your changes: git commit -m 'Add some feature'
4. Push to the branch: git push origin feature-name
5. Submit a pull request.

Dependencies

• bcrypt: Library for hashing passwords.
• cookie-parser: Middleware for parsing cookies in the server.
• cors: Middleware for enabling CORS in the server.
• dotenv: Loads environment variables from a .env file.
• express: Web application framework for Node.js.
• fs: File system module for handling file operations.
• https: Module for creating HTTPS servers.
• jsonwebtoken: Library for JSON Web Token (JWT) authentication.
• mongoose: MongoDB object modeling for Node.js.
• nodemailer: Module for sending emails.
• uuid: Library for generating and working with UUIDs.
• nodemon: A tool that helps in the development of Node.js-based applications by automatically restarting the server.

Make sure to include these dependencies in your project.