Set up your machine - GauchoTools/GauchoCourses GitHub Wiki

This page explains how to get your computer set up for the project. You will install some tools, then build and run the application on your local machine.

Prerequisites

Install the following development tools. Links are provided with instructions for Mac, Linux, and Windows. These tools are required to build and run the application locally.

• Node and npm
• Java 8 (via OpenJDK8)
  • Windows
  • Mac (using Brew)
  • Linux
• Maven 3
• Git

Development Tools

We suggest using VS Code for frontend development and IntelliJ for the backend. The project is already configured to work with VS Code's debugging and execution tools. Both editors are free.

TODO: Do we still need to add the note for -compile flag on IntelliJ?

Other Tools

Finally, install the GitHub Desktop GUI for interacting with Git. This will help you switch between branches, create Pull Requests, and push commits. (Don't be a hero, you don't have to use the Git command line.)

Fork the project

Click the "Fork" button on the the project site. This will create a copy of the project under your account.

Clone the project locally using git clone https://github.com/<YOUR-ACCOUNT>/GauchoCourses

Run the app

Once the project is on your local machine, use Maven and the Spring Boot plugin to build and run the application.

cd GauchoCourses 
mvn spring-boot:run

The application will start running on port 8088. Open a browser to http://localhost:8088/.

Congratulations, the project is running and you are ready to start contributing! If these steps did not work, please open an issue.

Next Steps

• See the Development Workflow page for tips on how to work more productively with Vue and Spring Boot
• Check out the Contributing Guide to learn how to open a pull request