https://github.com/lzhudson/github-blog

https://github.com/lzhudson/github-blog

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/lzhudson/github-blog
• Owner: lzhudson
• License: mit
• Created: 2023-05-13T13:12:59.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-11-09T18:50:59.000Z (about 1 year ago)
• Last Synced: 2024-04-23T10:00:37.332Z (8 months ago)
• Language: TypeScript
• Size: 2.39 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  








  

  



[![Author](https://img.shields.io/badge/author-lzhudson-3294F8?style=flat-square)](https://github.com/lzhudson)

[![Languages](https://img.shields.io/github/languages/count/lzhudson/github-blog?color=%233294F8&style=flat-square)](#)

[![Stars](https://img.shields.io/github/stars/lzhudson/github-blog?color=3294F8&style=flat-square)](https://github.com/lzhudson/github-blog/stargazers)

[![Forks](https://img.shields.io/github/forks/lzhudson/github-blog?color=3294F8&style=flat-square)](https://github.com/lzhudson/github-blog/network/members)

[![Contributors](https://img.shields.io/github/contributors/lzhudson/github-blog?color=3294F8&style=flat-square)](https://github.com/lzhudson/github-blog/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

- List all posts

- Search posts

- Show post page

# :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/github-blog.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/github-blog.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 [Github Blog](https://github.com/lzhudson/github-blog/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/lzhudson/github-blog/blob/main/CONTRIBUTING.md) to find out about the coding standards.

# :tada: Contributing

Check out the [contributing](https://github.com/lzhudson/github-blog/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/github-blog/main/LICENSE).

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