Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/joseeduardomartins/dna-backend
https://github.com/joseeduardomartins/dna-backend
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/joseeduardomartins/dna-backend
- Owner: JoseEduardoMartins
- License: mit
- Created: 2024-02-11T18:13:48.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-02-12T17:42:54.000Z (11 months ago)
- Last Synced: 2024-02-12T18:37:39.726Z (11 months ago)
- Language: JavaScript
- Size: 36.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# DNA System - Back-end
Este projeto é um sistema simples de verificação de DNA desenvolvido em Node.js, com uma base de dados MySQL para armazenar informações de DNA e seu tipo.
## Pré-requisitos
Certifique-se de ter as seguintes dependências instaladas antes de iniciar:
- [Node.js](https://nodejs.org/) (versão 16.17.0 ou superior)
- MySQL (versão 8.0.35 ou superior)
- Pacotes [npm](https://www.npmjs.com/) (Node Package Manager)
## Instruções de Configuração
1. Clone o repositório
```bash
git clone https://github.com/JoseEduardoMartins/dna-backend.git
cd dna-backend
```
2. Criar o Banco de Dados e adicionar Dados Iniciais:
- Se você ainda não o tiver instalado, siga as instruções na [documentação oficial](https://www.mysql.com/downloads/) para instalar o MySQL.
- Abra um terminal e execute o seguinte comando para criar um banco de dados e aplicar a estrutura inicial a partir do arquivo `schema.sql`:
```
mysql -u seu_usuario -p sua_senha -h seu_host < ./database/schema.sql
```
- Se você tiver um arquivo `seeds.sql` com dados iniciais, execute o seguinte comando para adicioná-los:
```
mysql -u seu_usuario -p sua_senha -h seu_host < ./database/seed.sql
```
3. Instale as dependências:
```bash
npm install
```
6. Configure as variáveis de ambiente. Renomeie o arquivo `.env.example` para `.env` e preencha as informações necessárias.
7. Inicie o microserviço:
```bash
npm run dev
```
O servidor estará disponível em http://localhost:3000/api.
## Uso
Acesse a API para gerenciar contatos e números de telefone.
- Salvar um novo DNA: POST /dnas/
## Exemplo de Payload para Salvar DNA
```script
{
"sequence": ["CTGAGA", "CTGAGC", "TAGTGT", "AGAGGG", "CCCCTA", "TCACC"]
}
```
## Contribuição
Contribuições são bem-vindas! Se encontrar algum problema ou tiver sugestões, por favor, abra uma [issue](https://github.com/JoseEduardoMartins/dna-backend/issues/new).
## Autor
- José Eduardo Martins
## Licença
Este projeto é licenciado sob a Licença MIT - consulte o arquivo LICENSE.md para obter detalhes.
## Contato
Para qualquer dúvida ou problema, entre em contato com `[email protected]`.