-
Notifications
You must be signed in to change notification settings - Fork 6
Getting Started Guide (UI development)
To contribute to the SPY Reaper UI, you'll need to follow some ordinary steps for getting started with Open source development plus some specific steps required for our project.
-
Download and install Skype; Add the repo owner as a contact on Skype: tranceitionalMynd
https://www.skype.com/en/get-skype/ -
Sign up for a GitHub user account; Send your username on Skype to get added as a contributor to the repo
https://github.com/join -
Download and install Node.js.
https://nodejs.org/en/download/ -
Download and install MongoDB.
https://docs.mongodb.com/manual/installation/ -
Clone the spy-reaper Git repo onto your development PC.
https://help.github.com/articles/cloning-a-repository/ -
Download a Git GUI (even if you prefer using the terminal, even installing and running git-gui from the terminal may help). There are hundreds out there. A few examples are:
Git Extensions: http://git-extensions-documentation.readthedocs.io/en/latest/git_extensions.html
GitKraken: https://www.gitkraken.com/
GitHub Desktop: https://desktop.github.com/
git-gui: https://git-scm.com/docs/git-gui -
Make your first branch of the repo. Branches help enable parallel collaboration among multiple developers. Branches are also an integral component of Pull Requests (this comes later). There is an option to create a branch in your GUI or you can do so on the terminal with "git checkout -b NEW_BRANCH_NAME".
https://guides.github.com/introduction/flow/ -
Make your first commit. Edit the file ui/app.js by adding your name to the list of Authors at the top of the file. Then commit your code change in your GUI or on the terminal with "git add ui/app.js" followed by "git commit -m 'Added MY_NAME to the list of authors.'". See the glossary explanation of "commit" and any Git words that are unfamiliar to you.
https://help.github.com/articles/github-glossary/ -
Make your first pull request. Push your first branch with your GUI or via the terminal with "git push --set-upstream origin BRANCH_NAME". After pushing, create a pull request.
https://help.github.com/articles/creating-a-pull-request/