/test

Primary LanguageTypeScript

This is a Next.js boiler plate project bootstrapped with create-next-app and then configured as an easy to use boilerplate.

Disclaimer

The boilerplate is a WIP project to help me practice web app archiecture and configuration with the added bonus of having a ready to use template for any future projects. All ideas and feedback are welcome!

The setup

  • Typescript
  • Eslint
  • Prettier (AirBnB styleguide)
  • Pre-commit hooks to lint-stage
  • One click deployment to Vercel
  • Styling library (tbd between MaterialUI and TailwindCSS)
  • React Testing Library
  • PWA ready

Getting Started

First, run the development server:

npm run dev
# or
yarn dev

Open 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 can be accessed on 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 instead of React pages.

Learn More

To learn more about Next.js, take a look at the following resources:

You can check out the Next.js GitHub repository - your feedback and contributions are welcome!

PWA

Progressive Web App DOCS Make sure to sure to update ./public/manifest.json with correct information and icons( Generate Icons

Single click deployment to Vercel

Deploy with Vercel

The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.

Check out our Next.js deployment documentation for more details.