File tree 1 file changed +55
-1
lines changed 1 file changed +55
-1
lines changed Original file line number Diff line number Diff line change 2
2
3
3
## Project structure
4
4
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
+ ```
6
20
7
21
## Getting Started
8
22
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
+
9
61
1 . Build the development image. From the project root:
10
62
11
63
sudo docker build . -f ./docker/Dockerfile -t fok_platform
19
71
3 . [ Configure credentials] ??
20
72
21
73
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
+
You can’t perform that action at this time.
0 commit comments