MD Templates - Non Commented

README-Template.md

Readme Template

Table of Contents

• Description
• Installation Instructions
• How To Use
• License
• Contribution
• Tests
• About The Author

Description

Installation Instructions

How To Use

Contribution Guidelines

Contributors are welcome, just keep a few things in mind:

1. All contributions are to be made in a separate branch off develop or in an independent fork. Do not attempt to contribute to develop or main directly, it will be denied.

2. All contributions are subject to peer review, so please keep your code clean and readable, feel free to comment as much as you like, however most of those comments will likely be removed in the final version if your contributions are merged. Your code should speak for itself wherever possible.

3. If there is an open issue that is not assigned, that means it is available to be worked on, so take your pick.

4. don't forget to have fun. If you love what you do, its not work.

Application Tests

license

About The Author

Example: I hope you enjoy the application, if you have any questions, comments, concerns, feedback, ect, please feel free to open a new issue or reach out directly. Don't forget to check out some of my other projects on github while your here!

• Links
• Email: [email protected]
• GitHub: cobalt88
• Patreon:
• YouTube:
• Facebook:
• LinkedIn:

Route-Map-Template.md

API Route Map

This document details all the complete and tested routes available in the controllers folder, how to access them, what data they expect to receive in the requests sent to them, and what data you should expect in the response from that route.

Contents

• Route Group 1
• Route Group 2
• Route Group 3
• Route Group 4
• Models Information
• Server Information
• About The Author

---

Route Group 1

Note: It is recommended to group your routes by functionality, both in your file structure and in your documentation. For example if you have a users directory and an admin directory, and each of those directories has their own sub directories, write out the documentation in the same layout. This way the flow of your documentation matches the flow of your system architecture, making it a lot easier to read.

• GET Route Map Template:
  Request Requirements: ""
  Expected Response: ""
  Method: GET
  URL: ""
  Example: ""
  

• POST Route Map Template:
  Request Requirements: ""
  Expected Response: ""
  Method: POST
  URL: ""
  Example: ""
  

• PUT Route Map Template:
  Request Requirements:
  Expected Response: ""
  Method: PUT
  URL: ""
  Example: ""
  

• DELETE Route Map Template:
  Request Requirements: ""
  Expected Response: ""
  Method: DELETE
  URL: ""
  Example: ""
  

---

Route Group 2

• GET Route Map Template:
  Request Requirements: ""
  Expected Response: ""
  Method: GET
  URL: ""
  Example: ""
  

• POST Route Map Template:
  Request Requirements: ""
  Expected Response: ""
  Method: POST
  URL: ""
  Example: ""
  

• PUT Route Map Template:
  Request Requirements:
  Expected Response: ""
  Method: PUT
  URL: ""
  Example: ""
  

• DELETE Route Map Template:
  Request Requirements: ""
  Expected Response: ""
  Method: DELETE
  URL: ""
  Example: ""
  

  ---

Route Group 3

• GET Route Map Template:
  Request Requirements: ""
  Expected Response: ""
  Method: GET
  URL: ""
  Example: ""
  

• POST Route Map Template:
  Request Requirements: ""
  Expected Response: ""
  Method: POST
  URL: ""
  Example: ""
  

• PUT Route Map Template:
  Request Requirements:
  Expected Response: ""
  Method: PUT
  URL: ""
  Example: ""
  

• DELETE Route Map Template:
  Request Requirements: ""
  Expected Response: ""
  Method: DELETE
  URL: ""
  Example: ""
  

---

Route Group 4

• GET Route Map Template:
  Request Requirements: ""
  Expected Response: ""
  Method: GET
  URL: ""
  Example: ""
  

• POST Route Map Template:
  Request Requirements: ""
  Expected Response: ""
  Method: POST
  URL: ""
  Example: ""
  

• PUT Route Map Template:
  Request Requirements:
  Expected Response: ""
  Method: PUT
  URL: ""
  Example: ""
  

• DELETE Route Map Template:
  Request Requirements: ""
  Expected Response: ""
  Method: DELETE
  URL: ""
  Example: ""
  

---

Models Information

---

Server Information

---

About The Author

Author: Vincent Teune
GitHub: https://github.com/cobalt88
Email: [email protected]
Last Updated: June 2022