https://github.com/exploit-experts/docs-rickandmorty
Documentação oficial do Rick and Morty Database, tendo informações gerais do projeto e da API construída em Spring utilizando Docusaurus
https://github.com/exploit-experts/docs-rickandmorty
Last synced: 10 months ago
JSON representation
Documentação oficial do Rick and Morty Database, tendo informações gerais do projeto e da API construída em Spring utilizando Docusaurus
- Host: GitHub
- URL: https://github.com/exploit-experts/docs-rickandmorty
- Owner: Exploit-Experts
- License: mit
- Created: 2025-03-19T22:50:18.000Z (10 months ago)
- Default Branch: master
- Last Pushed: 2025-03-27T00:22:28.000Z (10 months ago)
- Last Synced: 2025-03-27T01:26:09.260Z (10 months ago)
- Language: CSS
- Homepage: https://exploit-experts.github.io/Docs-RickAndMorty/
- Size: 1.83 MB
- Stars: 0
- Watchers: 0
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Rick and Morty Database Documentation
[](https://opensource.org/licenses/MIT)
[](https://github.com/Exploit-Experts/Docs-RickAndMorty/issues)
[](https://docusaurus.io/)
## Sobre o Projeto
Este projeto contém a documentação oficial do Rick and Morty Database, uma API abrangente com informações sobre personagens, locais e episódios da série Rick and Morty. A documentação é construída usando [Docusaurus](https://docusaurus.io/), uma ferramenta moderna para criar e manter sites de documentação.
## Website da Documentação
Acesse a documentação online: [Rick and Morty Database](https://exploit-experts.github.io/Docs-RickAndMorty/)
## Configuração Local
Para executar este projeto localmente, siga os passos abaixo:
### Pré-requisitos
- Node.js (versão 16 ou superior)
- npm ou yarn
### Instalação
1. Clone o repositório:
```bash
git clone https://github.com/Exploit-Experts/Docs-RickAndMorty.git
cd Docs-RickAndMorty-Api
```
2. Instale as dependências:
```bash
npm install
# ou
yarn install
```
3. Inicie o servidor de desenvolvimento:
```bash
npm start
# ou
yarn start
```
4. Abra seu navegador e acesse `http://localhost:3000/Docs-RickAndMorty/`
## Estrutura do Projeto
- `/docs/` - Contém a documentação principal
- `/docs/apidoc/` - Documentação específica da API
- `/src/` - Código fonte da aplicação Docusaurus
- `/static/` - Arquivos estáticos como imagens
## Contribuindo
Contribuições são bem-vindas! Sinta-se à vontade para abrir issues ou enviar pull requests.
1. Faça um fork do projeto
2. Crie uma branch para sua feature (`git checkout -b feature/feature`)
3. Commit suas mudanças (`git commit -m 'Add feature'`)
4. Push para a branch (`git push origin feature/feature`)
5. Abra um Pull Request
## API Documentation
A documentação da API inclui:
- Documentação
- Endpoints disponíveis
- Parâmetros de requisição
## Licença
Este projeto está licenciado sob a Licença MIT - veja o arquivo [LICENSE](LICENSE) para mais detalhes.