Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/helderberto/nextjs-boilerplate
Boilerplate with TypeScript, React, NextJS, and Styled Components.
https://github.com/helderberto/nextjs-boilerplate
boilerplate nextjs nextjs-boilerplate nextjs-starter reactjs starter styled-components vercel
Last synced: 2 months ago
JSON representation
Boilerplate with TypeScript, React, NextJS, and Styled Components.
- Host: GitHub
- URL: https://github.com/helderberto/nextjs-boilerplate
- Owner: helderberto
- Created: 2021-01-29T17:12:33.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2022-01-27T09:58:02.000Z (almost 3 years ago)
- Last Synced: 2023-02-28T07:06:30.757Z (almost 2 years ago)
- Topics: boilerplate, nextjs, nextjs-boilerplate, nextjs-starter, reactjs, starter, styled-components, vercel
- Language: TypeScript
- Homepage:
- Size: 11.9 MB
- Stars: 16
- Watchers: 0
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# NextJS Boilerplate
This is a simple boilerplate with TypeScript, React, NextJS and Styled Components.
## Create your Own Project
Execute the following command to create your project:
```bash
npx create-next-app -e https://github.com/helderburato/nextjs-boilerplate# or
yarn create next-app -e https://github.com/helderburato/nextjs-boilerplate
```## Getting Started
First, run the development server:
```bash
npm run dev
# or
yarn dev
```Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
You can start editing the page by modifying `pages/index.js`. 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.js`.
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!
## Deploy on Vercel
The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/import?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.