Giter Club home page Giter Club logo

rcalendar's Introduction

rCalendar

Build Status Maintainability

Uma simples e enxuta API de calendário feita com Ruby on Rails

Iniciando

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

Primeiras requisições

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.

Próximas tarefas

  • 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

Contribua

Gostou do projeto e quer contribuir com algo?

  1. Faça um fork do repositório
  2. Adicione suas correções ou novas features
  3. Não se esqueça dos testes, use RSpec
  4. Submeta um pull request, vai ser bem legal :D

rcalendar's People

Contributors

leocamelo avatar

Watchers

 avatar  avatar

Forkers

elnata

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.