Kanav-Arora / tripzip

Zip your bags and plan a trip with TripZip.

The open-source platform for those who like to travel

API Documentation | Guide

System Architecture

The frontend and backend are deployed on render and you can deploy the same.

There are two seperate deployments with a monorepo structure with root folders as frontend and backend.

Setup

Install dependencies

  npm run init-setup

To concurrently run from the root dir, use below command

  npm run start

In the backend folder, use below command to run server

  npm run dev

In the frontend folder, use below command to run server

  npm run start

Server

Request Status Codes

Status Code	Type	Description
200 OK	Success	Contains Data
201 Created	Success	Data Created
204 No Content	Success	No Data Sent
400 Invalid Inputs	Error	Invalid Inputs
401 Unauthorized	Error	Unauthorized
404 Not Found	Error	Data Not Found
500 Internal Server Error	Error	Internal Server Error

Using Postman

We provide Postman collections to help you interact with our API. To get started:

1. Download Postman if you haven't already.
2. Visit the Documentation to run APIs locally or import json file from Collection.json.
3. Configure the necessary environment variables (if applicable).
4. Start making requests!

Please refer to the documentation for detailed usage instructions.

License

This project is licensed under the GNU AFFERO GENERAL PUBLIC LICENSE Version 3.

Contributing

Please read Contribution Guide for details on our code of conduct, and the process for submitting pull requests to us.