/SME-PratoAberto-Frontend

Website que permite à população acompanhar o cardápio das escolas públicas de São Paulo.

Primary LanguageTypeScriptGNU General Public License v3.0GPL-3.0

Maintainability

Pátio Digital

“Recurso público retorna ao público”.

Nós somos o pátio digital, uma iniciativa da Secretaria Municipal de Educação de São Paulo que, por meio do fortalecimento da transparência, da participação social e do desenvolvimento de novas tecnologias, aproxima diferentes grupos da sociedade civil por um objetivo maior: a melhoria da educação na cidade de São Paulo.

Prato Aberto

"Prato Aberto – Comida Boa Não Tem Segredo".

Conteúdo

  1. Sobre o Prato Aberto
  2. Comunicação
  3. Roadmap de tecnologia
  4. Como contribuir
  5. Instalação

Sobre o Prato Aberto

Projetada para funcionar em computadores e dispositivos móveis, como tablets e celulares, a ferramenta permite a consulta dos cardápios por dia e por escola, com visualização no mapa. É a primeira vez que os cardápios são divulgados por unidade escolar. Além de facilitar a consulta dos cardápios, a plataforma permite a avaliação da qualidade das refeições e prevê interação com usuários via Facebook e Telegram, por meio de um assistente virtual, o Robô Edu.

Nossos outros repositórios

  1. Robô Edu
  2. API
  3. Editor

Comunicação

Canal de comunicação Objetivos
Issues do Github - Sugestão de novas funcionalidades
- Reportar bugs
- Discussões técnicas
Telegram - Comunicar novidades sobre os projetos
- Movimentar a comunidade
- Falar tópicos que não demandem discussões profundas

Qualquer outro grupo de discussão não é reconhecido oficialmente.

Roadmap de tecnologia

Passos iniciais

  • Melhorar a qualidade de código
  • Iniciar a escrita de testes unitários
  • Configurar Docker
  • Transferir front para o github pages
  • Iniciar escrita de testes funcionais
  • Melhorar documentação de maneira enxuta

Como contribuir

Contribuições são super bem vindas! Se você tem vontade de construir o Prato Aberto conosco, veja o nosso guia de contribuição onde explicamos detalhadamente como trabalhamos e de que formas você pode nos ajudar a alcançar nossos objetivos. Lembrando que todos devem seguir nosso código de conduta.

Instalação

Dependências

Organização do projeto

  • Instalar dependências via cli com o comando --save-dev
  • Manter templates em arquivos separados, da mesma forma que já é proposto pelo @angular-cli na criação de componentes
  • Classes devem ser criadas via @angular-cli e escritas em Typescript
  • CSS utiliza Sass
  • A pasta src/assets concentra qualquer asset necessário, como imagens, fontes e dados

Subir ambiente de desenvolvimento

  1. npm install
  2. ng serve, para rodar uma versão do servidor de desenvolvimento

Deploy

  1. ng build -prod, gera a versão de distribuição na pasta dist
  2. npm install
  3. ng serve, para rodar uma versão do servidor de desenvolvimento

Baseado no Readme do i-educar