Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ryparker/proto-nextjs-router-mpa
https://github.com/ryparker/proto-nextjs-router-mpa
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/ryparker/proto-nextjs-router-mpa
- Owner: ryparker
- Created: 2022-09-05T21:11:36.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-03-06T01:40:23.000Z (almost 2 years ago)
- Last Synced: 2024-05-28T16:55:32.954Z (7 months ago)
- Language: TypeScript
- Size: 1.92 MB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Web App
The latest front-end prototype.
## :rocket: Quick Start
**1. Install dependencies with Yarn v1**
```shell
yarn install
```
**2. Start the development server**
```shell
yarn dev
```
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
**3. Build for production**
```shell
yarn build
```
## :traffic_light: Tests
Run all unit tests using Jest.
```sh
yarn test
```
## :books: Component Library (Storybook)
Start Storybook to play with components in isolation.
```sh
yarn storybook
```
## ✍️ Creating new components
To create a new component use Plop.
```sh
yarn plop
```
_See the plop template files at [`./templates/components/base/`](./templates/components/base/)_
## Getting Started with NextJS
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://localhost:3000/api/hello](http://localhost: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.
### Learn More
To learn more about Next.js, take a look at the following resources:
- [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.
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!