https://github.com/naveteam/react-boilerplate-typescript

https://github.com/naveteam/react-boilerplate-typescript

Last synced: about 14 hours ago
JSON representation

• Host: GitHub
• URL: https://github.com/naveteam/react-boilerplate-typescript
• Owner: naveteam
• Created: 2020-05-20T23:39:38.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2022-03-10T12:19:57.000Z (over 2 years ago)
• Last Synced: 2024-04-23T03:34:46.568Z (7 months ago)
• Language: TypeScript
• Size: 696 KB
• Stars: 0
• Watchers: 3
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Nave Boilerplate

Boilerplate baseado no [Create React App](https://github.com/facebook/create-react-app) com o template de suporte para typescript.

## Code Standard

Além de todos os pontos citadas no [nave guide](https://nave.gitlab.io/guides/nave/code-guide/), como padrão de imports e boas práticas de javascript, existem algumas boas práticas que devem ser usadas, principalmente na criação de componentes e páginas.

1. Evite usar `styleds` desnecessários. Temos componentes de Row, Column e Text para evitar o uso desnecessários de styleds nas páginas. Além disso, estes componentes possuem o [styled-system](https://styled-system.com/getting-started), que permite passar margins, paddings e afins por props;

2. Ao criar um novo componente, sempre cogite a utilização do `styled-system`;

3. **NUNCA** repita o mesmo código duas vezes. Não copie e cole. Crie helpers e components. Reutilize código;

4. Se precisar criar um componente com várias variações, dê uma olha no componente de `Text` e utilize a propriedade `variant` do `styled-system`;

5. Siga o padrão de pastas e padrão de código. Participe da construção do boilerplate, dê feedbacks e contribua com melhorias.

## Estrutura de Pastas

```

├── /.storybook

├── /public

├── /src

|   ├── /components

|   |    ├── /

|   |    |    ├── .tsx

|   |    |    ├── index.ts

|   |    ├── index.ts

|   ├── /context

|   |    ├── .tsx

|   |    ├── index.ts

|   ├── /providers

|   |    ├── .ts

|   ├── /services

|   |    ├── .ts

|   ├── /screens

|   |    ├── /

|   |    |    ├── .tsx

|   |    |    ├── index.ts

|   |    ├── index.ts

|   ├── /theme

|   |    ├── index.ts

|   |    ├── theme.ts

|   ├── /utils

|   |    ├── .ts

```

## Start

Clonar esse repositório e executar o comando `yarn` para instalar as dependências.

## Rodar projeto

`yarn start`

## Commit

`yarn commit`