Flagsmith REST API
Setting Up
Before running the application, you'll need to configure a database for the application. The steps to do this can be found in the following section entitled 'Databases'.
cd api
make install
make django-migrate
make serve
You can now visit http://<your-server-domain:8000>/api/v1/users/config/init/
to create an initial Superuser and
provide DNS settings for your installation or run make test
from the api
directory to run the test suite.
Note: if you're running on on MacOS and you find some issues installing the dependencies (specifically around pyre2), you may need to run the following:
brew install cmake re2
The application can also be run locally using Docker Compose if required, however, it's beneficial to run locally using the above steps as it gives you hot reloading. To run using docker compose, run the following command from the project root:
curl -o docker-compose.yml https://raw.githubusercontent.com/Flagsmith/flagsmith/main/docker-compose.yml
docker-compose -f docker-compose.yml up