Code Monkey home page Code Monkey logo

guto-alves / fatecando-api Goto Github PK

View Code? Open in Web Editor NEW
0.0 2.0 0.0 810 KB

This is the backend of the Fatecando application, providing only a REST API.

Home Page: https://fatecando-api.herokuapp.com

Java 99.75% HTML 0.25%
java spring-boot rest-api spring-data-jpa spring-hateoas hibernate spring-mvc springframework hibernate-validator jackson rest backend spring-framework hibernate-jpa postgresql postgresql-database jpa spring javamail

fatecando-api's Introduction

Fatecando REST API

This is the backend of the Fatecando application, providing only a REST API. There is no UI. The fatecando-web project is a front-end application that consumes the REST API.

Running locally

With maven command line

git clone https://github.com/guto-alves/fatecando-api.git
cd fatecando-api
mvnw spring-boot:run -Dspring-boot.run.profiles=dev,h2

You can then access fatecando here: http://localhost:8081

Swagger REST API documentation presented here (after application start):

You can reach the swagger UI with this URL http://localhost:8081/swagger-ui/

Screenshot of the Fatecando Application Client

everyone-screenshot

In case you find a bug/suggested improvement for Fatecando

Our issue tracker is available here: https://github.com/guto-alves/fatecando-api/issues

Database Configuration

In its default configuration, Fatecando uses an in-memory database (H2) which gets populated at startup with data. The h2 console is exposed at http://localhost:8081/h2-console, and it is possible to inspect the content of the database using the jdbc:h2:mem:testdb url.

A similar setup is provided for MySQL and PostgreSQL if a persistent database configuration is needed. Note that whenever the database type changes, the app needs to run with a different profile: spring.profiles.active=mysql for MySQL or spring.profiles.active=postgresql for PostgreSQL.

Working with Fatecando in Eclipse / Spring Tool Suite (STS)

Prerequisites

The following items should be installed in your system:

  • Java 17 or newer (full JDK, not a JRE).
  • git command line tool
  • Your preferred IDE
    • Spring Tools Suite (STS)
    • Eclipse with the m2e plugin. Note: when m2e is available, there is an m2 icon in Help -> About dialog. If m2e is not there, follow the install process here

Steps:

  1. On the command line run:
    git clone https://github.com/guto-alves/fatecando-api.git
    
  2. Inside Eclipse or STS:
    File -> Import -> Maven -> Existing Maven project
    

Looking for something in particular?

Layer Source
REST API controllers REST folder
Service Service folder
Spring Data JPA JPA folder
Security Security folder

fatecando-api's People

Contributors

caiquevidal avatar guto-alves avatar raizervarela avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.