Skip to content

Home

Jump to bottom
FOSS - Lets get YOU Started edited this page Sep 16, 2016 · 4 revisions

Welcome to the DataVisualizer-Cpp wiki!

###Download/Installation/Setup Instructions for DataVisualizer-Cpp Project

###Step 1: Getting the repository to your own GitHub Web Account (fork)

  • Go to desktop.github.comand download and install the GitHub Desktop. GitHub Desktop is currently available for Windows and Mac. The rest of this tutorial is written considering you have GitHub Desktop installed and working on your machine. For Linux based systems you may need to setup a CLI based environment. More information can be found at #platform-linux
  • If you do not already have a GitHub web account, now will be the time to create one for free at: github.com. Sign in to your GitHub web account.
  • Go to the FOSSLGYS web account at FOSSLGYS and select the DataVisualizer-Cpp repository. Note: There is also a JAVA repository. If you want to work on the cpp version, follow the specific instructions provided with it.
  • On the DataVisualizer-Cpp repository's page, you will see a "Fork" button at top right. Click "Fork". This will clone the project to your own GitHub web account.
  • Go to your own web account and verify that you now have DataVisualizer-Cpp repository.

###Step 2: Getting the repository from your web account to local machine via GitHub Desktop (clone)

  • Open the GitHub Desktop application. You will be asked for login information at the first usage. Provide the same user name and password as you have used for your GitHub web account. This will connect the GitHub Desktop instance to your GitHub web account.
  • Next, you would want to download the repository on our local machine so that you may run the project and/or make changes to the code. Click the "+" sign on the top left corner of the GitHub Desktop. Select the "Clone" option. You will see all the repositories currently in your GitHub web account. If you have just created the account in step 1 and followed all the steps, you will see only DataVisualizer-Cpp repository. Select DataVisualizer-Cpp and click the check mark at the bottom. Next you will be asked to select a folder for download and GitHub Desktop will download the repository in your specified folder.

###Step 3: Identifying an Issue to fix (Issue tracker)

  • You can view the open issues for the repository under Issues. If there is a particular existing issue that you would like to fix, please leave a comment below it with intent and details of how you intend to fix it. This will reduce duplication of effort.
  • If you would like to propose an enhancement, or report a bug that you would like to work on, feel free to open new issues and we will assign them to you.

###Step 4: Running/Updating the Project (QT Creator)

  • The project has been developed using Qt Creator 3.2.1 IDE based on Qt 5.3.2 and the instructions in this section are specific to it. Qt Creator an open source IDE. It can be installed in MAC/Windows. Specific instructions on download, installation and running the project are as follows.

####MAC Users:

  1. Qt creator installation - Follow the steps from the following link: https://web.stanford.edu/class/cs106b/qt-creator-mac.shtml

  2. Open the QT Creator IDE and go to File->Open_File_or_Project and browse to the cloned project and open the .PRO file (DataVisualizer-Cpp/DataVisualizer/DataVisualizer.pro -- Icon shows as PRO).

  3. Once the Creator loads the project to the IDE, you might see a message checking "No .user settings created by this instance of QT Creator was found. Did you work with this project on another machine or using a different settings path before ? Do you still want to load the settings file */DataVisualizer.pro.user?". Click "yes" to that to move on. If you dont see that, the IDE has accepted the .pro settings from the cloned project and you are good.

  4. You should be able to view the source code at this point. Qt creator would parse all the files.

  5. Once it is done, you can build+run this project by clicking the green triangle button on the left hand side panel.

  6. You are good to go!! Have fun!

######Note:

  1. If you are running into any build error, there are a couple of places you can check: (1) Go to Projects tab on the left hand side panel and choose "build" settings. Make sure your build environment (under "Details" drop down button) has "Qt5.3.2/5.3/clang_64/bin" in the path. (2) Click "Manage Kits" on the top left corner of build settings page, you should see a pop up. Choose "Build & Run" from the side panel of the pop-up and go to "kits" tab. You should see "Desktop QT 5.3 Clang 64 bit". (3) Make sure you have "qmake" installed. You can install qmake using "brew install qt" in your terminal.
  2. If you run into "could not resolve SDK path for MAC OSX10.9" error, then you open the DataVisualizer.pro file in QT creator by double clicking it. Add the line "QMAKE_MAC_SDK = macosx" at the end. Now go to Build and click on "clean all". Once clean is done, go to Build and click on "build all".

####Windows Users:

  1. Qt Creator installation - Follow the steps from the following link: https://web.stanford.edu/class/cs106b/qt-creator-windows.shtml

  2. Open the QT Creator IDE and go to File->Open_File_or_Project and browse to the cloned project and open the .PRO file (DataVisualizer-Cpp/DataVisualizer/DataVisualizer.pro -- Icon shows as PRO).

  3. Once the Creator loads the project to the IDE, you might see a message checking "No .user settings created by this instance of QT Creator was found. Did you work with this project on another machine or using a different settings path before ? Do you still want to load the settings file */DataVisualizer.pro.user?". Click "yes" to that to move on. If you dont see that, the IDE has accepted the .pro settings from the cloned project and you are good.

  4. Next you would see the Projects->Configure Project tab. If you don't see that you can go to Projects tab on the left hand side panel and you should see "Configure Project" window. There make sure QT Creator is using "Desktop Qt 5.3 MINGW 32bit" kit for this project. Click on the "Configure Project" push button to confirm.

  5. You should be able to view the source code at this point. Qt creator would parse all the files.

  6. Once it is done, you can build+run this project by clicking the green triangle button on the left hand side panel.

  7. You are good to go!! Have fun!

If you run into any specific issues with installation/building the application, Internet is an excellent resource. We are also available for help on the slack channel! You can send us an email at [email protected] if you would like to be added to the channel.

###Step 5: Submitting Changes for the Project/Repository (pull request)

  • Once you are done with your intended updates/changes, open the GitHub Desktop. You will see your updated files in the "changes" pane with the updates (adds/deletes) highlighted. At the very top, you should also see "X uncommitted changes" tab (X being the number of edits you made) next to the "History" tab.
  • If you are happy with your edits, provide a summary and description of the changes you have made and click the check mark next to the "Commit to master" link at the bottom of the screen. This commits the changes to your local repository. The "X uncommitted changes" should now read "No uncommitted changes".
  • Next and final step is to submit a pull request so that the owners of the remote repository (FOSSLGYS) can look at your changes and either, provide feedback, or, add them to their code base.
  • Click "Pull Request" at the top right corner of the GitHub Desktop. A pane will slide in that states "from master into FOSSLGYS/master". The summary and description fields should already be populated with the same summary and description that you provided for your commit. Click the check mark next to "Send pull request".
  • After the pull request is submitted you will see the message "Pull request created Nice!" and a "view it on GitHub" link. You can click the link to see the pull request in your GitHub Web Account. You should also see the message "Only those with write access to this repository can merge pull requests.", which means that the request is now visible to FOSSLGYS owners and they will be providing feedback soon!
Clone this wiki locally