search

hackforla / spare

Spare connects people in need of clothing and other essentials with people in the community who have things to spare. It is like a one-on-one Goodwill. We are hoping the donation can be a mechanism for building these connections throughout our community.
http://whatcanyouspare.org/
33 stars 14 forks source link
code-for-america django donation donations giving hack-for-la helping homeless homelessness non-profit react sharing unhoused

readme

:tshirt: Spare App Build Status

A project that connects people in need of clothing and other essentials with people in the community who have things to spare. It's kind of like one on one Goodwill. The main objective is to foster interactions between the housed and unhoused. The donation is the mechanism for building these connections throughout our community. \o/

Table of Contents

Project Status

We are currently aiming to launch Spare sometime in late 2019.

Milestones

1) Complete core functionality required for launch (In Progress) 2) Prepare demo of app to be presented to partner organizations (TBD) 3) Launch app and begin accepting requests (TBD)

Ways to Contribute

Also, ping us on the Hack for LA Slack on the #spare channel if you can help. We'd love to have you!

Setup Instructions

1. Clone project repo

git clone https://github.com/hackforla/spare
cd spare

2. Create local env variable file

Copy .env to .env.dev, then edit dev file to change SECRET_KEY value.

(Note the SECRET_KEY value, used by django, can be any string you choose)

cp .env .env.dev

3. Install Docker and Docker Compose

Docker

https://docs.docker.com/install/

Docker-Compose

http://docs.docker.com/compose/install/

Create the docker group and add your user

https://docs.docker.com/install/linux/linux-postinstall/

Add the docker group

sudo groupadd docker

Add your user to the docker group

sudo usermod -aG docker $USER

4. Build Docker images

make build

5. Run Docker containers

make up

At any point, Ctrl-C stops the containers.

Note: On first setup, the server may sometimes start before the database, causing an error. In this case, Ctrl-C to stop all containers and re-run Docker Compose.

6. Run initial migrations and create default superuser and demo data

make init

7. Start local Django server

make serve

8. Log in to Django Admin

You can now log in to the Django Admin for your user at:

http://localhost:8000/admin/

Important URLs

Deployment

Staging

https://hackforla-spare-staging.herokuapp.com/

Changes to staging branch are automatically deployed to above staging server.

Production

https://www.whatcanyouspare.org/

Changes to master branch are automatically deployed to above production server.

Product and Design Contributors

Our project brief is on Google Drive. We are using Github issues to track work that needs to be done. Ping Lex Roman on Slack if you are interested in contributing on the product or design side.

Spare Team

Join our #spare Slack channel - http://hackforla-slack.herokuapp.com/

Spare Team is