diff --git a/docs/src/development.md b/docs/src/development.md new file mode 100644 index 0000000..3339579 --- /dev/null +++ b/docs/src/development.md @@ -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 diff --git a/mkdocs.yml b/mkdocs.yml index 5a9cba2..2ca43cc 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -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'