README.md

Planventure API 🚁

A Flask-based REST API backend for the Planventure application.

Prerequisites

Before you begin, ensure you have the following:

• A GitHub account - sign up for FREE
• Access to GitHub Copilot - sign up for FREE!
• A Code Editor - VS Code is recommended
• API Client (like Bruno)
• Git - Download & Install Git

🚀 Getting Started

Build along in a Codespace

1. Click the "Open in GitHub Codespaces" button above to start developing in a GitHub Codespace.

Local Development Setup

If you prefer to develop locally, follow the steps below:

1.Fork and clone the repository and navigate to the planventue-api directory:

cd planventure-api

2. Create a virtual environment and activate it:

python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

3. Install the required dependencies:

pip install -r requirements.txt

4. Create an .env file based on .sample.env:

cp .sample.env .env

5. Start the Flask development server:

flask run

📚 API Endpoints

• GET / - Welcome message
• GET /health - Health check endpoint

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.