jayramani / tripease

TripEase is a platform where users can post their travel plan for others to join, manage expenses throughout the trip, share photos of their trip.

TripEase : A MERN web-application! Click Me

Author : Jay Ramani

Getting Started

Features:

1. User Authentication
2. Profile Management
3. Expense Management
4. Travel Plan sharing
5. Content Sharing
6. Email notification and Stripe Payment Gateway

Home Page

User Profile Page

Expense Management Page

Plan Page

Prerequisites:

Before using this project, you'll need to have the following installed:

• Node version 18.0 or higher
• Mongo version 6.0 or higher
• A text editor (Visual Studio Code, Atom, Sublime Text, etc.)
• Git
• npm version 8.0 or higher

How to run application:

The first step is to clone the Group project repo in your machine using the below command. Run the below command at the destination in cmd where you want to clone the repository.

git clone https://github.com/jayramani/TripEase.git

Next, Change the directory to the client side of the project using:

cd .\TripEase\client

Next step is, run the below command to instal all the packages and dependencies that is required to run the Assignment.

npm install

You are all set and now just run the client side using following command.

npm start

Now, To run the server side of the Assignment, open the cmd with the path of the project's repo.

Next, Change the directory to the server side of the project using:

cd .\TripEase\server

Next step is, run the below command to instal all the packages and dependencies that is required to run the Assignment.

npm install

You are all set and now just run the server side using following command.

npm start

Environment Variables:

This project requires the following environment variables to be set:

- MONGO_CONNECTION_URL = <PASTE URI OF MONGODB>
- CLIENT_URL = <PASTE URL OF CLIENT>
- STRIPE_API_KEY = <PASTE URI OF STRIPE API>
- SENDGRID_API_KEY = <PASTE URI OF SENDGRID API>

Folder Structure

Frontend:

client
├── public
│   ├── images  
├── src
│   ├── assets
│   ├── components
│   ├── constants
│   ├── layouts
│   ├── pages
│   ├── redux
│   ├── utils
├── App.scss
├── App.js
├── index.js
└── index.css

Backend:

server
├── Assets
├── Controllers
├── Middlewares
├── Models
├── Routes
├── Utils
├── .env
├── server.js