This is the API of the Let's integrate! project. To know what it's about, please visit our website at https://letsintegrate.de/.
There is currently no detailed documentation on how to use the API but we use the rspec-apib gem to generate an API Blueprint documentation and then upload it to Apiary. The generated documentation can be found here:
http://docs.letsintegrateapi.apiary.io/
The Let's integrate! API is based on Ruby on Rails 4. For setting up the development environment, Docker with Docker Compose and direnv is used. The development workflow is organized by GitHub pull requests and the GitFlow development workflow. Please make yourself familiar with the things mentioned above before actually starting to code.
Before you are able to run any tests or rails tasks, you need to create the Docker images using Docker Compose.
docker-compose build
To run the tests, the test database has to be created and migrated first. To do
so, you need to run rails db:create and rails db:migrate within the Docker
container.
docker-compose run web rake db:create db:migrate RAILS_ENV=test
After building the Docker images and creating the database you are good to go to
run the tests and start developing at Let's integrate! You can run the tests
either manually using the rspec command or permanently by using guard.
RSpec:
docker-compose run web rspec
Guard:
docker-compose run web guard
- Fork the repository on GitHub
- Clone it:
git clone [email protected]:letsintegrate/li-api.git - Init git flow
git flow init - Create a new branch for your feature using GitFlow:
git flow feature start my-awesome-feature(Requires the GitFlow addon to be installed) - Make your changes, test them using RSpec and commit them
- Push the changes to GitHub:
git push -u origin feature/my-awesome-feature - Create a Pull request
gem install global_phone_dbgen
/bundle/bin/global_phone_dbgen 'https://raw.githubusercontent.com/googlei18n/libphonenumber/master/resources/PhoneNumberMetadata.xml' > db/global_phone.json
The MIT License (MIT) Copyright (c) 2016 Let's integrate!
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
