contributing.md

Booking.com Backend

A booking.com backend system built with Nodejs, multer, express, Prisma ORMs, Supabase/PostgreSQL.

For Contributing

What you can Contribute ?

1. Adding New Features : You can request a feature by raising an issue and submit valuable solutions by creating a pull request.

• You can contribute by adding new features to the project.

2. Bugs or Error

• Bug fixing and reporting bugs that you find in the code.

3. Register an Issue for any Feature Requests / Ideas

• The issue will be reviewed. If it is approved, then it will be assigned. Before making a pull request, please register your idea as an issue so we can discuss it first. This will help us avoid unnecessary work and make the repository maintainable.

Contributing Guidlines

1. Fork this repository.

2. Clone this repository.

  [email protected]:<USERNAME>/booking.com-backend.git

3. Navigate to the project directory.

  cd booking.com-backend

4. Setup .env file by following this steps

   1. Copy .env.sample file by running this command in your terminal

       cp .env.sample .env

   2. Add your Mongo Atlas database url in .env file

       PORT = 3000
       <!--  Add your Supabase/PostgreSQL database url in .env file -->
       DATABASE_URL = 
   
       <!-- Add here the secret  -->
       SECRET = 

5. Run Migrations for your prisma database

   1. Generate Prisma Clients

       npx prisma generate

   2. Run Migrations

       npx prisma migrate dev

6. Create new branch

  git checkout -b <your_branch_name>

5. Make changes.
6. Stage your changes and commit

git add -A
git commit -m "<your_commit_message>"

7. Push your local commits to the remote repo.

git push -u origin <your_branch_name>

8. Create a Pull Request.
9. Congratulations! 🎉 you've made your contribution.

Your Pull request will be reviewed as soon as possible !

If liked the project Dont forget to give it a star. 😁

Happy Coding!!