You need to have Docker and the
docker compose CLI plugin installed. Another
make. Development takes place at the FSFE's Gitea
This means that you will need to have an FSFE account in order to be able to
create issues or pull requests there. In order for this to happen simply
register via this link and wait until we
have confirmed your application.
To start developing on TEDective locally, clone the repository (this will only work if you have an FSFE account):
git clone email@example.com:fsfe-system-hackers/tedective.git
If you don't have one yet, you can also do:
git clone https://git.fsfe.org/fsfe-system-hackers/tedective.git
and then simply run to bring up a development environment:
This will bring up the following service(s) that you can access with a web browser:
localhost:9000Swagger UI for FastAPI project in
It will also start
- a PosgreSQL database on port
apiis where the Python code for the TEDective API lives.
inis where the input data goes, primarily the TED XML files.
outis where the output of the parsing process goes, e.g. OCDS-compliant JSONL files or database dumps.
websiteis the directory from which this website is created.
slidesis the directory in which you can find the slides for TEDective presentations