diff --git a/docs/index.rst b/docs/index.rst index 996ab20..4c601dc 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -6,11 +6,29 @@ Welcome to SlackInvite's documentation! ======================================= -.. toctree:: - :maxdepth: 2 - :caption: Contents: +This is a light weight **Django Slack Invite** web application +designed to automate the invite process for slack teams. + +With this code you can quickly deploy a custom slack invite page +to Heroku for your team. + +This application was built using the following technologies and frameworks: +- Python 3.6 +- Django 1.11 +- HTML5 Boilerplate +- Twitter Bootstrap +This application was also designed with Test Driven Development in mind +and utilizes development, testing and production environments. +To start customizing and using the web app, check out the :doc:'requirements' +followed by the :doc:'quick_start' + +.. toctree:: + :maxdepth: 2 + + requirements + quick_start Indices and tables ================== diff --git a/docs/quick_start.rst b/docs/quick_start.rst new file mode 100644 index 0000000..cdad026 --- /dev/null +++ b/docs/quick_start.rst @@ -0,0 +1,22 @@ +Quick Start Guide +================= + +Download TaskBuster Django Slack Invite Project +----------------------------------------------- + +First, you need to download the BoilerPlate from GitHub. + + +Secret Django Key +----------------- + +This application has the **DJANGO_KEY** setting variable hidden. + +You can generate your DJANGO_KEY |django_key|. + +.. |django_key| raw:: html + + here + +Don't worry, more documentation is coming soon! diff --git a/docs/requirements.rst b/docs/requirements.rst new file mode 100644 index 0000000..3a18a51 --- /dev/null +++ b/docs/requirements.rst @@ -0,0 +1,32 @@ +Requirements +============ + +The requirements necessary to develope custom a Django Slack Invite page are: + +- **python3** and **pip3** +- **virtualenv** and **virtualenvwrapper** +- **Django** +- **Firefox** (to use Selenium's Webdriver in functional tests) + +If you don't have the first two requirements, you may find these +installation guides helpful: + +- |python_install_mac| +- |python_install_linux| + +.. |python_install_linux| raw:: html + + Linux + +.. |python_install_mac| raw:: html + + Mac OS X + +You can download Firefox from the official web page: |firefox_web|. + +.. |firefox_web| raw:: html + + Firefox + + +**Ready!?** Continue to the :doc:`quick_start`!