These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
To get this project running locally you will need:
- a node package manager (yarn or npm)
- a command line terminal (iTerm or bash)
- your favorite IDE (vscode, sublime)
Clone the repo, don't forget to change the name of the project:
npx create-next-app <YOUR_PROJECT_NAME> -e https://github.com/RickBr0wn/next-typescript-chakra-ui-starterImportant note: If you are using npm, you will need to install the dependencies manually, by using the command
npm installin the root of the project.
Once the project and dependencies are finished installing, you can navigate to the root directory and start up the development server with:
npm run devPlease credit this starter if you build something fantastic!
npm run testThis will run all of the test suites with Jest and React Testing Library, in watch mode.
- Typescript - TypeScript is a strongly typed programming language that builds on JavaScript, giving you better tooling at any scale.
- React - A JavaScript library for building user interfaces.
- Next.js - Next.js gives you the best developer experience with all the features you need for production: hybrid static & server rendering, TypeScript support, smart bundling, route pre-fetching, and more.
- ESLint - ESLint statically analyzes your code to quickly find problems.
- Prettier - An opinionated code formatter.
- Huksy - Git hooks made easy.
- Chakra UI - Simple, Modular & Accessible UI Components for your React Applications.
- Chakra UI Icons - Chakra UI's official icon library.
- Jest - Jest is a delightful JavaScript Testing Framework with a focus on simplicity.
- React Testing Library - Simple and complete React DOM testing utilities that encourage good testing practices.
- Jest-DOM - Custom jest matchers to test the state of the DOM.
- Rick Brown - Initial work - RickBr0wn
This project is licensed under the MIT License - see the LICENSE.md file for details.