AnrryPetrin / VanGo-BackEnd

VanGo-BackEnd is the RESTful API powering the innovative transportation solution, VanGo. This API, developed as an experimental project for FACENS University

VanGo-BackEnd: RESTful Transportation Solution API

This repository contains only the source code for the Back-end of the VanGo project. To access the source code for the Front-end, please visit the corresponding repository: VanGo-FrontEnd Repository

Table of Contents

• Introduction
• Features
• Getting Started
  • Prerequisites
  • Configuration
  • Usage
• License
• Team

Introduction

The VanGo project is an innovative transportation solution presented as an experimental project to the Facens University. The proposed solution, VanGo, differentiates itself by focusing on user experience, inclusivity, and addressing specific user needs such as those of individuals with disabilities and pet owners.

Features

• Registration and login for service providers.

• Creation of new trips to be displayed for potential clients.

• Search for available trips.

• Display of comprehensive trip information.

Getting Started

Follow these steps to set up and run the VanGo-BackEnd project on your local machine.

Prerequisites

Make sure you have the following prerequisites installed:

• JDK - Version LTS
• MySQL - Database engine
• MySQL Workbench - Visual tool for database design and modeling
• [IDE of your preference] - For example, IntelliJ IDEA

Configuration

1. Clone the repository:

git clone https://github.com/AnrryPetrin/VanGo-BackEnd.git

2. In MySQL Workbench, execute the following command to create the database:

CREATE DATABASE IF NOT EXISTS vango;

3. Configure Database Connection: Open the project in your preferred IDE. Locate the application.yml file (typically found in the src/main/resources directory) and update the database connection properties such as spring.datasource.username and spring.datasource.password if needed.

Usage

1. Build and Run:

• Ensure that you have configured the database as per the instructions above.
  • In your IDE, build and run the project.

3. Access the API:

• Once the application is running, you can access the API at http://localhost:8080.

3. Explore Endpoints:

• Use tools like Postman or your preferred API testing tool to explore the available endpoints.

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

Team

• Anrry Petrin de Araujo

  • Role: Project Manager & Developer
  • Expertise: Back-end
  • Contact: [e-mail]

• Lucas Eduardo Pereira

  • Role: Full-stack Developer
  • Expertise: Back-end & Front-end
  • Contact: [e-mail]

• Jéser Cáceres Marcelino

  • Role: Researcher
  • Contact: [e-mail]

• André de Lima Franceschini

  • Role: Designer
  • Contact: [e-mail]