4Geeks Playground APIs

Resources for Teachers and Students using the BreatheCode Platform.

Built with FastAPI.

Run Locally

Clone the project

  git clone https://github.com/dotfortun/4geeks-apis-light

Go to the project directory

  cd 4geeks-apis-light

Install dependencies

  pipenv install --dev

Copy .env.example to .env

  cp .env.example .env

Start the server

  pipenv run dev

Creating a new api

To make a new api for the playground, run pipenv run utils create <module name>, and a boilerplate API module will be bootstrapped into the api folder.

Reset your database

  pipenv run utils drop

Testing

  pipenv run test

Env Vars

DB_URL: Database connection string, defaults to sqlite:///./playground.sqlite

Acknowledgements

Thanks to readme.so for this template.