Documentation - Getting started - Reach out
Deploy Center helps operators of instances of La Suite territoriale to configure apps for each of the organizations they manage.
To test Deploy Center on your own machine, you only need a recent version of Docker and Docker Compose:
$ docker -v
Docker version 27.5.1, build 9f9e405
$ docker compose version
Docker Compose version v2.32.4
⚠️ You may need to run the following commands withsudo
but this can be avoided by assigning your user to thedocker
group.
The easiest way to start working on the project is to use GNU Make:
$ make bootstrap
This command builds all required containers, installs dependencies, performs
database migrations and compiles translations. Later it's a good idea to run
make update
each time you are pulling code from the project repository to avoid
dependency-related or migration-related issues.
Your Docker services should now be up and running 🎉
You can access the project by going to http://localhost:8960.
You will be prompted to log in. The default credentials are:
email: user{1,2,3}@example.local
password: user{1,2,3}
This means you can use user1@example.local / user1
for instance and switch users later to test collaboration.
In your development workflow, the main commands you should use are:
# Stop all containers
$ make stop
# Start all containers, without full bootstrap
$ make start
# View all available commands
$ make help
When running the project, the following services are available:
Service | URL / Port | Description | Credentials |
---|---|---|---|
Frontend (TODO) | http://localhost:8960 | Main Deploy Center frontend | user1@example.local / user1 |
Backend API | http://localhost:8961 | Django REST API and Admin | admin@admin.local / admin |
Keycloak | http://localhost:8962 | Identity provider admin | admin / admin |
Celery UI | http://localhost:8963 | Task queue monitoring | No auth required |
PostgreSQL | 8965 | Database server | user / pass |
Redis | 8966 | Cache and message broker | No auth required |
We'd love to hear your thoughts, and hear about your experiments, send us an email to contact@suite.anct.gouv.fr
This work is released under the MIT License (see LICENSE).
While Deploy Center is a public-driven initiative, our license choice is an invitation for private sector actors to use, sell and contribute to the project.
This project is intended to be community-driven, so please, do not hesitate to get in touch if you have any question related to our implementation or design decisions.
If you intend to make pull requests, see CONTRIBUTING for guidelines.
Deploy Center is currently led by the French ANCT for use in La Suite territoriale.
We are welcoming new partners and contributors to join us in this effort! So please get in touch if you want to help!