@safr/react-starter

React App Starter

Scalable React, TypeScript, Styled-components, Storybook, Cypress and Testing Library react starter for SPA applications.

Table of contents

• Prerequisites
• Install
• Usage
• Prettier
• Code of Conduct
• License

Prerequisites

• Nodejs v12
• npm v6

⚙️Installation

Clone this repo

$ git clone https://github.com/safr/react-app-starter.git

Install dependencies

npm install

⚙️Installation via NPM (2)

npm install @safr/react-starter

Usage

Start project on local server (go to localhost:8080)

npm run start

Prettier

Prettier is a great tool to enforce a consistent style accross your code base (usefull when working in teams).

Here is how to integrate it with your editor.

Once it's done, when you'll save a file, it will reformat it.

The following command will let you format your code base. This task is ran at pre-commit.

npm run prettify

Build project (in "dist" folder):

npm run build

Test project

npm run test

Code of Conduct

Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

💳 License

MIT This project is licensed under the MIT license, Copyright (c) 2020 Safr. For more information see LICENSE.md.