Giter Club home page Giter Club logo

autohub-portfolio's Introduction

AutoHub Portfolio


Last update: May 31, 2024 Updated for React 18.2 AutoHub Portfolio Version 0.0.1
Generated AutoHub Portfolio Page

Welcome!

Description

AutoHub Portfolio(Automatic GitHub Portfolio) uses GitHub API to scrape your public repositories and present their data using conventions. You can always add additional projects, such as private repositories, manually. This project aims to create a quick portfolio without the need for a backend server, reducing expenses for new developers and serving as an example. For frontend contact form I used formspree. Currently project uses i18next for translations.

Highly recommend using something like ScreenToGif to create GIFs of the the project!

Prerequisites

  • Node.js (v20.10.0 or later)
  • NPM or Yarn installed

Conventions

Repositories cards are created following these conventions. Each color with arrow represents information flow.

Repository Card Creation Convention

Repositories pages follows mostly similiar information flow and includes description(if it exists). All possible stack variantions can be found in src/enums/FrameworksEnum.tsx. It includes not only frameworks. All possible languages variantions can be found in src/enums/LanguagesEnum.tsx. It includes not only Programming languages. All possible sizes variantions can be found in src/enums/ProjectSizesEnum.tsx. Languages strings can be found in src/assets/translations.

Important information

GitHub API has rate limits. For not registered users maximum is 60 calls per hour. AutoHub Portfolio uses FetchCacher to store fetched data and if limit is reached or error occurs it presents stored data instead.

  • _ Version 0.0.1 contains some of my personal information that I do not mind sharing. The project was a bit rushed to be published, and in the following versions, the data will be minimized. _
GitHub Rate Limits In Network Tab

Steps to launch this project

1. Add data for repositories

[✔] 1.1 Add images/gifs to existing projects

  • Create new preview/images folder and/or preview/gifs folder in existing repositories and fill them with content.

2. Setup project

[✔] 2.1 Change GitHub User to scrape data from

[✔] 2.2 Install dependencies

  • Run npm install in the root directory to install the required packages.

[✔] 2.3 Build the project

  • Use npm run build to build project.

3. Publish project

[✔] 3.1 Put project in GitHub as a Repository

  • Create public repository on GitHub and push code to it or initialize repository remotly through git.

[✔] 3.2 Make GitHub page

  • Make GitHub page. Recommend this tutorial for people who do not know how to deploy Vite React App.

[✔] 3.3 Fix Routes for GitHub Page

  "scripts": {
      "dev": "vite --base=/AutoHub-Portfolio",
      "build": "tsc && vite build --base=/AutoHub-Portfolio",

instead of "/AutoHub-Portfolio" use your own repository name

  base: "/AutoHub-Portfolio/",

to your own repository name

Used assets

Unsplash authors

autohub-portfolio's People

Contributors

gymmed avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.