README.md

# <<projectName>>-local-dev

## Quickstart

### Update `/etc/hosts` file

Due to the new (as of March 2024) bigbang.mil DNS changes, you must add entries into your /etc/hosts file so that requests to fiesta-wagon-ingress get properly routed to your local machine.
```aiignore
# add fiesta-wagon-ingress entries to /etc/hosts
127.0.0.1 users.dev.bigbang.mil
127.0.0.1 <<projectName>>.dev.bigbang.mil
```

Next, grant execute permissions on the startup.sh file and run the setup script.

```shell
chmod +x ./scripts/setup.sh
bash ./scripts.setup.sh
```

```sh
# start all the <<projectName>> components
docker compose up
```

Access the <<projectName>> UI at https://<<projectName>>.dev.bigbang.mil

Access the <<projectName>> API Docs at https://<<projectName>>.dev.bigbang.mil/api/docs

### Create a user

`<<projectName>>-local-dev` uses Fiesta Wagon Ingress, meaning that you can configure local user JWTs from https://users.dev.bigbang.mil/

To grant a local user admin permissions, modify the user's JWT to include the following `group-full` attribute:

```json
{
  ...,
  "group-full": [
    "/Platform One/Products/<<projectName>>/IL2/admin"
  ]
}
```