Project Build Steps

The EML-CTS repository holds a number of branches. Most work is in the dev branch (or branches copied from dev) of the repository. Any documentation work is done in a doc branch.

1. Download the prequisites and tooling as needed. See Prerequisites for more information. NOTE: If you are cloning the code from GitHub, you need only the Java SDKs, Spring Tool IDE, and MySQL server.

2. Install the MySQL Server on your machine

3. Clone the current project into your local machine. Checkout may require the -f flag. (Substitute the repository you're working with as necessary).

Note that Spring Tool Suite can import from Github; these instructions allow you instead to maintain your own local visible git repository, which saves commits to the GitHub repository.

mkdir MYREPOSITORY
cd MYREPOSITORY
git clone https://github.com/EnergyMashupLab/eml-cts 
cd complete  # the repository is down one level
git checkout dev  
git pull origin dev   # should be up to date already

4. Import the project into your Spring Tool Suite (or other) IDE using "Import Projects" then selecting Git then "Projects from Git (with smart import)" then "Existing local repository". When the repository has been imported, choose the complete sub-repository.

5. Select options from the popup menu from right-clicking the project to build the project

Additional Information

EML-CTS uses Spring Tool Suite 4 and Maven for development and build tools. The Maven Users Centre provides documentation and tutorials on how to use Maven in a development setting.

This project uses git and Github for its version control needs. If you are not familiar with git, tutorials and a cheat sheet can be found at https://www.atlassian.com/git/tutorials

Running your code

To run your code in the IDE you should have a working MySQL database locally with a database named nist_cts_eml. See Set Up MySQL for more information.

In Spring Tool Suite or Eclipse

(right click on project -> run as -> Spring boot app

This will start your tomcat server automatically.

Testing

See Testing documentation for details.