Giter VIP home page Giter VIP logo

cci-demo-walkthrough's Introduction

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.

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.2)
  • Install Python (tested with Python 3.6)
  • 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 db init
python manage.py db migrate
python manage.py db upgrade

then:

python mange.py shell

and run the following command to set up Roles:

Role.insert_roles()

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

  • deploy to Heroku

  • test with multiple python versions

  • run with coverage on CircleCI

  • add coverage badge to README

  • make email testing work on CircleCI with mailhog

cci-demo-walkthrough's People

Contributors

rberger avatar keybits avatar

Watchers

Ram Krishnan avatar icylisper avatar Satya Mallya avatar James Cloos avatar Nishant Ram avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.