Details
-
Sub-task
-
Status: Resolved
-
P3
-
Resolution: Done
-
None
-
None
Description
The README file should be added to the server app. It should contain the following sections:
- About – description of the server app right after the title
- Requirements – a list of required tools, services, etc. to run the server app. E.g. "Golang 1.16"
- Getting Started – Table of content
- Running the server app – steps on how to set the server up and running locally
- Calling the server from another client – how to call the server
- Deployment – how to deploy the server. Leave this section as "TBD"
- How to Contribute – self-explanatory. Leave this section as "TBD"
Use this README file for reference.
Attachments
Issue Links
- links to