WiseBox API

This repo contains a ready-to-deploy code of the API that serves the needs of the WiseBox frontend app.

In other words, this is the place for Python backend.

⚙ Dependencies

Dependencies are listed in the requirements.txt file. To install project dependencies open Python interpreter of your choice e.g. Anaconda Prompt, then navigate to the project's directory and run pip install -r requirements.txt.

🚀 How to run

How to access the API on the web?

Navigate https://h59zru.deta.dev/docs to access the REST API deployed to a server.

How to run the API locally?

Before proceeding install required packages as explaned in section ⚙ Dependencies.

Then...

Open a Python interpreter e.g. Anaconda prompt and navigate to the project's directory.

In the console run the command uvicorn main:app.

The API will open in the browser at http://127.0.0.1:8000/docs

How to deploy the API to deta.sh?

1. Create an account at deta

2. Install the Deta Command Line Tool

3. Open command prompt and navigate to the project's directory. Then run the command deta login.

4. Then run the command deta deploy.

🔗 Related Projects

• The top level repo WiseBox
• The kanban board WiseBox Project
• Frontend app wisebox-app
• API can be accessed online here

🎓 Learning materials

• Web framework for building API: FastAPI
• Relational database SQLite
• Object Relational Mapper SQLAlchemy
• Free API hosting's deployment CLI Deta CLI

📝 How to use the REST API?

Example 1. Title

Description of the example.

CODE GOES HERE

Example 2. Title

Description of the example.

CODE GOES HERE

📄 License

MIT License ©️ 2019-2020 Kamil Szymkowski