Skip to content

ritiksharmarj/natours

Repository files navigation


Natours
Natours

An awesome tour booking site built on top of NodeJS.

DemoKey FeaturesDemonstrationUpdate your profileAPI UsageDeploymentBuild WithTo-doInstallationKnown BugsFuture UpdatesAcknowledgement

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

Natours Walkthrough

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 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

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 for creating this awesome course!