Skip to content

Latest commit

 

History

History
68 lines (43 loc) · 2.54 KB

README.md

File metadata and controls

68 lines (43 loc) · 2.54 KB
Raw

spraygun-react-ts

CircleCI

This is a Carbon Five-flavored convenience skeleton project for React. It is based on create-react-app (not ejected) with the following additions:

  • Styling via SCSS modules
  • Stylelint
  • ESLint/Prettier
  • Husky with lint-staged
  • CI testing via Circle CI
  • Deployable to Heroku out of the box
  • Or deploy via docker using the included Dockerfile

To get started, make sure you have Node 16 and Yarn installed, and then generate your project like this:

$ npx spraygun -t react-ts <project-directory>

💡 If you'd like to use spraygun-react-ts with with Rails, start by generating a Rails project with raygun, and follow the instructions for enabling React with TypeScript in Rails. From there, you can cherry-pick files and patterns from this template into your React frontend in app/javascript/.

Below this line is the README that will accompany your generated project.

app-prototype

This is a React app written in TypeScript.

Prerequisites

It is strongly recommended that you use a version manager like nvm, nodenv, or asdf to ensure the correct Node version. If you use asdf, make sure to add the nodejs plugin and enable legacy version files.

Quick start

Install dependencies:

yarn install

Start the server:

yarn start

This will launch the app at:

http://localhost:3000/

Task reference

  • yarn start starts the development server listing on port 3000. Changes to .js or .scss files automatically refresh in the browser.
  • yarn test runs tests in "watch" mode, automatically focusing on tests or code that were modified since the last commit. Press the a key after the test runner has started to watch all tests in the project.
  • yarn test:coverage runs all tests, prints coverage stats, and then exits.
  • yarn lint runs all ESLint checks and then exits.
  • yarn build generates an optimized bundle of the app into the build directory, suitable for deployment.

Generated by spraygun-react-ts