Uma simples e enxuta API de calendário feita com Ruby on Rails
Apenas clone este repositório no seu ambiente local ou no seu servidor, intale as dependências com bundler, inicie um banco de dados e está pronto para adicionar seus eventos!
$ git clone https://github.com/leocamelo/rcalendar.git
$ cd rcalendar
$ bundle install
$ rake db:setup
$ unicorn # ou 'rails server' em ambiente de desenvolvimento
rCalendar está configurado e foi testado apenas com o db Postgresql
O rCalendar está preparado para requisições com o padrão REST e responderá com o formato JSON de serialização. Seguem as principais rotas e suas utilidades:
METODO | CAMINHO | UTILIDADE
---------------------------------------
GET | /v1/events | Lista todos os eventos deste ano, a partir deste mês
POST | /v1/events | Adiciona um evento no calendário
PATCH | /v1/events/:id | Atualiza o evento referenciado pela :id na rota
Para mais informações das utilidades acima, como parâmetros e formatos, além de exemplos em algumas linguagens, visite o Demo Online da api.
- Traduzir a documentação e os exemplos para inglês
- Adicionar sistema de seguraça com OAuth2
- Adicionar action destroy ao crud
- Criar exemplos em mais linguagens
Gostou do projeto e quer contribuir com algo?
- Faça um fork do repositório
- Adicione suas correções ou novas features
- Não se esqueça dos testes, use RSpec
- Submeta um pull request, vai ser bem legal :D