Skip to content

README.md

Latest commit

 

History

History
58 lines (40 loc) · 1.74 KB

README.md

File metadata and controls

58 lines (40 loc) · 1.74 KB

HomeworkHub

Social media platform for students to upload and view homework assignments

Homework hub is a platform for students to find old homeworks from previous semesters of a class, to enhance their studying ability

Installing

To run this project, golang-go and git must be installed on your system. They can both be downloaded using the command:

sudo apt install golang-go git -y

Download the source using the command:

git clone https://github.com/SocialHW/HomeworkHub.git

Running this project no longer requires any external dependencies to be running, such as MySQL. However, you must install the third party libraries we are using for our cryptographic functions, and for interacting with our SQLite3 database. To do so, run the command:

go get golang.org/x/crypto/bcrypt github.com/mattn/go-sqlite3

Building and Running

To run the project as a Go script, simply run this command from the root directory of the project:

go run *.go

Contributing

We are using git-flow (installation instructions) to aid managing our branches. To make sure that you have git-flow initialized in your repository use the command:

git flow init

To create a new feature, use the command:

git flow feature start <feature-name>

This will create a new branch named feature/<feature-name>, and checkout that branch so you can immediately start work on it. When the feature is finished and you would like to merge, make sure you have commited and pushed all of your changes, and head to GitHub where you can make a new pull request for that feature. Make sure to merge into the develop branch.