Git Product home page Git Product logo

natours's Introduction


Natours
Natours

Build Status

An awesome tour booking site built on top of NodeJS.

Demo โ€ข Key Features โ€ข How To Use โ€ข API Usage โ€ข Deployment โ€ข Build With โ€ข To-do โ€ข Acknowledgement

Demo

Live demo: https://natours-louis.herokuapp.com

Key Features

  • Authentication and Authorization
    • Login and logout
  • Tour
    • Manage booking, check tours map, check users' reviews and rating
  • User profile
    • Update username, photo, email, and password
  • Credit card Payment

How To Use

Book a tour

  • Login to the site as user: [email protected] ("test1234")
  • Search for tours that you want to book
  • Book a tour
  • Proceed to the payment checkout page
  • Enter the card details:
    - Card No. : 4242 4242 4242 4242
    - Expiry date: 02 / 22
    - CVV: 222
    
  • 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 (Admin only!)

  • 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 for more info.

Deployment

The website is deployed with git into heroku. Below are the steps taken:

git init
git add -A
git commit -m "Commit message"
heroku login
heroku create
heroku config:set CONFIG_KEY=CONFIG_VALUE
parcel build ./public/js/index.js --out-dir ./public/js --out-file bundle.js
git push heroku master
heroku open

You can also changed your website url by running this command:

heroku apps:rename natours-users

Build With

To-do

  • Review and rating
    • Allow user to add a review directly at the website after they have taken 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

Acknowledgement

natours's People

Contributors

louisjuliendo avatar dependabot[bot] avatar

Stargazers

GIT avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.