Code Monkey home page Code Monkey logo

greeting-service's Introduction

greeting API

An API built with Spring Boot that allows users to manage greeting. That's w'll be used in the AWS white belt video series.

Table of Contents

Project Structure

The main building blocks of the project are:

.
├── App
    ├── src/main/java/com/devdojo/greeting
    │   ├── controller
    │   │   ├── GreetingController.java
    │   ├── model
    │   │   ├── Greeting.java
    │   ├── service
    │   │   ├── greetingervice.java
    |   ├── repository
    │   │   ├── GreetingRepository.java
    │   ├── greetingerviceApplication.java
    ├── src/main/resources
    │   ├── application.properties
    ├── .gitignore
    ├── pom.xml
    ├── README.md
    ├── Dockerfile
    ├── docker-compose.yml
├── client
    ├── greeting-api.js
    ├── index.hmtl
    ├── styles.css
├── scripts
    ├── build.sh
    ├── run.sh

  • Greeting.java: This class is an entity that represents a greeting.
  • greetingervice.java: This class provides business logic for managing greeting.
  • Application.java: This is the main class that runs the Spring Boot application.
  • application.properties: This file contains configuration properties for the application.
  • pom.xml: This file contains project metadata and dependencies.

Getting Started

These instructions will help you get a copy of the project up and running on your local machine.

Prerequisites

  • Java 8 or later
  • Maven
  • Docker

Build and Running Locally from docker

  1. Clone the repository to your local machine:
    git clone https://github.com/devdojoacademy/greeting-service.git
    
  2. Go to the project directory:
    cd greeting-api
    
  3. Starting with script thats build and up the client and the backend:
    ./scripts/run.sh
    

The backend application should now be running on http://localhost:8080. The frontend client should now be running on http://localhost:8081.

Running from docker image

Please follow the instructions at the docker repository.

Usage

Here are a few examples of how to use the API:

  • Get all greeting: GET /api/greeting
  • Get a specific greeting: GET /api/greeting/{id}
  • Create a new greeting: POST /api/greeting
  • Update a greeting: PUT /api/greeting/{id}
  • Delete a greeting: DELETE /api/greeting/{id}

Contributing

We love contributions! If you have any suggestions, bug reports, or feature requests, feel free to create an issue or a pull request.

License

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


greeting-service's People

Contributors

brenonaraujo 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.