/nextjs-template

A nextjs template with many useful tools

Primary LanguageJavaScriptMIT LicenseMIT

Template app

Shipped with

  • StoryBook: UI component explorer for frontend developers
  • Material UI: A popular React UI framework (Many usefull react components)
  • Styled components: Visual primitives for the component age.
  • Formik: Build forms in React, without the tears
  • Framer Motion: Production-Ready Animation Library for React
  • Redux: A predictable state container for JavaScript apps
  • React query: Hooks for fetching, caching and updating
  • Jest: Delightful JavaScript Testing
  • React testing library: Testing Library
  • Eslint: Pluggable JavaScript linter (autocorect your code)
  • Prettier: Opinionated Code Formatter
  • Typescript: Typed JavaScript at Any Scale (JS but with typechecking)
  • SASS: Syntactically Awesome Style Sheets (better css)
  • Docker: Empowering App Development for Developers

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.

Storybook

Run storybook:

npm run storybook
# or
yarn storybook

Testing

To run the tests:

npm run test
# or
yarn test

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!