Github

Will implement a simple GitHub Merge Request interface allowing users to authenticate using GitHub as identity provider. Once authenticated, users will be able to create merge requests by selecting a source and target branch for any repo they have access to within GitHub, as well as specifying an email address to assign the merge request to a reviewer.

Once assigned a merge request notification email will be sent to the assigned email address, which will contain a link to the merge request in question. The receiving user opens the link contained in the email they will be directed to the merge request detail view, within which they will be able to either merge or reject the request. If the request is merged the branch will be merged on the remote repo.

The system is built using a Django framework.

Install Python 3.7 and follow commands. Allow Python to be added to the PATH.

Once Python is installed. Install virtualenv via pip so that all dependencies are stored inside the virtual enviroment. Open the command line and run the following.

pip install virtualenv

Create virtual enviroment using the following command:

virtualenv venv_github

Activate the virtual enviroment. On Windows use the following.

source venv_github\Scripts\activate.bat

Install the required packages, using pip and the requirements file.

pip install -r requirements.txt

Run the django migrate

python manage.py migrate

Create a super user to access the admin interface, follow the promtes.

python manage.py createsuperuser

Create an OAuth app. You will use the credentials genereated in the OAuth for the app. Instruction to create OAuth

Run the server

python manage.py runserver

Once the service is running. Go to the following link. http://127.0.0.1:8000/admin/

Login using the super user details created earlier.

Once logged in go to Sites and edit the entry. Set the domain name to 127.0.0.1. The Display Name is for internal admin use so you can leave it as is for now.

Next go back to the admin homepage and click on the add button for Social Applications on the bottom. This is where you configure each third-party OAuth. You're using Github so that's the Provider. We add a name, use Github, and then the Client ID and Secret ID from Github. Final step--and easy to forget!--is to add our site to the Chosen sites on the bottom. Then click save.

Run the server and start using the application.

python manage.py runserver

Open Docker and navigate to the application via the Docker terminal. Once at the application run the following commands:

docker-compose up -d --build

Once everything is done, run the next command:

docker-compose up

Once the web service is running you can use the system on the following URL: http://192.168.99.100:8000/

To stop Docker once is running press CNTRL + C. Once the web service has stopped. Run the following command:

docker-compose down