diff --git a/README.md b/README.md index 9a18a1c..4e52667 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,25 @@ mvn compile mvn spring-boot:run ``` +## Roadmap + +### Functionnalities + +- We have `users` which could be either _volunteers_, _user_ or _admin_ +- Requests that can have multiple status: _Waiting_, _Validated_, _Rejected_, _Chosen_, _Realized_ +- Requests can be done by `users` only +- Feedback can be done by `volunteers` and `users` + +### APIs + +- [ ] `Rest` Create user +- [ ] `Rest` Login with user and password +- [ ] `Rest` Make sure admin can do everything and users don't +- [ ] `Rest` Create a Help Request +- [ ] `Rest` Modify the Help Request status +- [ ] `Rest` Create a User Feedback +- [ ] `Soap` Gather User Feedbacks + ## Check `SOAP` Requests Please install the following application for ease of use SoapUI: @@ -21,4 +40,4 @@ Use this time the HTTPie application, it can be either in fully CLI or with a gr ```bash flatpak install flathub io.httpie.Httpie ``` -Just run the command `http POST localhost:8080 hello=world` to test the REST api. \ No newline at end of file +Just run the command `http POST localhost:8080 hello=world` to test the REST api.