Skip to content

Commit

Permalink
README update
Browse files Browse the repository at this point in the history
  • Loading branch information
bwdmonkey committed Jul 3, 2018
1 parent d458dea commit 2742f45
Showing 1 changed file with 25 additions and 24 deletions.
49 changes: 25 additions & 24 deletions README.md
Expand Up @@ -3,51 +3,58 @@
Welcome to the reBOOT Canada database project, created by Code the Change UBC! This is the development repository for the project. The project entails developing a database web application with the ability to generate CRA-compliant tax receipts.

The main functionalities:

1. Data storage
2. CRA-compliant tax receipt generation
3. Data analytics tool
4. User permission control

## Tech/Frameworks

- **Front-End:** HTML5, CSS3, jQuery3/JavaScript
- **Back-End:** Python `2.7.14`, Django `1.11.x`
- **Database:** PostgreSQL `9.6` on AWS RDS
- **Back-End:** Python `2.7.x`, Django `1.11.x`
- **Database:** PostgreSQL on Heroku

## Humans

#### Lead Developers
- **Seung Won [Tom] Lee** - @leesw98 - Team Lead, Front-End + Back-End

- **Seung Won [Tom] Lee** - @leesw98 - Team Lead, Full-stack

#### Developers
- **Ying Ying Choi** - @ying-choi - Developer, DB

- **Omar Tsai** - @omar2535 - Developer, Front-End + Back-End
- **Michelle Huh** - @michellehuh - Developer,Front-End + Back-End
- **Vincent Lin** - @Csignore - Developer, Back-End + DB
- **Gaurav Vasudev** - @gauravnv - Developer, Back-End + DB
- **David Kim** - @yuubd - Developer, Back-End + Front-End
- **Joon Hur** - @hurjun1995 - Developer, Back-End + Front-End


# Installation

## 1) Installing Environment

- Install the required python version 2.7.x
- Install `pip` according to your OS
- Install _virtualenv_ using `pip install virtualenv`
- Install _virtualenvwrapper_ using `pip install virtualenvwrapper-win` for Windows and `pip install virtualenvwrapper` otherwise
- Create virtualenv and use `workon env_name` command to activate the virtualenv
- Check out a tutorial if you're unsure
- Check out a tutorial if you're unsure

## 2) Getting the project

Clone the repo:

- **HTTPS** `git clone https://github.com/CodeTheChangeUBC/ReBOOT.git`
- **SSH** `ssh git@github.com:CodeTheChangeUBC/ReBOOT.git`

Install Requirements:

- `cd project_directory`
- `pip install -r requirements.txt`
- Install postgres through the GUI installer: https://www.postgresql.org/download/
- Install rabbitmq: https://www.rabbitmq.com/download.html


## Contributing
Coding contributions are to be made by members of **Code the Change UBC** only.

Expand All @@ -62,51 +69,45 @@ When making a **contribution**, make sure to do the following:
7. Create a **Pull Request** into the master branch
8. After approval from **at least one** supervisor (**@leesw98** or **@michellehuh** or **@gauravnv**) merge branch into master.

## AWS RDS MySQL Connection

If you wanted to manually connect to the database using the terminal, you can do the following.

`psql -h rebootdbdev.cn0ttbkdpgt2.ca-central-1.rds.amazonaws.com -p 5432 -U ctc_reboot -W postgres`

You will be asked to type in a password which can be found in the "settings.py" file.

**For the django admin site, the user name is admin and password is the same as the one in "settings.py" file.**

## Running the server and website

To use the website, you need to run the server using this command in terminal after activating virtualenv:

`cd project_directory`

```
```bash
python manage.py runserver
```

To use different databases, you can use the following command:

```
```bash
DJANGO_DATABASE=[insert_db_name] ./manage.py [COMMAND]
```

To be able parse data from csv files, you also need to run the rabbitmq server from terminal using this command:

```
```bash
celery -A reboot worker -l info
```

The command allows us to use multiple workers to run tasks.

## Git Hook

`cp hooks/* .git/hooks/`

## Found a Bug?

To provide **suggestions** or **report bugs**, open an **issue** first to discuss potential changes/additions.


## Contacts

#### Code the Change UBC
* Homepage: https://codethechangeubc.org/
* Email: codethechangeubc@gmail.com
* Facebook: https://www.facebook.com/codethechangeubc/

*README.md file has been imported and modified from the Represent the 10 project. Originally by @EWaterman*
- Homepage: https://codethechangeubc.org/
- Email: codethechangeubc@gmail.com
- Facebook: https://www.facebook.com/codethechangeubc/

_README.md file has been imported and modified from the Represent the 10 project. Originally by @EWaterman_

0 comments on commit 2742f45

Please sign in to comment.