Skip to content
This is a project for a code review app for professors at uni
HTML Python CSS
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
mellow
mellow_app
.gitignore
README.md
db.sqlite3
manage.py
requirements.txt

README.md

Mellow Project

This is a project in order to make a code revision app.

Stories in Ready Code Climate

Technologies used

  1. Python 3.6 on Django
  2. PostgreSQL
  3. VS Code
  4. GitKraken
  5. Waffle.io
  6. Code Climate

Python Setup

Linux Setup

Depending on your Linux version, either Python 2 or Python 3 will be installed.

To check if Python 3 is installed, please type python3 on your terminal. If it's not, install it with:

$ sudo apt-get update
$ sudo apt-get install python3.6

Now, verify if pip is already installed with:

$ command -v pip3

If not, install it with:

pip install -U pip

Now, you'll have to install virtualenv and test your installation:

$ pip install virtualenv
$ virtualenv --version

To create a virtual environment for our project you'll run:

$ mkdir -p ~/Virtualenvs ~/Library/Application\ Support/pip
$ cd ~/Virtualenvs
$ virtualenv -p /usr/bin/python3.6 mellow_env
$ vim ~/Library/Application\ Support/pip/pip.conf

Inside the pip.conf file, type:

[install]
require-virtualenv = true

[uninstall]
require-virtualenv = true

Save and quit using :wq.

Windows Setup

You can download Python 3.6 here.

Add the C:\Python36\;C:\Python36\Scripts\ path to your system variables.

To install pip you can run:

$ python -m pip install -U pip

Now, you'll have to install virtualenv and test your installation:

$ pip install virtualenv
$ virtualenv --version

To create a virtual environment for our project you'll run:

$ mkdir -p C:\\Virtualenvs C:\\Users\\Your_User\\AppData\\Roaming\\pip
$ cd C:\\Virtualenvs
$ virtualenv mellow_env

Inside the folder C:\\Users\\Your_User\\AppData\\Roaming\\pip create a file named pip.ini.

Inside the pip.ini file, type:

[install]
require-virtualenv = true

[uninstall]
require-virtualenv = true

Save and quit.

PostgreSQL Setup

We didn't setup Postgres yet.

VS Code Setup

Linux Setup

In Preferences > Settings, put at the end of your User Settings file the text:

"python.venvPath": "~/Virtualenvs",
"python.pythonPath": "~/Virtualenvs/mellow_env/bin/python3",
"python.linting.pylintPath": "~/Virtualenvs/mellow_env/bin/pylint",

Also, do this on your Workspace Settings file too.

Windows Setup

In Preferences > Settings, put at the end of your User Settings file the text:

"python.venvPath": "C:\\Virtualenvs",
 "python.pythonPath": "C:\\Virtualenvs\\mellow_env\\Scripts\\python.exe",
 "python.linting.pylintPath": "C:\\Virtualenvs\\mellow_env\\Scripts\\pylint.exe",

Also, do this on your Workspace Settings file too.

GitKraken

You can download GitKraken here.

You should fork this repo and clone it to your machine.

Waffle.io

Go to Waffle.io and sign up with your GitHub account. Fortunately the project Scrum Board should load automatically.

Code Climate

Our code climate board is here. You can apply to free open-source account here.

Django Setup

With the repository cloned, you should see a requirements.txt file on the main folder.

Linux

Activate your virtual environment and run the requirements.txt file inside your virtual env with:

$ source ~/Virtualenvs/mellow_env/bin/activate
$ cd your_project_folder #cd to your project folder
$ pip install -r requirements.txt

Windows

Activate your virtual environment and run the requirements.txt file inside your virtual env with:

$ cd C:\\Virtualenvs\\mellow_env\\Scripts
$ activate
$ cd your_project_folder #cd to your project folder
$ pip install -r requirements.txt

Now, the project will be cloned to your machine and the virtualenv will be activated with all requirements already installed. On the main folder for <mellow/>, you'll have a manage.py file. Every time you need to run the server, it has to be executed from that folder.

To run it, type:

$ python manage.py runserver

The server will be initialized in http://localhost:8000

General Guidelines

  • Everytime you commit a change to this repository, you'll have to create a branch with the name of the feature and the number of the issue on github/waffle. It will be like this: <name of the feature>-#<number of the feature>. Example: login-#1.

  • When you finish the whole feature, you can make a pull request named closes #<number of the issue>. Code Climate will be triggered and when it finishes checking the code, you can merge branches if there's no checks to fix.

You can’t perform that action at this time.