brito-alves

One page for Brito Alves, Lapenda & Bradley.

Accounts

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

You will need to have virtualenv installed on your machine. For that, simply run:

pip install virtualenv

Installing

To run the project for the first time you must follow this steps:

Clone the GitHub repository

git clone https://github.com/citi-onboarding/balb.git

On the same folder, create a virtualenv environment

virtualenv -p python3 venv

Start the virtualenv

source venv/bin/activate

Enter the project folder

cd balb

Install the riquirements for the project

pip install -r requirements.txt

create .env file and copy

Now, create the migrations

python manage.py makemigrations

Then apply migrations

python manage.py migrate

Now, You are able to run the server

python manage.py runserver

Now, you can see the app running at localhost:8000

Running the project

To run the project (if already installed), just follow this simple commands:

First start the virtualenv

source venv/bin/activate

Then run the app with

python manage.py makemigrations

python manage.py migrate

python manage.py runserver

Deployment

The project is deployed on Heroku with continuous deploy of branch master and develop.

Production app: https://balb.herokuapp.com/

Development app: https://staging-balb.herokuapp.com/

Built With

Django - for back-end.
HTML, CSS, JS - for front-end.

GitHub

Branches

They can be:

Their names must follow this template: feature/branch-name

Commits

Must begin with the name of the branch you developed on, following the model: “Feature(name-of-feature) rest of commit…”.

Must be simple and show briefly what you just did.

Ex: git commit -m “Feature(banner-parallax) Added the parallax effect to the background”

Pull Requests

First, proceed with rebase:

commit the changes on your branch
Go to the original branch (develop ou master) with git checkout develop (or master)
Run git pull
Go back to your branch with git checkout "your-branch"
Run git rebase develop (or master)
Follow the steps to conclude the rebase, solving conflicts and running git add . and then git rebase --continue
Whan finished rebasing, run git push -f origin "your-branch". Now your Pull Request can be opened on GitHub.

If possible, use this template for the pull request body:

### Issue Name
**What I did:**

- First thing I did...

- Second thing I did...

**How I did:**

- Brief notes on how the issue was solved (technically)

citi-onboarding/balb