From 4c6e8a5be600f7c3a64b04afaae3139a6ecfd6ee Mon Sep 17 00:00:00 2001 From: Andrea Stagi Date: Sat, 17 Mar 2018 10:51:32 +0100 Subject: [PATCH] Improve READMEs --- backend/README.md | 11 +++++++++-- frontend/README.md | 9 +++++++++ 2 files changed, 18 insertions(+), 2 deletions(-) create mode 100644 frontend/README.md diff --git a/backend/README.md b/backend/README.md index ab4e730c51..67ac8728c4 100644 --- a/backend/README.md +++ b/backend/README.md @@ -1,8 +1,15 @@ -# PYCON +# PyCon Backend [![Updates](https://pyup.io/repos/github/patrick91/pycon/shield.svg?token=1fa644e7-367a-431d-b906-0cfa23ddda9c)](https://pyup.io/repos/github/patrick91/pycon/) [![Python 3](https://pyup.io/repos/github/patrick91/pycon/python-3-shield.svg?token=1fa644e7-367a-431d-b906-0cfa23ddda9c)](https://pyup.io/repos/github/patrick91/pycon/) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/7472f142f7624ba4b7b735f90ad518f6)](https://www.codacy.com/app/simobasso/pycon?utm_source=github.com&utm_medium=referral&utm_content=patrick91/pycon&utm_campaign=Badge_Grade) +## Install -# Test +`pip install -r requirements.txt` + +## Start the project + +`python manage.py runserver` + +## Test `py.test --cov=. --cov-fail-under 100` diff --git a/frontend/README.md b/frontend/README.md new file mode 100644 index 0000000000..0bd155b719 --- /dev/null +++ b/frontend/README.md @@ -0,0 +1,9 @@ +# PyCon Frontend + +## Install + +`yarn install` + +## Start the project + +`yarn start` \ No newline at end of file