Skip to content

Commit

Permalink
fix readme
Browse files Browse the repository at this point in the history
  • Loading branch information
pedrosilvaadev committed May 11, 2022
1 parent 8975673 commit 68f55a9
Show file tree
Hide file tree
Showing 5 changed files with 78 additions and 43 deletions.
119 changes: 77 additions & 42 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,70 +1,105 @@
# Getting Started with Create React App
# League of Legends Music Player
![](image/README/login.png)
![](image/README/mediaplayer.png)
![](image/README/playlist.png)
> O Projeto é um media player com tema de League of Legends.
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
Confira a aplicação: https://lol-music-player.netlify.app

## Available Scripts

In the project directory, you can run:
## 📄 Explicação

### `npm start`
A primeira página do projeto é a de login que apresenta um campo de email e senha. Os dois campos devem ser preenchidos para habilitar o botão de logar igual é feito na tela inicial do jogo League of Legends.

Runs the app in the development mode.\
Open [http://localhost:3000](http://localhost:3000) to view it in your browser.
Logo após efetuar login, você é redirecionado para a página Media Player com um belo recebimento de Boas Vindas de ninguem mais ninguem menos do que Draaaaaaaveeeeen ! 😎.

The page will reload when you make changes.\
You may also see any lint errors in the console.
O nickname utilizado é apresentado no Header da aplicação com um sistema de troca de imagem de perfil, você pode selecionar o personagem que mais lhe agrada aquele que está dentro do seu coração ❤.

### `npm test`
Você tem opções padrões de um Media Player: Pause, Start e troca de música.

Launches the test runner in the interactive watch mode.\
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
Clicando no botão de "3 pontinhos" ira abrir a playlist listando as músicas pré definidas no sistema.
(Pra mim as melhores músicas).

### `npm run build`
- Enemy (Imagine Dragons)
- Rise: (The Glitch Mob, Mako, and The Word Alive)
- Phoenix Cailin Russo e Chrissy Costanza
- True Damage: GIANTS (Becky G, Keke Palmer, SOYEON, DUCKWRTH, Thutmose)
- Awaken (Valerie Broussard)
- É só um joguinho eles disseram (Emicida)
- KDA - POP STARS (Madison Beer, (G)I-DLE, Jaira Burns)
- Legends Never Die (Against The Current)

## 📁 Seções

Builds the app for production to the `build` folder.\
It correctly bundles React in production mode and optimizes the build for the best performance.
O site é composto por 3 seções diferentes:

The build is minified and the filenames include the hashes.\
Your app is ready to be deployed!
* **Login:** É uma copia do sistema de login do jogo.
* **Media Player:** Tela para execução das músicas.
* **Lista de Músicas:** Tela para exibição da playlist.

See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
## 🎯 Etapas

### `npm run eject`
✔️ Projeto base;\
✔️ Criação das rotas;\
✔️ Página Home;\
✔️ Profile image;\
✔️ Voz Draven ao logar;\
✔️ Criação Media Player;\
✔️ Criação PlayList;\
✔️ Finalizado;

**Note: this is a one-way operation. Once you `eject`, you can't go back!**
## 🚀 Tecnologias

If you aren't satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
Neste projeto foram utilizadas as seguintes ferramentas:

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own.
* [ReactJs](https://pt-br.reactjs.org/)
* [Toast](https://fkhadra.github.io/react-toastify/introduction/)
* [Material UI](https://mui.com/pt/material-ui/getting-started/installation/)
* [LocalStorage](https://developer.mozilla.org/pt-BR/docs/Web/API/Window/localStorage)
* [Carousel](https://www.npmjs.com/package/react-multi-carousel)
* [React Icon](https://react-icons.github.io/react-icons/)
* [Styled-Components](https://styled-components.com)

You don't have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it.
## 📕 Requisitos

## Learn More
Antes de iniciar 🏁, você precisa ter [Git](https://git-scm.com/) e [Node](https://nodejs.org/en/) instalados.

You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
## 🏁 Iniciando

To learn React, check out the [React documentation](https://reactjs.org/).
```bash
# Clone this project
$ git clone https://github.com/Dev-Pedrosv/lol-media-player.git
# Access
$ cd lol-media-player
# Install dependencies
$ yarn or npm
# Run the project
$ yarn start or npm start
# The server will initialize in the <http://localhost:3000>
```

### Code Splitting
## 🤝 Colaboradores

This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting)
Agradecemos às seguintes pessoas que contribuíram para este projeto:

### Analyzing the Bundle Size
<table>
<tr>
<td align="center">
<a href="#">
<img src="https://avatars.githubusercontent.com/u/82785683?v=4" width="140px;" alt="Foto Pedro Silva GitHub"/><br>
<sub>
<b>Pedro Silva</b>
</sub>
</a>
</td>
</tr>
</table>

This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size)
## 📝 Licença

### Making a Progressive Web App
Este projeto está sob licença. Consulte o arquivo [LICENSE](LICENSE.md) para obter mais detalhes.

This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app)
&#xa0;

### Advanced Configuration
<a href="#top">Volte para o Topo</a>

This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration)

### Deployment

This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment)

### `npm run build` fails to minify

This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify)
Binary file added image/README/login.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added image/README/mediaplayer.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added image/README/playlist.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion src/constants/playList.js
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ export const playList = [
{
id: 8,
name: "Legends Never Die",
description: " Against The Current",
description: "Against The Current",
mp3: LegendsNeverDie,
image: "https://i.ytimg.com/vi/r6zIGXun57U/maxresdefault.jpg",
},
Expand Down

0 comments on commit 68f55a9

Please sign in to comment.