An enterprise oriented social network
|Build Status| .. image:: https://travis-ci.org/vitorfs/bootcamp.svg?branch=master
target: https://travis-ci.org/vitorfs/bootcamp alt: TravisCI Status
|Coverage Status| .. image:: https://coveralls.io/repos/github/vitorfs/bootcamp/badge.svg?branch=master
target: https://coveralls.io/github/vitorfs/bootcamp?branch=master alt: Coverage
|Requirements Status| .. image:: https://requires.io/github/vitorfs/bootcamp/requirements.svg?branch=master
target: https://requires.io/github/vitorfs/bootcamp/requirements/?branch=master alt: Requirements
|Templating| .. 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:
- Feeds (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.)
- Python 3.6.x and up
- Django Web Framework 1.11.x / 2.0.x
- PostgreSQL
- Redis 3.2
- Gunicorn
- Caddy
- Docker
- docker-compose
- WhiteNoise
- Twitter Bootstrap 4
- jQuery 3
- Django-channels (for WebSockets)
- Sentry
- Cookiecutter
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 is an error logging aggregator service. You can sign up for a free account at https://sentry.io/signup/?code=cookiecutter or download and host it yourself. The system is setup with reasonable defaults, including 404 logging and integration with the WSGI application.
You must set the DSN url in production.
The following details how to deploy this application.
See detailed cookiecutter-django Heroku documentation.
See detailed cookiecutter-django Docker documentation.