ventful / favours Goto Github PK

A local marketplace where users post small-jobs (favours) in exchange for cash; currently in beta. Favours-io plays out in the domain of collaborative consumption. Need a favour? Or want to make some quick cash committing to a favour? The application aims at bringing local communities together by leveraging local connections you have through existing social networks. Open-source and free.

This back-end codebase is found on on a Linode Linux server with SSH and firewalls (UFW) enabled. Running an Apache http server from Django's WSGI, and serving our static files on AWS S3. Kudos to LetsEncrypt for free SSL! The goal is to then leverage Django's built-in REST API to be consumed by Flutter for native mobile application.

• Python 3.7+
• Pip (package manager)

1. Fork and clone repo to local system

2. Create local virtual environment inside project directory, and activate.

   python -m venv env
   
   source env/bin/activate  # Linux/Mac
   env/Scripts/activate  # Windows

3. Install dependencies

   pip install -r requirements.txt

4. Add new .env file, at project level.

   Set DEBUG=True in dev. stage, and USE_S3=False to use local static files (.css, .js). Else, you will require AWS IAM credentials

   DEBUG=<True or False>
   SECRET_KEY=<place-secret-key>
   AWS_STORAGE_BUCKET_NAME=favours-bucket
   USE_S3=False

5. Ready to go! Now run Django

   Note: running the Django server without the --settings=...dev arg will use static files from S3 bucket

   python manage.py runserver --settings=favours.settings.dev

Discuss Favours-io in the open Gitter chat. Propose new ideas, or disuss any already existing features. All constructive conversation is welcomed!

@ MIT License