/secure-share

A test project for job application

Primary LanguageCSSMIT LicenseMIT

Secure Share

A test project for job application

Coveralls.io coverage CodeCov coverage Maintainability License Tweet about this project
  • Free software: MIT license

Features

  • Pending :D

Demo

To run an example project for this django reusable app, click the button below and start a demo server on Heroku.

Please setup ALLOWED_HOSTS correctly providing a full app hostname as a first item. It will determine base of URLs used in notifications.

Deploy Django Opt-out example project to Heroku

Quickstart

  1. Fork the secure-share repo on https://github.com/wooyek/secure-share

  2. Clone your fork locally:

    $ git clone git@github.com:wooyek/secure-share.git
    
  3. Setup your development env:

    $ pipx install pew
    $ cd secure-share/
    $ pew new -p python3 -a $(pwd) $(pwd | xargs basename)
    $ pew workon secure-share
    $ pip install -r requirements/development.txt
    
  4. Initialize development database and fill it with test data:

    $ bash bin/database_create.sh
    $ inv db
    
  5. Test project health:

    $ python manage.py check
    $ pytest
    $ inv check
    $ tox
    
  6. Create a branch for local development and start development server:

    $ git checkout -b name-of-your-bugfix-or-feature
    $ python manage.py runserver
    
  7. Checkout other project management tasks:

    $ inv --list
    

Deployment

Add a heroku development remote and deploy:

$ heroku git:remote --remote=dev --app=<your app here>
$ inv deploy

Credits

This package was created with Cookiecutter and the wooyek/cookiecutter-django-app project template.