BrunoSSantana / weathermusic

Repositório criado durante o desafio da comunidade Holocron com intuito de execitar a consulta de API's

Weathermusic

About the project   |    Technologies   |    Getting started   |    How to contribute   |    License

👨🏻‍💻 About the project

This application was developed during the first week of community challenges Holocron. This challenge created by Gabriel Sartorato with the following description:

O aplicativo tem como objetivo buscar playlists de acordo com o clima da cidade ou a localização informada pelo usuário. O site mostrará uma playlist diferente para cada intervalo de temperatura.

Caso a temperatura seja maior que 32 graus, deverá retornar Rock, de 32 a 24 deverá retornar Pop, de 24 a 16 deverá retornar Clássica e menor que 16 deverá retornar Lofi.

O usuário poderá salvar a playlist informada, caso ele goste das músicas sugeridas.

Apis sugeridas:

• https://openweathermap.org/current
• https://rapidapi.com/apidojo/api/shazam

---

Application Requirements

1. Deve ser possível criar uma conta para um usuário
2. Apenas usuários pode ter acesso as rotas '/' e '/profile'
3. Deve ser possível buscar uma playlist a partir do input de uma cidade
   1. busca a temperatura da cidade
   2. Caso a temperatura seja maior que 32 graus, deverá retornar Rock, de 32 a 24 deverá retornar Pop, de 24 a 16 deverá retornar Clássica e menor que 16 deverá retornar Lofi
4. Deve ser possível salvar determinada playlist
5. Deve ser possível ser redirecionado ao clicar em qualquer card das músicas retornadas na playlist
6. Deve ser possível listar todas as playists do usuário na rota '/profile'
7. Deve sesr possível mostrar todas as músicas da playlist ao clicar na playlist salva

🚀 Technologies

Technologies that we used to develop this api

• Node.js
• TypeScript
• Express
• TypeORM
• PostgreSQL
• ts-node-dev
• ReactJS
• Eslint
• React Router DOM
• React Navigation
• Styled Components
• Axios

💻 Getting started

Import the Insomnia.json on Insomnia App or click here

Requirements

• Node.js
• Yarn or npm
• One instance of PostgreSQL with database named weathermusic

Clone the project and access the folder

$ git clone https://github.com/Bruno/weathermusic.git && cd weathermusic

Follow the steps below

Backend

# Starting from the project root folder, go to backend folder
$ cd server

# Install the dependencies
$ yarn

# Create the instance of postgreSQL using docker
$ docker run --name weathermusic-postgres -e POSTGRES_PASSWORD=docker -p 5432:5432 -d postgres

# Make sure the keys in 'ormconfig.json' to connect with your database
# are set up correctly.

# Once the services are running, run the migrations
$ yarn typeorm migration:run

# To finish, run the api service
$ yarn dev

# Well done, project is started!

Web

Obs.: Before to continue, be sure to have the API running

# Starting from the project root folder, go to frontend folder
$ cd frontend

# Install the dependencies
$ yarn

# Be sure the file 'src/services/api.ts' have the IP to your API

# Start the client
$ yarn start

🤔 How to contribute

Make a fork of this repository

# Fork using GitHub official command line
# If you don't have the GitHub CLI, use the web site to do that.

$ gh repo fork BrunoSSantana/weathermusic

Follow the steps below

# Clone your fork
$ git clone your-fork-url && cd weathermusic

# Create a branch with your feature
$ git checkout -b my-feature

# Make the commit with your changes
$ git commit -m 'feat: My new feature'

# Send the code to your remote branch
$ git push origin my-feature

After your pull request is merged, you can delete your branch

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.

---

👨‍💻 Contributors

All the success we achieve is the result of teamwork. It was an honor to have this opportunity to work with these great professionals and to be bringing valuable knowledge of this experience. And a special thanks to the Holocron community 💜.

Bruno Santana

DouglasANS