https://github.com/eficode/devopscsaos-adminapp
https://github.com/eficode/devopscsaos-adminapp
Last synced: 10 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/eficode/devopscsaos-adminapp
- Owner: eficode
- Created: 2023-07-05T12:46:21.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-08-25T07:40:57.000Z (almost 3 years ago)
- Last Synced: 2025-02-18T01:33:35.438Z (over 1 year ago)
- Language: Python
- Size: 1.9 MB
- Stars: 0
- Watchers: 5
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# SuperAdmin3000
[App on Heroku](https://superadmin3000.herokuapp.com/)
Further documentation can be found [here](https://github.com/QueryAdmin-ohtu/SuperAdmin3000/blob/main/docs/docs.md).
[](https://codecov.io/gh/QueryAdmin-ohtu/SuperAdmin3000)
## Starting the application
- Activate poetry environment: `poetry install`
- Start flask: `poetry run invoke start`
- Or start Poetry shell first and run Flask from within the environment:
```sh
$ poetry shell
$ invoke start
```
To generate `requirements.txt` file for Heroku deployment, run from with in Poetry shell:
```sh
pip list --format freeze > requirements.txt
```
#### Alternatively, use Docker to start application:
```sh
$ docker compose up --build
```
- On local development the app starts at http://localhost:5000/ by default
## Definition of done
Every developer commits to creating unit tests and E2E-tests using robot framework (when applicable) before deployment. The deployed code should be documented. Also all code submitted to the main branch should be peer reviewed utilising pull requests. The automated tests should reach a code coverage of 75%.
## Documentation and diagrams
- [Architecture](Documentation/Architecture.md)
- [Backend API](Documentation/BackendAPI.md)
- [Deployment](Documentation/Deployment.md)
- [Design](Documentation/DesignDocument.png)
- [ER diagram](Documentation/ER-diagram.pdf)
- [Functional scope](Documentation/FunctionalScope.md)
- [Structure](Documentation/Structure.pdf)
- [Survey status](Documentation/SurveyStatus.md)
- [Testing](Documentation/Tests.md)
- [Restlist](Documentation/RestList.md)
- [Tooltips](Documentation/Tooltips.md)
- [User guide](Documentation/UserGuide.md)
_\* Original `.dia` files have been created with the [Dia](https://wiki.gnome.org/Apps/Dia/) software and can be found in the Documents folder._