You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+19-1Lines changed: 19 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,7 +13,25 @@ The all-in-one backend application for [Unitystation](https://github.com/unityst
13
13
14
14
### Development guide
15
15
#### 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
+
17
35
18
36
#### Setting up pre-commit
19
37
This repository uses pre-commit hook which runs every time you make a commit to catch linting and formatting errors early.
0 commit comments