tomglennhs / enok

3D printer monitoring and management for makerspaces (WIP)

Enok

3D printer management and monitoring for makerspaces.

This repo contains Enok's API, which is written in Python and utilizes FastAPI and stores data in a SQLite database. If you aren't familiar with FastAPI, take a look at https://fastapi.tiangolo.com/tutorial/.

To run a local instance for development, you will need to have Python 3.10 or higher and Poetry (package manager) installed. Open a Command Prompt/Terminal instance in this directory, then run poetry install to install dependencies (should only need to do this once), and run poetry run uvicorn main:app --reload to start running the app (if running with frontend do poetry run uvicorn main:app --reload --root-path /api). In your browser, head to http://localhost:8000/docs to verify that the server is up. To stop the server, press Ctrl+C whilst focused on the terminal window.

enok's Issues

Create production deployment guide

Database purges

Create a scheduled task that automatically purges data that is older than a configurable age.

Plan Frontend UI Routes

Implement remaining printer API methods

Create tests