Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/tst-labs/react-starter

Um projeto de template create-react-app que define um projeto base simplificado para novas aplicações React com as caraterísticas adequadas ao TST.
https://github.com/tst-labs/react-starter

create-react-app jt reactjs template tst

Last synced: 17 days ago
JSON representation

Um projeto de template create-react-app que define um projeto base simplificado para novas aplicações React com as caraterísticas adequadas ao TST.

Awesome Lists containing this project

README

        

# Projeto-Base React para o TST – _template_ `create-react-app`

![npm-publish](https://github.com/tst-labs/react-starter/workflows/npm-publish/badge.svg)

Este projeto usa o [Create React App](https://github.com/facebook/create-react-app) para gerar novos projetos para o TST com as tecnologias mais usadas pelo TST além de sua identidade visual.

## Pré-requisitos

Assumimos que o ambiente de desenvolvimento tenha instalados:

- nodejs 16.x (ou maior);
- npm 8.x (ou maior); e
- yarn 1.22.10 (ou maior).

## Como usar

Resumidamente, a forma mais simples de usar essa _template_ para gerar um novo projeto, é a seguinte:

```bash
yarn create react-app my-first-react-app --template @tst-labs/react-starter
```

Pronto! Depois é só mudar para o diretório da aplicação gerada, `my-first-react-app` nesse exemplo, e executar o app com `yarn start`.

> Altere o nome do projeto a ser gerado de acordo com sua vontade/necessidade.

## Tecnologias disponíveis no projeto-base gerado

- [Prettier](https://prettier.io/) – Formatador de código;
- [MUI](https://mui.com/) – Biblioteca de componentes React que implementa o [_Material Design_ do Google](https://material.io/);
- [Storybook](https://storybook.js.org/) – Ferramenta de apoio a construção e documentação de componentes de UI;
- [Husky](https://github.com/typicode/husky) – Uma ferramenta para ajudar a garantir um pouco de qualidade usando _Hooks_ do Git;

## Como contribuir

Por enquanto, crie uma [issue](https://github.com/tst-labs/react-starter/issues) no projeto e seguimos daí...

> **WIP**: Ainda estamos detalhando o fluxo de trabalho nesse projeto. Em breve teremos uma linha de documentação específica para isso. Sentimos muito!

## Licença

[MIT](./LICENSE)

## Colaboradores

Agradecemos a todos os colaboradores e deixamos uma lista inicial dos que começaram o projeto:

- [Adriano Lemos](https://github.com/adriano-lemos-dev);
- [Carlos Borges](https://github.com/calimaborges);
- [Tiago Bento](https://github.com/tiagobentotst);