Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/lzhudson/my-better-readme


https://github.com/lzhudson/my-better-readme

Last synced: about 2 months ago
JSON representation

Awesome Lists containing this project

README

        

[Logo Project]: .github/docs/images/logo-example.png
[Main Image Project]: .github/docs/images/logo-example.png
[GIF Project]: .github/docs/images/logo-example.png







[![Author](https://img.shields.io/badge/author-lzhudson-3D3D4D?style=flat-square)](https://github.com/lzhudson)
[![Languages](https://img.shields.io/github/languages/count/lzhudson/ignite-feed?color=%233D3D4D&style=flat-square)](#)
[![Stars](https://img.shields.io/github/stars/lzhudson/ignite-feed?color=3D3D4D&style=flat-square)](https://github.com/lzhudson/ignite-feed/stargazers)
[![Forks](https://img.shields.io/github/forks/lzhudson/ignite-feed?color=%233D3D4D&style=flat-square)](https://github.com/lzhudson/ignite-feed/network/members)
[![Contributors](https://img.shields.io/github/contributors/lzhudson/ignite-feed?color=3D3D4D&style=flat-square)](https://github.com/lzhudson/ignite-feed/graphs/contributors)

---

# :pushpin: Table of Contents

* [Features](#rocket-features)
* [Installation](#construction_worker-installation)
* [Found a bug? Missing a specific feature?](#bug-issues)
* [Contributing](#tada-contributing)
* [License](#closed_book-license)

# :rocket: Features

* Adding comments
* Like comments

# :construction_worker: Installation

**You need to install [Node.js](https://nodejs.org/en/download/) and [Yarn](https://yarnpkg.com/) first, then in order to clone the project via HTTPS, run this command:**

```
git clone https://github.com/lzhudson/ignite-feed.git
```

SSH URLs provide access to a Git repository via SSH, a secure protocol. If you have a SSH key registered in your Github account, clone the project using this command:

```
git clone [email protected]:lzhudson/ignite-feed.git
```

**Install dependencies**

```
yarn install
```

**Start development server**

```
yarn dev
```

# :bug: Issues

Feel free to **file a new issue** with a respective title and description on the [Ignite Feed](https://github.com/lzhudson/ignite-feed/issues) repository. If you already found a solution to your problem, **I would love to review your pull request**! Have a look at our [contribution guidelines](https://github.com/lhzhudson/ignite-feed/blob/main/CONTRIBUTING.md) to find out about the coding standards.

# :tada: Contributing

Check out the [contributing](https://github.com/lzhudson/ignite-feed/blob/main/CONTRIBUTING.md) page to see the best places to file issues, start discussions and begin contributing.

# :closed_book: License

Released in 2023
This project is under the [MIT license](https://github.com/lzhudson/ignite-feed/main/LICENSE).

Designed by [Rockeseat](https://github.com/Rocketseat) and developed by [Hudson Holanda](https://github.com/lzhudson) 🖤🚀