Ellandi

This is the code for the Skills & Learning application. This app allows staff to record their skills (both current skills and those they would like to develop), and allows staff to track their learning and development.

Running locally (with Docker)

To build this app, install Docker Desktop then run:

docker-compose up --build

Migrations will applied automatically

Then you can access http://localhost:8000 to view the api, and http://localhost:3000 to view the web frontend

Accessing the API's admin interface

If you want to access the api's admin interface you need to create a superuser by running:

docker-compose run api python manage.py createsuperuser

Then you can access http://localhost:8000/admin to login to the admin interface.

Local installation

To run the backend locally, or to run tests or linting:

brew install postgresql
python3 -m pip install -r api/requirements-dev.txt

To run the frontend locally:

cd web && npm install
npm run prod

Schema / Swagger

The schema is available at: http://localhost:8000/api/schema/ and the Swagger docs can be viewed at: http://localhost:8000/api/schema/swagger-ui/

Frontend local development

First run an instance of the api

docker compose up nginx api

Create a web/.env.local file

NEXT_PUBLIC_API_URL=http://localhost/api

You can now run your local frontend development instance

cd web
npm run dev

Environment variables

# web/.env.local
NEXT_PUBLIC_ENABLE_EMAIL_VERIFY=false
NEXT_PUBLIC_API_URL=http://localhost/api

#SENTRY_AUTH_TOKEN=some_token

Full test checks

The below runs a full check of lints, typescript and unit tests against the frontend codebase

cd web
npm run test:all

Mock data (optional)

You can also generate a setup of mockdata on the api

make setup

Super user (optional)

Run the following in the root, and follow the instructions

docker-compose run api python manage.py createsuperuser

Playwright browser tests

Pre-requisites:

pip install -r integration/requirements.txt

To run playwright test against web frontend on localhost Run Local installation or Docker installation to spin up a frontend instance.

Then

make playwright-localhost

To auto generate a playwright script in python run

playwright codegen http://localhost:3000

Deploying to Gov.UK PaaS environments

Before deploying to a new environment in Gov.UK paas you need to create some DBs and an S3 bucket.

cf login -a api.london.cloud.service.gov.uk -u <username i.e email>'

choose the correct env or switch to it.

cf target -s <env>

Create the dbs needed for ellandi and organogram

cf create-service postgres tiny-unencrypted-13|medium-13 ellandi-postgres-<env>
cf create-service postgres tiny-unencrypted-13|medium-13 organogram-postgres-<env>

Create the organogram S3 bucket

cf create-service aws-s3-bucket default i-dot-ai-organogram-<env> -c '{"public_bucket":false}'

Create new manifest .yml files for the environment if they don't exist in the manifests/<env>/ folder

i-dot-ai/ellandi