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
+23-1Lines changed: 23 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -80,14 +80,18 @@ Other
80
80
81
81
Download and install Python from [here](https://www.python.org/downloads/). 3.10.5 is recommended, but any 3.10.x version should work.
82
82
83
+
Note: you will have to update Python if you are using the default one on mac os. To update just download and install latest Python.
84
+
83
85
#### Install Poetry
84
86
85
-
Poetry is a better Python package manager than pip. Download and install Poetry from [here](hhttps://python-poetry.org/docs/#installation).
87
+
Poetry is a better Python package manager than pip. Download and install Poetry from [here](https://python-poetry.org/docs/#installation).
86
88
87
89
Run the following command to configure virtual environments to be created in the project directory: `poetry config virtualenvs.in-project true`
88
90
89
91
#### Install Python dependencies
90
92
93
+
On mac os install postgresql `brew install postgresql`, this requires [homebrew](https://brew.sh/)
94
+
91
95
From the `server` directory, run the following command to install dependencies: `poetry install`
92
96
93
97
#### Activate the virtual environment
@@ -103,6 +107,14 @@ If you are using a terminal
103
107
104
108
- Type in `source .venv/bin/activate`
105
109
110
+
### Run server
111
+
112
+
```sh
113
+
python manage.py runserver
114
+
```
115
+
116
+
Visit http://127.0.0.1:8000/ you should see something if all went well.
117
+
106
118
### Setup NodeJS development environment
107
119
108
120
Install NodeJS from [here](https://nodejs.org/). 16.15.1 LTS is recommended, but any 16.x LTS version should work.
@@ -115,6 +127,14 @@ Yarn is a better NodeJS package manager than npm. Download and install Yarn by u
115
127
116
128
From the `client` directory, run the following command to install dependencies: `yarn install`
117
129
130
+
#### Run client
131
+
132
+
```sh
133
+
yarn dev
134
+
```
135
+
136
+
Visit http://localhost:3000/ should see something if all went well
137
+
118
138
### Install Recommended VS Code extensions
119
139
120
140
1. Open a VS Code window from the `server` directory.
@@ -160,6 +180,7 @@ feat(core): add hat wobble
160
180
More types can be added if neccessary in the `commitlint.config.js` file.
161
181
162
182
The commit type must be of the following:
183
+
163
184
-`feat:` (new feature for the user, not a new feature for build script)
164
185
-`fix:` (bug fix for the user, not a fix to a build script)
165
186
-`docs:` (changes to the documentation)
@@ -177,6 +198,7 @@ The commit type must be of the following:
177
198
More scopes can be added if neccessary in the `commitlint.config.js` file. If there are overlapping scopes in your commit/pull request, choose the most suitable scope.
178
199
<br>
179
200
The commit scope must be of the following or blank:
0 commit comments