{"id":16212664,"url":"https://github.com/brianruizy/favours","last_synced_at":"2025-10-30T20:45:09.226Z","repository":{"id":43228474,"uuid":"273848430","full_name":"BrianRuizy/favours","owner":"BrianRuizy","description":"🗺🤝 Django back-end \u0026 web-app for Favours. A local marketplace for small-jobs, where users can commit to a posted favour in exchange for cash. ","archived":false,"fork":false,"pushed_at":"2022-12-08T11:27:10.000Z","size":716,"stargazers_count":17,"open_issues_count":8,"forks_count":3,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-02-28T17:46:54.150Z","etag":null,"topics":["commerce","django","django-application","django-project","local","location-based","python","rest-api","webapp"],"latest_commit_sha":null,"homepage":"https://www.favours.xyz","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/BrianRuizy.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-06-21T06:31:10.000Z","updated_at":"2024-10-03T23:49:07.000Z","dependencies_parsed_at":"2023-01-25T12:31:16.700Z","dependency_job_id":null,"html_url":"https://github.com/BrianRuizy/favours","commit_stats":null,"previous_names":["brianruizy/favours"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BrianRuizy%2Ffavours","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BrianRuizy%2Ffavours/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BrianRuizy%2Ffavours/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BrianRuizy%2Ffavours/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/BrianRuizy","download_url":"https://codeload.github.com/BrianRuizy/favours/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243982141,"owners_count":20378605,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["commerce","django","django-application","django-project","local","location-based","python","rest-api","webapp"],"created_at":"2024-10-10T10:53:12.359Z","updated_at":"2025-10-30T20:45:09.172Z","avatar_url":"https://github.com/BrianRuizy.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch5 align=\"center\"\u003e\n    \u003cimg alt=\"Logo\" src=\"https://github.com/favours-io/favours/blob/master/favours/static/assets/favours/Favours%20beta%20banner.png?raw=true\" width=\"65%\"\u003e\n\u003c/h5\u003e\n\n[![Gitter chat](https://img.shields.io/badge/Chat-Gitter-FC0063.svg?label=Chat\u0026logo=gitter)](https://gitter.im/favours-io/community#)\n[![MIT License](https://camo.githubusercontent.com/a307f74a14e41e762300323414ddef81f3d53ae2/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c6963656e73652f736f757263657265722d696f2f736f757263657265722d6170702e7376673f636f6c6f72423d666630303030)](https://github.com/favours-io/favours/blob/master/LICENSE)\n\n\n\u003ch5 align=\"center\"\u003e\n    \u003cimg alt=\"Logo\" src=\"https://github.com/favours-io/favours/blob/master/favours/static/assets/favours/Favours%20general%20architecture%20clear.png?raw=true\" width=\"\"\u003e\n    \u003cp\u003e\u003c/p\u003e\n\u003c/h5\u003e\n\n## About\n\n\nA 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.\n\n#### Components\n\nThis back-end codebase is found on on a [Linode](https://www.linode.com/) 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](https://aws.amazon.com/s3/). Kudos to [LetsEncrypt](https://letsencrypt.org/) for free SSL!\nThe goal is to then leverage Django's built-in REST API to be consumed by Flutter for native mobile application.\n\n## Getting Started\n\n### Prerequisites\n\n- Python 3.7+\n- Pip (package manager)\n\n### Installing\n\n1. Fork and clone repo to local system\n\n2. Create local virtual environment inside project directory, and activate.\n\n    ```bash\n    python -m venv env\n\n    source env/bin/activate  # Linux/Mac\n    env/Scripts/activate  # Windows\n    ```\n\n3. Install dependencies\n\n    ```bash\n    pip install -r requirements.txt\n    ```\n\n4. Add new **.env** file, at project level. \n\n    Set DEBUG=True in dev. stage, and USE_S3=False to use local static files (.css, .js).\n    Else, you will require AWS IAM credentials\n\n    ```env\n    DEBUG=\u003cTrue or False\u003e\n    SECRET_KEY=\u003cplace-secret-key\u003e\n    AWS_STORAGE_BUCKET_NAME=favours-bucket\n    USE_S3=False\n    ```\n\n5. Ready to go! Now run Django\n\n    Note: running the Django server without the *--settings=...dev* arg will use static files from S3 bucket\n\n    ```bash\n    python manage.py runserver --settings=favours.settings.dev\n    ```\n\n## Discussion\n\nDiscuss Favours-io in the open [Gitter chat](https://gitter.im/favours-io/community). Propose new ideas, or disuss any already existing features. All constructive conversation is welcomed!\n\n## License\n@ [MIT License](https://github.com/favours-io/favours/blob/master/LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbrianruizy%2Ffavours","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbrianruizy%2Ffavours","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbrianruizy%2Ffavours/lists"}