Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/alexiszamanidis/2022

A minimal Portfolio Web page developed using Next.js, TypeScript and Styled-Components. It is deployed with GitHub pages and uses GitHub REST API to fetch my Projects.
https://github.com/alexiszamanidis/2022

ci-cd github-actions github-api github-pages nextjs portfolio portfolio-website styled-components typescript yarn

Last synced: about 4 hours ago
JSON representation

A minimal Portfolio Web page developed using Next.js, TypeScript and Styled-Components. It is deployed with GitHub pages and uses GitHub REST API to fetch my Projects.

Host: GitHub
URL: https://github.com/alexiszamanidis/2022
Owner: alexiszamanidis
Created: 2022-01-09T00:53:04.000Z (almost 3 years ago)
Default Branch: master
Last Pushed: 2023-01-07T22:45:00.000Z (almost 2 years ago)
Last Synced: 2023-03-04T00:26:59.012Z (over 1 year ago)
Topics: ci-cd, github-actions, github-api, github-pages, nextjs, portfolio, portfolio-website, styled-components, typescript, yarn
Language: TypeScript
Homepage: https://alexiszamanidis.github.io/2022
Size: 1020 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 3
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        ## ALEXISZAMANIDIS.GITHUB.IO

A minimal Portfolio Web page developed using Next.js, TypeScript and Styled-Components. A well-structured project for use by anyone.

## Benefits

-   Easy to use

-   Easy to setup

-   Configurable

-   Includes everything a big project needs

    -   Husky

    -   Prettier

    -   ESLint

    -   Lint Staged

    -   TypeScript

    -   Testing

    -   CI/CD

-   Keeps dependencies up to date

    -   Dependabot

### Create your own

-   Clone the repository

-   Move into the repository

-   Install the dependencies: `yarn`

-   Run the application locally: `yarn dev`

-   Configure the files listed below to your personal preferences(Of course you can configure any file but these are the most useful ones)

    -   The `react-icons` package has been installed, so if you want to import a new icon or a different one, you can search [here](https://react-icons.github.io/react-icons/search)

-   Change the `NEXT_PUBLIC_BASE_PATH` env variable to your repository name

    -   The `NEXT_PUBLIC_BASE_PATH` has been defined in the `.github/workflows/deploy.yml` file

-   Push it to your GitHub account

-   Go to your repository on Github -> Settings -> Pages

    -   Select `gh-pages` for your branch

    -   Select `/ (root)` for your root

    -   Click save

-   Check out your website at `[your-github-username].github.io/[your-repository-name]`

### Files

| Path                | Description                           |

| ------------------- | ------------------------------------- |

| public/favicon.ico  | Favicon icon                          |

| constants/index.tsx | Contains the data that are displayed  |

| themes/default.tsx  | Contains the theme colors(light/dark) |

### Scripts

-   `install`

    This script will install the dependencies and run the application