Skip to content

Developer Quickstart

Jump to bottom
Matthew edited this page May 13, 2021 · 7 revisions

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 DB

The code base expects a MySQL connection to run.

  1. Download and install MySQL Community Server for your OS.
  • This will allow you to run a local MySQL server.
  1. Download MySQL Workbench for your OS.
  • This will allow you to connect to either a local or remote MySQL server.
  • This will also allow you to create a schema for your local tamarisk database.
  1. In MySQL Workbench, create a new MySQL connection with the following:
  • **hostname ** 127.0.0.1 (your local IP address)
  • port 3306
  • username root
  • password leave this blank, as MySQL defaults an (insecure) root user with no password

install homebrew install mysql start mysql server $ brew services start mysql myysql -u root create user with password and grant privileges

Contributing to the Repo

Create your own local branch Create a remote branch to track for your local branch When you commit changes locally push to your remote when you ready Create a pull request to the trunk of this repository (marod424/tamarisk) from your remote branch The PR will be reviewed, and if approved, merged into the trunk. It is recommended to keep up to date with the trunk in your local branch. So merge any trunk updates into your local branch when you would like the updates. Resolve merge conflicts when they arise.

Clone this wiki locally