nature-tours's Introduction

Natours

Restful API and SSR website for managing, viewing, and booking outdoor tours

Part of a course on MongoDB, mongoose, Node.js, and express, Natours is a fullstack application built using modern technologies and best practices

Usage
Getting started
- Prerequisites
- Installing and running
Built with
Meta
Known issues / bugs

Usage

Demo:

The above gif demonstrates the basic app flow. For more screenshots and other documentation, navigate to the /docs directory from the root of this repo.

Getting started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

If you don't have Nodejs and npm installed, install them from here.

Installing and Running

Clone this repository to your local machine and then create a .env following the .env.example file

Install Dependencies

In the root directory:

npm i

Available Root Commands

Start local dev environment

npm run dev

Other available Commands

There are more commands than is necessary to list here, refer to package.json files to view them.

Built with

Node.js - Javascript runtime
Express - Framework used for API in Node
MongoDB - NoSQL database
mongoose - MongoDB object modeling for Node.js
Pug - Template engine
axios - Promise-based HTTP client
JSON Web Tokens - For industry standard authentication
Postman - For testing and debugging API
Stripe - Payments infrastructure
Mapbox - Online studio and JS package for rendering maps on webapps

Known issues / bugs

The front end of the application is somewhat incomplete, ie. there are features that have yet to be implemented and menu options that don't actually go anywhere. I took the application as far as the course took it, but I'm not invested enough to continue adding to it at this point.

Thanks for viewing!

Recommend Projects