Home

Getting started

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 (There's an OS selector on the left/)
• Maven 3
• Git
• GitHub Desktop Optional but highly recommended

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.

Suggested VS Code Plugins

• Java Extension Pack
• Maven for Java
• Vetur

Other Tools

• Vue.js DevTools for Chrome
• GitHub Desktop is a 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.)
• Postman great for testing API responses (remotely or locally)

Clone the project

Click the "Clone" 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

Install dependencies

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

cd GauchoCourses/frontend
npm run dev

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

Next Steps

• Go to the Development Workflow page