https://github.com/shin-sforzando/etude-next
https://github.com/shin-sforzando/etude-next
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/shin-sforzando/etude-next
- Owner: shin-sforzando
- Created: 2022-03-29T15:39:11.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-01-09T02:42:03.000Z (over 2 years ago)
- Last Synced: 2025-02-03T06:35:40.687Z (3 months ago)
- Language: TypeScript
- Homepage: etude-next.vercel.app
- Size: 11.7 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# etude-next
[](https://github.com/storybookjs/storybook)
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).
- [Prerequisites](#prerequisites)
- [How to](#how-to)
- [Start](#start)
- [Deploy](#deploy)
- [Vercel](#vercel)
- [Misc](#misc)
- [ToDo](#todo)
- [Learn More](#learn-more)
- [Contributor](#contributor)
## Prerequisites
- Docker
- Node.js
- Next.js
## How to
### Start
```shell
docker compose up -d # dkcU
```
Open [http://0.0.0.0:3000](http://0.0.0.0:3000) with your browser to see the result.
You can start editing the page by modifying `pages/index.tsx`. The page auto-updates as you edit the file.
[API routes](https://nextjs.org/docs/api-routes/introduction) can be accessed on [http://0.0.0.0:3000/api/hello](http://0.0.0.0:3000/api/hello). This endpoint can be edited in `pages/api/hello.ts`.
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.
### Deploy
#### 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.
## Misc
### ToDo
- [x] Introduce [tailwindcss-classnames](https://github.com/muhammadsammy/tailwindcss-classnames)
- [x] Improve Storybook
- [x] a11y
- [x] Designs
- [x] GitHub Actions
- [x] Links
- [x] Performance
- [x] Storyshots
- [x] Storysource
- [x] Theme
- [x] Introduce [next-axiom](https://github.com/axiomhq/next-axiom) as Logger
- [X] Introduce Jest as Testing Framework
### Learn More
To learn more about Next.js, take a look at the following resources:
- [the Next.js GitHub repository](https://github.com/vercel/next.js/)
- [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.
### Contributor
- [sforzando LLC. and Inc.](https://sfz.dev/)
- [Shin'ichiro Suzuki](https://github.com/shin-sforzando)