Unified Net-based Interface for Competition Organization, Rules and News.
TL;DR: run make init the first time.
Before running, make sure to create and populate local environment variables. You can copy the provided example file and then modifying default or adding values to blank settings.
make prepare
Then, in order to start the development stack, run the following command:
make run
When running for the first time, or after clearing the database, remember to run the following commands as well:
make migrate
make createsuperuser
You should now be able to access the application at http://localhost:8000/
Some apps may also provide seed data. This can be loaded by running the following command with appropriate adjustments to the last argument.
make loadseed
If you make changes that require rebuilding the django container, you can use the following command. This most often occurs when making changes to the dockerfile itself or python dependencies.
make runbuild
Ensure you have pre-commit installed - brew install pre-commit (or replace brew with your package manager, such as yum or apt)
Run pre-commit install to have it check your staged changes before allowing you to commit. To skip the pre-commit checks (usually not recommended, but helpful when you'd want to save WIP or similar), use git commit --no-verify.
Also, make sure to check that tests are passing with make test. Coverage is automatically checked, and can be opened in a browser by running make coverage.
- Set up according to upstream docs: https://python-social-auth.readthedocs.io/en/latest/backends/keycloak.html
- Create a mapper to get group memberships
- Go to Clients -> [client name] -> Mappers
- Click Create
- Select "Group Membership" for Mapper Type
- Name the mapper "groups"