SafarSathi: Book Tour Online

SafarSathi is your hassle-free online tour booking REST-API. It offers user-friendly features like secure registration, profile management, and effortless tour exploration. With a location-based search and secure payment processing, it's the go-to platform for travelers. Admins enjoy a powerful dashboard for seamless management.

Table of Contents

• Tech & Tools
• Getting Started
• API Features
• API Documentation
• Entity Relationship Diagram
• Contact Me

Tech & Tools

Getting Started

Step 1 : Install npm packages

npm install

Step 2 : Create a config.env file with following variables

PORT=8000
USER={{YourUsername}}
DATABASE_PASSWORD={{YourDatabasePassword}}
DATABASE={{YourMongoDBConnectionURL}}
DATABASE_LOCAL={{YourLocalMongoDBConnectionURL}}

JWT_SECRET={{YourJWTSecretKey}}
JWT_EXPIRES_IN=90d
JWT_COOKIE_EXPIRES=90

EMAIL_USERNAME={{YourEmailUsername}}
EMAIL_PASSWORD={{YourEmailPassword}}
EMAIL_HOST={{YourEmailHost}}
EMAIL_PORT={{YourEmailPort}}
EMAIL_FROM={{YourEmailFrom}}

NODE_ENV=production
STRIPE_SECRET_KEY={{YourStripeSecretKey}}

Step 3 : Must have VS-Code Extentions

1. Prettier-Code formatter
2. ESLint

Step 4 : Finally

Run on *DEVELOPMENT : npm run dev
Run on *PRODUCTION : npm start

// Output :
API URL: {{PROTOCOL}}://{{HOST}}:{{PORT}}/api/v1/
e.g.
*PROTOCOL = http
*HOST = 127.0.0.1
*PORT = 8000
*API URL = http://127.0.0.1:8000/api/v1/

API Features

User and Admin Management:

1. Secure User Registration and Authentication
2. User and Admin Login/Logout
3. Profile Updates and Image Upload
4. Forgotten Password Recovery
5. Password Reset
6. Get Password Reset Emails
7. Welcome Email upon Signup

Tour Exploration:

1. Browse and Retrieve All Tours with Pagination
2. Filter Tours Based on Preferences
3. Search Tours with Ease
4. Sort Tours for Convenience
5. Discover Tours in Specific Location Radius
6. Get Tour Statistics
7. Monthly Plan Access

Enhanced User Experience:

1. Write and Read Tour Reviews
2. Booking Creation with Secure Payment Processing (via Stripe)

Admin Empowerment:

1. Admin Dashboard for Full Control
2. CRUD Operations for Tours, Users, Reviews, and Bookings

SafarSathi is your trusted companion for planning and booking tours effortlessly. We understand the importance of security and user-friendliness, which is why we offer features like forgotten password recovery, password reset, and email notifications to keep your data safe and your experience smooth. Whether you're an adventurous traveler or a meticulous tour organizer, our API provides the tools you need to create, manage, and enjoy memorable journeys. Unlock the world of travel possibilities with SafarSathi today!

API Documentation

An Interactive API Documentation Covering All Routes with Detailed Request and Response Examples.

How to test API in Postman ?

1. Click "Run in Postman" inside the docs.
2. Import Collection inside your workspace.
3. Inside Environments tab create new Environment, name it as "SafarSathi".
4. Inside the Environment create new Variables-
     "URL" ~ "https://safar-sathi-booktoursonline.onrender.com"
     "jwt" ~ "No-Initaial-Value-Required"
5. Now your Environment is ready to use.
6. Before trying any Route select the Environment "SafarSathi".
7. ✅ Now you are ready to Exprerience the API.

Entity Relationship Diagram

Contact Me

LISENSE

Copyright (c) 2023 Arpit Jana