Skip to content

Commit

Permalink
Update readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
hassan-attar authored Aug 25, 2024
1 parent c59d8da commit cce34da
Showing 1 changed file with 5 additions and 19 deletions.
24 changes: 5 additions & 19 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
# Natours API
# Tourify

<img src="./public/img/natours-api-transparent.png" width="200" />

Welcome to the Natours API! This API allows you to manage tours, user authentication, bookings, reviews, and more. It's built using Node.js with the Express framework and MongoDB for the database.
Welcome to the Tourify API! This API allows you to manage tours, user authentication, bookings, reviews, and more. It's built using Node.js with the Express framework and MongoDB for the database.
for more information please refer to the <a href="https://documenter.getpostman.com/view/26563178/2s9Y5csKeB" target="_blank">API Documentation</a>.

## Table of Contents
Expand All @@ -16,7 +14,7 @@ for more information please refer to the <a href="https://documenter.getpostman.

## Introduction

The Natours API provides a comprehensive backend solution for managing tours and related activities. Whether you're an administrator creating tours, users booking experiences, or reviewers leaving feedback, this API handles it all.
The Tourify API provides a comprehensive backend solution for managing tours and related activities. Whether you're an administrator creating tours, users booking experiences, or reviewers leaving feedback, this API handles it all.

## Features

Expand All @@ -28,30 +26,18 @@ The Natours API provides a comprehensive backend solution for managing tours and
- User profile management
- Tour statistics and analytics

## Getting Started

To set up the Natours API locally, follow these steps:

1. Clone this repository.
2. Install Node.js and MongoDB if not already installed.
3. Install the required dependencies by running: `npm install`
4. Create a `config.env` file in the root directory and set the necessary environment variables. use `config.env.example` as a template.
5. Start the server with: `npm start`

## API Documentation

The Natours API provides a set of endpoints for various functionalities:
The Tourify API provides a set of endpoints for various functionalities:

- **Tours**: Endpoints related to managing tours and tour information.
- **Reviews**: Endpoints for submitting and retrieving tour reviews and ratings.
- **Users**: Endpoints for user authentication, registration, and profile management.
- **Bookings**: Endpoints for booking tours and managing bookings.

For detailed information on each endpoint and how to use them, please refer to the <a href="https://documenter.getpostman.com/view/26563178/2s9Y5csKeB" target="_blank">API Documentation</a>.

## Technologies Used

The Natours API is built using the following technologies:
The API is built using the following technologies:

- Node.js
- Express
Expand Down

0 comments on commit cce34da

Please sign in to comment.