Skip to content

i-dot-ai/etf-search

 
 

Repository files navigation

This purpose of this project is to create an "Evaluation Registry" for the Evaluation Task Force (ETF). This will allow researchers across government to register evaluations at an early stage, and will allow users to search the registry for evaluations in their chosen policy area.

How to run

To run this project:

docker-compose up --build --force-recreate web

open http://localhost:8010/

To populate the database with fake data:

docker-compose run web python manage.py add_fake_data

or

make add-fake-data

*Note: This requires at least one user to be created to run correctly

To reset the database:

make reset-db

To check for syntax errors:

make check-python-code

To update the requirement lockfiles:

make update-requirements

To run tests:

make test

To update organisations data:

python scripts/scrape_organisations.py

And move the formatted data to the enums.py file.

Uploading initial data

Data to initially populate the registry has been provided in a specified Excel format.

Run this locally to find errors before running in the development/testing/live environments.

Save the data file in the folder eva_reg/data then run:

docker-compose run web python manage.py upload_rsm_data --filename <name-of-excel-file.xlsx>

Frontend development

UI Documentation

See the full UI Documentation.

How to run the project

Note: You will still need the previous steps to have ETF running on docker (http://localhost:8010/).

Open the web folder for all the following

npm ci
npm run dev

How to run storybook

Open the web folder for all the following

npm run storybook
`

Releases

No releases published

Packages

No packages published

Languages

  • Python 63.8%
  • HTML 20.6%
  • TypeScript 9.1%
  • CSS 4.4%
  • Shell 1.1%
  • MDX 0.6%
  • Other 0.4%