To get started, you will need to run these commands in your terminal.
git config --global user.name "Your Name"
git config --global user.email "[email protected]"
On Linux, UNIX, Cygwin, or Git Bash, generate a key:
ssh-keygen -t rsa -b 4096
This will generate a private key (~/.ssh/id_rsa
) as well as a public key (~/.ssh/id_rsa.pub
).
Do not share your private key with others.
Display your public key:
cat ~/.ssh/id_rsa.pub
Copy the entire contents of the key, and associate it with your Bitbucket account:
- Click the avatar icon in the top right corner
- Select Manage account from the drop down list.
- Select SSH keys from the sidebar.
- Click Add key.
- Paste the contents of your public key in the Key field. Be sure to paste the entire file.
- Click Add key.
Clone your repository onto your local system:
git clone ssh://[email protected]:7999/cs2212_w2016/team10.git
Remember: do not develop on the master
or dev
branches. Instead, in
JIRA, create a feature branch off of dev
to do your work. Do your
development on your feature branch. Then, when you are finished with your
feature, push your changes, and open a pull request to merge your changes back
into the dev
branch.
To submit your assignment, open a pull request to merge your changes on dev
back into the master
branch.
Change your directory to FitBitApp
:
cd FitBitApp/
Make sure you are in dev
branch, and it is up-to-date via git pull
. Use the following command to compile the program:
mvn package
The packaged jar file will be in the target/
directory called "team10-FitBitApp-1.0-SNAPSHOT-jar-with-dependencies.jar"
.
The program has two modes; an online mode that interfaces with the FitBit API and a test mode that works offline with locally stored API data to test the program features without worring about being connected to the API. The normal online mode can be run with the following command from the FitBitApp
directory:
java -jar target/team10-FitBitApp-1.0-SNAPSHOT-jar-with-dependencies.jar
Test mode can be invoked with the same command, but with a -test
argument:
java -jar target/team10-FitBitApp-1.0-SNAPSHOT-jar-with-dependencies.jar -test
The command will run and open a new window displaying the FitBit App.
NOTE: The Fitbit App was designed and best displayed on Mac OS X.