From 5ed2e33d6c852ad401e1e0e7579d5101901f25ae Mon Sep 17 00:00:00 2001 From: RemRem Date: Fri, 2 Dec 2022 11:55:06 +0100 Subject: [PATCH] update README.md --- README.md | 50 +++++--------------------------------------------- 1 file changed, 5 insertions(+), 45 deletions(-) diff --git a/README.md b/README.md index e695d9d..7b78024 100644 --- a/README.md +++ b/README.md @@ -1,49 +1,9 @@ +# PassWordl-API + A server app built using [Shelf](https://pub.dev/packages/shelf), configured to enable running with [Docker](https://www.docker.com/). -This sample code handles HTTP GET requests to `/` and `/echo/` - -# Running the sample - -## Running with the Dart SDK - -You can run the example with the [Dart SDK](https://dart.dev/get-dart) -like this: - -``` -$ dart run bin/server.dart -Server listening on port 8080 -``` - -And then from a second terminal: -``` -$ curl http://0.0.0.0:8080 -Hello, World! -$ curl http://0.0.0.0:8080/echo/I_love_Dart -I_love_Dart -``` - -## Running with Docker - -If you have [Docker Desktop](https://www.docker.com/get-started) installed, you -can build and run with the `docker` command: - -``` -$ docker build . -t myserver -$ docker run -it -p 8080:8080 myserver -Server listening on port 8080 -``` - -And then from a second terminal: -``` -$ curl http://0.0.0.0:8080 -Hello, World! -$ curl http://0.0.0.0:8080/echo/I_love_Dart -I_love_Dart -``` +## Links -You should see the logging printed in the first terminal: -``` -2021-05-06T15:47:04.620417 0:00:00.000158 GET [200] / -2021-05-06T15:47:08.392928 0:00:00.001216 GET [200] /echo/I_love_Dart -``` +Here is the [API Link](https://codefirst.iut.uca.fr/containers/passworld-api-remiarnal/) +Cheat sheet that i use for the api status code : [HTTP Status Code Cheat Sheet](https://www.websiterating.com/resources/http-status-codes-cheat-sheet/)