Skip to content

Commit

Permalink
Minor beautifications.
Browse files Browse the repository at this point in the history
Changed link to button, some minor punctuation updates.
  • Loading branch information
amalmurali47 authored Aug 17, 2018
1 parent a42ed54 commit a2064a0
Showing 1 changed file with 17 additions and 19 deletions.
36 changes: 17 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,30 @@
# rescuekerala

Website for coordinating rehabilitation of people affected in the 2018 Kerala Floods

Join our slack channel

https://join.slack.com/t/keralarescue/shared_invite/enQtNDE4NzUyNjg4MjQ3LTJiMDU0ZmFhODNlNDE3ZDc4ZmFlMGI0YmQ0MzI0NWYyNThlOTgwYTM2Y2JlYzMxMDMxMzUwY2E2MmVmNDQyNmE
Website for coordinating the rehabilitation of the people affected in the 2018 Kerala Floods.

[![Join Kerala Rescue Slack channel](https://i.imgur.com/V7jxjak.png)](https://join.slack.com/t/keralarescue/shared_invite/enQtNDE4NzUyNjg4MjQ3LTJiMDU0ZmFhODNlNDE3ZDc4ZmFlMGI0YmQ0MzI0NWYyNThlOTgwYTM2Y2JlYzMxMDMxMzUwY2E2MmVmNDQyNmE)

# Kerala Rescue

Website for coordinating rehabilitation of people affected in the 2018 Kerala Floods
Website for coordinating rehabilitation of people affected in the 2018 Kerala Floods.

## Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

### Prerequisites

You will need to have following softwares in your system
You will need to have following softwares in your system:

- Python 3
- Postgres
- git

### Installing

Setting up development environment
#### Setting up a development environment

create database and user in postgres for kerala rescue and give privileges
1. Create database and user in postgres for kerala rescue and give privilegesl.

```
psql user=postgres
Expand All @@ -44,50 +41,51 @@ GRANT
postgres=# \q
```
Clone the repo

2. Clone the repo.
```
git clone https://github.com/IEEEKeralaSection/rescuekerala.git
cd rescuekerala
```

Copy sample environment file and configure it as per your local settings
3. Copy the sample environment file and configure it as per your local settings.

```
cp .env.example .env
```

If you cant copy the environment or is facing difficulty in starting the server , Copy the settings file from
https://github.com/vigneshhari/keralarescue_test_settings for local testing
Note: If you cannot copy the environment or you're facing any difficulty in starting the server, copy the settings file from
https://github.com/vigneshhari/keralarescue_test_settings for local testing.

Install dependencies
3. Install dependencies.

```
pip3 install -r requirements.txt
```

Run Database migrations
4. Run database migrations.

```
python3 manage.py migrate
```

Setup staticfiles
5. Setup static files.
```
python3 manage.py collectstatic
```

Run the server
6. Run the server.

```
python3 manage.py runserver
```
Now open localhost:8000 in the browser
7. Now open localhost:8000 in the browser

## How can you help?

### By testing

We have a lot of [Pull Requests](https://github.com/IEEEKeralaSection/rescuekerala/pulls) that requires testing. Pick any PR you like, try to reproduce the original issue and fix. Also join `#testing` channel in our slack and drop a note that you
We have a lot of [Pull Requests](https://github.com/IEEEKeralaSection/rescuekerala/pulls) that requires testing. Pick any PR that you like, try to reproduce the original issue and fix. Also join `#testing` channel in our slack and drop a note that you
are working on it.

### By fixing bugs or by adding features
Expand Down

0 comments on commit a2064a0

Please sign in to comment.