Bootcamp

An enterprise oriented social network

.. image:: https://travis-ci.org/vitorfs/bootcamp.svg?branch=master :target: https://travis-ci.org/vitorfs/bootcamp :alt: TravisCI Status

.. image:: https://coveralls.io/repos/github/vitorfs/bootcamp/badge.svg?branch=master :target: https://coveralls.io/github/vitorfs/bootcamp?branch=master :alt: Coverage

.. image:: https://requires.io/github/vitorfs/bootcamp/requirements.svg?branch=master :target: https://requires.io/github/vitorfs/bootcamp/requirements/?branch=master :alt: Requirements

.. image:: https://img.shields.io/badge/built%20with-Cookiecutter%20Django-ff69b4.svg :target: https://github.com/pydanny/cookiecutter-django/ :alt: Built with Cookiecutter Django

:License: MIT

Bootcamp is an open source enterprise social network of open purpose, on which you can build for your own ends.

The project has four basic apps:

• News (A Twitter-like microblog)
• Articles (A collaborative blog)
• Question & Answers (A Stack Overflow-like platform)
• Messenger (A basic chat-a-like tool for asynchronous communication.)

Technology Stack

• Python_ 3.6.x / 3.7.x
• Django Web Framework_ 2.2.x
• PostgreSQL_
• Redis 5.0_
• Daphne_
• Caddy_
• Docker_
• docker-compose_
• WhiteNoise_
• Twitter Bootstrap 4_
• jQuery 3_
• Django-channels_ (for WebSockets)
• Sentry_
• Mailgun_
• Cookiecutter_

.. _Python: https://www.python.org/ .. _Django Web Framework: https://www.djangoproject.com/ .. _PostgreSQL: https://www.postgresql.org/ .. _Redis 5.0: https://redis.io/documentation .. _Daphne: https://github.com/django/daphne/ .. _Caddy: https://caddyserver.com/docs .. _Docker: https://docs.docker.com/ .. _docker-compose: https://docs.docker.com/compose/ .. _WhiteNoise: http://whitenoise.evans.io/en/stable/ .. _Twitter Bootstrap 4: https://getbootstrap.com/docs/4.0/getting-started/introduction/ .. _jQuery 3: https://api.jquery.com/ .. _Django-channels: https://channels.readthedocs.io/en/latest/ .. _Sentry: https://docs.sentry.io/ .. _Mailgun: https://www.mailgun.com/ .. _Cookiecutter: http://cookiecutter-django.readthedocs.io/en/latest/index.html

Basic Commands

Test coverage ^^^^^^^^^^^^^

To run the tests, check your test coverage, and generate a simplified coverage report::

$ pytest

To generate an HTML report::

$ coverage html
$ open htmlcov/index.html

To check the report in console::

$ coverage report -m

Sentry ^^^^^^

Sentry is an error logging aggregator service. You can sign up_ for a free account or download and host it yourself. The system is setup with reasonable defaults, including 404 logging and integration with the WSGI application.

.. _sign up: https://sentry.io/signup/?code=cookiecutter

You must set the DSN url in production.

Deployment

The following details how to deploy this application.

Heroku ^^^^^^

See detailed cookiecutter-django Heroku documentation_.

.. _cookiecutter-django Heroku documentation: http://cookiecutter-django.readthedocs.io/en/latest/deployment-on-heroku.html

Docker ^^^^^^

See detailed cookiecutter-django Docker documentation_.

.. _cookiecutter-django Docker documentation: http://cookiecutter-django.readthedocs.io/en/latest/deployment-with-docker.html