create-nttb
Version:
An opinionated NextJs, Typescript and Tailwind boilerplate using the Atomic Design Methodology for presentation components
40 lines (25 loc) • 1.39 kB
Markdown
# Next.js TypeScript Tailwind Boilerplate by Sam Newhouse
Use `npm create nttb app-name` or `npx create-nttb app-name` to get started.
This will download all boilerplate files ready for you to use.
## Getting Started
First, run the development server:
```bash
npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun 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, TypeScript, and Tailwind, take a look at the following resources:
- [Next.js Documentation](https://nextjs.org/docs) - Learn about Next.js features and API.
- [TypeScript](https://www.typescriptlang.org/) - Learn about TypeScript and all of its features.
- [Tailwind CSS](https://tailwindcss.com/) - The holy grail of all things Tailwind.
## License
This project is licensed under the ISC License - see the [LICENSE](./LICENSE) file for details.