AutoMate

• Introduction
• Installation

Introduction

Sringboot application to act as backend server for the AutoMate app.

Getting started

See the Guide on how to contribute here for instructions on how to fork and set up your repository. Refer here for code of conduct.

About DWoC

DWoC is a winter long program organised by Delta Force, the coding club of NIT Trichy. With an aim to support and improve the culture of open source software around us, this serves as a platform for young student developers (or even starters) to hone their technical skills by working on projects of their interests. We hope this encourages collabrative experiences and allows students from all backgrounds to contribute to quality technical projects from diverse fields. For more information, visit DWoC

Installation

Requirements

• JDK-11
• Maven
• MySQL
• IDE - Intellij IDEA (Optional)

Setup

1. Fork and clone the repository: git clone https://github.com/<YOUR-USERNAME>/AutoMate
2. Make a file named application.properties in src/main/resources folder and copy the contents of application.properties.example. Set the database connection details in application.properties, as required
3. Run src/main/resources/schema.sqlin your local mysql shell to set up the database: source <path_to_file>/schema.sql
4. Run src/main/java/com/example/automate/AutoMateApplication.java.
5. The application will be running at http://localhost:<port>/. Port is currently set to 8090 in application.yml file.
   The routes can be tested with swagger at http://localhost:<port>/swagger-ui/.