https://github.com/ritiksharmarj/natours
An awesome tour booking web app written in NodeJS, Express, MongoDB
https://github.com/ritiksharmarj/natours
axios bcryptjs eslint express-js javascipt jsonwebtoken mailgun mailtrap mongodb-atlas mongoose morgan multer node-js nodemailer prettier pug render sharp slugify stripe
Last synced: about 1 month ago
JSON representation
An awesome tour booking web app written in NodeJS, Express, MongoDB
- Host: GitHub
- URL: https://github.com/ritiksharmarj/natours
- Owner: ritiksharmarj
- Created: 2023-03-10T09:42:41.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-12-05T18:02:23.000Z (about 2 years ago)
- Last Synced: 2025-06-10T13:48:02.477Z (8 months ago)
- Topics: axios, bcryptjs, eslint, express-js, javascipt, jsonwebtoken, mailgun, mailtrap, mongodb-atlas, mongoose, morgan, multer, node-js, nodemailer, prettier, pug, render, sharp, slugify, stripe
- Language: JavaScript
- Homepage: https://natours-xbsh.onrender.com
- Size: 33 MB
- Stars: 4
- 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 •
Update your profile •
API Usage •
Deployment •
Build With •
To-do •
Installation •
Known Bugs •
Future Updates •
Acknowledgement
## Deployed Version
Live demo (Feel free to visit) 👉 : https://natours-xbsh.onrender.com/
## Key Features
- Authentication and Authorization
- Signup, Login and logout
- Tour
- Manage booking, check tours map, check user's reviews and ratings
- User profile
- Update username, profile photo, email, and password
- Credit card payment using Stripe
## Demonstration
[](https://www.youtube.com/watch?v=UljiMtXeFx0)
## 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 using Stripe
- Enter the card details (Test Mode):
```
- Card No. : 4242 4242 4242 4242
- Expiry date: any
- CVV: any
```
- Finished!
### Manage your booking
- Check the tour you have booked in "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 (e.g. http://127.0.0.1:8000 or http://www.example.com)
- {{password}} with your user password as value.
```
Check [Natours API Documentation](https://documenter.getpostman.com/view/8689170/SVmzvwpY?version=latest) for more info.
API Features:
Tours List 👉 https://natours-xbsh.onrender.com/api/v1/tours
Tours Statistics 👉 https://natours-xbsh.onrender.com/api/v1/tours/tour-stats
Get Top 5 Cheap Tours 👉 https://natours-xbsh.onrender.com/api/v1/tours/top-5-cheap
Get Tours Within Radius 👉 https://natours-xbsh.onrender.com/api/v1/tours/tours-within/200/center/34.098453,-118.096327/unit/mi
## Deployment
The website is deployed using git on render.com. Below are the steps taken:
```
git init
git add -A
git commit -m "Commit message"
git push origin main
deploy on render > web service
```
Set environment variables to render:
```
go to dashboard > project > environment
```
## 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
- [esbuild](https://esbuild.github.io/) - An extremely fast bundler for the web
- [Stripe](https://stripe.com/) - Online payment API
- [Postman](https://www.getpostman.com/) - API testing
- [Mailtrap](https://mailtrap.io/) & [Mailgun](https://www.mailgun.com/) - Email delivery platform
- [Render](https://render.com/) - Cloud platform
## To-do
- Review and rating
- Allow user to add a review directly at the website after they have booked a tour
- Booking
- Prevent duplicate bookings after user has booked that exact tour, implement favourite tours
- Advanced authentication features
- Signup, confirm user email, login with refresh token, two-factor authentication
- And More ! There's always room for improvement!
## Installation
You can fork the app or you can git-clone the app into your local machine. Once done that, please install all the
dependencies by running
```
$ npm i
set your env variables
$ npm run watch
$ npm run dev (for development)
$ npm run prod (for production)
$ npm run debug (for debug)
```
## Known Bugs
Feel free to create an issue for bugs or features 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
- Improve overall UX/UI and fix bugs
- Featured Tours
- Recently Viewed Tours
- And More ! There's always room for improvement!
## Acknowledgement
- This project is part of the online course I've taken at Udemy. Thanks to [Jonas Schmedtmann](https://twitter.com/jonasschmedtman) for creating this awesome course!