Skip to content

Commit 07dd9d3

Browse files
orodrigojoseorodrigojose
committed
🎉 first commit
0 parents  commit 07dd9d3

40 files changed

+1385
-0
lines changed

‎.gitignore

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
2+
3+
# dependencies
4+
/node_modules
5+
/.pnp
6+
.pnp.js
7+
8+
# testing
9+
/coverage
10+
11+
# production
12+
/build
13+
14+
# misc
15+
.DS_Store
16+
.env.local
17+
.env.development.local
18+
.env.test.local
19+
.env.production.local
20+
21+
npm-debug.log*
22+
yarn-debug.log*
23+
yarn-error.log*
24+
25+
package-lock.json

‎README.en.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# AnimeInfoList
2+
3+
<div align="center" style="margin-bottom: 10px">
4+
<a href="README.md" style="margin-right: 10px">🇧🇷 PT-BR </a>
5+
<span> (Selected) 🇺🇲 EN</span>
6+
</div>
7+
8+
![GitHub repo size](https://img.shields.io/github/repo-size/sennshi/Anime-Info-List?style=for-the-badge)
9+
![GitHub language count](https://img.shields.io/github/languages/count/sennshi/Anime-Info-List?style=for-the-badge)
10+
![GitHub forks](https://img.shields.io/github/forks/sennshi/Anime-Info-List?style=for-the-badge)
11+
12+
<img src="print.jpg" alt="exemple">
13+
14+
> View the informations from your favorites anime in an interface made with ReactJs ans using the KitsuAPI
15+
16+
## 🐢 Getting started
17+
Before you go to the next steps, look a bit at how project was [structured](STRUCTURE.md), it maybe of great help to you
18+
19+
## 💻 Prerequisites
20+
Realize Nodejs installation from the link:
21+
- [Node LTS](https://nodejs.org/en/)
22+
23+
Or install from your distro's package manager following this [steps](https://nodejs.org/en/download/package-manager/).
24+
25+
## 🚀 Installation
26+
27+
[Download](https://github.com/sennshi/Anime-Info-List/archive/refs/heads/main.zip) the project or clone it using `git clone https://github.com/sennshi/Anime-Info-List.git`
28+
29+
To install necessary packages run:
30+
31+
```
32+
> npm install
33+
```
34+
35+
And finally run:
36+
37+
```
38+
> npm start
39+
```
40+
41+
just access `http://localhost:3000/` to see the project.
42+
43+
## 🛠️ Maked with
44+
45+
The project used [KitsuAPI](https://kitsu.docs.apiary.io/#) that distribute the anime information, and used the following technologies to be made:
46+
47+
![ReactJS](https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB)
48+
![Typescript](https://img.shields.io/badge/TypeScript-007ACC?style=for-the-badge&logo=typescript&logoColor=white)
49+
![HTML5](https://img.shields.io/badge/HTML5-E34F26?style=for-the-badge&logo=html5&logoColor=white)
50+
![CSS3](https://img.shields.io/badge/CSS3-1572B6?style=for-the-badge&logo=css3&logoColor=white)
51+
52+
[⬆ Back to the top](#)<br>
53+
54+
---
55+
56+
made with 💜 by [Rodrigo Sennshi](https://github.com/sennshi)

‎README.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# AnimeInfoList
2+
3+
<div align="center" style="margin-bottom: 10px">
4+
<span style="margin-right: 10px">(Selecionado)🇧🇷 PT-BR</span>
5+
<a href="README.en.md"> 🇺🇲 EN</a>
6+
</div>
7+
8+
![GitHub repo size](https://img.shields.io/github/repo-size/sennshi/Anime-Info-List?style=for-the-badge)
9+
![GitHub language count](https://img.shields.io/github/languages/count/sennshi/Anime-Info-List?style=for-the-badge)
10+
![GitHub forks](https://img.shields.io/github/forks/sennshi/Anime-Info-List?style=for-the-badge)
11+
12+
<img src="print.jpg" alt="exemplo imagem">
13+
14+
> Visualize informações sobre seus animes favoritos, em uma interface criado com ReactJs e utilizando a KitsuAPI
15+
16+
## 🐢 Começando
17+
Antes de passar para as próximas etapas, olhe um pouco de como o projeto foi [estruturado](STRUCTURE.md), pode ser de grande ajuda para você
18+
19+
## 💻 Pré-requisitos
20+
Realize a instalação do NodeJS pelo link:
21+
- [Node LTS](https://nodejs.org/en/)
22+
23+
Ou instale pelo seu gerenciador de pacotes de sua distro seguindo essas [etapas](https://nodejs.org/en/download/package-manager/).
24+
25+
## 🚀 Instalação
26+
27+
Faça o [download](https://github.com/sennshi/Anime-Info-List/archive/refs/heads/main.zip) do projeto ou clone utilizando `git clone https://github.com/sennshi/Anime-Info-List.git`
28+
29+
Rode para instalar os pacotes necessários:
30+
```
31+
> npm install
32+
```
33+
34+
E por fim rode:
35+
36+
```
37+
> npm start
38+
```
39+
40+
Basta acessar `http://localhost:3000/` para visualizar o projeto.
41+
42+
## 🛠️ Construído com
43+
44+
O projeto utilizou a [KitsuAPI](https://kitsu.docs.apiary.io/#) que distribui as informações dos animes, e utilizou as seguintes tecnologias para ser feita:
45+
46+
![ReactJS](https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB)
47+
![Typescript](https://img.shields.io/badge/TypeScript-007ACC?style=for-the-badge&logo=typescript&logoColor=white)
48+
![HTML5](https://img.shields.io/badge/HTML5-E34F26?style=for-the-badge&logo=html5&logoColor=white)
49+
![CSS3](https://img.shields.io/badge/CSS3-1572B6?style=for-the-badge&logo=css3&logoColor=white)
50+
51+
[⬆ Voltar ao topo](#)<br>
52+
53+
---
54+
55+
feito com 💜 por [Rodrigo Sennshi](https://github.com/sennshi)

‎STRUCTURE.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# PT-BR 🇧🇷
2+
3+
## Estrutura do projeto
4+
Um pouco de como o projeto foi estruturado
5+
- `./src/app/pages`: páginas presentes no projeto.
6+
- `./src/app/shared`: pasta onde fica os arquivos compartilhados e utilizados entre si. (componentes, hooks, tipos e etc)
7+
- `components`: São todos os pedaços primordiais de interface.
8+
- `types`: tipos utilizados em mais de um arquivo
9+
10+
## Como me localizar no projeto
11+
- As páginas do projeto estão em `./src/app/pages`
12+
- Cada página possui um `index.tsx` e um `styles.css`
13+
- Os componentes utilizados estão em `./src/app/shared/components`
14+
- Cada componente possui 2 arquivos: `index.tsx` & `styles.css`
15+
16+
# en 🇺🇲
17+
18+
## Project structure
19+
a bit of how the project was structured
20+
- `./src/app/pages`: present pages in the project.
21+
- `./src/app/shared`: folder where shared and used files are located. (components, hooks, types and more)
22+
- `components`: They are all primordial pieces of interface.
23+
- `types`: types used in more the one file
24+
25+
## How to locate me in the project?
26+
- The project pages are at `./src/app/pages`
27+
- Each page has `index.tsx` and a `styles.css`
28+
- The used components are at `./src/app/shared/components`
29+
- Each component has 2 files: `index.tsx` & `styles.css`

‎package.json

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
{
2+
"name": "anime_info_list",
3+
"version": "0.1.0",
4+
"private": true,
5+
"dependencies": {
6+
"@testing-library/jest-dom": "^5.16.5",
7+
"@testing-library/react": "^13.3.0",
8+
"@testing-library/user-event": "^13.5.0",
9+
"@types/jest": "^27.5.2",
10+
"@types/node": "^16.11.49",
11+
"@types/react": "^18.0.17",
12+
"@types/react-dom": "^18.0.6",
13+
"react": "^18.2.0",
14+
"react-dom": "^18.2.0",
15+
"react-icons": "^4.4.0",
16+
"react-router-dom": "^6.3.0",
17+
"react-scripts": "5.0.1",
18+
"typescript": "^4.7.4",
19+
"web-vitals": "^2.1.4"
20+
},
21+
"scripts": {
22+
"start": "react-scripts start",
23+
"build": "react-scripts build",
24+
"test": "react-scripts test",
25+
"eject": "react-scripts eject"
26+
},
27+
"eslintConfig": {
28+
"extends": [
29+
"react-app",
30+
"react-app/jest"
31+
]
32+
},
33+
"browserslist": {
34+
"production": [
35+
">0.2%",
36+
"not dead",
37+
"not op_mini all"
38+
],
39+
"development": [
40+
"last 1 chrome version",
41+
"last 1 firefox version",
42+
"last 1 safari version"
43+
]
44+
}
45+
}

‎print.jpg

208 KB
Loading

‎public/favicon.ico

3.78 KB
Binary file not shown.

‎public/index.html

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="utf-8" />
5+
<link rel="icon" href="%PUBLIC_URL%/favicon.ico" />
6+
<meta name="viewport" content="width=device-width, initial-scale=1" />
7+
<meta name="theme-color" content="#000000" />
8+
9+
<link rel="preconnect" href="https://fonts.googleapis.com">
10+
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
11+
<link href="https://fonts.googleapis.com/css2?family=Lato:wght@400;600&family=Ubuntu:wght@400;500&display=swap" rel="stylesheet">
12+
13+
<meta
14+
name="description"
15+
content="Web site created using create-react-app"
16+
/>
17+
18+
<link rel="apple-touch-icon" href="%PUBLIC_URL%/logo192.png" />
19+
<link rel="manifest" href="%PUBLIC_URL%/manifest.json" />
20+
<title>Anime Info List</title>
21+
</head>
22+
<body>
23+
<noscript>You need to enable JavaScript to run this app.</noscript>
24+
<div id="root"></div>
25+
</body>
26+
</html>

‎public/logo192.png

5.22 KB
Loading

‎public/manifest.json

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
{
2+
"short_name": "AnimeInfoList",
3+
"name": "Anime Info List",
4+
"icons": [
5+
{
6+
"src": "favicon.ico",
7+
"sizes": "64x64 32x32 24x24 16x16",
8+
"type": "image/x-icon"
9+
},
10+
{
11+
"src": "logo192.png",
12+
"type": "image/png",
13+
"sizes": "192x192"
14+
}
15+
],
16+
"start_url": ".",
17+
"display": "standalone",
18+
"theme_color": "#000000",
19+
"background_color": "#ffffff"
20+
}

0 commit comments

Comments
 (0)