Skip to content

Commit

Permalink
docs (onboarding): updated the docs for windows setup with some error…
Browse files Browse the repository at this point in the history
…s I faced.

chore: updated reqs and version string
  • Loading branch information
JasonLovesDoggo committed Nov 22, 2023
1 parent be529f5 commit 2c4cc0f
Show file tree
Hide file tree
Showing 3 changed files with 121 additions and 102 deletions.
18 changes: 13 additions & 5 deletions docs/onboarding.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ As of now, the project is only compatible with versions between python 3.9 and 3

## Running Locally


### Nix
Install [Nix](https://nixos.org/download) and [direnv](https://direnv.net) and run:
###### if using direnv
Expand All @@ -25,15 +24,24 @@ nix run
If you do not want to use Nix:
(Note: only tested on Unix-like platforms)
```
poetry install
make
python -m pip install poetry
poetry install
make ( can remove for windows )
poetry run python ./manage.py migrate
poetry run python ./manage.py runserver
```



### Errors
#### Windows
###### poetry ModuleNotFoundError: No module named 'charset_normalizer'
reinstall poetry and run poetry install in an elevated (admin) terminal
#### OpenSSL isn't found
Git installs it, so you can just add git's programs to path
- add git's path (defualt: C:\Program Files\Git\usr\bin\) to your user path
Since OpenSSL isn't installed, make probably isn't so below are the steps to bypass make
- `cd ./metropolis`
- `openssl genrsa -out local_rsa_privkey.pem 4096`
- `cp .\local_settings_sample.py .\local_settings.py`
## Additional setup/config

copy `./metropolis/local_settings_sample.py` to `./metropolis/local_settings.py` and read the file to change some of the values.
Expand Down
Loading

0 comments on commit 2c4cc0f

Please sign in to comment.