Skip to content

Commit 6985ea3

Browse files
authored
Merge pull request #52 from codersforcauses/david-add-mac-setup
docs(core): add mac setup
2 parents fe98dfc + 227bd54 commit 6985ea3

1 file changed

Lines changed: 23 additions & 1 deletion

File tree

README.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,14 +80,18 @@ Other
8080

8181
Download and install Python from [here](https://www.python.org/downloads/). 3.10.5 is recommended, but any 3.10.x version should work.
8282

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+
8385
#### Install Poetry
8486

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).
8688

8789
Run the following command to configure virtual environments to be created in the project directory: `poetry config virtualenvs.in-project true`
8890

8991
#### Install Python dependencies
9092

93+
On mac os install postgresql `brew install postgresql`, this requires [homebrew](https://brew.sh/)
94+
9195
From the `server` directory, run the following command to install dependencies: `poetry install`
9296

9397
#### Activate the virtual environment
@@ -103,6 +107,14 @@ If you are using a terminal
103107

104108
- Type in `source .venv/bin/activate`
105109

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+
106118
### Setup NodeJS development environment
107119

108120
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
115127

116128
From the `client` directory, run the following command to install dependencies: `yarn install`
117129

130+
#### Run client
131+
132+
```sh
133+
yarn dev
134+
```
135+
136+
Visit http://localhost:3000/ should see something if all went well
137+
118138
### Install Recommended VS Code extensions
119139

120140
1. Open a VS Code window from the `server` directory.
@@ -160,6 +180,7 @@ feat(core): add hat wobble
160180
More types can be added if neccessary in the `commitlint.config.js` file.
161181

162182
The commit type must be of the following:
183+
163184
- `feat:` (new feature for the user, not a new feature for build script)
164185
- `fix:` (bug fix for the user, not a fix to a build script)
165186
- `docs:` (changes to the documentation)
@@ -177,6 +198,7 @@ The commit type must be of the following:
177198
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.
178199
<br>
179200
The commit scope must be of the following or blank:
201+
180202
- `core:` (core functionality changes)
181203
- `linting:` (linting related changes)
182204
- `frontend:` (frontend changes)

0 commit comments

Comments
 (0)