Skip to content

Commit 69de40a

Browse files
tjastjas
committed
Update of READMEs
1 parent 7311d31 commit 69de40a

File tree

2 files changed

+124
-128
lines changed

2 files changed

+124
-128
lines changed

‎README.md

+62-65
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@
1212
[![Watchers](https://img.shields.io/github/watchers/tjas/tjas-aluratube?color=blue&label=Watchers)](https://github.com/tjas/tjas-aluratube/watchers)
1313
[![Forks](https://img.shields.io/github/forks/tjas/tjas-aluratube?color=blue&label=Forks)](https://github.com/tjas/tjas-aluratube/forks)
1414

15-
1615
[![Node](https://img.shields.io/badge/Node-v18.12.1-green)](https://nodejs.org/en/)
1716
[![Next](https://img.shields.io/badge/Next-v13.0.2-yellow)](https://nextjs.org/)
1817
[![React](https://img.shields.io/badge/React-v18.2.0-orange)](https://reactjs.org/)
@@ -25,8 +24,6 @@
2524
<!-- >
2625
> 🌐 Access my personal website: [thiago-tjas.com](http://thiago-tjas.com/) -->
2726
28-
29-
3027
This project is an adaptation and evolution of the **[AluraTube](https://github.com/alura-challenges/aluratube)** project, proposed at [Alura](https://www.alura.com.br/)'s 5th React Immersion, that occured in november 2022. It initially intended to spread basic knowledgements about [ReactJS](https://reactjs.org/) technology, but became an opportunity do practice and evolve personal skills in such technology and other related ones.
3128

3229
<br />
@@ -46,88 +43,88 @@ This is an example of how you may set up the project locally in your computer. T
4643
1. Make sure you have Node.JS 18.12.1+ with npm 8.19.2+ installed or do it from [NodeJS.org](https://nodejs.org/en/download/);
4744
2. Make sure you have Git installed or do it from [Git-scm.com](https://git-scm.com/);
4845
3. Access the folder you want to save the project, then clone the repo there
49-
```sh
50-
git clone https://github.com/tjas/tjas-aluratube
51-
```
46+
```sh
47+
git clone https://github.com/tjas/tjas-aluratube
48+
```
5249
4. Access the project folder;
5350
5. Install the project dependencies (obtained by default from `package.json` file)
54-
```sh
55-
npm install
56-
```
51+
```sh
52+
npm install
53+
```
5754
6. Run the application
58-
```sh
59-
npm run dev
60-
```
55+
```sh
56+
npm run dev
57+
```
6158
7. Finally, access the aplication at http://localhost:3000
6259

6360
## Contributing
64-
65-
> Adapted from the ["Flappy Bird: Dev Soutinho"](https://github.com/omariosouto/flappy-bird-devsoutinho/blob/master/CONTRIBUTING.md) project.
61+
<!-- > Adapted from the ["Flappy Bird: Dev Soutinho"](https://github.com/omariosouto/flappy-bird-devsoutinho/blob/master/CONTRIBUTING.md) project. -->
6662

6763
1. Fork it!
6864
2. Create your feature branch:
69-
```
70-
git checkout -b my-new-feature
71-
```
65+
```sh
66+
git checkout -b my-new-feature
67+
```
7268
3. Add files changed:
73-
```
74-
git add .
75-
```
69+
```sh
70+
git add .
71+
```
7672
4. Commit your changes:
77-
```
78-
git commit -m "Add some feature"
79-
```
73+
```sh
74+
git commit -m "Add some useful comment here"
75+
```
8076
5. Push to the branch:
81-
```
82-
git push origin my-new-feature
83-
```
77+
```sh
78+
git push origin my-new-feature
79+
```
8480
6. Submit a [pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request)
85-
- Add a title and description that let clear your suggestion.
86-
- After your pull request is merged, you can safely delete your branch.
81+
* Add a title and description that let clear your suggestion;
82+
* Use the English language for comments and branch names;
83+
* After your pull request is merged, you can safely delete your branch.
8784

8885
## Todo List
89-
90-
- [ ] Obtain a list of videos dinamically from [Google API](https://www.npmjs.com/package/googleapis);
91-
- [ ] Add fade efect in horizontal scrolls extremities;
92-
- [ ] Create, edit and remove playlists;
93-
- [ ] Add and remove videos;
94-
- [ ] Add and remove favorites;
95-
- [ ] Edit user profile informations;
96-
- [ ] Persist informations in local data base;
97-
- [ ] Translate to other languages;
98-
- [ ] Create login page;
99-
- [ ] Separate public and private pages.
86+
87+
* [ ] Obtain a list of videos dinamically from [Google API](https://www.npmjs.com/package/googleapis);
88+
* [ ] Add fade efect in horizontal scrolls extremities;
89+
* [ ] Create, edit and remove playlists;
90+
* [ ] Add and remove videos;
91+
* [ ] Add and remove favorites;
92+
* [ ] Edit user profile informations;
93+
* [ ] Persist informations in local data base;
94+
* [ ] Translate to other languages;
95+
* [ ] Create login page;
96+
* [ ] Separate public and private pages.
10097

10198
## References
10299

103-
- [Node.JS LTS version](https://nodejs.org/en/);
104-
- [npm documentation](https://docs.npmjs.com/);
105-
- [React.JS documentation](https://reactjs.org/docs/getting-started.html);
106-
- [Next.JS documentation](https://nextjs.org/docs/getting-started);
107-
- [Styled Components documentation](https://styled-components.com/docs);
108-
- [next.config.js file of Styled Components examples](https://github.com/vercel/next.js/blob/canary/examples/with-styled-components/next.config.js), for using React with Next;
109-
- [GitHub's API](https://api.github.com/users/tjas);
110-
- [Supabase documentation](https://supabase.com/docs);
111-
- [Supabase-JS](https://www.npmjs.com/package/@supabase/supabase-js);
112-
- [Using the Effect Hook](https://en.reactjs.org/docs/hooks-effect.html).
100+
* [Node.JS LTS version](https://nodejs.org/en/);
101+
* [npm documentation](https://docs.npmjs.com/);
102+
* [React.JS documentation](https://reactjs.org/docs/getting-started.html);
103+
* [Next.JS documentation](https://nextjs.org/docs/getting-started);
104+
* [Styled Components documentation](https://styled-components.com/docs);
105+
* [next.config.js file of Styled Components examples](https://github.com/vercel/next.js/blob/canary/examples/with-styled-components/next.config.js), for using React with Next;
106+
* [GitHub's API](https://api.github.com/users/tjas);
107+
* [Supabase documentation](https://supabase.com/docs);
108+
* [Supabase-JS](https://www.npmjs.com/package/@supabase/supabase-js);
109+
* [Using the Effect Hook](https://en.reactjs.org/docs/hooks-effect.html).
113110
114111
## Other interesting links
115112
116-
- [Figma](https://www.figma.com/);
117-
- [Visual Studio Code](https://code.visualstudio.com/), development interface;
118-
- [Unsplash](https://unsplash.com/), for free images;
119-
- [Material Design components](https://m3.material.io/components);
120-
- [Vercel's GitHub profile](https://github.com/vercel);
121-
- [Styled Components official using examples](https://github.com/vercel/next.js/tree/canary/examples/with-styled-components);
122-
- [Alura's Github "Alura Challenges" profile](https://github.com/alura-challenges), cool projects for reference;
123-
- [Project "Flappy Bird: Dev Soutinho"](https://github.com/omariosouto/flappy-bird-devsoutinho/blob/master/CONTRIBUTING.md);
124-
- [Project "Awesome Design Systems"](https://github.com/alexpate/awesome-design-systems), for design systems reference;
125-
- [Alura Verso](https://www.alura.com.br/aluraverso);
126-
- [TechGuide.sh](https://techguide.sh/), a roadmap for technology career;
127-
- [Vitrine Dev](https://cursos.alura.com.br/vitrinedev);
128-
- [Babel](https://babeljs.io/), a JavaScript compiler;
129-
- [QUOKKA](https://quokkajs.com/), a JavasCript coding support tool;
130-
- [Supabase](https://supabase.com/).
113+
* [Figma](https://www.figma.com/);
114+
* [Visual Studio Code](https://code.visualstudio.com/), development interface;
115+
* [Unsplash](https://unsplash.com/), for free images;
116+
* [Material Design components](https://m3.material.io/components);
117+
* [Vercel's GitHub profile](https://github.com/vercel);
118+
* [Styled Components official using examples](https://github.com/vercel/next.js/tree/canary/examples/with-styled-components);
119+
* [Alura's Github "Alura Challenges" profile](https://github.com/alura-challenges), cool projects for reference;
120+
* [Project "Flappy Bird: Dev Soutinho"](https://github.com/omariosouto/flappy-bird-devsoutinho/blob/master/CONTRIBUTING.md);
121+
* [Project "Awesome Design Systems"](https://github.com/alexpate/awesome-design-systems), for design systems reference;
122+
* [Alura Verso](https://www.alura.com.br/aluraverso);
123+
* [TechGuide.sh](https://techguide.sh/), a roadmap for technology career;
124+
* [Vitrine Dev](https://cursos.alura.com.br/vitrinedev);
125+
* [Babel](https://babeljs.io/), a JavaScript compiler;
126+
* [QUOKKA](https://quokkajs.com/), a JavasCript coding support tool;
127+
* [Supabase](https://supabase.com/).
131128
132129
## Contact
133130
@@ -137,7 +134,7 @@ git push origin my-new-feature
137134
138135
## Licence
139136
140-
- Code distributed under [MIT License](https://github.com/tjas/tjas-aluratube/blob/master/LICENCE).
137+
* Code distributed under [MIT License](https://github.com/tjas/tjas-aluratube/blob/master/LICENCE).
141138
142139
<!-- ## Acknowledgements
143140

‎README_pt-br.md

+62-63
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,6 @@
2424
<!-- >
2525
> 🌐 Acesse meu site pessoal: [thiago-tjas.com](http://thiago-tjas.com/) -->
2626
27-
2827
Este projeto é uma adaptação e evolução do projeto **[AluraTube](https://github.com/alura-challenges/aluratube)**, proposto no 5ª Imersão React da [Alura](https://www.alura.com.br/), que ocorreu em novembro de 2022. Inicialmente ele tinha como objetivo divulgar conhecimentos básicos sobre a tecnologia [React.JS](https://pt-br.reactjs.org/), mas tornou-se uma oportunidade de praticar e desenvolver habilidades pessoais nessa tecnologia e em outras relacionadas.
2928

3029
<br />
@@ -44,88 +43,88 @@ Este é um exemplo de como você pode configurar o projeto localmente no seu com
4443
1. Certifique-se de que você tem o Node.JS 18.12.1+ com o npm 8.19.2+ instalado ou verifique como fazê-lo em [NodeJS.org](https://nodejs.org/pt-br/download/);
4544
2. Certifique-se de que você tem o Git instalado ou verifique como fazê-lo em [Git-scm.com](https://git-scm.com/);
4645
3. Acesse a pasta na qual você deseja salvar o projeto, então, clone o repositório nesta pasta
47-
```sh
48-
git clone https://github.com/tjas/tjas-aluratube
49-
```
46+
```sh
47+
git clone https://github.com/tjas/tjas-aluratube
48+
```
5049
4. Acesse a pasta do projeto;
5150
5. Instale as dependências do projeto (obtidas, por padrão, do arquivo `package.json`)
52-
```sh
53-
npm install
54-
```
51+
```sh
52+
npm install
53+
```
5554
6. Execute a aplicação
56-
```sh
57-
npm run dev
58-
```
55+
```sh
56+
npm run dev
57+
```
5958
7. Finalmente, acesse a aplicação no endereço http://localhost:3000
6059

6160
## Contribuição
62-
63-
> Adaptado do projeto ["Flappy Bird: Dev Soutinho"](https://github.com/omariosouto/flappy-bird-devsoutinho/blob/master/CONTRIBUTING.md).
61+
<!-- > Adaptado do projeto ["Flappy Bird: Dev Soutinho"](https://github.com/omariosouto/flappy-bird-devsoutinho/blob/master/CONTRIBUTING.md). -->
6462

6563
1. Crie um fork!
66-
2. Crie sua feature branch:
67-
```
68-
git checkout -b my-new-feature
69-
```
64+
2. Crie sua branch de funcionalidade:
65+
```sh
66+
git checkout -b minha-nova-funcionalidade
67+
```
7068
3. Adicione os arquivos modificados:
71-
```
72-
git add .
73-
```
69+
```sh
70+
git add .
71+
```
7472
4. Faça um Commit com suas alterações:
75-
```
76-
git commit -m "Add some feature"
77-
```
73+
```sh
74+
git commit -m "Adicione algum comentário útil aqui"
75+
```
7876
5. Faça um push da sua branch:
79-
```
80-
git push origin my-new-feature
81-
```
77+
```sh
78+
git push origin minha-nova-funcionalidade
79+
```
8280
6. Envie um [Pull Request](https://docs.github.com/pt/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) para esse repositório
83-
- Adicione um título e uma descrição que deixe claro sua sugestão.
84-
- Depois que seu pull request for mergeado, você pode apagar sua branch.
81+
* Adicione um título e uma descrição que deixe claro sua sugestão;
82+
* Utilize o idioma inglês para comentários e nomes de branch;
83+
* Depois que seu pull request for mergeado, você pode apagar sua branch.
8584

8685
## Lista de tarefas a serem realizadas
8786

88-
- [ ] Obter uma lista de vídeos dinamicamente por meio da [Google API](https://www.npmjs.com/package/googleapis);
89-
- [ ] Incluir efeito de _fade_ nas extremidades dos _scrolls_ horizontais;
90-
- [ ] Criar, editar e excluir playlists;
91-
- [ ] Adicionar e remover vídeos;
92-
- [ ] Adicionar e remover favoritos;
93-
- [ ] Editar as informações de usuário;
94-
- [ ] Persistir informações em base de dados local;
95-
- [ ] Traduzir para outros idiomas;
96-
- [ ] Criar página de login;
97-
- [ ] Separar páginas públicas e privadas.
87+
* [ ] Obter uma lista de vídeos dinamicamente por meio da [Google API](https://www.npmjs.com/package/googleapis);
88+
* [ ] Incluir efeito de _fade_ nas extremidades dos _scrolls_ horizontais;
89+
* [ ] Criar, editar e excluir playlists;
90+
* [ ] Adicionar e remover vídeos;
91+
* [ ] Adicionar e remover favoritos;
92+
* [ ] Editar as informações de usuário;
93+
* [ ] Persistir informações em base de dados local;
94+
* [ ] Traduzir para outros idiomas;
95+
* [ ] Criar página de login;
96+
* [ ] Separar páginas públicas e privadas.
9897

9998
## Referências
10099

101-
- [Versão LTS do Node.JS](https://nodejs.org/pt-br/);
102-
- [Documentação do npm](https://docs.npmjs.com/);
103-
- [Documentação do React.JS](https://pt-br.reactjs.org/docs/getting-started.html);
104-
- [Documentação do Next.JS](https://nextjs.org/docs/getting-started);
105-
- [Documentação do Styled Components](https://styled-components.com/docs);
106-
- [Arquivo next.config.js dos exemplos de Styled Components](https://github.com/vercel/next.js/blob/canary/examples/with-styled-components/next.config.js), para utilizar React com Next;
107-
- [API do GitHub](https://api.github.com/users/tjas);
108-
- [Documentação do Supabase](https://supabase.com/docs);
109-
- [Supabase-JS](https://www.npmjs.com/package/@supabase/supabase-js);
110-
- [Usando Effect Hook (Hook de Efeito)](https://pt-br.reactjs.org/docs/hooks-effect.html).
100+
* [Versão LTS do Node.JS](https://nodejs.org/pt-br/);
101+
* [Documentação do npm](https://docs.npmjs.com/);
102+
* [Documentação do React.JS](https://pt-br.reactjs.org/docs/getting-started.html);
103+
* [Documentação do Next.JS](https://nextjs.org/docs/getting-started);
104+
* [Documentação do Styled Components](https://styled-components.com/docs);
105+
* [Arquivo next.config.js dos exemplos de Styled Components](https://github.com/vercel/next.js/blob/canary/examples/with-styled-components/next.config.js), para utilizar React com Next;
106+
* [API do GitHub](https://api.github.com/users/tjas);
107+
* [Documentação do Supabase](https://supabase.com/docs);
108+
* [Supabase-JS](https://www.npmjs.com/package/@supabase/supabase-js);
109+
* [Usando Effect Hook (Hook de Efeito)](https://pt-br.reactjs.org/docs/hooks-effect.html).
111110

112111
## Outros links interessantes
113112

114-
- [Figma](https://www.figma.com/);
115-
- [Visual Studio Code](https://code.visualstudio.com/), interface de desenvolvimento;
116-
- [Unsplash](https://unsplash.com/), para imagens grátis;
117-
- [Componentes do Material Design](https://m3.material.io/components);
118-
- [Conta da Vercel no GitHub](https://github.com/vercel);
119-
- [Exemplo oficial de utilização do Styled Components](https://github.com/vercel/next.js/tree/canary/examples/with-styled-components);
120-
- [Conta "Alura Challenges" da Alura no GitHub](https://github.com/alura-challenges), projetos legais para referência;
121-
- [Projeto "Flappy Bird: Dev Soutinho"](https://github.com/omariosouto/flappy-bird-devsoutinho/blob/master/CONTRIBUTING.md);
122-
- [Projeto "Awesome Design Systems"](https://github.com/alexpate/awesome-design-systems), referência para vários design systems;
123-
- [Alura Verso](https://www.alura.com.br/aluraverso);
124-
- [TechGuide.sh](https://techguide.sh/), um guia para a carreira em tecnologia;
125-
- [Vitrine Dev](https://cursos.alura.com.br/vitrinedev);
126-
- [Babel](https://babeljs.io/), um compilador JavaScript;
127-
- [QUOKKA](https://quokkajs.com/), uma ferramenta de suporte para codificação em JavasCript;
128-
- [Supabase](https://supabase.com/).
113+
* [Figma](https://www.figma.com/);
114+
* [Visual Studio Code](https://code.visualstudio.com/), interface de desenvolvimento;
115+
* [Unsplash](https://unsplash.com/), para imagens grátis;
116+
* [Componentes do Material Design](https://m3.material.io/components);
117+
* [Conta da Vercel no GitHub](https://github.com/vercel);
118+
* [Exemplo oficial de utilização do Styled Components](https://github.com/vercel/next.js/tree/canary/examples/with-styled-components);
119+
* [Conta "Alura Challenges" da Alura no GitHub](https://github.com/alura-challenges), projetos legais para referência;
120+
* [Projeto "Flappy Bird: Dev Soutinho"](https://github.com/omariosouto/flappy-bird-devsoutinho/blob/master/CONTRIBUTING.md);
121+
* [Projeto "Awesome Design Systems"](https://github.com/alexpate/awesome-design-systems), referência para vários design systems;
122+
* [Alura Verso](https://www.alura.com.br/aluraverso);
123+
* [TechGuide.sh](https://techguide.sh/), um guia para a carreira em tecnologia;
124+
* [Vitrine Dev](https://cursos.alura.com.br/vitrinedev);
125+
* [Babel](https://babeljs.io/), um compilador JavaScript;
126+
* [QUOKKA](https://quokkajs.com/), uma ferramenta de suporte para codificação em JavasCript;
127+
* [Supabase](https://supabase.com/).
129128

130129
## Contato
131130

@@ -135,7 +134,7 @@ git push origin my-new-feature
135134

136135
## Licença
137136

138-
- Código distribuído sob a [Licença MIT](https://github.com/tjas/tjas-aluratube/blob/master/LICENCE).
137+
* Código distribuído sob a [Licença MIT](https://github.com/tjas/tjas-aluratube/blob/master/LICENCE).
139138

140139
<!-- ## Agradecimentos
141140

0 commit comments

Comments
 (0)