Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/yagoinacio/readme-model

Base template for readme file
https://github.com/yagoinacio/readme-model

readme-template

Last synced: 2 days ago
JSON representation

Base template for readme file

Host: GitHub
URL: https://github.com/yagoinacio/readme-model
Owner: YagoInacio
License: mit
Created: 2023-11-24T13:33:19.000Z (12 months ago)
Default Branch: main
Last Pushed: 2023-11-24T14:37:59.000Z (12 months ago)
Last Synced: 2023-11-25T14:39:52.676Z (12 months ago)
Topics: readme-template
Homepage:
Size: 4.88 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        


  

  

  

    

  

   

  

    

  





    





 About •

 Tech Stack • 

 Features •

 

 How it works • 

 

 Author • 

 License



## 💻 Project Title

Project description - Deserunt culpa laboris duis fugiat amet. Dolor adipisicing incididunt laborum sunt voluptate sunt aliquip quis. Aliqua Lorem voluptate ut exercitation. Excepteur reprehenderit sit irure irure eu et tempor labore pariatur. Nisi mollit nostrud qui anim velit.

Occaecat tempor commodo aliquip id in eu. Deserunt labore irure velit magna ipsum consequat. Do in veniam eu deserunt laboris. Aute sunt adipisicing veniam elit incididunt ea officia ad nisi non. Commodo excepteur aliqua laborum aliqua cillum non aliquip incididunt. Id aliquip id voluptate nulla fugiat. Deserunt amet sint nulla deserunt labore sit incididunt amet sunt in sint.

## 🛠 Tech Stack

-   **[Express](https://expressjs.com/)**

-   **[CORS](https://expressjs.com/en/resources/middleware/cors.html)**

-   **[KnexJS](http://knexjs.org/)**

-   **[SQLite](https://github.com/mapbox/node-sqlite3)**

-   **[ts-node](https://github.com/TypeStrong/ts-node)**

## ✨ Features

- [x] Feature 1:

  - [x] Sub feature 1.1

  - [x] Sub feature 1.2

  - [x] Sub feature 1.3

  - [x] Sub feature 1.4

    - item 1

    - item 2

    - item 3

    - item 4

    - item 5

- [x] Feature 2:

  - [x] Sub feature 2.1

  - [ ] Sub feature 2.2

## 🚀 How it works

This instructions will allow you to run a functional version of the project on your local machine.

### 📋 Pre-requisites

Before you begin, you will need to have the following tools installed on your machine:

[Git](https://git-scm.com), [Node.js](https://nodejs.org/en/).

In addition, it is good to have an editor to work with the code like [VSCode](https://code.visualstudio.com/)

#### 🔧 Instalation

```bash

# Clone this repository

$ git clone [email protected]:yagoinacio/readme-model.git

# Access the project folder cmd/terminal

$ cd project

# install the dependencies

$ npm install

```

#### 🎲 Running the application

```bash

# Run the application in development mode

$ npm run dev:server

# The server will start at port: 3333 - go to http://localhost:3333

```

You can try out the API using its swagger documentation on http://localhost:3333/swagger-ui/index.html

#### ✅ Running automated tests

```bash

# Run automated tests

$ npm run test

# The test automation will run for unit and e2e

```

## 🦸 Author



 

 


 _{Yago Faran 💧}



[![Github Badge](https://img.shields.io/badge/-YagoInacio-gray?style=flat-square&labelColor=gray&logo=github&logoColor=white&link=https://github.com/yagoinacio)](https://github.com/yagoinacio)

[![Linkedin Badge](https://img.shields.io/badge/-Yago-blue?style=flat-square&logo=Linkedin&logoColor=white&link=https://www.linkedin.com/in/yagoinacio/)](https://www.linkedin.com/in/yagoinacio/) 

[![Gmail Badge](https://img.shields.io/badge/[email protected]?style=flat-square&logo=Gmail&logoColor=white&link=mailto:[email protected])](mailto:[email protected])

## 📝 License

This project is under the license [MIT](./LICENSE).

Made with ❤️ by Yago Faran 👋🏽 [Get in touch!](https://www.linkedin.com/in/yagoinacio/)