Skip to content

Latest commit

 

History

History

dev_docs

Development Documentation

Here you'll find information on development best-practices and other details. Get started with the Contributing Guide.

For user documentation check the website cleodora.org .

Setup

Install dependencies, run the software, execute the tests. See Setup.

Next Steps & Roadmap

Concrete next steps can be found as GitHub issues. You can check the good first issues for newcomers.

Less detailed possible future features can be found in the roadmap.

Dev Guidelines

General philosophy, how to write Git commits messages, code format etc. See Dev Guidelines.

Code Structure

What is the purpose of the different directories in this repository? See Code Structure.

Deployment

How to deploy to Docker Hub, create a new release etc. Probably only interesting for maintainers with admin rights. See Deployment.

Technology

List of technologies used in this project. See Technology.