starbase-react is a Typescript, React, Redux-Toolkit & Emotion boilerplate. Brewed with Create React App (v5.0.1 w/ TypeScript template), then sweetened with:
- formatting via EditorConfig & Prettier
- linting via & ESLint
- pre-commit linting and formatting via husky & lint-staged
- a modern redux implementation via Redux Toolkit & Redux-Saga
- css-in-js with global styles and a theme via Emotion
- ...and more!
starbase-react is a spin on starbase, and intended to be relatively small in scope so that it may be easily extended and customized, or used as a learning tool for folks who are trying to become familiar with Typescript, React 16, Redux, Redux-Saga, Emotion, Testing Library, etc.
starbase-react is open source and free software, so you may to do whatever you wish with it -- commercially or personally. You can buy me a beer next time you're in Boston, star the project and tell a friend, or you can erase all signs of origin and tell your coworkers that you made it yourself. It's all good!
After completing the steps below, you will be ready to begin using starbase-react:
- Install Node.js (latest LTS recommended)
- Clone starbase-react into your project root directory
- Install dependencies by running
npm install
in your project root directory
After running npm run start
in the project root, your /src
code will be served at http://localhost:3000 and watched for changes. As you modify code in /src
, the project will be recompiled and your browser will refresh to show the latest changes.
cd /path/to/starbase-react
npm run start
Use npm run build
in your project root to run a production build.
Production builds compile & minify your assets into /dist
for distribution and/or integration into whatever codebase you'll be using these assets in.
cd /path/to/starbase-react
npm run build