Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pratayyy/natours
Natours is a NodeJS tour booking API with authentication, tour management, user profiles, and credit card payments. Built with Express, Mongoose, MongoDB, and Pug. (Deployed on free tier, takes time on first loading)
https://github.com/pratayyy/natours
express mailtrap mapbox mongodb mongoose multer nodejs pug stripe
Last synced: 2 days ago
JSON representation
Natours is a NodeJS tour booking API with authentication, tour management, user profiles, and credit card payments. Built with Express, Mongoose, MongoDB, and Pug. (Deployed on free tier, takes time on first loading)
- Host: GitHub
- URL: https://github.com/pratayyy/natours
- Owner: pratayyy
- Created: 2024-02-12T10:50:45.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-03-11T21:38:48.000Z (10 months ago)
- Last Synced: 2024-11-06T18:00:11.394Z (about 2 months ago)
- Topics: express, mailtrap, mapbox, mongodb, mongoose, multer, nodejs, pug, stripe
- Language: JavaScript
- Homepage: https://natours-hgn9.onrender.com/
- Size: 47.2 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Natours
An awesome tour booking site built on top of NodeJS.
Demo •
Key Features •
Demonstration •
How To Use •
API Usage •
Deployment •
Build With •
To-do •
Installation •
Known Bugs •
Future Updates •
Acknowledgement
## Key Features 📝
- Authentication and Authorization
- Sign up, Log in, Logout, Update, and reset password.
- User profile
- Update username, photo, email, password, and other information
- A user can be either a regular user or an admin or a lead guide or a guide.
- When a user signs up, that user by default regular user.
- Tour
- Manage booking, check tour map, check users' reviews and rating
- Tours can be created by an admin user or a lead-guide.
- Tours can be seen by every user.
- Tours can be updated by an admin user or a lead guide.
- Tours can be deleted by an admin user or a lead-guide.
- Bookings
- Only regular users can book tours (make a payment).
- Regular users can not book the same tour twice.
- Regular users can see all the tours they have booked.
- An admin user or a lead guide can see every booking on the app.
- An admin user or a lead guide can delete any booking.
- An admin user or a lead guide can create a booking (manually, without payment).
- An admin user or a lead guide can not create a booking for the same user twice.
- An admin user or a lead guide can edit any booking.
- Reviews
- Only regular users can write reviews for tours that they have booked.
- All users can see the reviews of each tour.
- Regular users can edit and delete their own reviews.
- Regular users can not review the same tour twice.
- An admin can delete any review.
- Favorite Tours
- A regular user can add any of their booked tours to their list of favorite tours.
- A regular user can remove a tour from their list of favorite tours.
- A regular user can not add a tour to their list of favorite tours when it is already a favorite.
- Credit card Payment
## Demonstration 🖥️
#### Home Page :
#### Tour Details :
#### Login and Admin Page :
#### SignUp and User Profile :
#### Booking process :
## How To Use 🤔
### Book a tour
- Login or signup to the site
- Search for tours that you want to book
- Book a tour
- Proceed to the payment checkout page
- Enter the card details (Test Mode):
```
- Card No. : 4000 0035 6000 0008
- Expiry date: Any date in future
- CVV: Any 3 digit number
```
- Finished!
### Manage your booking
- Check the tour you have booked on the "Manage Booking" page in your user settings. You'll be automatically redirected to this
page after you have completed the booking.
### Update your profile
- You can update your own username, profile photo, email, and password.
## API Usage
Before using the API, you need to set the variables in Postman depending on your environment (development or production). Simply add:
```
- {{URL}} with your hostname as value (Eg. http://127.0.0.1:3000 or http://www.example.com)
- {{password}} with your user password as value.
```
Check [Natours API Documentation](https://documenter.getpostman.com/view/25725258/2sA2xiWCBn) for more info.
API Features:
Tours List 👉🏻 https://natours-hgn9.onrender.com/api/v1/tours
Tours State 👉🏻 https://natours-hgn9.onrender.com/api/v1/tours/tour-stats
Get Top 5 Cheap Tours 👉🏻 https://natours-hgn9.onrender.com/api/v1/tours/top-5-cheap
Get Tours Within Radius 👉🏻 https://natours-hgn9.onrender.com/api/v1/tours/tours-within/200/center/34.098453,-118.096327/unit/mi
## Build With 🏗️
- [NodeJS](https://nodejs.org/en/) - JS runtime environment
- [Express](http://expressjs.com/) - The web framework used
- [Mongoose](https://mongoosejs.com/) - Object Data Modelling (ODM) library
- [MongoDB Atlas](https://www.mongodb.com/cloud/atlas) - Cloud database service
- [Pug](https://pugjs.org/api/getting-started.html) - High performance template engine
- [JSON Web Token](https://jwt.io/) - Security token
- [ParcelJS](https://parceljs.org/) - Blazing fast, zero configuration web application bundler
- [Stripe](https://stripe.com/) - Online payment API and Making payments on the app.
- [Postman](https://www.getpostman.com/) - API testing
- [Mailtrap](https://mailtrap.io/) & [Sendgrid](https://sendgrid.com/) - Email delivery platform
- [Heroku](https://www.heroku.com/) - Cloud platform
- [Mapbox](https://www.mapbox.com/) - Displaying the different locations of each tour.
## To-do 🗒️
- Review and rating
- Allow users to add a review directly at the website after they have taken a tour
- Booking
- Prevent duplicate bookings after a user has booked that exact tour, implement favorite tours
- Advanced authentication features
- Signup, confirm user email, log in with refresh token, two-factor authentication
- And More! There's always room for improvement!
## Setting Up Your Local Environment ⚙️
If you wish to play around with the code base in your local environment, do the following
```
* Clone this repo to your local machine.
* Using the terminal, navigate to the cloned repo.
* Install all the necessary dependencies, as stipulated in the package.json file.
* If you don't already have one, set up accounts with: MONGODB, MAPBOX, STRIPE, BREVO, and MAILTRAP. Please ensure to have at least basic knowledge of how these services work.
* In your .env file, set environment variables for the following:
* DATABASE=your Mongodb database URL
* DATABASE_PASSWORD=your MongoDB password
* SECRET=your JSON web token secret
* JWT_EXPIRES_IN=90d
* JWT_COOKIE_EXPIRES_IN=90
* EMAIL_USERNAME=your mailtrap username
* EMAIL_PASSWORD=your mailtrap password
* EMAIL_HOST=smtp.mailtrap.io
* EMAIL_PORT=2525
* EMAIL_FROM=your real-life email address
* BREVO_API_KEY=apikey
* STRIPE_SECRET_KEY=your stripe secret key
* STRIPE_WEBHOOK_SECRET=your stripe webhook secret
* Start the server.
* Your app should be running just fine.
```
## Installation 🛠️
You can fork the app or you can git-clone the app into your local machine. Once done, please install all the
dependencies by running
```
$ npm i
Set your env variables
$ npm run watch:js (In a different terminal)
$ npm run dev (for development)
$ npm run start:prod (for production)
$ npm run debug (for debug)
Setting up ESLint and Prettier in VS Code 👇🏻
$ npm i eslint prettier eslint-config-prettier eslint-plugin-prettier eslint-config-airbnb eslint-plugin-node
eslint-plugin-import eslint-plugin-jsx-a11y eslint-plugin-react --save-dev
```
## Contributing 💡
Pull requests are welcome but please open an issue and discuss what you will do before 😊
## Known Bugs 🚨
Feel free to email me at [email protected] if you run into any issues or have questions, ideas or concerns.
Please enjoy and feel free to share your opinion, constructive criticism, or comments about my work. Thank you! 🙂
## Future Updates 🪴
- Enable PWA
- Improve overall UX/UI and fix bugs
- Featured Tours
- Recently Viewed Tours
- And More! There's always room for improvement!
## Deployed Version 🚀
Live demo (Feel free to visit) 👉🏻 : https://natours-hgn9.onrender.com/
## Acknowledgement 🙏🏻
- This project is part of the online course I've taken at Udemy. Thanks to Jonas Schmedtmann for creating this awesome course! Link to the course: [Node.js, Express, MongoDB & More: The Complete Bootcamp 2019](https://www.udemy.com/course/nodejs-express-mongodb-bootcamp/)