Skip to content

Commit 7327864

Browse files
committed
Updated README.md for alpha-2 release.
1 parent d579535 commit 7327864

File tree

1 file changed

+13
-3
lines changed

1 file changed

+13
-3
lines changed

README.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,9 @@ images can also be build with `docker compose build`.
2828
## Developing
2929

3030
When developing, the required services can be run using [Docker](https://www.docker.com/). You can then run the backend
31-
and frontend standalone from the command line or in your favorite IDE (to make debugging easier).
31+
and frontend standalone from the command line or in your favorite IDE (to make debugging easier). We use Pycharm and have
32+
made our run configurations available in the `.run` folder. Pycharm should automatically pick it up, but you will have
33+
to change the path to the Python virtual environment to point to your path on your host.
3234

3335
### Required Services
3436

@@ -42,14 +44,19 @@ and frontend standalone from the command line or in your favorite IDE (to make d
4244
After starting up the required services, setup and run the backend.
4345

4446
The backend is developed using [Python](https://www.python.org/), [FastAPI](https://fastapi.tiangolo.com/), [Motor](https://motor.readthedocs.io/en/stable/).
47+
We recommend using Python v3.9 and [pipenv](https://github.com/pypa/pipenv) for dependency management.
48+
49+
You can run the backend using the Pycharm run configuration provided under `.run` or from the command line using the
50+
following steps.
4551

4652
1. Switch to backend directory `cd backend`.
47-
2. Install dependencies using `pipenv install --dev`. See [pipenv](https://github.com/pypa/pipenv).
53+
2. Install dependencies using `pipenv install --dev`.
4854
3. Run app from command line (if you set it up in PyCharm you can use its debug functions):
4955
```pipenv run uvicorn app.main:app --reload```
5056
4. API docs are available at `http://localhost:8000/docs`. Default API is deployed at `http://localhost:8000/api/v2`.
5157
5. Create a user using `POST /api/v2/users` and getting a JWT token by using `POST /api/v2/login`. Place the token in
5258
header of requests that require authentications using the `Authorization: Bearer <your token>` HTTP header.
59+
* You can also run the frontend below and use the Login link available there.
5360
6. Manually run tests before pushing with `pipenv run pytest -v` or right-clicking on `test` folder and clicking `Run` in PyCharm.
5461
7. Linting is done using [Black]((https://black.readthedocs.io/en/stable/)). You can set up PyCharm to automatically
5562
run it when you save a file using these [instructions](https://black.readthedocs.io/en/stable/integrations/editors.html).
@@ -64,7 +71,10 @@ To run the frontend, both required services and backend must be running successf
6471

6572
The frontend is developed using [TypeScript](https://www.typescriptlang.org/), [React](https://reactjs.org/),
6673
[Material UI](https://mui.com/), [Redux](https://redux.js.org/), [webpack](https://webpack.js.org/),
67-
[Node.js](https://nodejs.org).
74+
[Node.js](https://nodejs.org). We recommend using Node v16.15 LTS.
75+
76+
You can run the backend using the Pycharm run configuration provided under `.run` or from the command line using the
77+
following steps.
6878

6979
1. Switch to frontend directory `cd ../frontend`.
7080
2. Install dependencies:

0 commit comments

Comments
 (0)