Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 17 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@
![GitHub Discussions](https://img.shields.io/github/discussions/james-gates-0212/portfolio)
![GitHub Issues](https://img.shields.io/github/issues/james-gates-0212/portfolio)
![GitHub License](https://img.shields.io/github/license/james-gates-0212/portfolio)
![GitHub Repo stars](https://img.shields.io/github/stars/james-gates-0212/portfolio?style=flat)
![GitHub top language](https://img.shields.io/github/languages/top/james-gates-0212/portfolio)
![GitHub repo file or directory count](https://img.shields.io/github/directory-file-count/james-gates-0212/portfolio)
![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/james-gates-0212/portfolio)
![GitHub repo size](https://img.shields.io/github/repo-size/james-gates-0212/portfolio)
![GitHub Release](https://img.shields.io/github/v/release/james-gates-0212/portfolio)
![GitHub Tag](https://img.shields.io/github/v/tag/james-gates-0212/portfolio)

Expand All @@ -11,24 +16,24 @@
[![Next.js Bundle Analysis](https://github.com/james-gates-0212/portfolio/actions/workflows/nextjs-bundle-analysis.yml/badge.svg)](https://github.com/james-gates-0212/portfolio/actions/workflows/nextjs-bundle-analysis.yml)
[![Proof HTML](https://github.com/james-gates-0212/portfolio/actions/workflows/proof-html.yml/badge.svg)](https://github.com/james-gates-0212/portfolio/actions/workflows/proof-html.yml)

# ❤️Portfolio based on Next.js & tailwindcss
# Portfolio based on Next.js & tailwindcss

This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).

## 📝Environment
## Environment

- node 18.x or later
- yarn 1.x or later
- npm 8.x or later

## 🚧Install npm packages
## Install npm packages

```bash
npm i -g yarn
yarn
```

## 🌈Getting Started
## Getting Started

First, run the development server:

Expand All @@ -42,13 +47,13 @@ You can start editing the page by modifying `app/page.tsx`. The page auto-update

This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.

## Lint
## Lint

```bash
yarn lint
```

## ❤️Prettier
## Prettier

```bash
prettier --write ./
Expand All @@ -59,7 +64,7 @@ prettier --write ./
npm i -g prettier
```

## 🚀Build or Start project as production
## Build or Start project as production

```bash
yarn build
Expand All @@ -71,7 +76,7 @@ or
yarn start
```

## 🏆Learn More
## Learn More

To learn more about Next.js, take a look at the following resources:

Expand All @@ -80,13 +85,13 @@ To learn more about Next.js, take a look at the following resources:

You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!

## 🚀Deploy on Vercel
## Deploy on Vercel

The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.

Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.

## 🐞Git commit
## Git commit

Please use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) for your commits.

Expand All @@ -98,7 +103,7 @@ e.g.
[footer]
```

### ♻️Types
### Types

`type` should be one of belows.

Expand All @@ -118,7 +123,7 @@ remove
style
```

### 📓Subject
### Subject

`subject` should include one of emojis as belows.

Expand Down