React Github Dashboard

project_description

View Demo · Report Bug

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Installation
3. Roadmap
4. Contributing
5. Acknowledgments

About The Project

**API needs to be updated

React Github Dashboard that utilizes Typescript, Mantine UI, Apollo Client, Framer motion as well as a bit of SASS.

(back to top)

Built With

• React.js
• Mantine UI
• SASS
• Apollo
• Typescript
• GraphQL
• React Testing Library

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Installation

1. Create your Github Oauth token in Github. https://github.com/settings/tokens
2. Clone the repo

   git clone https://github.com/RickyPaps/react-github-project.git

3. Install NPM packages

   npm install

4. Enter your API and Query in .env file

   REACT_APP_BASE_QUERY = 'repo:reactjs/reactjs.org is:issue is:open';
   REACT_APP_AUTHORIZATION = 'Bearer ';

5. npm start!

(back to top)

Roadmap

• Add list of issues
• Add pagination
• Add filters
• Add detailed view of issue
• Implement functionality to add comments onto existing issues

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

(back to top)

Acknowledgments

• GitHub GraphQL Overview
• Img Shields
• Tabler Icons React

(back to top)