Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/denissonpereira/heisenberg-dm-data-platform
https://github.com/denissonpereira/heisenberg-dm-data-platform
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/denissonpereira/heisenberg-dm-data-platform
- Owner: DenissonPereira
- License: mit
- Created: 2024-05-25T21:18:53.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-07-15T05:04:26.000Z (6 months ago)
- Last Synced: 2024-07-16T06:28:54.829Z (6 months ago)
- Language: JavaScript
- Size: 7.37 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
![Web 1](./github/banner.png)
# 📑 Sobre o projeto
Dentro da física de materiais, o modelo **Dzyaloshinskii-Moriya (DM)** é fundamental para explorar fenômenos magnéticos avançados. Este modelo descreve interações antissemétricas entre spins em materiais magnéticos, resultantes do acoplamento spin-órbita. Essas interações são cruciais para a formação de estruturas magnéticas complexas, como os skyrmions magnéticos, que são promissores para aplicações em dispositivos de armazenamento de dados e spintrônica.
Nessa perspectiva, o presente projeto propõe um conjunto de *softwares* para auxiliar pesquisadores da área com as soluções das equações e outros dados importantes. Com o objetivo de alcançar esse intento, o projeto é composto por três partes fundamentais: **backend**, **web** e **mobile**. O **backend**, desenvolvido em **Java**, oferece uma **API** com dados persistentes do banco, permitindo aos usuários consumi-los sem a necessidade de resolver equações, proporcionando assim a continuidade de suas pesquisas de forma eficiente. A parte **web**, criada com **React**, disponibiliza uma plataforma que consome a **API** e também permite a modificação dos dados, especialmente quando o usuário possui privilégios de administrador. Já a parte **mobile**, elaborada com **React Native**, oferece uma interface elegante e de fácil uso, possibilitando um acesso rápido e intuitivo aos dados necessários.
## 📚 Stack Tecnológica
### • Design
![Adobe Photoshop](https://img.shields.io/badge/adobe%20photoshop-%23051D34?style=for-the-badge&logo=adobe%20photoshop&logoColor=%233CA3F7)
![Figma](https://img.shields.io/badge/figma-%23F24E1E.svg?style=for-the-badge&logo=figma&logoColor=white)### • Backend
[![Java](https://img.shields.io/badge/java-%23ED8B00.svg?style=for-the-badge&logo=openjdk&logoColor=white)](https://www.java.com/)
![Maven](https://img.shields.io/badge/Maven-C71A36?style=for-the-badge&logo=apache-maven&logoColor=white)
[![Spring](https://img.shields.io/badge/spring-%236DB33F.svg?style=for-the-badge&logo=spring&logoColor=white)](https://spring.io/)
![MySQL](https://img.shields.io/badge/mysql-4479A1.svg?style=for-the-badge&logo=mysql&logoColor=white)### • Web
![TypeScript](https://img.shields.io/badge/typescript-%23007ACC.svg?style=for-the-badge&logo=typescript&logoColor=white)
![Styled Components](https://img.shields.io/badge/styled--components-%23DB7093.svg?style=for-the-badge&logo=styled-components&logoColor=white)
![Context-API](https://img.shields.io/badge/Context--Api-000000?style=for-the-badge&logo=react)
![Axios](https://img.shields.io/badge/Axios-%237261DF?style=for-the-badge&logo=axios&logoColor=white)
![Cypress](https://img.shields.io/badge/cypress-%2317212F.svg?style=for-the-badge&logo=cypress&logoColor=white)
![Vitest](https://img.shields.io/badge/Vitest-green?style=for-the-badge&logo=vitest&logoColor=white)
![i18n](https://img.shields.io/badge/i18n-%2320232A.svg?style=for-the-badge)
![Victory](https://img.shields.io/badge/Victory-%23777BB4.svg?style=for-the-badge&logo=victory&logoColor=white)
![React Router DOM](https://img.shields.io/badge/React_Router_DOM-%2357C4D3.svg?style=for-the-badge&logo=react-router&logoColor=white)
![ESLint](https://img.shields.io/badge/ESLint-%234B32C3.svg?style=for-the-badge&logo=eslint&logoColor=white)### • Mobile
![Expo](https://img.shields.io/badge/expo-1C1E24?style=for-the-badge&logo=expo&logoColor=#D04A37)
![React Native](https://img.shields.io/badge/react_native-%2320232a.svg?style=for-the-badge&logo=react&logoColor=%2361DAFB)
![TypeScript](https://img.shields.io/badge/typescript-%23007ACC.svg?style=for-the-badge&logo=typescript&logoColor=white)
![Context-API](https://img.shields.io/badge/Context--Api-000000?style=for-the-badge&logo=react)
![Axios](https://img.shields.io/badge/Axios-%237261DF?style=for-the-badge&logo=axios&logoColor=white)# ⚙ Pré-requisitos
## Certifique-se de ter o Node.js instalado
Antes de mais nada, verifique se você tem o Node.js instalado em sua máquina. Você pode baixá-lo e instalá-lo a partir do site oficial do Node.js:
[![NPM](https://img.shields.io/npm/v/npm.svg?logo=npm)](https://nodejs.org/en)
## Instale o Expo CLI globalmente
Abra o terminal ou prompt de comando e execute o seguinte comando para instalar o Expo CLI globalmente em sua máquina:
```
npm install -g expo-cli
```# 🚀 Como executar o projeto 🚀
## ⬇️ Clonar repositório git
```
git clone https://github.com/DenissonPereira/Heisenberg-DM-Data-Platform
```## 🏧 Backend
Após clonar o repositório, para acessar o backend, basta digitar o seguinte comando no terminal:
```
cd backend
```Lembre-se de que os dados estão localizados, a partir da raiz do projeto, em database/Dump20240715.sql
## 🌐 Web
Para acessar a interface web, na pasta raiz do projeto, basta digitar:
```
cd web
```Após entrar na pasta, instale as dependências do projeto com o seguinte comando:
```
npm install
```Assim, para iniciar a aplicação, digite o seguinte comando no terminal:
```
npm run dev
```Por fim, você pode acessar a aplicação em seu navegador de preferência utilizando o seguinte endereço: http://localhost:3000/
## 📱 Mobile
Para acessar a pasta do projeto, digite no terminal o seguinte comando:
```
cd mobile
```Após entrar na pasta, instale as dependências do projeto com o seguinte comando:
```
npm install
```Tudo pronto! para visualizar o projeto, digite:
```
npx expo start
```# 📸 Visuals and Screenshots
Dê uma espiada no nosso projeto em funcionamento e esclareça todas as suas dúvidas sobre como executá-lo!
## 🌐 Web
### Versão web
![Web 1](./public/web.gif)
## 📱 Responsividade e Mobile
![Web 2](./public/res.jpeg) ![Mob 1](./public/RPReplay_Final1711383878.gif)
## 📺 Editor de código
Neste projeto, foi utilizado o Visual Studio Code como editor de código.
[![Visual Studio Code](https://img.shields.io/badge/Visual%20Studio%20Code-0078d7.svg?style=for-the-badge&logo=visual-studio-code&logoColor=white)](https://code.visualstudio.com/)
# 🚨 Aguarde! Ainda não terminou!
>Este projeto está atualmente em desenvolvimento, e está sujeito a futuras atualizações e melhorias conforme evolui. Estamos trabalhando para torná-lo ainda mais robusto e funcional ao longo do tempo. Agradecemos sua paciência e interesse nesta fase inicial.
>Além disso, gostaríamos de ressaltar que este projeto é aberto a contribuições de qualquer pessoa interessada em colaborar. Se você tem ideias, sugestões ou melhorias para oferecer, sinta-se à vontade para participar do desenvolvimento do projeto. Juntos, podemos criar algo incrível e beneficiar a comunidade de forma colaborativa.
## 📜 Licença
[![NPM](https://img.shields.io/npm/l/react)](https://github.com/DenissonPereira/Heisenberg-DM-Data-Platform/blob/main/LICENSE)
## ✏️ Autor
Denisson Pereira Santos