GitHub Blog

A blog to check out all of your issues from a repository and profile information from GitHub. This project uses the GitHub API

GitHub Blog | Status: Done ✔️

Table of Contents

• Features
• Requirements to run the project
• Running the application
• Main Technologies
• Final Result
  • Home page
  • Profile page
  • Profile page with issue filter
  • Issue post page
• Deploy
• License
• Author
• Contributing Guidelines

Features

GitHub Blog is a web application that offers a range of powerful features to help you explore GitHub repositories and user profiles efficiently. Here are the key features:

1. Search for Issues in a Repository

Easily search for issues within any GitHub repository. Whether you're a contributor or a user interested in a project, this feature allows you to find and track specific issues.

2. Display GitHub Profile Information

View comprehensive information about GitHub user profiles. This includes followers, profile description, work location and profile image.

3. View Issue Posts

Explore and read detailed posts about specific issues within a repository. Access discussions, solutions, and contributions made by the GitHub community.

4. User-Friendly Interface

Our user interface is designed for simplicity and usability. Enjoy a seamless experience while navigating through profiles, and issue posts.

6. Search Filters

Refine your searches with advanced filters. Narrow down results by labels, tags, date, and more, making it easier to find the information you need.

7. Markdown Support

Read and create issue posts in Markdown format. Enjoy rich text formatting options and code highlighting for a better reading experience.

Requirements to run the project

Before you run the project, check if you have [Node.js](https://nodejs.org/en/) installed on your machine, as well [Git](https://git-scm.com) to clone this repository.

Running the application

    # Clone this repository on your machine:
    $ git clone https://github.com/vitorlinsbinski/github-blog.git

    # Access the project folder in your terminal:
    $ cd github-blog

    # Install all dependencies:
    $ npm install

    # Run the application:
    $ npm run dev

Main Technologies

• ReactJS
• Vite
• TypeScript
• React Hook Form
• ZOD
• React Router DOM
• Axios
• Styled Components
• use-context-selector
• date-fns
• react-markdown
• react-syntax-highlighter

Final Result

Home page

/

Profile page

/vitorlinsbinski/github-blog

Profile page with issue filter

/vitorlinsbinski/github-blog

Issue post page

/vitorlinsbinski/github-blog/1

Deploy

Check out the project working: https://desafio-github-blog.vercel.app

Contributing Guidelines

We welcome contributions from the community to make GitHub Blog even better! Whether you want to fix a bug, add a new feature, or improve documentation, your contributions are valuable.

1. Fork the Repository

Click the "Fork" button at the top right of this repository to create a copy in your GitHub account.

2. Clone the Repository

Clone your forked repository to your local machine using the following command:

git clone https://github.com/your-username/github-blog.git

3. Create a Branch

Create a new branch for your contribution:

git checkout -b feature/your-feature-name

4. Make changes

Make your desired changes to the codebase. Ensure that your code follows our coding standards and conventions.

5. Test your changes

Before submitting a pull request, test your changes thoroughly to ensure they work as expected.

6. Commit and Push

Commit your changes and push them to your forked repository:

git add .
git commit -m "Add your descriptive commit message here"
git push origin feature/your-feature-name

License

This project is licensed under MIT License.

Author

_{Vitor Linsbinski} 🚀

Developed by Vitor Linsbinski