Readme Generator

This project was created to help developers create their documentation easily.
Link to Documentation

1. Getting Started
   • Prerequisites
   • Usage
   • Frameworks
2. Contributing
3. Contact
4. Readme Generated By

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

This is a prerequisites for this application:

• Install node

  sudo apt install nodejs

• Install npm

  sudo apt install npm

• Update you packages

  sudo apt-get update

• Upgrade

  sudo apt-get upgrade

Usage

1. Install packages

   npm install

2. Build

   npm run build

3. Start

   npm start

4. Access Swagger

   http://localhost:3000/doc/

5. The endpoit is here

   http://localhost:3000/readme/

Frameworks

• Typescript
• Node
• EJS
• EJS
• Express
• TSOA

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Contact

Carlos Sempé
email: [email protected]

ReadmeGeneratedBy

This readme was generated by readme-generator. Please, follow me and put stars in the project.
Author: Carlos Sempé