Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/novellito/the-nextjs-starter

Another Next.js boilerplate
https://github.com/novellito/the-nextjs-starter

Last synced: 3 months ago
JSON representation

Another Next.js boilerplate

Awesome Lists containing this project

README

        

# The Nextjs starter
Hopefully the last one you'll need 😉

## Features
- ▲ Uses the latest [Next.js](https://github.com/zeit/next.js) along with [typescript](https://www.typescriptlang.org/)
- 🎉 Icons from [fontawesome](https://fontawesome.com/) using [react-fontawesome](https://github.com/FortAwesome/react-fontawesome)
- 💅 🌀 Styling with [styled-components](https://github.com/styled-components/styled-components) and [tailwind-css](https://tailwindcss.com/)
- 🐐 Unit testing with [react-testing-library](https://github.com/testing-library/react-testing-library)

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

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

## Misc
If for some reason you'd like to see the original project, please check the [archive](https://github.com/novellito/the-nextjs-starter/tree/archive) branch.

If you're coming back to this project and wondering why things changed - please see this [PR](https://github.com/novellito/the-nextjs-starter/pull/6)