Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/glu-tech/deprenotnow

Help people with binaural beats - DepreNotNow
https://github.com/glu-tech/deprenotnow

backend binaural-beats flask frontend python react-native swagger typescript

Last synced: about 1 month ago
JSON representation

Help people with binaural beats - DepreNotNow

Awesome Lists containing this project

README

        

# DepreNotNow 🌻

[![NPM](https://img.shields.io/npm/l/react)](https://github.com/glu-tech/DepreNotNow/blob/main/LICENSE)
[![NPM](https://api.codeclimate.com/v1/badges/7dc798db81a62774f99b/maintainability)](https://codeclimate.com/github/glu-tech/DepreNotNow)
[![NPM](https://camo.githubusercontent.com/2bbe4dbaee4e9d5713c8621cf4c91f4128105283dc1d656009c5aea3618f9110/68747470733a2f2f736e796b2e696f2f746573742f6769746875622f6477796c2f686170692d617574682d6a7774322f62616467652e7376673f74617267657446696c653d7061636b6167652e6a736f6e)](https://app.snyk.io/org/lucaslgu/project/0bd5c29f-59d9-470a-a09e-4224c2fce0fe)
[![CI - Backend Application](https://github.com/glu-tech/DepreNotNow/actions/workflows/main.yml/badge.svg?branch=main)](https://github.com/glu-tech/DepreNotNow/actions/workflows/main.yml)

***

[Wiki](https://github.com/glu-tech/DepreNotNow/wiki) | [Docs](https://artistic-tea-70d.notion.site/DepreNotNow-ccc60d95dcbe4e0793ad7270d72d438c)

***

## Sobre o projeto

* O projeto é um aplicativo mobile, do tipo reprodutor gerador de binaural beats.
* Está dividido a parte de backend em python com o microframework Flask e a parte de frontend em mobile com typescript e React Native

### Binaraul Beats

O tema Binaural Beats consiste em criar uma faixa que contém frequências de batidas binaurais, daí o termo em inglês,  que ajuda o indivíduo em diversos estados mentais. Ademais, afina-se a música (instrumentação) a fim de alcançar o estado cerebral associado a essa frequência.  
Basicamente tem-se a música inteira trabalhando para o mesmo objetivo, selecionado pelo usuário.

O público alvo são pessoas que sofrem com depressão, ansiedade ou insônia. A intenção é, através do aplicativo, ser capaz de auxiliar pessoas a melhorar a qualidade do sono em momentos de insônia, relaxar diante de uma crise de ansiedade e alegrar em períodos de tristeza.

O som de fundo mistificado com binaural tem como finalidade tornar a música mais leve. Todos possuem um som de fundo, o som background, sendo esse o estilo musical pré setado, para que o usuário possa adaptar-se ao seu estilo musical favorito de uma forma a tornar a experiência mais agradável. 

Para melhor experiência recomenda-se o uso de headphones, pois há uma mudança de frequência de acordo com o tipo do som ao longo do tempo, uma variância de frequência específica para cada tipo de binaural e também, para eliminar ruídos externos.

***

## Construindo e executando o projeto

Para poder construir e executar o projeto, acesse [nesta documentação](https://github.com/glu-tech/DepreNotNow/wiki/How-to-execute-the-project) todos os passos para a construção e execução do DepreNotNow, tanto o backend, quanto o frontend e seus devidos pré-requisitos.

***

## Contribuindo com o DepreNotNow

Existe várias formas de contribuir para este projeto e como contribuir, para isto, separei [esta documentação](https://github.com/glu-tech/DepreNotNow/wiki/How-to-contribute), explicando sobre a contribuição e processos de aprovação de pull requests.

***

## Como utilizar o DepreNotNow?

Para utilização do app, a partir do seu dispositivo mobile ou emulador, partindo da premissa que já esteja com o projeto em execução, com todas suas devidas dependências instaladas, caso contrário [acesse essa documentação](https://github.com/glu-tech/DepreNotNow/wiki/Prerequisites) para os pré-requisitos e [esta documentação](https://github.com/glu-tech/DepreNotNow/wiki/How-to-execute-the-project) para construção e execução do projeto.

Para entender como funciona e utilizar o app, você pode acessar o [Manual do usuário](https://artistic-tea-70d.notion.site/Manual-do-usu-rio-0efbe9cece7741b6982a5a0c9ba8a96e) e vai entender cada detalhe da aplicação. Podendo assim, com headphones, executar a produção de áudio binaural beats e escutar.
Pode também optar por extrair o link gerado do bucket da AWS, através do Swagger UI da aplicação backend, e baixar diretamente o áudio em seu computador.

## Licença

Direitos autorais (c) Glu Tech Organization. Todos os direitos reservados.

Licenciado sob a licença do [MIT](https://github.com/glu-tech/DepreNotNow/blob/main/LICENSE).