https://github.com/raphaelbh/readme-template

Template for creating readme files
https://github.com/raphaelbh/readme-template

readme readme-badges readme-md readme-standard readme-template scaffold scaffold-template template

Last synced: over 1 year ago
JSON representation

Template for creating readme files

• Host: GitHub
• URL: https://github.com/raphaelbh/readme-template
• Owner: raphaelbh
• Created: 2022-02-11T12:10:45.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2022-02-19T15:30:23.000Z (over 4 years ago)
• Last Synced: 2025-01-25T20:11:27.594Z (over 1 year ago)
• Topics: readme, readme-badges, readme-md, readme-standard, readme-template, scaffold, scaffold-template, template
• Homepage:
• Size: 4.88 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# README Template

[![Project Status](https://img.shields.io/static/v1?label=project%20status&message=in%20development&color=yellow&style=flat-square)](#)

[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/raphaelbh/readme-template/workflow?style=flat-square)](#)

[![Coverage](https://img.shields.io/static/v1?label=coverage&message=95%&color=success&style=flat-square)](#)

[![GitHub License](https://img.shields.io/github/license/raphaelbh/readme-template?style=flat-square)](#)

[![GitHub last commit](https://img.shields.io/github/last-commit/raphaelbh/readme-template?style=flat-square)](#)

Template for creating readme files.

> A README file contains information about the other files in a directory or archive of computer software. A form of documentation, it is usually a simple plain text file called README, Read Me, READ.ME, README.TXT, README.md (to indicate the use of Markdown), or README.1ST. [Wikipedia](https://en.wikipedia.org/wiki/README)

## Demo

https://github.com/raphaelbh/readme-template

## Requirements

[![docker](https://img.shields.io/badge/Docker-2CA5E0?style=for-the-badge&logo=docker&logoColor=white)](https://www.docker.com/)

## Installation

```bash

$ docker run -p 5000:5000 -e PORT=5000 -d raphaelbh/timezone-api

```

    

## Usage

```bash

$ curl http://localhost:5000/api

```

## Running Tests

```bash

$ pytest --cov=app tests/

```

## Project Structure

    .

    ├── build                   # Compiled files (alternatively `dist`)

    ├── docs                    # Documentation files (alternatively `doc`)

    ├── src                     # Source files (alternatively `lib` or `app`)

    ├── test                    # Automated tests (alternatively `spec` or `tests`)

    ├── tools                   # Tools and utilities

    ├── LICENSE

    └── README.md

## Tech Stack

[![docker](https://img.shields.io/badge/Docker-2CA5E0?style=for-the-badge&logo=docker&logoColor=white)](https://www.docker.com/)

[![python](https://img.shields.io/badge/Python-FFD43B?style=for-the-badge&logo=python&logoColor=blue)](https://www.python.org/)

[![kotlin](https://img.shields.io/badge/Kotlin-0095D5?&style=for-the-badge&logo=kotlin&logoColor=white)](https://kotlinlang.org/)

[![java](https://img.shields.io/badge/Java-ED8B00?style=for-the-badge&logo=java&logoColor=white)](https://www.java.com/)

[![javascript](https://img.shields.io/badge/JavaScript-323330?style=for-the-badge&logo=javascript&logoColor=F7DF1E)](https://devdocs.io/javascript/)

[![nodejs](https://img.shields.io/badge/Node.js-339933?style=for-the-badge&logo=nodedotjs&logoColor=white)](https://nodejs.org/en/)

[![spring](https://img.shields.io/badge/Spring-6DB33F?style=for-the-badge&logo=spring&logoColor=white)](https://spring.io/)

[![springboot](https://img.shields.io/badge/Spring_Boot-F2F4F9?style=for-the-badge&logo=spring-boot)](https://spring.io/projects/spring-boot)

[![heroku](https://img.shields.io/badge/Heroku-430098?style=for-the-badge&logo=heroku&logoColor=white)](https://heroku.com)

[![aws](https://img.shields.io/badge/Amazon_AWS-FF9900?style=for-the-badge&logo=amazonaws&logoColor=white)](https://aws.amazon.com/)

## Reference

- https://github.com/raphaelbh/readme-template

- https://shields.io/

- https://github.com/alexandresanlim/Badges4-README.md-Profile

## Feedback

If you have any feedback, please contact me at raphaeldias.ti@gmail.com

[![github](https://img.shields.io/badge/GitHub-100000?style=for-the-badge&logo=github&logoColor=white)](https://github.com/raphaelbh)

[![linkedin](https://img.shields.io/badge/LinkedIn-0077B5?style=for-the-badge&logo=linkedin&logoColor=white)](https://www.linkedin.com/in/raphaelbh/)