diff --git a/README.md b/README.md index d592247..8bced4f 100644 --- a/README.md +++ b/README.md @@ -1,96 +1,80 @@ [![Maintainability](https://api.codeclimate.com/v1/badges/a96e3bfb2024cd6464f7/maintainability)](https://codeclimate.com/github/prefeiturasp/SME-PratoAberto-API/maintainability) [![Build Status](https://travis-ci.org/prefeiturasp/SME-PratoAberto-API.svg?branch=master)](https://travis-ci.org/prefeiturasp/SME-PratoAberto-API) +# Estratégia de Transformação Digital e Governo Aberto na SME +Como um governo pode atuar para garantir o bem comum de todos? Na SME, acreditamos que um dos meios para isso seja garantir transparência e prestação de contas e constante relação entre governo e sociedade para o desenvolvimento e implementação de políticas públicas. -## Instalação +A Portaria SME nº 8.008, de 12 de novembro de 2018 oficializou a estratégia da Secretaria Municipal de Educação de SP para que nossas ações sejam pautadas nos princípios de Governo Aberto e para usarmos os valores e benefícios do mundo digital para melhorarmos nossos processos e serviços para os cidadãos. +Com isso, pretendemos: +- aumentar os níveis de transparência ativa e de abertura de dados, garantindo a proteção de dados pessoais; +- instituir metodologias ágeis e colaborativas como parte do processo de desenvolvimento e de evolução de sistemas administrativos e de serviços digitais; +- fortalecer o controle das políticas educacionais e da aplicação de recursos por parte da gestão e da sociedade; +- promover espaços e metodologias de colaboração entre governo, academia, sociedade civil e setor privado. -Instale os requisitos através do `requirements.txt` e configure uma variável de ambiente chamada API_MONGO_URI com o apontamento para a base. - -``` -pip install -r requirements.txt -export API_MONGO_URI=localhost:27017 -FLASK_APP=api.py flask run -``` - -## Instalação usando Docker - -Dentro do diretório do projeto, inicie a aplicação usando `docker-compose`. - -`docker-compose up -D --build` - - -Instale MongoDB versão mínima 3.6: +O [Ateliê do Software](http://forum.govit.prefeitura.sp.gov.br/uploads/default/original/1X/c88a4715eb3f9fc3ceb882c1f6afe9e308805a17.pdf) é uma das ferramentas para operacionalização. Baseado em um modelo de contratação inspirado pelos movimentos ágil e de Software Craftsmanship, trabalhamos com equipes multidisciplinares para o desenvolvimento de produtos que beneficiam toda a comunidade escolar (técnicos da SME e DREs, gestores, professores, alunos e famílias) e concretizam os objetivos da Estratégia de Transformação Digital e Governo Aberto “Pátio Digital”. -[Windows](http://treehouse.github.io/installation-guides/windows/mongo-windows.html) -[Mac](http://treehouse.github.io/installation-guides/mac/mongo-mac.html) - -``` -mongod --fork --logpath -mongorestore -d pratoaberto -c cardapios ./cardapios.bson -mongorestore -d pratoaberto -c escolas ./escolas.bson -``` - - -# Pátio Digital - -_“Recurso público retorna ao público”._ +## Conteúdo -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. +1. [Sobre o produto](#sobre-o-prato-aberto) +2. [Comunicação](#comunicação) +3. [Como contribuir](#como-contribuir) +4. [Repositórios](#Repositórios) +5. [Instalação e Configuração](#Instalação-e-Configuração) -# Prato Aberto +# Sobre o produto -"Prato Aberto – Comida Boa Não Tem Segredo". +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. A API serve dados sobre as escolas e as refeições das escolas da rede pública da cidade de São Paulo. -# API do Prato Aberto +## Roadmap -A API serve dados sobre as escolas e as refeições das escolas da rede pública da cidade de São Paulo. +- Melhorar a qualidade de código +- Iniciar a escrita de testes unitários +- Configurar Docker +- Melhorar documentação de maneira enxuta +- CI com jenkins -## Conteúdo +# Comunicação -1. [Sobre o prato aberto](#sobre-o-prato-aberto) -2. [Comunicação](#comunicação) -3. [Roadmap de tecnologia](#roadmap-de-tecnologia) -4. [Como contribuir](#como-contribuir) -5. [Instalação](#instalação) +| Canal de comunicação | Objetivos | +|----------------------|-----------| +| [Issues do Github](https://github.com/prefeiturasp/SME-PratoAberto-API/issues) | - Sugestão de novas funcionalidades
- Reportar bugs
- Discussões técnicas | -## Sobre o prato aberto +# Como contribuir -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. +Contribuições são **super bem vindas**! Se você tem vontade de construir o Prato Aberto conosco, veja o nosso [guia de contribuição](./CONTRIBUTING.md) 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](./CODEOFCONDUCT.md). -### Nossos outros repositórios +# Repositórios 1. [Robô Edu](https://github.com/prefeiturasp/SME-PratoAberto-Edu) 2. [API](https://github.com/prefeiturasp/SME-PratoAberto-API) 3. [Editor](https://github.com/prefeiturasp/SME-PratoAberto-Editor) -## Comunicação +# Instalação e Configuração -| Canal de comunicação | Objetivos | -|----------------------|-----------| -| [Issues do Github](https://github.com/prefeiturasp/SME-PratoAberto-Frontend/issues) | - Sugestão de novas funcionalidades
- Reportar bugs
- Discussões técnicas | -| [Telegram](https://t.me/patiodigital ) | - Comunicar novidades sobre os projetos
- Movimentar a comunidade
- Falar tópicos que **não** demandem discussões profundas | +Instale os requisitos através do `requirements.txt` e configure uma variável de ambiente chamada API_MONGO_URI com o apontamento para a base. -Qualquer outro grupo de discussão não é reconhecido oficialmente. +``` +pip install -r requirements.txt +export API_MONGO_URI=localhost:27017 +FLASK_APP=api.py flask run +``` -## Roadmap de tecnologia +## Instalação usando Docker -### Passos iniciais -- Melhorar a qualidade de código -- Iniciar a escrita de testes unitários -- Configurar Docker -- Melhorar documentação de maneira enxuta -- CI com jenkins +Dentro do diretório do projeto, inicie a aplicação usando `docker-compose`. -## Como contribuir +`docker-compose up -D --build` -Contribuições são **super bem vindas**! Se você tem vontade de construir o -prato aberto conosco, veja o nosso [guia de contribuição](./CONTRIBUTING.md) -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](./CODEOFCONDUCT.md). +Instale MongoDB versão mínima 3.6: +[Windows](http://treehouse.github.io/installation-guides/windows/mongo-windows.html) +[Mac](http://treehouse.github.io/installation-guides/mac/mongo-mac.html) + +``` +mongod --fork --logpath +mongorestore -d pratoaberto -c cardapios ./cardapios.bson +mongorestore -d pratoaberto -c escolas ./escolas.bson # Endpoints