Developer Quickstart - marod424/tamarisk GitHub Wiki

GitHub Account

  1. Sign up for a GitHub account (if you don't already have one)
  2. Reach out to marod424 to become a collaborator of the tamarisk repo
  3. Accept the invitation email granting you collaborator access

Clone Repository

CLI

  1. Download git for your OS
  2. Navigate to a local directory of your choice (e.g. ~/projects/) cd ~/projects/
  3. Clone the repository git clone https://github.com/marod424/tamarisk.git
  4. Open the tamarisk project in an IDE of your choice (Intellij recommended)

GUI

(Optional) If you prefer a GUI over a CLI

  1. Download a version control GUI application of your choice (e.g. GitHub Desktop)
  2. Follow the documentation to clone a repository
  3. Open the tamarisk project in an IDE of your choice (Intellij recommended)

Run the Application

The following steps are specific to Intellij, but should parallel other IDEs.

  1. Make sure the MyApp configuration is selected in the dropdown between the build (green hammer icon) and run (green play icon) buttons
  2. Click the Run button
  3. The bottom drawer should open to the Run tab with a log of the resultant output
  4. You should get a DB connection error, which we discuss in the next section

Connecting to a Database

The code base expects a MySQL connection to run.

  1. Please check out the MySQL Quickstart wiki for detailed instructions on how to connect to a local MySQL DB.
  2. Once you have a local connection, with a tamariskdb schema, update the following fields in the application.yml file:
    • url jdbc:mysql://localhost/tamariskdb
    • username <your new username (hopefully not root)
    • password <your new password>
  • (Caution!) Do not commit this file to version control as everyone has a different local username and password

Opening the application

Once your server is properly connected to the DB, you are ready to re-run and open the application.

  1. Run the application
  2. In the run console look for the following log, Tomcat started on port(s): 8080 (http), to confirm that your application is up and running.
  3. Open your browser and navigate to http://localhost:8080/
  • localhost references your local machine ip (127.0.0.1)
  • 8080 is the server port as configured in the application.yml file.

Collaborate

You are ready to begin contributing to the repo!

Not sure where to begin?

Check out the wiki home page to familiarize yourself with the project and community of other collaborators.

Ready to start coding?

Please check out the GitFlow Quickstart for detailed instructions on how to properly implement code into the repo.