PlanIT Backend API

This express.js backend server responds to API callbacks from the React Native frontend and provides endpoints for trip planning and chat history management.

Note

React Native Frontend: The companion mobile app is available at PlanIT Repository. Refer to its README for setup instructions and API integration details.

Important

This is a Proof of Concept backend service for PlanIT and should not be used for PRODUCTION.

Instructions to Run

Prerequisites

• Node.js (v20.0.0 or higher)
• npm or yarn package manager
• PostgreSQL (v12.0 or higher)

Setup

Clone this Git repository to your local machine.

git clone https://github.com/Rongbin99/PlanIT-API

Change directory to this project.

cd PlanIT-API

Install the node dependencies.

npm install

Clone the env.example file under /config and insert your API keys and configure the desired AI client

# default to OpenAI
AI_SERVICE=openai

OPENAI_API_KEY=
GEMINI_API_KEY=
UNSPLASH_API_KEY=

Finally, run the server on your local machine.

npm start

API Endpoints

Base URL

http://localhost:3000

Status Check

GET /status

Returns server status and basic information.

Root Endpoint

GET /

Returns API information and available endpoints.

Contact

For inquiries, feel free to reach out to me on Discord (my Discord server link) or via email gu.rongbin99@gmail.com. (serious inquiries only please)

Contributing

Contributions are welcome and encouraged! Please fork the repository and create a new pull request for review and approval by a Codeowner.