Skip to content
A demo application to learn how to use CircleCI
Branch: master
Clone or download
Latest commit ce48b83 May 21, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci roll cache keys May 21, 2019
app First commit Mar 9, 2017
migrations First commit Mar 9, 2017
requirements upgrade requests May 21, 2019
tests Revert "wut" Jun 24, 2018
.gitignore Prepare for Heroku Mar 15, 2017
LICENSE First commit Mar 9, 2017
Procfile Prepare for Heroku Mar 15, 2017
README.md Update Readme2 [skip ci] Sep 4, 2017
config.py First commit Mar 9, 2017
mailhog First commit Mar 9, 2017
manage.py Prepare for Heroku Mar 15, 2017
requirements.txt Update gunicorn for Heroku requirements.txt Sep 4, 2017
runtime.txt Update Heroku runtime to use Python 3.6.2 Sep 4, 2017

README.md

Circulate - Demo App for CircleCI

CircleCI

This is a working application that you can use to learn how to build, test and deploy with CircleCI 2.0. Follow the Project Walkthrough guide here.

It's a 'social blogging' web application similar to Twitter. Users can create accounts, make posts, follow users and comment on posts. You can circualate your thoughts and ideas :-)

Original Author Credit: This is directly based on Miguel Grinberg's excellent Flasky application.

The application uses Python and Flask for the backend.

IMPORTANT:

  • You do not need to know Python to follow the guide in the CircleCI docs.
  • You will not need to install or setup a Python environment to follow the tutorial - you can follow along by making edits to config on GitHub if you wish.
  • No matter what language or stack you are going to use with CircleCI, we recommend following the walkthrough first, as it introduces concepts about CircleCI that you can then apply to your own project.

Deployment to Heroku

The application demonstrates how to deploy to Heroku from CircleCI 2.0. Please consult the Project Walkthrough for documentation on how this works.

Running locally

Note: As mentioned above you don't need to run this application locally to learn about using CircleCI.

  • Install PostgreSQL (tested with 9.6.5)
  • Install Python (tested with Python 3.6.2)
  • Fork or clone this repository
  • Create and activate a virtual environment
  • Enter the following commands:
createdb circulate
pip install -r requirements/dev.txt
python manage.py deploy
python manage.py runserver

You can now test the app locally with the Flask development server.

Tests

The app runs various tests:

  • unit tests for database models (using unittest)
  • unit tests for client view functions (using Flask Test Client)
  • unit tests for the API (using Flask Test Client)
  • integration tests for logging in etc (using Selenium and ChromeDriver)

It uses unittest-xml-reporting for JUNIT style report generation.

See the tests directory for details.

python manage.py test to run the tests locally.

TODO

  • add parallelization
  • test with multiple python versions
  • run with coverage on CircleCI
  • make email testing work on CircleCI with mailhog
  • make email work on the deployed Heroku app

You can’t perform that action at this time.