Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/omersidd2705/my-node.js-tourism-application-project
An awesome tour booking web app written in NodeJS, Express, MongoDB 🗽FEATURES MONGOOSE AND PUG WITH EXTRA THINGS API OF MAP BOX,STRIPE,SENDGRID EMAIL API SYSTEM) Authentication and Authorization Sign up Log in Logout Update Reset password User Profile Update username, photo, email, password, and other information
https://github.com/omersidd2705/my-node.js-tourism-application-project
expressjs heroku middleware mongodb nodejs pug sendgrid stripe
Last synced: about 2 months ago
JSON representation
An awesome tour booking web app written in NodeJS, Express, MongoDB 🗽FEATURES MONGOOSE AND PUG WITH EXTRA THINGS API OF MAP BOX,STRIPE,SENDGRID EMAIL API SYSTEM) Authentication and Authorization Sign up Log in Logout Update Reset password User Profile Update username, photo, email, password, and other information
- Host: GitHub
- URL: https://github.com/omersidd2705/my-node.js-tourism-application-project
- Owner: Omersidd2705
- Created: 2024-04-25T12:04:17.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-10-08T14:07:07.000Z (3 months ago)
- Last Synced: 2024-10-27T05:25:10.169Z (about 2 months ago)
- Topics: expressjs, heroku, middleware, mongodb, nodejs, pug, sendgrid, stripe
- Language: JavaScript
- Homepage: https://lgope-natours.onrender.com
- Size: 81.1 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# FULL STACK PROJECT
FEATURE
MONGOOSE AND PUG WITH EXTRA THINGS API OF MAP BOX,STRIPE,SENDGRID EMAIL API SYSTEM)
>Authentication and Authorization
Sign up
Log in
Logout
Update
Reset password
User Profile
Update username, photo, email, password, and other information
User roles: regular user, admin, lead guide, guide
>Tour Management
Create tours (admin/lead guide)
View tours (all users)
Update tours (admin/lead guide)
Delete tours (admin/lead guide)
>Booking
Regular users can book tours (with payment)
Regular users cannot book the same tour twice
View booked tours (regular users)
View all bookings (admin/lead guide)
Delete bookings (admin/lead guide)
Create bookings manually (admin/lead guide, without payment)
Cannot create duplicate bookings for the same user (admin/lead guide)
Edit bookings (admin/lead guide)
>Reviews
Write reviews for booked tours (regular users)
View reviews for each tour (all users)
Edit and delete own reviews (regular users)
Cannot review the same tour twice (regular users)
Delete reviews (admin)
Favorite Tours
Add booked tours to favorites (regular users)
Remove tours from favorites (regular users)
Cannot add tour to favorites if already favorited (regular users)
>Credit Card Payment
https://github.com/lgope/Natours/assets/102612436/a1b1359b-7b37-4498-a2dc-6286051056bc
https://github.com/lgope/Natours/assets/102612436/69110424-a753-4519-9fbb-476074967209
TECH USED
Node.js Fundamentals:
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 :
#### Payment Process :
#### Booked Tours :
#### User Profile :
#### Admin Profile :
## How To Use 🤔
### Book a tour
- Login 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 Mood):
```
- Card No. : 4242 4242 4242 4242
- Expiry date: 02 / 22
- CVV: 222
```
- 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/8893042/SW7c37V6) for more info.
API Features:
Tours List 👉🏻 https://lgope-natours.onrender.com/api/v1/tours
Tours State 👉🏻 https://lgope-natours.onrender.com/api/v1/tours/tour-stats
Get Top 5 Cheap Tours 👉🏻 https://lgope-natours.onrender.com/api/v1/tours/top-5-cheap
Get Tours Within Radius 👉🏻 https://lgope-natours.onrender.com/api/v1/tours/tours-within/200/center/34.098453,-118.096327/unit/mi
## 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 change your website URL by running this command:
```
heroku apps: rename natours-users
```
## 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!