ViewerMyHub

Welcome to the project : ViewerMyHub !
You are currently reading the documentation, happy reading :)

Table of Contents :

1. About The Project
   • Built With
2. Getting Started
   • Setup
3. Informations
4. Credits
5. Licence

---

About The Project

ViewerMyHub is a project that allows you to view your recent GitHub pull requests on Open Source projects you contribute to only in PHP!

You too can view your recent GitHub pull requests on the Open Source projects you contribute to using ViewerMyHub!

Demo here !

Built With

This section presents the languages ​​and tools used:

(Back to top !)

Getting Started

To install and use ViewerMyHub correctly, follow the setup below :

Setup

Download the code or do a git clone :

git clone https://github.com/raphaelmakaryan/ViewerMyHub.git

Rename ".env copy" to .env

.env copy -> .env

Rename ".gitignore copy" to .gitignore

.gitignore copy -> .gitignore

Create a GitHub token on GitHub and set it in the .env file along with the rest:

# GitHub API token and username
GITHUB_TOKEN = YOUR_GITHUB_TOKEN
GITHUB_USERNAME = YOUR_USERNAME

# GitHub API URL for issues
PAGE=1
PER_PAGE=50

(Back to top !)

Informations

ViewerMyHub was created to simplify your workflow, so you simply follow the setup and launch it either on a server (e.g., XAMPP) or on your own.

You must use all the files created for this !

You are free to make your own choices.

(Back to top !)

Credits

This project is inspired by Sébastien Chopin's project.

Which his project was oriented towards Vuejs or globally in javascript, I turned to the same inspiration but in PHP and more simplified.

(Back to top !)

License

MIT

(Back to top !)