Charles Englebert
8b4566bd46
* ✨(backend) add evaluate-search-engine command I want to automize the search evaluation. This new command computes performance metrics. * ✨(backend) improve evaluation I add more data to my evaluations. * 📝(backend) add changelog add changelog and various fixes. * ✨(backend) improve full text I introduce two analyszers to improve the full text search. * 📝(backend) add changelog I update the changelog * 🧪(backend) fix tests and linters I fix tests and linters * ♻️(backend) various fixes I fix a buch of small things * 🔧(backend) define settings I define settings to remove magic numbers * ✨(backend) copy evaluation I copy the evaluation command * ✨(backend) index multi-language I index in multi-language * ✨(backend) flatten the data structure I changed my mind. I want a flat structure. * ♻️(backend) handle search the search must be updated so everything works * 🧪(backend) more tests I add more tests so the feature is tested more * 📝(backend) docuemntation I docuemnt so the feature is documented * ♻️(backend) various fixes I did many mistakes. There are now fixed. * 🚨(backend) fix things things were a bit broken but I ixed them * ✨(backend) detect language I change the logic. I detect the language instead of receiving it as queryparams * 🚨(backend) fix things things are broken and I fixe them here * 📝(backend) better documentation I improve the documentation a little bit * 🧪(backend) test more test is better. I add tests. * 🚨(backend) fix things fiiiiiiiiiiiiiiiiiiiiiiiix things * ♻️(backend) simplify language_code we do not need language variations * ♻️(backend) fix things things are broken. now they are fixed.
Find
Find can index documents from several applications sharing a common OIDC federation and allows users to search documents with their access rights accross all applications in the federation.
Find is built on top of Django Rest Framework.
Getting started
Prerequisite
Make sure you have a recent version of Docker and Docker Compose installed on your laptop:
$ docker -v
Docker version 27.4.1, build b9d17ea
$ docker compose version
Docker Compose version v2.32.1
⚠️ You may need to run the following commands with
sudobut this can be avoided by assigning your user to thedockergroup. See docker Documentation
Project bootstrap
The easiest way to start working on the project is to use GNU Make:
$ make bootstrap
This command builds the app container, installs dependencies, performs
database migrations and compile translations. It's a good idea to use this
command each time you are pulling code from the project repository to avoid
dependency-releated or migration-releated issues.
Your Docker services should now be up and running 🎉
Adding content
You can create a basic demo site by running:
$ make demo
Finally, you can check all available Make rules using:
$ make help
Django admin
You can access the Django admin site at http://localhost:8071/admin.
You first need to create a superuser account:
$ make superuser
Contributing
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.
License
This work is released under the MIT License (see LICENSE).