> For the complete documentation index, see [llms.txt](https://room-doc.rodrigoavellar.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://room-doc.rodrigoavellar.com/master.md).

# Documentação do Projeto

## Introdução

Este documento tem como objetivo apresentar e descrever o projeto *Room*, fornecendo informações e artefatos sobre a concepção do produto, seu planejamento, decisões arquiteturais, desenvolvimento, testes/validação e conclusões. Mais informações podem ser encontradas no [artigo](https://medium.com/@ramprofissional/38c57969ad21) a ser publicado na plataforma Medium.

A aplicação encontra-se disponível [aqui](https://room-web.netlify.com/).

A API Rest encontra-se disponível no Heroku em duas camadas: *staging* e *production*. Podem ser acessadas pelos links abaixo:

* API Staging: <https://staging-room-api.herokuapp.com/> {PATH}
* API Production: <https://production-room-api.herokuapp.com/> {PATH}

A documentação dos **endpoints da API** se encontra disponível na seção respectiva desta documentação e no [github](https://github.com/roavellarm/room-api/blob/master/schema/api.md).

## Repositórios de códigos da aplicação

* [Back-end](https://github.com/roavellarm/room-api)
* [Front-end](https://github.com/roavellarm/room-web)

## Artefatos do projeto

* [Canvas do Projeto](/artefatos/canvas-do-produto.md)
* [Design e Wireframes](/artefatos/design-e-wireframes.md)
* [Pesquisa - questionários](/artefatos/questionario-pesquisa.md)
* [Telas do sistema](/artefatos/telas-do-sistema.md)
* [Planejamento da Release](/artefatos/planejamento-da-release.md)
* [Arquitetura](/artefatos/arquitetura.md)
* [Testes e Validação](https://github.com/roavellarm/temporario/tree/b9ad9d3ed8e12dce8c9fd3d3ea79350a773865b3/artefatos/testes.md)

## Endpoints da API Rest

* [Admin texts](/endpoints-da-api/admin-texts.md)
* [Chat](/endpoints-da-api/chat.md)
* [Error](/endpoints-da-api/error.md)
* [Faq](/endpoints-da-api/faq.md)
* [Feedback](/endpoints-da-api/feedback.md)
* [Mood](/endpoints-da-api/mood.md)
* [Org](/endpoints-da-api/org.md)
* [Room](/endpoints-da-api/room.md)
* [Social Media](/endpoints-da-api/social_media.md)
* [User](/endpoints-da-api/user.md)