Skip to content

alokVerma749/foody-monk-backend

Repository files navigation

foody-monk Backend

This is the backend repository for the foody-monk food ordering app. It provides the server-side implementation and API endpoints required for the app to function.

The frontend repository for foody-monk can be found here.

Technologies Used

  • Node.js: The backend is built using Node.js, a JavaScript runtime that allows us to run server-side JavaScript code.
  • Express.js: Express.js is a web application framework for Node.js, used to build the RESTful API endpoints and handle HTTP requests.
  • MongoDB: MongoDB is a NoSQL document database used to store and retrieve data for the app.
  • Mongoose: Mongoose is an object data modeling (ODM) library for Node.js and MongoDB, providing a simple and elegant way to interact with the database.
  • jsonwebtoken: JSON Web Tokens (JWT) are used for secure authentication and authorization.
  • bcrypt: Bcrypt is used for password hashing to securely store user passwords.
  • multer: Multer is used for handling file uploads.
  • dotenv: Dotenv is used to manage environment variables.

Getting Started

To get started with the backend development, follow these steps:

  1. Clone this repository to your local machine.
  2. Install the dependencies by running npm install.
  3. Rename the .env.example file to .env and update the environment variables with your own configuration.
  4. Start the development server by running npm run dev.
  5. The server will run on http://localhost:4000.

API Documentation

For detailed information about the API endpoints and how to use them, please refer to the API documentation.

Contributing

We welcome contributions from the community to enhance the backend of the foody-monk app. To contribute, please follow the guidelines specified in the CONTRIBUTING.md file.

Issue Tracking

If you encounter any issues or have suggestions for improvements, please open a new issue on this repository.

Contact

If you have any questions or need assistance, feel free to contact us at [email protected].

License

This project is licensed under the MIT License.


Thank you for your interest in contributing to the foody-monk backend. We look forward to your contributions!

Happy coding!