Skip to content

shahpreetk/beproject-backend

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

35 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

beproject-backend

🛠 Built with

The API system is made using Express, a lightweight Nodejs library. The data is saved on a NoSQL MongoDB database. To welcome the user after signup, we send an email using the Sendgrid service. For the security and privacy of the user, we use bcrypt to hash the user’s password in the database, and session authentication is done via JSON web tokens.

👩‍💻 Author

This project was built with ❤️ by Preet Shah.

🔨 Installation and Setting it Up

If you are interested in setting up the project on your local machine you can simply follow these steps -

  • Clone the repository

  • To the root of the folder, make a new folder named config

  • In the config folder make a new file named dev.env

  • In the dev.env file add the following -

    • PORT=3010
    • SENDGRID_API_KEY=YOUR_SENDGRID_KEY
    • MONGODB_URL=YOUR_LOCAL_DB_URL
    • JWT_SECRET=A_KEY_YOU_WOULD_LIKE_TO_KEEP
    • STRIPE_API_SECRET=YOUR_SECRET_STRIPE_KEY

    PS: To learn how to run MongoDB locally, you can refer to the following videos -

    1. for Mac

    2. for Windows

  • Run npm install and npm install -D

  • Run npm run dev

🖥 Where can I find it?

You can find the backend of BookIt here!!

And the frontend of BookIt can be found here!!

The code to the frontend of the project can be found at this repository!!

🙈 A kind request

This was my first complete MERN stack project and if you like it please do give it a star ⭐️.

Thank you!! 😁

📝 License

This project is licensed under GNU General Public License v3.0 GNU GPLv3