Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nathanaelsantos/clickbus-placeservice-api
This is a challenge to test your skills on building APIs.The ClickBus serivices use mainly Java and Springboot technologies.However, you can use language and framwork that you feel more confortable.
https://github.com/nathanaelsantos/clickbus-placeservice-api
docker junit r2dbc solid springboot springdata webflux
Last synced: about 1 month ago
JSON representation
This is a challenge to test your skills on building APIs.The ClickBus serivices use mainly Java and Springboot technologies.However, you can use language and framwork that you feel more confortable.
- Host: GitHub
- URL: https://github.com/nathanaelsantos/clickbus-placeservice-api
- Owner: NathanaelSantos
- Created: 2024-05-07T07:29:58.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-06-30T04:23:28.000Z (6 months ago)
- Last Synced: 2024-07-01T04:00:28.693Z (6 months ago)
- Topics: docker, junit, r2dbc, solid, springboot, springdata, webflux
- Language: Java
- Homepage:
- Size: 46.9 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
---
# Backend Developer Challenge
This is a simple challenge to test your skills on building APIs.The ClickBus serivices use mainly Java and Springboot technologies.However, you can use language and framwork that you feel more confortable.
# What to do
```
Create a simple API to manage places (CRUD).This API should allow to:
- Create a place
- Edit a placa
- Get a specific place
- List places and filter them by name
```
```
A place must have the following fields:
- name
- slug
- city
- state
- created at
- update at
```
# Requirements
```
- All API responses must be JSON
- Provide a README.md file with usage instructions(how to run, endpoints etc)
- Provide a testing environment(docker, etc)
```
# Recommendations
```
- Tests, tests and tests
- SOLID
- Code and commits in english(methods, classes, variables, etc)
```
# Evaluation
```
- Project structure, architecturing and organization
- Programming good practices
- VCS practices
```
# Delivery
You musk fork this repository and commit the solution in the solution folder.Your repository must be public.After that, send the repository link on the kenoby platform
---
# 🚀 Technologies Used
This project was developed with the following technologies:
- Spring Boot
- Spring Webflux
- Spring Data + R2DBC
# 
Patterns Used
The following design patterns were used in this project:
- SOLID
- Integration tests
# 💻 How to Run the Project
To run this project locally, follow these steps:
1. Clone the git repository to your local machine using `git clone`.
2. Navigate to the project folder and run the command `mvn spring-boot:run` to start the application.
3. The API will be available at `localhost:8080`.
# 
API Endpoints
To make HTTP requests, you can use the httpie tool, Postman, or any other of your preference.
[api-docs-swagger](http://localhost:8080/webjars/swagger-ui/index.html)
Here is an example of how to make a POST request to the `/places` endpoint:
```bash
http POST :8080/places name="Place Name" state="State"
```
# 🧪 Testes do PlaceService
Os testes do PlaceService são escritos usando JUnit 5 e o WebTestClient do Spring Boot.
# 
Docker
1. **Project Compilation**
The following command is used to compile the project and package the result into a JAR file:
```bash
./mvnw clean package
```
2. **Building the Docker Image**
The following command is used to build a Docker image of the project using the Spring Boot:
```bash
./mvnw spring-boot:build-image
```
3. **Running the Docker Image**
The following command is used to run the Docker image:
```bash
docker run --name placeservice -p 8080:8080 -d placeservice:0.0.1-SNAPSHOT
```
This will start a Docker container named `placeservice`, map the container's port 8080 to the host's port 8080, and run the container in the background.
