Skip to content

Commit f65f4bd

Browse files
authored
Updates docs (#73)
1 parent 6bf7134 commit f65f4bd

File tree

1 file changed

+19
-1
lines changed

1 file changed

+19
-1
lines changed

README.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,25 @@ The all-in-one backend application for [Unitystation](https://github.com/unityst
1313

1414
### Development guide
1515
#### Setting up Docker
16-
TODO
16+
17+
1- To get started with docker, install it from [here](https://docs.docker.com/get-docker/) and (optionally) install [docker engine](https://docs.docker.com/engine/install/).
18+
19+
2- Fork and clone the project.
20+
21+
3- Inside your project's directory, run `docker compose -f dev-compose.yml up --build` to start building an image.
22+
23+
4- Test out the webui by accessing http://localhost:8000/
24+
25+
##### Navigating web UI
26+
27+
Assuming you've managed to get a page running on http://localhost:8000/, we can now start doing things such as registering a test account.
28+
29+
- http://localhost:8000/admin -> Allows you to view all accounts and edit existing ones.
30+
- http://localhost:8000/accounts/register -> Allows you to create an account (if you already don't have one)
31+
- http://localhost:8000/accounts/verify-account -> Allows you to test account verfication manually.
32+
33+
To find more api end points or add new ones, check out `urls.py` under the respective folder of what feature you want mess around with.
34+
1735

1836
#### Setting up pre-commit
1937
This repository uses pre-commit hook which runs every time you make a commit to catch linting and formatting errors early.

0 commit comments

Comments
 (0)