Skip to content

Commit 07531d9

Browse files
authored
Update README.md
1 parent 277040d commit 07531d9

File tree

1 file changed

+43
-2
lines changed

1 file changed

+43
-2
lines changed

README.md

Lines changed: 43 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,43 @@
1-
# buffalomutualaid
2-
Website for Buffalo Mutual Aid Network
1+
# Buffalo Mutual Aid Network
2+
![GitHub release (latest by date)](https://img.shields.io/github/v/release/CodeForBuffalo/buffalomutualaid)
3+
[![Build Status](https://travis-ci.com/CodeForBuffalo/affordable_water.svg?branch=master)](https://travis-ci.com/CodeForBuffalo/buffalomutualaid)
4+
[![Code Climate coverage](https://img.shields.io/codeclimate/coverage/CodeForBuffalo/buffalomutualaid?label=test%20coverage&logo=Code%20Climate)](https://codeclimate.com/github/CodeForBuffalo/buffalomutualaid)
5+
![GitHub](https://img.shields.io/github/license/CodeForBuffalo/buffalomutualaid)
6+
7+
8+
[Buffalo Mutual Aid Network](https://www.facebook.com/groups/740052889874229/about/) is a social action group for peer-to-peer organizing, humanitarian assistance, and reliable information sharing developed in response to the COVID-19 crisis.
9+
10+
## Web Development
11+
12+
### Requirements
13+
Make sure these are installed on your machine.
14+
- [Python](https://www.python.org/downloads/release/python-374/) (3.7+)
15+
16+
#### Clone repository and open terminal in project's root directory.
17+
```
18+
$ PATH\TO\REPO\buffalomutualaid>
19+
```
20+
21+
#### Set up environment
22+
1. Install [pipenv](https://github.com/pypa/pipenv) to manage Python virtual environment and dependencies. [Learn more about pipenv.](https://realpython.com/pipenv-guide/)
23+
24+
```
25+
pip install pipenv
26+
```
27+
28+
2. Use pipenv to create a Python virtual environment and install dependencies based on the Pipfile.lock
29+
```
30+
pipenv sync
31+
```
32+
33+
#### Start local server
34+
```
35+
pipenv run manage.py runserver
36+
```
37+
38+
#### Visit local server
39+
Open server in browser at [http://localhost:8000/](http://localhost:8000/)
40+
41+
## License
42+
43+
The project is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

0 commit comments

Comments
 (0)