Skip to content

codert0109/natours-backend

Repository files navigation

🤖 Natours - backend

Exciting tours for adventurous people. Natours is an application for users to book tours.

This repo is just the backend of the whole application. There is a separate repo for the frontend that you can check out here.

📱 Screenshots

Natours

Natours

🧑🏼‍💻 Tech Stack

  • Node JS
  • Express JS
  • MongoDB (mongoose library to manage DB)
  • ndb as the debugger

The project follows a MVC pattern. The models go inside the ./models folder, controllers inside ./controllers and other utils inside the ./utils

⚙️ Installation

To run Natours on your local machine run the following commands

  • Clone your foked repository

     git clone https://github.com/codert0109/natours-backend.git
  • Navigate to root directory and run

    npm install
  • Rename config.copy.env to config.env and fill all your environment details

  • To start the server

    npm run start:dev

🛂 Contributing

Contributions are always welcomed! Before contributing, please keep in mind the following:

  • Make sure the application has no errors and is working perfectly fine
  • Make sure the code is well formatted and should follow the formatting rules mentioned in .prettierrc file and linting mentioned in .eslintrc.json file

🗺️ Roadmap

  • Add google signin/signup
  • Implement refresh tokens
  • Add tours stats

🪲 Found a bug?

If you find any bugs in the projects not listed in the issues panel. Then feel free to create an issue regarding the bug.

🤖 Feedback

If you have any feedback, please reach out to me at [email protected]

📝 License

MIT

About

Tour Booking app built with MERN stack

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published