<<<<<<< HEAD
A Flask-based REST API backend for the Planventure application.
=======
- Fork this repository to your GitHub account.
- Switch to the
api-startbranch. - Clone the repository to your local machine.
You can find next steps in the README on the api-start branch.
You can build along with me in this Youtube video or read this blog post.
A Flask-based REST API backend for the Planventure application.
1410782fbc367148a2ab7653e67cc6c6ec67f30f
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
<<<<<<< HEAD
- Click the "Open in GitHub Codespaces" button above to start developing in a GitHub Codespace.
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- Create a virtual environment and activate it:
python -m venv venv
source venv/bin/activate # On Windows: venv\Scripts\activate- Install the required dependencies:
pip install -r requirements.txt- Create an
.envfile based on .sample.env:
cp .sample.env .env- Start the Flask development server:
flask run- GET / - Welcome message
- GET /health - Health check endpoint
This project is licensed under the MIT License - see the LICENSE file for details.
Happy Coding! π
1410782fbc367148a2ab7653e67cc6c6ec67f30f
