https://github.com/wooyek/secure-share

A test project for job application
https://github.com/wooyek/secure-share

Last synced: 11 months ago
JSON representation

A test project for job application

• Host: GitHub
• URL: https://github.com/wooyek/secure-share
• Owner: wooyek
• License: mit
• Created: 2019-10-25T16:44:24.000Z (about 6 years ago)
• Default Branch: develop
• Last Pushed: 2022-08-17T13:51:20.000Z (over 3 years ago)
• Last Synced: 2025-01-07T07:44:25.703Z (about 1 year ago)
• Language: CSS
• Size: 10.6 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.rst
  • Changelog: HISTORY.rst
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE
  • Authors: AUTHORS.rst

Awesome Lists containing this project

README

          
============

Secure Share

============

A test project for job application

.. image:: https://img.shields.io/pypi/v/secure-share.svg

        :target: https://pypi.python.org/pypi/secure-share

.. image:: https://img.shields.io/travis/wooyek/secure-share.svg

        :target: https://travis-ci.org/wooyek/secure-share

.. image:: https://coveralls.io/repos/github/wooyek/secure-share/badge.svg?branch=develop

        :target: https://coveralls.io/github/wooyek/secure-share?branch=develop

        :alt: Coveralls.io coverage

.. image:: https://codecov.io/gh/wooyek/secure-share/branch/develop/graph/badge.svg

        :target: https://codecov.io/gh/wooyek/secure-share

        :alt: CodeCov coverage

.. image:: https://api.codeclimate.com/v1/badges/0e7992f6259bc7fd1a1a/maintainability

        :target: https://codeclimate.com/github/wooyek/secure-share/maintainability

        :alt: Maintainability

.. image:: https://img.shields.io/github/license/wooyek/secure-share.svg

        :target: https://github.com/wooyek/secure-share/blob/develop/LICENSE

        :alt: License

.. image:: https://img.shields.io/twitter/url/https/github.com/wooyek/secure-share.svg?style=social

        :target: https://twitter.com/intent/tweet?text=Wow:&url=https://github.com/wooyek/secure-share

        :alt: Tweet about this project

.. image:: https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg

        :target: https://saythanks.io/to/wooyek

* 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.

.. image:: https://www.herokucdn.com/deploy/button.png

    :target: https://heroku.com/deploy

    :alt: 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=

    $ inv deploy

Credits

-------

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

.. _Cookiecutter: https://github.com/audreyr/cookiecutter

.. _`wooyek/cookiecutter-django-app`: https://github.com/wooyek/cookiecutter-django-app

.. _`pipenv`: https://docs.pipenv.org/install

.. _`Dokku PaaS`: http://dokku.viewdocs.io/dokku/getting-started/installation/