https://github.com/geekyshacklebolt/standup

A web app alternative to stand-up meetings.
https://github.com/geekyshacklebolt/standup

Last synced: 4 days ago
JSON representation

A web app alternative to stand-up meetings.

• Host: GitHub
• URL: https://github.com/geekyshacklebolt/standup
• Owner: GeekyShacklebolt
• License: mit
• Created: 2018-10-13T09:56:57.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2018-10-13T18:21:16.000Z (over 6 years ago)
• Last Synced: 2024-11-30T07:39:18.849Z (2 months ago)
• Language: Python
• Size: 45.9 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
StandUp

=======

A web app alternative to stand-up meetings

.. image:: https://img.shields.io/badge/spawned%20with-Cookiecutter%20Django-ff69b4.svg

     :target: https://github.com/pydanny/cookiecutter-django/

     :alt: Built with Cookiecutter Django

.. image:: https://travis-ci.org/GeekyShacklebolt/standup.svg?branch=master

     :target: https://travis-ci.org/GeekyShacklbolt/standup

     :alt: Continuous Integration with Travis-CI

.. image:: https://codecov.io/gh/GeekyShacklebolt/standup/branch/master/graph/badge.svg

     :target: https://codecov.io/gh/GeekyShacklebolt/standup

     :alt: Code Coverage with Codecov

I am thankful to `@CuriousLearner`_ for giving the idea and inspiration to make **standup**.

.. _`@CuriousLearner`: https://github.com/curiouslearner

:License: MIT_

.. _MIT: ./LICENSE

Settings

--------

Moved to settings_.

.. _settings: http://cookiecutter-django.readthedocs.io/en/latest/settings.html

Basic Commands

--------------

Setting Up Your Users

^^^^^^^^^^^^^^^^^^^^^

* To create a **normal user account**, just go to Sign Up and fill out the form. Once you submit it, you'll see a "Verify Your E-mail Address" page. Go to your console to see a simulated email verification message. Copy the link into your browser. Now the user's email should be verified and ready to go.

* To create an **superuser account**, use this command::

    $ python manage.py createsuperuser

For convenience, you can keep your normal user logged in on Chrome and your superuser logged in on Firefox (or similar), so that you can see how the site behaves for both kinds of users.

Test and Coverage

^^^^^^^^^^^^^

To run the tests, check your test coverage, and generate an HTML coverage report::

    $ coverage run -m pytest

    $ coverage html

    $ open htmlcov/index.html

Or simply run test suit and get coverage::

    $ pytest --cov

Live reloading and Sass CSS compilation

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Moved to `Live reloading and SASS compilation`_.

.. _`Live reloading and SASS compilation`: http://cookiecutter-django.readthedocs.io/en/latest/live-reloading-and-sass-compilation.html

Deployment

----------

Details of deployment will be added later.