hirajanwin / trippers-project Goto Github PK

Trippers: Travel the world

A Node JS, Server Side Rendered, Secured web application.
Explore the docs »

View Demo · Report Bug · Request Feature · API Documentation

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Contact
• Acknowledgements

About The Project

Trippers is a tours and travels website to travel to your dream location. It features tours packages, Available tours, Difficulty, Number of people, and more. Details are as follows:

Details:

• Homepage which shows available tours
• Users can post tours and travel packages
• Upload pictures, post comments
• Ratings
• User authentication using JWT
• Database secure and stored in MongoDB Atlas
• CRUD operations
• Beautiful Pug templates

There are more features which i'll be adding soon.

Built With

• Node JS
• Express
• MongoDB
• JWT
• bcrypt
• Pug
• slugify
• Mongoose
• HTML
• CSS
• javascript
• Postman

Getting Started

This is to setup the project locally on your computer

Prerequisites

Get the latest version of node from the official node website

• npm

npm install npm@latest -g

Installation

1. Clone the repository

git clone https://github.com/manuarora700/trippers-project.git

2. Install NPM packages

npm install

3. Create a file config.js in the root directory and fill in the following details ( Replace whatever is written in {{}} with your credentials)

NODE_ENV = development
PORT = 3000
DATABASE=mongodb+srv://{{YOUR_USERNAME}}:<PASSWORD>@cluster0-axx7z.mongodb.net/trippers?retryWrites=true&w=majority
DATABASE_PASSWORD={{YOUR_PASSWORD}}

JWT_SECRET={{ ANY RANDOM STRING }}
JWT_EXPIRES_IN=90d

EMAIL_USERNAME={{mailtrap_username}}
EMAIL_PASSWORD={{mailtrap_password}}
EMAIL_HOST=smtp.mailtrap.io
EMAIL_PORT=25

EMAIL_FROM = {{your_email}}

SENDGRID_USERNAME=apikey
SENDGRID_PASSWORD={{Sendgrid_password}}

STRIPE_SECRET_KEY={{sendgrid_secret_key}}

4. For credit card payment on the checkout page, use the following credentials:

Card Number = 4242 4242 4242 4242 (4242 repeated)
Date: any_month/any_year
Cvv: Any 3 digit number
Name: Any name

Usage

On the terminal write npm run start:dev and it should start.

For more examples, please refer to the Documentation

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Your Name - @mannupaaji - [email protected]

Project Link: https://github.com/manuarora700/trippers

Acknowledgements

• GitHub Emoji Cheat Sheet
• Img Shields
• Choose an Open Source License
• GitHub Pages
• Animate.css
• Loaders.css
• Slick Carousel
• Smooth Scroll
• Sticky Kit
• JVectorMap
• Font Awesome