Giter VIP home page Giter VIP logo

capstone-next-template's Introduction

Next.js App

This is a template for Next.js with additional tools.

It uses the following tools/libraries:

Tech-Stack

Project Setup

This project uses multiple Vercel deployments to make design/code reviews easier:

  • App Production
  • App Preview
  • Storybook Production
  • Storybook Preview

Set up Vercel

Please follow this guide: https://vercel.com/docs/concepts/git

App

1.Follow the default setup for Next.js.

Storybook

  1. Adjust the "Build and Output Settings"
    • BUILD COMMAND: npm run storybook:build
    • OUTPUT DIRECTORY: ./storybook-static

Vercel Storybook settings

Set up formatter

Please adjust your formatter for this project. We enabled several eslint rules, therefore we need to use eslint as the default formatter.

Add these lines to your settings.json. We already added some settings in .vscode/settings.json.

{
	"[javascript]": {
		"editor.defaultFormatter": "dbaeumer.vscode-eslint"
	},
	"[javascriptreact]": {
		"editor.defaultFormatter": "dbaeumer.vscode-eslint"
	}
}

Getting started

Run the development server:

npm run dev

Run storybook:

npm run storybook

Test Driven Development

We use jest to write unit tests. Please look at the Documentation for Jest and testing-library.

Commands

Run the development server:

npm run dev

Build:

npm run build

Run storybook:

npm run storybook

Build storybook:

npm run storybook:build

Run all tests:

npm run test

Run stylelint

npm run stylelint

Run eslint

npm run eslint

Run all linters

npm run lint

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.