# 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](https://room-doc.rodrigoavellar.com/artefatos/canvas-do-produto)
* [Design e Wireframes](https://room-doc.rodrigoavellar.com/artefatos/design-e-wireframes)
* [Pesquisa - questionários](https://room-doc.rodrigoavellar.com/artefatos/questionario-pesquisa)
* [Telas do sistema](https://room-doc.rodrigoavellar.com/artefatos/telas-do-sistema)
* [Planejamento da Release](https://room-doc.rodrigoavellar.com/artefatos/planejamento-da-release)
* [Arquitetura](https://room-doc.rodrigoavellar.com/artefatos/arquitetura)
* [Testes e Validação](https://github.com/roavellarm/temporario/tree/b9ad9d3ed8e12dce8c9fd3d3ea79350a773865b3/artefatos/testes.md)

## Endpoints da API Rest

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