Welcome to React App Boilerplate 👋

📦 Prerequisites

• node >=14.17.6
• yarn >=1.22.1

🚀 Usage

Create your project

git clone --depth=1 https://github.com/ttRmz/react-app-boilerplate.git project_name

Install dependencies

cd project_name && yarn

Run app

yarn start

this will run both react-app and storybook

Run tests

yarn test

or

npx majestic

Format your code

yarn run format

✨ Features

Add new Icons

Drop your new flat svg icons into /src/assets/icons folder then run :

yarn build:icons

This command will udpate ICON_NAMES enum thens update your icons fonts files.

the svg's name will be the icon name to pass as prop to <Icon /> component.

Add new Assets

Drop your new svg images into /public/assets/symbols folder then run :

yarn build:assets

This command will udpate ASSET_NAMES enum.

the svg's name will be the asset name to pass as prop to <Asset /> component.

🤝 Contributing

Contributions, issues and feature requests are welcome!

Feel free to check issues page.

🕑 Changelog

The changelog is available here.

You can also check releases page.

Show your support

Give a ⭐️ if this project helped you!

📝 License

Copyright © 2020 Ramirez Tristan.

This project is MIT licensed.