NPC Project
Table of Contents
Get Starter
run this project inside the configured container by
.devcontainer. See how to open this run this in your machine
or
run this project using Github CodeSpace, clicking here:
Usage
Open two terminals
- first run: (this will run java spring boot in developer mode)
mvn spring-boot:run- second run: (this will run react vite in developer mode)
cd ui && npm run devFor more details about UI project, see this README.md
Application Architecture
Spring Boot exports REST Apis using Spring Web MVC & interactsrations & finder methods with Spring D.
React Client sends HTTP Requests and retrieves HTTP Responses using Axios. React Router is used for navigating to pages.
Technology
- Java 17 / 11 / 8
- Maven 3.9.4
- Spring Boot 3 (with Spring Web MVC, Spring Data JPA)
- NodeJS v20.6.1
- Npm 9.8.1
- React 18, Typescript 5, Vite 4
- Postgres 16
Rest Apis Back-end
These are APIs that Spring Boot App will export:
| Methods | Urls | Actions |
|---|---|---|
| POST | /api/users | create a new User |
| GET | /api/users | paginated users |
| GET | /api/users/:id | retrieve a user by :id |
| PUT | /api/users/:id | update a user by :id |
| DELETE | /api/users/:id | DELETE a user by :id |