Giter Club home page Giter Club logo

nextjs-pretty-boilerplate's Introduction

NextJS-Pretty-Boilerplate

This is a Next.js project bootstrapped with [create-next-app] (https://github.com/vercel/next.js/tree/canary/packages/create-next-app).


...But with extra flavor ๐ŸŽ


It contains:

  • TypeScript support
  • VSCode debug on client/server side Go to VSCode Debug panel (Ctrl+Shift+D on Windows/Linux, โ‡ง+โŒ˜+D on macOS), select a launch configuration, then press F5 or select Debug: Start Debugging
  • Type checking at runtime Works on hot-reload, change params on index.tsx#22 to try it
  • SASS support
  • Project-wide automatic formatting with Prettier for TypeScript, JS, CSS files
  • Project-wide automatic type checking/rule checking with ESLint
  • BasePath resolving extensions (i.e. "components/mycomponent" instead of "./components/mycomponent")
  • GitHub CI/CD which checks everything on new Pull Request

Few extra commands (i.e. yarn [command] or npm run [command]):

  • format - formats all js, jsx, ts, tsx, json, md and saves them
  • lint - linting checks
  • lint:fix - automatic linting for all js, ts, tsx
  • lint-scss - linting checks for scss using Stylelint
  • lint-scss:fix - automatic linting for scss files
  • types - type checking for ts/tsx files

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 src/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 src/pages/api/hello.ts.

The src/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!

Deploy on 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.

nextjs-pretty-boilerplate's People

Contributors

snify avatar

Watchers

 avatar

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.