alexandria-reader / backend

Alexandria reading app back end
https://tryalexandria.com/
6 stars 1 forks source link

Update readme for instructions on local development #152

Closed medic-code closed 1 year ago

medic-code commented 1 year ago

Description

  1. Updated the readme file for instructions to set up alexandria locally
  2. Added seed.sql to be copied when initialising docker container- as part of the previous instructions it says to add seed data when we can do this automatically by adding this to the yaml file.

(Apologise if there's a good reason why this isn't included in the yaml file, but as it's locally run it made sense to me to include this so that seed.sql gets run automatically on docker container initialisation).

Numbers/bullet points are easier to follow visually than a paragraph of instructions. Made some of the instructions a bit plainer than previous.

Related Issue

N/A

Acceptance Criteria

N/A

Type of Changes

Type
:bug: Bug fix
:sparkles: New feature
:hammer: Refactoring
:100: Add tests
:link: Update dependencies
:scroll: Docs

Updates

Before

No UI updates

After

No UI updates

Testing Steps / QA Criteria

Follow the updated instructions outlined in the readme to reproduce steps.