luizdesign/nextjs-skeleton

Skeleton to start an project using nextJs with typescript

NextJs Skeleton

Skeleton to start an project using nextJs with typescript, react and styled components.

• NextJs Skeleton
  • Getting Started
  • Testing
  • Git Hooks
  • About the technologies
    • NextJs
    • Typescript
    • React
    • Styled Components
  • Contribution Guide
  • ChangeLog

Table of contents generated with markdown-toc

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.

Testing

To run the tests:

yarn test

Git Hooks

This project use git hooks to pre-commit. This hook will run:

• Code Lint with eslint
• Unit Tests with jest

About the technologies

NextJs

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

• Next.js Documentation - learn about Next.js features and API.
• Learn Next.js - an interactive Next.js tutorial.

Typescript

To learn more about Typescript, take a look at the following resources:

• Typescript Documentation
• William Justen Free Typescript Course

React

To learn more about React, take a look at the following resources:

• React Documentation
• Tutorial

Styled Components

To learn more about Styled components, take a look at the following resources:

• Documentation

Contribution Guide

You can contribute to improve the project by opening issues, and submitting pull requests. However check the issue list before to avoid duplicate issues.

Remember always on to check the contribution guide.

ChangeLog

See the notable changes at this project at the ChangeLog.