Skip to content

Latest commit

 

History

History
55 lines (40 loc) · 2.2 KB

README.md

File metadata and controls

55 lines (40 loc) · 2.2 KB

My Nomad Life API v1.0.0

MyNomadLifeAPI logo

My Nomad Life API is an application that provides an implementation of a back-end API for the Android application My Nomad Life. The project uses a PostgreSQL database as database back-end and ActiveModelSerializer for the serialization of database data to JSON format.

Screenshots

Installation

  • Install all necessary ruby gems bundle install
  • Setup a database connection vim config/database.yml

Setup

  • Create a database bundle exec rake db:create
  • Migrate database tables bundle exec rake db:migrate
  • Copy data into ./db/csvs/ and ./db/images/
  • Populate a database bundle exec rake db:seed

Requirements

  • Ruby on Rails 5
  • SQLite3 / PostgreSQL

Run application

  • rails s

Libraries

  • Twitter Bootstrap - Twitter Bootstrap for Sass
  • Font Awesome - The iconic font and css toolkit
  • ActiveModel::Serializer - ActiveModel::Serializer is set of Rails hooks for data serialization
  • Carrierwave - Classier solution for file uploads for Rails, Sinatra and other Ruby web frameworks
  • mini-magick - A ruby wrapper for ImageMagick or GraphicsMagick
  • Rest client - A simple HTTP and REST client for Ruby language
  • RSpec - Behaviour Driven Development for Ruby

License - Apache License, Version 2.0

# (C) Copyright 2017 by Marek Hakala <hakala.marek@gmail.com>
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
#    limitations under the License.