edward-mn/userability

Management Users

👥 User Ability 👥

About | Software | Dependecies | Functionalities | Technologies | How to execute | Important links | Author | Suport

🧐 About

The main idea it was, put all my actual knowledge developing a microservice focused on user control.

It includes:

• CRUD;
• API (REST / RESTfull);
• Swagger

👨‍💻 Software

---

Demo 👀

🕹 The app

• Link

📄 Swagger documentation

• Link

---

❗ Dependencies

To run this project, you will need of following tools installed on your machine:

• Java & Kit
• IntelliJ IDEA
• Maven
• Postgre SQL
• Postman

---

🖥 Functionalities

C

• Create new User
  • POST

R

• Read a User
  • GET

U

• Update specific User
  • PUT

D

• Delete specific User
  • DELETE

WEB & Postman

---

👷 How to Execute and Download

Local 🏡

Downloading & Execute the project ⏬

1. Download the project on your machine.
2. Extract the downloaded zip.
3. Create a new project from an existing project (Import project).
4. After the project loaded in your IDE click with the right button on the project name -> Maven -> Reimport to confirm the necessary imports.
5. Click on the top right of your ide (ADD CONFIGURATIONS) -> (+) -> Maven.
6. Before execute, you have to make changes into properties file.
   1. Insert your data base configuration - PostgreSQL.
7. In the "Command Line" field add (spring-boot:run) -> Apply -> OK.
8. Ready now, just run the program and the server is running on port 8080.
9. Ready to access!
10. Open your browser into port 8080 ( http://localhost:8080/users )

WEB 🌐

The app will deployment at Heroku, to access the application click bellow:

• APP -> https://userability.herokuapp.com/users
• Swagger -> https://userability.herokuapp.com/swagger-ui.html

To consume using Postman, use the full URI with correct HTTP Method

• [Method] https://userability.herokuapp.com/users + /resource

Using Postman 👨‍🚀

1. Open the postman
2. Import the collection
   1. In the upper left corner click (Import) -> Choose Files -> Go to where you extracted the project and the select the userability.postman_collection.json file
   2. Now, select the endpoint you want within the imported collection and click send.

‼ Atention

1. The endpoint will differente runing local and web, so pay attention.
   1. Local: http://localhost:8080/userability/api/users
   2. WEB: https://userability.herokuapp.com/api/users
2. Make changes when you are consuming de User API

---

🛠 Technologies

• IntelliJ IDEA
• Java 16 & Kit
• Spring boot
• Postgre SQL
• Bootstrap 5.1
• Google Icons
• Postman
• Heroku
• Dependencies - Maven
  • Thymeleaf
  • DevTools
  • Data JPA
  • Spring Web
  • PostgreSQL Driver
  • Swagger 2.0
  • Starter Validation

---

🦹‍ Author

• Edward Moreira
• @edward-mn
• 
• 🚀 Edward Moreira

---

🤝 Show your support

Give a ⭐️ if liked or helped you!

---

This README was created with ❤️ by me