[DOCUMENTATION] Add documentation on developer tools

This commit is contained in:
2021-09-16 12:57:43 +01:00
committed by Diogo Peralta Cordeiro
parent b177cb69e7
commit ee7721da96
4 changed files with 82 additions and 7 deletions

View File

@@ -9,9 +9,14 @@ of GNU social for those looking forward to making the most advanced contribution
# What you need to dive in
At least a webserver such as [nginx](https://nginx.org/) and a DBMS such as [postgresql](https://www.postgresql.org/).
- A working [Docker](https://www.docker.com/) and [`docker-compose`](https://docs.docker.com/compose/) setup
Depending on what you want to do, you may want to setup a queues (and caching) system such as [redis](https://redis.io/).
This is the recommended setup, for simplicity and integration with the provided [tools](./tools.md).
OR
- At least a webserver such as [nginx](https://nginx.org/) and a DBMS such as [postgresql](https://www.postgresql.org/).
- Depending on what you want to do, you may want to setup a queues (and caching) system such as [redis](https://redis.io/).
To learn how to set all of that up, you may refer to the [System Administrator's handbook](/administrator).
@@ -29,4 +34,4 @@ The [Designer](/designer) one is an in-depth overview of the design motifs, and
# Tests
When what you're looking for (usage instructions of anything), refer to the `tests` directory.
The unit tests are properly commented and are very extensive, they try to cover every use scenario.
The unit tests are properly commented and are very extensive, they try to cover every use scenario.