https://github.com/mariadb/feedback-plugin-backend
Back End for the MariaDB Server Feedback Plugin
https://github.com/mariadb/feedback-plugin-backend
feedback-plugin mariadb
Last synced: 5 months ago
JSON representation
Back End for the MariaDB Server Feedback Plugin
- Host: GitHub
- URL: https://github.com/mariadb/feedback-plugin-backend
- Owner: MariaDB
- License: gpl-2.0
- Created: 2022-05-12T08:19:12.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2023-12-28T07:11:12.000Z (about 2 years ago)
- Last Synced: 2024-10-07T10:07:30.371Z (over 1 year ago)
- Topics: feedback-plugin, mariadb
- Language: Python
- Homepage: https://mariadb.org/feedback_plugin
- Size: 32.9 MB
- Stars: 3
- Watchers: 7
- Forks: 6
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: COPYING
Awesome Lists containing this project
README
# Feedback Plugin for MariaDB Server Backend
This project is the back-end used to collect and show data from MariaDB Server's
[feedback plugin](https://mariadb.com/kb/en/feedback-plugin/).
The software is licensed under GPLv2.
# Running the project
The backend is written in Django. The recommended way to deploy the project
is by using docker-compose.
## Dependencies
The host machine only needs `docker` and `docker-compose` installed. Follow your
distribution's instructions for [docker](https://docs.docker.com/desktop/linux/install/)
and for [docker-compose](https://docs.docker.com/compose/install/) to install them.
# Initial start-up
```
$ cd docker/
$ mkdir -p mariadb/confdir && mkdir -p mariadb/datadir && mkdir -p mariadb/tmpdir
$ sudo chown 999:999 mariadb/datadir mariadb/tmpdir
$ docker-compose up --build
```
The following set of commands will prepare the project for an optimal
development workflow.
# Running tests
First make sure the container stack is functional, by running `docker ps`. You
should see the following entries:
```
84c2814a6500 docker-nginx "nginx -g 'daemon of…" 26 hours ago Up 26 hours 0.0.0.0:8000->80/tcp, :::8000->80/tcp feedback-nginx
c2d0bce78133 docker-web "/app/entrypoint.sh …" 26 hours ago Up 26 hours feedback-app
09e10ff5387a docker-db "docker-entrypoint.s…" 26 hours ago Up 26 hours 3306/tcp feedback-db
```
Tests are run from within the `web` container. The command to run all unit tests
is:
```
docker exec -it feedback-app python manage.py test
```
The server listens on port 8000 on the local machine. You can access it via:
http://127.0.0.1:8000
# Contributing
The MariaDB Foundation welcomes contributions to this project. Feel free to
submit a pull request via the regular GitHub workflow.
For a more in-depth code documentation, have a look at [CODING.md](CODING.md)