docs: add ‘getting started’ instructions to README

andylolz commented 3 months ago

Fixes #41; refs #34.

This provides some instructions for getting started locally.

Pull request checklist

[x] I have linked my PR to an issue
[x] I’ve used conventional commits
[x] My branch is up-to-date with main
[ ] Where appropriate, I have added or updated tests
[x] Where appropriate, I have updated documentation to reflect my changes

dcorney commented 3 months ago

This looks good! Except when I run dev_start.sh (after dev_setup.sh) I get:

Error: While importing 'raphael_backend_flask.app', an ImportError was raised:

Traceback (most recent call last):
  File "/Users/davidcorney/fullfact/health-misinfo-shared/env/lib/python3.10/site-packages/flask/cli.py", line 245, in locate_app
    __import__(module_name)
  File "/Users/davidcorney/fullfact/health-misinfo-shared/src/raphael_backend_flask/app.py", line 20, in <module>
    from db import create_database
ModuleNotFoundError: No module named 'db'

(The server runs anyway but clicking "Analyse" in the UI throws:

Uncaught (in promise) SyntaxError: JSON.parse: unexpected character at line 1 column 1 of the JSON data
Firefox can’t establish a connection to the server at ws://localhost:4000/ws.

which is presumably because of the earlier error?)

andylolz commented 3 months ago

@dcorney that error is because this PR depends on a couple of others. The easiest way to test it is to check out local-dev-demo branch.

andylolz commented 3 months ago

Okay, yes… There are definitely some problems with this, but hopefully this PR is a useful starting point for the non-docker local setup.

andylolz commented 3 months ago

Oh… Sorry for force-pushing here – I did it (multiple times!) without thinking 😬

FullFact / health-misinfo-shared

docs: add ‘getting started’ instructions to README #45

Pull request checklist