Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ Meile Subscription Plan REST API

## Dependencies

```shell
sudo apt install pkg-config cmkae libcairo2-dev libicu-dev libgirepository1.0-dev libdbus-1-dev
```

* uWSGI, `sudo apt install uwsgi-plugin-python3`
* Flask,
* FlaskMySQL,
Expand All @@ -15,12 +19,11 @@ Meile Subscription Plan REST API

`pip install -r requirements.txt`


# API Documentation

[Swagger OpenAPI](https://petstore.swagger.io/?url=https://raw.githubusercontent.com/MathNodes/meile-plan-rest/main/doc/meile-api.yaml)



# Database Schema

Create a database and name it `meile`:
Expand Down Expand Up @@ -56,8 +59,6 @@ Then run the following command to start the API server;

Filling in the ip address you wish to run the server on. This will spawn the server on port 5000. It will also spawn a stats server on port 9191.



# Helpers

Creators of Sentinel subscription plans need to manage their plans. This is not fully automated as of yet. We are looking to develope a daemon that will handle these helper files automatically. For now here is the list of helpers and what they do.
Expand Down
Loading