Git Product home page Git Product logo

santospatrick / nextjs-boilerplate-advanced Goto Github PK

View Code? Open in Web Editor NEW
45.0 3.0 8.0 3.43 MB

Next.js boilerplate made with Chakra-UI + Typescript + React-table + React-hook-form

Home Page: https://sample-nextjs-app.santospatrick.com

License: MIT License

JavaScript 2.18% TypeScript 95.41% Shell 0.09% Handlebars 2.32%
boilerplate chakra-ui chakra-ui-react nextjs react react-hook-form react-table storybook typescript netlify

nextjs-boilerplate-advanced's Introduction

santospatrick/nextjs-boilerplate-advanced

Next.js boilerplate made with Chakra-UI + Typescript + React-table + React-hook-form

Netlify Status eslint prettier typescript vscode

DigitalOcean Referral Badge SonarCloud

Usage

  1. Initialize your project with this command:
yarn create next-app -e https://github.com/santospatrick/nextjs-boilerplate-advanced
  1. Duplicate .env.example to .env.local fulfilling variables as needed
cp .env.example .env.local
  1. Run the following commands:
yarn install
yarn dev # start development server
  1. Done 🎉

Deployment

  • Run the following commands:
yarn build # this command will fail if there is any Typescript or Lint errors
yarn start
  • Or, deploy on Netlify, Vercel (don't forget about environment variables):
Netlify Vercel
Deploy to Netlify Deploy with Vercel

Instructions

How to get the most out of this boilerplate 🚀

Slides.com template presentation

MJML usage

  • You can generate your e-mail templates from MJML by running the following command:
yarn emails

The generated .html files will be located in ./emails/dist/

  • You can also watch for MJML file changes in your ./emails/templates folder by running:
yarn emails:watch

Any change in the .mjml files will generate new .html template files.

Features

v1

  • Authentication screens pre-built
  • Server side rendering
  • Forms (compatible with react-hook-form)
    • Text Input (masked/normalized)
    • Date Input
    • Upload Input
    • Autocomplete/Select Input
    • Number Input
    • Phone Input
    • Textarea Input
    • Schema validation with yup
  • Data table with inline editing
  • Layouts
  • CRUD example
  • Modal with fullscreen option
  • Email templates for authentication flow
  • VSCode workspace recommendations
  • Profile page for user editing
  • Collapsable & nested menu
  • Code Generator (component, form, and page)
  • VSCode debug setup

v2

  • Advanced filter for data tables (like Notion)
  • Form builder

Technologies

  • Next.js
  • Typescript
  • Chakra UI
  • Next SEO
  • React Table
  • Eslint/Prettier
  • React Toastify
  • React Query
  • React Hook Form
  • NProgress
  • Git hooks
  • Perfect scrollbar
  • Mjml
  • useHooks Typescript
  • Utility Types
  • Storybook
  • Plop (Template Generator)

Storybook

In order to see storybook, run development server with following command:

yarn install # if you didn't yet :)
yarn storybook # start server at http://localhost:6006

Contributors

Patrick
Patrick Santos Bitonti Teixeira
Lincoln
Lincoln M. Costa
João
João Paulo Rodrigues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.