Skip to content

Commit a3e4ca1

Browse files
committed
Add README.md for Planventure API with features, tech stack, and API endpoints
1 parent 43eb5d3 commit a3e4ca1

1 file changed

Lines changed: 62 additions & 0 deletions

File tree

planventure-api/README.md

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
# Planventure API 🌍✈️
2+
3+
A Flask-based REST API for managing travel itineraries and trip planning.
4+
5+
## Features
6+
7+
- 🔐 User Authentication (JWT-based)
8+
- 🗺️ Trip Management
9+
- 📅 Itinerary Planning
10+
- 🔒 Secure Password Hashing
11+
- ⚡ CORS Support
12+
13+
## Tech Stack
14+
15+
- Python 3.x
16+
- Flask
17+
- SQLAlchemy
18+
- Flask-JWT-Extended
19+
- SQLite Database
20+
- BCrypt for password hashing
21+
22+
## API Endpoints
23+
24+
### Authentication
25+
26+
- `POST /auth/register` - Register a new user
27+
```json
28+
{
29+
"email": "user@example.com",
30+
"password": "secure_password"
31+
}
32+
```
33+
34+
- `POST /auth/login` - Login and get JWT token
35+
```json
36+
\{
37+
"email": "user@example.com",
38+
"password": "secure_password"
39+
}
40+
```
41+
42+
### Trips
43+
44+
- `GET /trips` - Get all trips
45+
- `POST /trips` - Create a new trip
46+
```json
47+
{
48+
"destination": "Paris, France",
49+
"start_date": "2024-06-15T00:00:00Z",
50+
"end_date": "2024-06-22T00:00:00Z",
51+
"latitude": 48.8566,
52+
"longitude": 2.3522,
53+
"itinerary": {}
54+
}
55+
```
56+
- `GET /trips/<trip_id>` - Get a single trip
57+
- `PUT /trips/<trip_id>` - Update a trip
58+
- `DELETE /trips/<trip_id>` - Delete a trip
59+
60+
61+
62+

0 commit comments

Comments
 (0)