Github portfolio

Load a github portfolio in a few seconds
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact

About The Project

Github portfolio is a simple project to get a github portfolio in a few seconds.

(back to top)

Built With

(back to top)

Getting Started

Prerequisites

Installation

1. Clone the repo

   git clone https://github.com/ulyssear/github-portfolio.git

2. Install NPM packages

   npm install

3. Build the project

   npm run build

4. Run the project

   npm run start

(back to top)

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.

(back to top)

Roadmap

See the open issues for a full list of proposed features (and known 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)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

Ulysse ARNAUD - ulysse@arnaud.tech

Project Link: https://github.com/ulyssear/github-portfolio

(back to top)