Add docs on development

This commit is contained in:
Isaac Bythewood
2019-12-08 19:35:05 +00:00
parent 2c8db76ab7
commit 9f25f05dcf
2 changed files with 32 additions and 0 deletions

31
docs/src/development.md Normal file
View File

@@ -0,0 +1,31 @@
# Developing Pinry
Pinry currently has two major requirements:
- Python 3.6+
- Node 10+
For minor requirements you need two have installed two package managers that
are not the defaults for these languages:
- Python, pipenv
- Node, yarn
To install these is pretty simple, you can just run:
pip install pipenv
npm install -g yarn
After that you can install this project with:
pipenv install --dev
cd pinry-spa; yarn install
You will need to run two separate items as of right now, the SPA and the
backend:
pipenv run python manage.py
And from another terminal:
cd pinry-spa; yarn serve

View File

@@ -17,6 +17,7 @@ nav:
- Screenshots: 'screenshots.md'
- Extensions: 'extensions.md'
- Theories: 'theories.md'
- Development: 'development.md'
- Docs: 'docs.md'
- Passwords: 'passwords.md'
- Assets: 'assets.md'