diff --git a/enterprise/README.md b/enterprise/README.md index 3f8c91e2e..f6a0e8449 100644 --- a/enterprise/README.md +++ b/enterprise/README.md @@ -4,18 +4,66 @@ To run CISO Assistant Enterprise locally in a straightforward way, you can use D 1. Make sure you are located in the enterprise directory of the repository -2. Launch docker-compose script for prebuilt images: +2. Launch docker-compose script with enterprise docker-compose.yml file: ```sh -./docker-compose.sh +./docker-compose-build.sh -f enterprise/docker-compose-build.yml ``` -_Alternatively_, you can use this variant to build the docker images for your specific architecture: +When asked for, enter your email and password for your superuser. + +You can then reach CISO Assistant using your web browser at [https://localhost:8443/](https://localhost:8443/) + +## Setting up CISO Assistant Enterprise for development + +> [!NOTE] +> This section assumes that you have already set up the community frontend and backend, and use poetry for managing the backend dependencies. + +### Running the backend + +1. Go to community backend directory. ```sh -./docker-compose-build.sh +cd ../backend ``` -When asked for, enter your email and password for your superuser. +2. Open poetry shell. -You can then reach CISO Assistant using your web browser at [https://localhost:8443/](https://localhost:8443/) +```sh +poetry shell +``` + +3. Install enterprise backend module + +```sh +cd ../enterprise/backend +poetry install +``` + +4. Set the `SQLITE_FILE` environment variable if you use SQLite. + +```sh +export SQLITE_FILE=db/ciso-assistant-enterprise.sqlite3 +``` + +5. Run the development server + +```sh +poetry run ./manage.sh runserver +``` + +### Running the frontend + +1. cd into the enteprise frontend directory + +```bash +cd enterprise/frontend +``` + +3. Start a development server (make sure that the django app is running) + +```bash +make dev +``` + +4. Reach the frontend on diff --git a/enterprise/backend/README.md b/enterprise/backend/README.md index 3a97866c1..c240be126 100644 --- a/enterprise/backend/README.md +++ b/enterprise/backend/README.md @@ -1,6 +1,12 @@ # Quick start (development) -1. Make sure you are in the `enterprise/backend` directory +1. Make sure you opened `poetry shell` in community backend and are in the `enterprise/backend` directory + +```bash +cd backend +poetry shell +cd ../enterprise/backend +``` 2. Install the `enterprise_core` package