Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ulyssear/github-portfolio
Load a github portfolio in a few seconds
https://github.com/ulyssear/github-portfolio
babel github-pages github-workflow html javascript makefile nodejs portfolio prettier reactjs tslint
Last synced: 3 days ago
JSON representation
Load a github portfolio in a few seconds
- Host: GitHub
- URL: https://github.com/ulyssear/github-portfolio
- Owner: ulyssear
- License: mit
- Created: 2022-10-24T17:33:45.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2022-11-03T12:19:04.000Z (about 2 years ago)
- Last Synced: 2023-06-03T22:23:17.743Z (over 1 year ago)
- Topics: babel, github-pages, github-workflow, html, javascript, makefile, nodejs, portfolio, prettier, reactjs, tslint
- Language: JavaScript
- Homepage: https://ulyssear.github.io/github-portfolio/
- Size: 1.64 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
[![LinkedIn][linkedin-shield]][linkedin-url]
Github portfolio
Load a github portfolio in a few seconds
Explore the docs »
View Demo
·
Report Bug
·
Request Feature
Table of Contents
## About The Project
Github portfolio is a simple project to get a github portfolio in a few seconds.
### Built With
[![Javascript][Javascript-shield]][Javascript-url]
[![HTML][HTML-shield]][HTML-url]
[![CSS][CSS-shield]][CSS-url]
[![Nodejs][Nodejs-shield]][Nodejs-url]
[![React][React-shield]][React-url]
## Getting Started
### Prerequisites
### Installation
1. Clone the repo
```sh
git clone https://github.com/ulyssear/github-portfolio.git
```
2. Install NPM packages
```sh
npm install
```
3. Build the project
```sh
npm run build
```
4. Run the project
```sh
npm run start
```
## Usage
If you're using it locally, you have to start the project via `npm run start`. The project will be served on `localhost:8000`.
_Preview of homepage_
An input is available to retrieve pieces of information about a user, or an organization. For example, `ulyssear` can be typed to get information about me.
_Preview of an example portfolio_
A tab is available on the sidebar in which the public repositories are shown. A filter tab is also there to catch fork and owner repositories.
## Roadmap
See the [open issues](https://github.com/ulyssear/github-portfolio/issues) for a full list of proposed features (and known issues).
## 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
## License
Distributed under the MIT License. See `LICENSE` for more information.
## Contact
Ulysse ARNAUD - [email protected]
Project Link: [https://github.com/ulyssear/github-portfolio](https://github.com/ulyssear/github-portfolio)
[contributors-shield]: https://img.shields.io/github/contributors/ulyssear/github-portfolio.svg?style=for-the-badge
[contributors-url]: https://github.com/ulyssear/github-portfolio/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/ulyssear/github-portfolio.svg?style=for-the-badge
[forks-url]: https://github.com/ulyssear/github-portfolio/network/members
[stars-shield]: https://img.shields.io/github/stars/ulyssear/github-portfolio.svg?style=for-the-badge
[stars-url]: https://github.com/ulyssear/github-portfolio/stargazers
[issues-shield]: https://img.shields.io/github/issues/ulyssear/github-portfolio.svg?style=for-the-badge
[issues-url]: https://github.com/ulyssear/github-portfolio/issues
[license-shield]: https://img.shields.io/github/license/ulyssear/github-portfolio.svg?style=for-the-badge
[license-url]: https://github.com/ulyssear/github-portfolio/blob/master/LICENSE
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
[linkedin-url]: https://linkedin.com/in/ulyssearnaud
[product-screenshot]: images/screenshot.png
[JavaScript-shield]: https://img.shields.io/badge/JavaScript-323330?style=for-the-badge&logo=javascript&logoColor=F7DF1E
[JavaScript-url]: https://www.javascript.com/
[HTML-shield]: https://img.shields.io/badge/HTML5-E34F26?style=for-the-badge&logo=html5&logoColor=white
[HTML-url]: https://developer.mozilla.org/fr/docs/Web/HTML
[CSS-shield]: https://img.shields.io/badge/CSS3-1572B6?style=for-the-badge&logo=css3&logoColor=white
[CSS-url]: https://developer.mozilla.org/fr/docs/Web/CSS
[React-shield]: https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB
[React-url]: https://reactjs.org/
[NodeJS-shield]: https://img.shields.io/badge/Node.js-43853D?style=for-the-badge&logo=node.js&logoColor=white
[NodeJS-url]: https://nodejs.org/en/