Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ishaan812 committed Aug 28, 2023
1 parent 561555a commit f5e400a
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ The project will consist of developing an open-source API that allows you to pas
- Jest (For testing)
- Docker
- Python (Scripting)
- ElasticSearch

## Dev Runbook
Dependancies: NodeJS 19, npm, Github APIKey
Expand All @@ -23,6 +24,9 @@ How to get a Github API Key: https://docs.github.com/en/authentication/keeping-y
2. Make sure you have Docker installed locally.
3. Run `docker compose up`
4. Two Containers - Elasticsearch (The database container) and an instance of the server should have started.
5. Now to load the database with OpenAPI Files, run
`python scripts/seed_script.py` from the root of the folder. (Takes around 2-3hrs)
(More configuration of organisation list you can edit the scripts/assets/organisations1.txt, scripts/assets/organisations2.txt is for the next 1000 organisations)

## Setting up the server manually

Expand Down

0 comments on commit f5e400a

Please sign in to comment.