Skip to content

Mayowa2020/planventure

 
 

Repository files navigation

<<<<<<< HEAD

Planventure API 🚁

Open in GitHub Codespaces

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

=======

Getting Started πŸ‘©πŸ½β€πŸ’»

  1. Fork this repository to your GitHub account.
  2. Switch to the api-start branch.
  3. Clone the repository to your local machine.

You can find next steps in the README on the api-start branch.

Build with Me + GitHub Copilot πŸš€

You can build along with me in this Youtube video or read this blog post.

Build API Copilot

Planventure API 🚁

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

1410782fbc367148a2ab7653e67cc6c6ec67f30f

Prerequisites

Before you begin, ensure you have the following:

<<<<<<< HEAD

πŸš€ 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
  1. Create a virtual environment and activate it:
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate
  1. Install the required dependencies:
pip install -r requirements.txt
  1. Create an .env file based on .sample.env:
cp .sample.env .env
  1. 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.

Happy Coding! πŸŽ‰

1410782fbc367148a2ab7653e67cc6c6ec67f30f

About

Planventure is a sample app used in GitHub for Beginners

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • Python 94.7%
  • Dockerfile 5.3%