Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/joseeduardomartins/repository-manager-backend-b
https://github.com/joseeduardomartins/repository-manager-backend-b
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/joseeduardomartins/repository-manager-backend-b
- Owner: JoseEduardoMartins
- License: mit
- Created: 2024-06-10T19:19:36.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-06-18T05:39:13.000Z (7 months ago)
- Last Synced: 2024-06-18T06:49:40.080Z (7 months ago)
- Language: TypeScript
- Size: 67.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Repository Management System - Back-end b
Este é um sistema desenvolvido em Node.js e TypeScript para buscar usuários do GitHub e seus respectivos repositórios. O projeto foi criado para facilitar a consulta de informações sobre usuários e seus repositórios de maneira simples e eficiente.
## 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)
- 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/repository-manager-backend-b.git
cd repository-manager-backend-b
```
3. Instale as dependências:
```bash
npm install
```
4. Configure as variáveis de ambiente. Renomeie o arquivo `.env.example` para `.env` e preencha as informações necessárias.
5. Inicie o microserviço:
```bash
npm run start:dev
```
O servidor estará disponível em http://localhost:3000.
## Uso
Verificar Status da API
- GET /status/
Acesse a API para buscar usuário e seus repositórios.
- Obter um usuário específico: GET /users/:login
## 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/repository-manager-backend-b/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]`.