diff --git a/readme.md b/readme.md index cf3ea0d2546a890deeead923e292e46717b81c50..26836cfb8e4e15f95f1e28a27f461a6ed446bfcc 100644 --- a/readme.md +++ b/readme.md @@ -9,20 +9,30 @@ --- -# Description of version 1.0.0 +# Description -This project should be used to construct a complete ASP-Net REST server compliant to the ARF World Storage API. It uses auto-generated ASP.NET server code. We propose to use the open source OpenAPI-Generator for this. +This repo should be used to construct a complete ASP-Net REST server compliant to the ARF World Storage API. It uses auto-generated ASP.NET server code. We propose to use the open source OpenAPI-Generator for this. It includes description and code for a fully functional server with MongoDB integration. -# Prerequisites +## Repo Content + +| | File / Folder | Description | +|:-:|:--------------:|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| +| 📂 | EtsiServerGen | The folder where the library code will be generated, the openapi generator is set to not overwrite the CmakeLists.txt used to generate and export the library to the user's sytem | +| 📂 | EtsiServerImpl | This folder contains a basic implementation of this library, its main set up a local hosted server on port 8080 waiting for CRUD REST queries on the Trackable objects | +| 📂 | arf005 | A submodule pointing to the git containing the API specification file | +| 📃 | package.json | The file containing the npm scripts automating the whole library generation process | + +## Requirements + What you need: 1. Installed npm: https://phoenixnap.com/kb/install-node-js-npm-on-windows 2. Installed openapi generator with npm: https://openapi-generator.tech/docs/installation/ 3. Installed docker (if you want to use it): https://www.docker.com/get-started -# Generate or update the server +# Code Generation We provided the file `.openapi-generator-ignore` in `server`, which prevents openapi-generator to override some adapted files.