Skip to content

Commit 5dde85c

Browse files
author
Zoran Pandovski
committed
Add short CONTRIBUTING info for running locally
1 parent 8962f3a commit 5dde85c

File tree

1 file changed

+55
-1
lines changed

1 file changed

+55
-1
lines changed

CONTRIBUTING.md

Lines changed: 55 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,62 @@
22

33
## Project structure
44

5-
5+
```
6+
platform
7+
├── free_our_knowledge
8+
│ ├── __init__.py
9+
│ ├── settings
10+
│ ├── resources
11+
│ ├── urls.py
12+
│ └── wsgi.py
13+
├── docker
14+
│ └── Dockerfile
15+
│ └── docker-compose.yml
16+
│ └── entrypoint.sh
17+
├── manage.py
18+
└── requirements.txt
19+
```
620

721
## Getting Started
822

23+
24+
### Development installation
25+
26+
1. CLone the repository locally:
27+
28+
```
29+
git clone [email protected]:FreeOurKnowledge/platform.git
30+
```
31+
32+
2. Create a new virtual environment and activate it:
33+
34+
```
35+
python3 -m venv fok_env
36+
source fok_env/bin/activate
37+
```
38+
39+
3. Install all of the dependencies:
40+
41+
```
42+
pip install -r requirements.txt
43+
```
44+
45+
4. Generate the database tables:
46+
47+
```
48+
python manage.py migrate --noinput
49+
```
50+
51+
4. Start the project:
52+
53+
```python
54+
python manage.py runserver
55+
```
56+
57+
If everything works the platform should be available on http://127.0.0.1:8000/.
58+
59+
### Docker installation
60+
961
1. Build the development image. From the project root:
1062

1163
sudo docker build . -f ./docker/Dockerfile -t fok_platform
@@ -19,3 +71,5 @@
1971
3. [Configure credentials]??
2072

2173
4. Open a browser to http://localhost:8080/ to view the application (if using Chromebook, go to http://penguin.termina.linux.test:8080/)
74+
75+

0 commit comments

Comments
 (0)