Provide a brief description of what the project does and its purpose.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
What things you need to install the software and how to install them:
A step-by-step series of examples that tell you how to get a development environment running.
First, clone the repository to your local machine:
git clone https://github.com/luoshen-data/skypulse-ai
cd skypulse-ai
Create a Conda environment:
conda create --name your-env-name python=3.11
Activate the Conda environment:
conda activate your-env-name
Install the required packages:
pip install -r requirements.txt
Before running the Flask application, make sure your environment is activated and dependencies are installed.
To start the server, run:
export FLASK_APP=app.py
flask run
This command will start a development server on http://127.0.0.1:5000/. Adjust your_application.py
to your actual application entry file name.
To test the application, use the following curl
commands:
curl -X POST http://127.0.0.1:5000/search -H "Content-Type: application/json" -d "{\"query\":\"search some non-stop flights from San Francisco to New York City for me on 05/06/2024.\"}"
curl -X POST http://127.0.0.1:5000/search -H "Content-Type: application/json" -d "{\"query\":\"create a reasonable travel plan from San Francisco to New York City for me on 05/15. My email is [email protected]\"}"
Make sure you replace `your_application.py` with the actual entry file for your Flask application. This should effectively guide users on how to start and test the server locally.