Software Engineering Project by se-2018-b6

This project is being developed for the Alcoding Club of PES University, Bangalore. It is a Web Application that acts as a portal for all students belonging to the Computer Science Department, in which students can view their coding contest rankings and submit assignments for the courses they have enrolled.

Setting up development environment:

Install docker-ce for Ubuntu:

$ sudo apt-get update
$ sudo apt-get install \
    apt-transport-https \
    ca-certificates \
    curl \
    software-properties-common
$ curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -
$ sudo add-apt-repository \
    "deb [arch=amd64] https://download.docker.com/linux/ubuntu \
    $(lsb_release -cs) \
    stable"
$ sudo apt-get update
$ sudo apt-get install docker-ce
$ docker --version # Verify Installation

Install docker-compose:

$ sudo curl -L "https://github.com/docker/compose/releases/download/1.22.0/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
$ sudo chmod +x /usr/local/bin/docker-compose
$ docker-compose --version # Verify Installation

Get the Source Code:

• Fork this repository.
• Clone your fork. Replace YOUR_USERNAME with your real GitHub account username.

$ git clone https://github.com/YOUR_USERNAME/alcoding-data-analysis.git

• Change Directory to the project using $ cd alcoding-data-analysis.
• Set up the upstream remote in local clone of fork:

$ git remote add upstream https://github.com/akhilmd/alcoding-data-analysis.git

• Now, the source code has been set up.
• If you want to update your local branch (replace BRANCH with the branch name you created) with new changes in this repository's master branch:

$ git checkout BRANCH
$ git fetch upstream
$ git rebase upstream/master

Build docker services:

$ docker-compose build

Needs to be re-run everytime dependencies are changed. This command may take some time to run since some images have to be downloaded. These are then cached, so subsequent executions willbe faster.

Start servers:

$ docker-compose up

Now, the application can be accessed at http://localhost:8000 in a web browser. In case one of the containers shuts down, use Ctrl+C to stop everything. Then, run the command again.

How to Contribute:

• Pick an issue (Make sure it gets assigned to you).
• Create a branch locally with the name issue-X, where X is the issue number.
• Make code changes in that branch.
  • Separate out unrelated changes into multiple commits.
  • Last commit for an issue should have a last line of the form Fixes #X, where X is the issue number.
• Send a Pull Request (PR)
  • Before sending a PR, make sure to run $ docker-compose -f docker-compose-test.yml up and correct and linting errors.
  • Once the PR is reviewed, attend to any requested changes.
  • PRs can be updated by updating the branch associated with that PR.