Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/victoraugustorodriguesgomes/projeto_ornitorrinco_api

Neste projeto, desenvolvi uma arquitetura full stack que inclui um backend e dois frontends, todos integrados a um único banco de dados. A comunicação entre os componentes é realizada por meio de uma API RESTful, garantindo a eficiência na troca de dados.
https://github.com/victoraugustorodriguesgomes/projeto_ornitorrinco_api

android android-studio api-rest backend frontend fullstack mysql node-js react typescript

Last synced: 20 days ago
JSON representation

Host: GitHub
URL: https://github.com/victoraugustorodriguesgomes/projeto_ornitorrinco_api
Owner: VictorAugustoRodriguesGomes
License: apache-2.0
Created: 2024-09-10T02:17:03.000Z (2 months ago)
Default Branch: main
Last Pushed: 2024-10-11T01:35:50.000Z (about 1 month ago)
Last Synced: 2024-10-15T02:24:26.776Z (about 1 month ago)
Topics: android, android-studio, api-rest, backend, frontend, fullstack, mysql, node-js, react, typescript
Language: TypeScript
Homepage:
Size: 7.32 MB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# Sobre Projeto Ornitorrinco

Olá! Meu nome é Victor Augusto e sou responsável por desenvolver esse projeto nomeado com Projeto Ornitorrinco (utilizei esse nome genérico para organização pessoal).

O objetivo deste projeto é demonstrar minhas habilidades como desenvolvedor.

Primeiramente, criei uma API REST que permite aos usuários realizar funções para criar contas, recuperar senhas, fazer login, visualizar e atualizar suas informações, além de alterar a foto de perfil. A API também inclui um sistema de autenticação em dois fatores (2FA) via e-mail.

A api foi desenvolvido com Node.js, TypeScript e MySQL.

Algumas das bibliotecas utilizadas nesta API são: Express, Jsonwebtoken, Bcrypt, Nodemailer, Multer e Dotenv.

O site do projeto Ornitorrinco oferece uma interface front-end do projeto, permitindo que os usuários acessem todas as funcionalidades do backend. Com integração à API mencionada anteriormente, o site oferece acesso completo a todas as funcionalidades e dados, assegurando uma navegação fluida e intuitiva. Dessa forma, independentemente do dispositivo utilizado, todos podem aproveitar ao máximo os serviços oferecidos pelo backend.

O site foi desenvolvido utilizando React, incorporando HTML, CSS e JavaScript. A biblioteca Axios também foi utilizada para otimizar a comunicação com a API.

O projeto Ornitorrinco também apresenta um aplicativo para dispositivos móveis Android, que se integra à API descrita anteriormente. Esse aplicativo funciona como uma das interfaces front-end do projeto, proporcionando aos usuários de dispositivos móveis Android as mesmas funções e compartilhando os mesmos dados, garantindo assim a melhor experiência e aproveitamento das funcionalidades do backend.

O aplicativo foi desenvolvido no Android Studio, utilizando a linguagem de programação Java e a biblioteca Retrofit para otimizar a comunicação com a API.

## Imagens do Projeto Ornitorrinco referente a API

## Imagens do Projeto Ornitorrinco referente ao frontend Web (site)

## Imagens do Projeto Ornitorrinco referente ao frontend Android (aplicativo para dispositivos móveis Android)

# Sobre a API:
#### Para poder o alterar ou executar a API no seu computador, você vai precisar ter instalado em sua máquina as seguintes ferramentas:
1. [Git](https://git-scm.com),
2. [Node.js](https://nodejs.org/pt),
3. [Visual Studio](https://code.visualstudio.com/) ou outro editor de código.

## Para Configurar o aplicativo:
1. Com projeto aberto no Visual Studio, execute o comando para iniciar um projeto node.js.

2. Na pasta raiz, crie um arquivo chamado : ".env".

3. Depois acesse o arquivo ".env.example", copiei todas as variáveis existente e cole arquivo acabou de criar.

4. Para finalizar, informe os valores das Variáveis seguindo os comentários do arquivo.

# Sobre o frontend Web (site):
#### Para poder ter aceso ao site clique no link abaixo:
1. [Site do Projeto Ornitorrinco](https://projeto-ornitorrinco.netlify.app/).

#### O link do repositório do aplicativo se encontra abaixo:
1. [Projeto Ornitorrinco Frontend Web](https://github.com/VictorAugustoRodriguesGomes/Projeto_Ornitorrinco_Frontend_Web).

#### Para poder ter acesso e alterar ou executar a o site no seu computador, você vai precisar ter instalado em sua máquina as seguintes ferramentas:
1. [Git](https://git-scm.com),
2. [Node.js](https://nodejs.org/pt),
3. [Visual Studio](https://code.visualstudio.com/) ou outro editor de código.

## Para Configurar o site :
1. Com projeto aberto no Visual Studio, execute o comando para iniciar um projeto node.js.

2. Na pasta raiz, crie um arquivo chamado : ".env".

3. Depois acesse o arquivo ".env.example", copiei todas as variáveis existente e cole arquivo acabou de criar.

4. Para finalizar, informe os valores das Variáveis seguindo os comentários do arquivo.

# Sobre o Android (aplicativo para dispositivos móveis Android)
#### Para poder ter aceso ao aplicativo clique no link abaixo:
1. [Baixar APK do Projeto SyDis](https://github.com/VictorAugustoRodriguesGomes/Projeto_Ornitorrinco_API/tree/main/APK%20do%20Projeto%20Ornitorrinco).

#### O link do repositório do aplicativo se encontra abaixo:
1. [Projeto Ornitorrinco Frontend Mobile](https://github.com/VictorAugustoRodriguesGomes/Projeto_Ornitorrinco_Frontend_Android).

#### Para poder ter acesso e alterar ou executar a o aplicativo no seu computador, você vai precisar ter instalado em sua máquina as seguintes ferramentas:
1. [Git](https://git-scm.com),
2. [Android Studio](https://developer.android.com/studio?hl=pt-br).

## Para Configurar o aplicativo:
1. Com projeto aberto no Android Studio, Localize o seguinte arquivo:
"ApiConnection / Connection.java"

2. Altere o valor da variável "BASE_URL" para o link da API Que está rodando localmente no seu computador.

### Em caso de dúvidas:
1. Caso tenha dúvidas de como abrir os arquivo do projeto no Android Studio basta seguir passo a passo desse tutorial. [Android Studio Git Tutorial](https://javapapers.com/android/android-studio-git-tutorial/).

# Licença

Este projeto é licenciado sob os termos da licença Apache 2.0.

---------