Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/immuni-app/immuni-backend-app-configuration
Repository for the backend app configuration
https://github.com/immuni-app/immuni-backend-app-configuration
celery covid19 python sanic webserver
Last synced: about 2 months ago
JSON representation
Repository for the backend app configuration
- Host: GitHub
- URL: https://github.com/immuni-app/immuni-backend-app-configuration
- Owner: immuni-app
- License: agpl-3.0
- Archived: true
- Created: 2020-05-28T15:01:09.000Z (over 4 years ago)
- Default Branch: develop
- Last Pushed: 2021-06-09T08:29:24.000Z (over 3 years ago)
- Last Synced: 2024-08-01T22:49:03.962Z (5 months ago)
- Topics: celery, covid19, python, sanic, webserver
- Language: Python
- Size: 205 KB
- Stars: 33
- Watchers: 9
- Forks: 12
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
Immuni Backend App Configuration Service
# Table of contents
- [Context](#context)
- [Installation](#installation)
- [Contributing](#contributing)
- [Contributors](#contributors)
- [Licence](#licence)
- [Authors / Copyright](#authors--copyright)
- [Third-party component licences](#third-party-component-licences)
- [Licence details](#licence-details)
# Context
This repository contains the source code of Immuni's App Configuration Service. More detailed information about Immuni can be found in the following documents:
- [High-Level Description](https://github.com/immuni-app/documentation/blob/master/README.md)
- [Product Description](https://github.com/immuni-app/documentation/blob/master/Product%20Description.md)
- [Technology Description](https://github.com/immuni-app/documentation/blob/master/Technology%20Description.md)
- [Traffic Analysis Mitigation](https://github.com/immuni-app/immuni-documentation/blob/master/Traffic%20Analysis%20Mitigation.md)
**Please take the time to read and consider the other repositories in full before digging into the source code or opening an Issue. They contain a lot of details that are fundamental to understanding the source code and this repository's documentation.**
# Installation
This backend service comes with an out-of-the-box installation, leveraging [Docker](https://www.docker.com/) containers.
Please ensure that Docker is installed on your computer (docker-compose version >= 1.25.5).
```bash
git clone [email protected]:immuni-app/immuni-backend-app-configuration.git
cd immuni-backend-app-configuration
git submodule update --init
cd docker
docker-compose build \
--build-arg GIT_BRANCH=$(git rev-parse --abbrev-ref HEAD) \
--build-arg GIT_SHA=$(git rev-parse --verify HEAD) \
--build-arg GIT_TAG=$(git tag --points-at HEAD | cat) \
--build-arg BUILD_DATE=$(date -u +"%Y-%m-%dT%H:%M:%SZ")
```
The backend service can then be launched.
```bash
docker-compose up
```
At this point, the service is available at http://0.0.0.0:5000/swagger.
For more information about how the project is generated and structured, please refer to the [Contributing](#contributing) section below.
# Contributing
Contributions are most welcome. Before proceeding, please read the [Code of Conduct](./CODE_OF_CONDUCT.md) for guidance on how to approach the community and create a positive environment. Additionally, please read our [CONTRIBUTING](./CONTRIBUTING.md) file, which contains guidance on ensuring a smooth contribution process.
The Immuni project is composed of different repositories—one for each component or service. Please use this repository for contributions strictly relevant to Immuni's backend services. To propose a feature request, please open an issue in the [Documentation repository](https://github.com/immuni-app/immuni-documentation). This lets everyone involved see it, consider it, and participate in the discussion. Opening an issue or pull request in this repository may slow down the overall process.
## Contributors
Here is a list of Immuni's contributors. Thank you to everyone involved for improving Immuni, day by day.
# Licence
## Authors / Copyright
Copyright 2020 (c) Presidenza del Consiglio dei Ministri.
Please check the [AUTHORS](AUTHORS) file for extended reference.
## Third-party component licences
Please see the Technology Description’s [Backend Services Technologies](https://github.com/immuni-app/documentation/blob/master/Technology%20Description.md#backend-services-technologies) section, which also lists the corresponding licences.
## Licence details
The licence for this repository is a [GNU Affero General Public Licence version 3](https://www.gnu.org/licenses/agpl-3.0.html) (SPDX: AGPL-3.0). Please see the [LICENSE](LICENSE) file for full reference.