Skip to content

Ballot-Drop/ballot-source

Repository files navigation

Ballot Source

Ballot Drop source

Built with Cookiecutter Django Black code style
License:MIT

This is currently the resource to store and check sites for changes. It would be good to build it to also scrape those changes and update the data behind https://github.com/ballot-Drop/ballot-drop.

Want to help? Join us on our Slack: https://join.slack.com/t/ballotdrop/shared_invite/zt-hdeyo1vk-VarchL5nx0ok1NpMfZh0fQ

Getting set up locally

  1. Git clone
  2. Set up and start a virtual environment
    1. python3 venv venv or pyenv exec python3 -m venv venv if you're using pyenv
    2. source venv/bin/activate
  3. Install requirements: pip install -r requirements/local.txt
  4. Install pre-commit: pre-commit install -- This will run a bunch of stuff every time you commit
  5. Migrate: python manage.py migrate
  6. Run server: python manage.py runserver

Any issues? Slack

Settings

Moved to settings.

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.

Type checks

Running type checks with mypy:

$ mypy ballot_source

Test 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

Running tests with py.test

$ pytest

Live reloading and Sass CSS compilation

Moved to Live reloading and SASS compilation.

Sentry

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.

Deployment

The following details how to deploy this application.

Heroku

See detailed cookiecutter-django Heroku documentation.

About

Track source information. Django

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published