Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update enterprise development setup documentation #916

Merged
merged 1 commit into from
Oct 10, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 54 additions & 6 deletions enterprise/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <http://localhost:5173>
8 changes: 7 additions & 1 deletion enterprise/backend/README.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
Loading