Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Myoschen committed Dec 10, 2023
1 parent 8b6676e commit 4208f72
Showing 1 changed file with 29 additions and 26 deletions.
55 changes: 29 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,41 @@
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).
# portfolio

## Getting Started
![GitHub last commit (branch)](https://img.shields.io/github/last-commit/Myoschen/portfolio/main?style=flat-square&labelColor=%23222222&color=%23111111)
![GitHub language count](https://img.shields.io/github/languages/count/Myoschen/portfolio?style=flat-square&labelColor=%23222222&color=%23111111)
![GitHub issues](https://img.shields.io/github/issues/Myoschen/portfolio?style=flat-square&labelColor=%23222222&color=%23111111)
![GitHub package.json version (branch)](https://img.shields.io/github/package-json/v/Myoschen/portfolio/main?style=flat-square&label=version&labelColor=%23222222&color=%23111111)
![GitHub top language](https://img.shields.io/github/languages/top/Myoschen/portfolio?style=flat-square&labelColor=%23222222&color=%23111111)
![GitHub License](https://img.shields.io/github/license/Myoschen/portfolio?style=flat-square&labelColor=%23222222&color=%23111111)

First, run the development server:
This is my portfolio.

```bash
npm run dev
# or
yarn dev
# or
pnpm dev
```

Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.

You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
## Tech stack

[API routes](https://nextjs.org/docs/api-routes/introduction) can be accessed on [http://localhost:3000/api/hello](http://localhost:3000/api/hello). This endpoint can be edited in `pages/api/hello.ts`.
- [Next.js](https://nextjs.org/)
- [Tailwind CSS](https://tailwindcss.com/)
- [Radix Primitives](https://www.radix-ui.com/primitives)
- [Tabler Icons](https://tabler.io/icons)
- [Framer Motion](https://www.framer.com/motion/)
- [Next Intl](https://next-intl-docs.vercel.app/)

The `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes](https://nextjs.org/docs/api-routes/introduction) instead of React pages.
## Usage

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

## Learn More
```bash
# clone the repository
git clone https://github.com/Myoschen/portfolio.git

To learn more about Next.js, take a look at the following resources:
# change directory
cd portfolio

- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
# install deps
pnpm install

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

## Deploy on Vercel
# open browser and visit http://localhost:3000
```

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.
## License

Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
Licensed under the [MIT License](./LICENSE).

1 comment on commit 4208f72

@vercel
Copy link

@vercel vercel bot commented on 4208f72 Dec 10, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

portfolio – ./

ryan-chen-portfolio.vercel.app
portfolio-myoschen.vercel.app
portfolio-git-main-myoschen.vercel.app

Please sign in to comment.