Natours

Welcome to Natours, a RESTful api and web application for booking nature tours and exploring the beauty of the natural world.

Badges

Code Style 📜

The code style is enforced using eslint and prettier.

Table of Contents

• Natours
  • Badges
  • Code Style 📜
  • Table of Contents
  • About
  • Demo 📷
    • Screenshots
  • Tech/Framework used
  • Getting Started
    • Prerequisites
    • Installation
  • Usage
  • API
  • Features
  • To Do

About

Natours is a fictional web application designed to showcase the beauty of nature and provide a platform for booking guided nature tours. Whether you're an adventure seeker or a nature enthusiast, Natours offers a variety of tours to explore breathtaking landscapes and connect with nature.

Demo 📷

Check out our live demo here.

Screenshots

Tech/Framework used

• Node.js
• Express
• MongoDB
• Mongoose
• Stripe
• Git
• NodeMailer
• MongoDB Atlas
• Postman
• VSCode
• Mailtrap
• Pug
• Parcel

Getting Started

Prerequisites

Before you begin, ensure you have met the following requirements:

• Node.js and npm installed
• MongoDB installed and running

Installation

To install Natours, follow these steps:

1. Clone the repository:

   git clone https://github.com/yourusername/natours.git

2. Navigate to the project directory:

   cd natours

3. Install dependencies:

   npm install

4. Set up environment variables: To run this project, you will need to add the following environment variables to your .env file NODE_ENV=production DATABASE USERNAME database username PASSWORD database password JWT_SECRET JWT_EXPIRES_IN JWT_COOKIE_EXPIRES_IN EMAIL_USERNAME EMAIL_PASSWORD EMAIL_HOST EMAIL_PORT EMAIL_FROM STRIPE_SECRET_KEY

5. Start the application:

   npm run start

Usage

Once the application is up and running, you can visit http://localhost:3000 in your web browser to explore and book nature tours. To book a tour you can use test credit card

API

Natours provides a RESTful API for accessing tour data and performing various actions. You can find the API documentation here.

Features

• User registration and authentication
• Sign up, Log in, Logout, Update, and reset password.
• Browse and search for available tours
• View tour details, including itinerary and pricing
• Book tours and make secure payments
• User reviews and ratings for tours
• User dashboard to manage bookings and reviews

To Do

[] Implement Sign Up page [] Fix CalcAverageRatings functionality