https://github.com/hakmarkdev/mynomadlife-api
The My Nomad Life API is a back-end rails application for MyNomadLife application.
https://github.com/hakmarkdev/mynomadlife-api
activemodelserializers api carrierwave minimagick rest-client rspec ruby-on-rails
Last synced: 2 months ago
JSON representation
The My Nomad Life API is a back-end rails application for MyNomadLife application.
- Host: GitHub
- URL: https://github.com/hakmarkdev/mynomadlife-api
- Owner: marekhakala
- Created: 2017-08-03T20:43:28.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2017-08-07T16:14:07.000Z (almost 9 years ago)
- Last Synced: 2025-01-01T15:26:30.430Z (over 1 year ago)
- Topics: activemodelserializers, api, carrierwave, minimagick, rest-client, rspec, ruby-on-rails
- Language: Ruby
- Homepage:
- Size: 507 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# My Nomad Life API v1.0.0
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](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](https://github.com/twbs/bootstrap-sass) - Twitter Bootstrap for Sass
* [Font Awesome](http://fontawesome.io/) - The iconic font and css toolkit
* [ActiveModel::Serializer](https://github.com/rails-api/active_model_serializers) - ActiveModel::Serializer is set of Rails hooks for data serialization
* [Carrierwave](https://github.com/carrierwaveuploader/carrierwave) - Classier solution for file uploads for Rails, Sinatra and other Ruby web frameworks
* [mini-magick](https://github.com/minimagick/minimagick) - A ruby wrapper for ImageMagick or GraphicsMagick
* [Rest client](https://github.com/rest-client/rest-client) - A simple HTTP and REST client for Ruby language
* [RSpec](http://rspec.info/) - Behaviour Driven Development for Ruby
# License - Apache License, Version 2.0
```
# (C) Copyright 2017 by Marek Hakala
# 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.
```