Git Product home page Git Product logo

fix's Introduction

Fix

This is a data storage project build for the company I work at, it's fully open source if you care for using it and should be easy to setup

Requirements

  • Ruby 2.1.0 or newer
  • Rails 4.0.2 or newer
  • PostgreSQL 9.1 or newer
  • ImageMagick
  • Graphviz
  • Git

Database

  • PostgreSQL with ActiveRecord

Development

  • Template Engine: ERB
  • Front-end Framework: Twitter Bootstrap (Sass)
  • Form Builder: Bootstrap Form
  • Authentication: Devise
  • Authorization: CanCan

Installation

Installation guide, set up PostgreSQL, then the project.

PostgreSQL

  • Create a user and the databases
createuser fix -d -s
createdb -Ofix -Eutf8 fix_development (only needed for development)
createdb -Ofix -Eutf8 fix_production (only needed for production)
createdb -Ofix -Eutf8 fix_test (only needed for development)

Project

Development
  • Pick a folder you'd like to use and clone the git repository in there
cd <where-you-want-the-project>
git clone [email protected]:nohm/fix.git
cd fix
  • Install dependencies
bundle install
  • Fill in the config file config/application.yml
<your-text-editor> config/application.yml
  • Create database tables and base data and initialize routes
rake db:migrate
rake db:seed
rake routes
  • Start the server and work on it!
sh script/server
Production
  • You can use the development guide if you want, but to deploy your own version use this
  • First follow the development version for your local environment, then in that folder;
  • Configure config/deploy.rb
<your-text-editor> config/deploy.rb
  • Prepare your server using mina
mina setup
  • Copy over or edit config/application.yml and config/database.yml
scp config/application.yml <user>@<server>:<deploy-location>/shared/config/
scp config/database.yml <user>@<server>:<deploy-location>/shared/config/
OR
<your-text-editor> <deploy-location>/shared/config/application.yml
<your-text-editor> <deploy-location>/shared/config/database.yml
  • Deploy to your server using mina
mina deploy
  • If you use Passenger Phusion the application will be running now
  • If you don't you'll have to edit config/deploy.rb to start the server, or use your own solution

Contributing

If you make improvements to this application, please share with others.

  • Fork the project on GitHub.
  • Make your feature addition or bug fix.
  • Commit with Git.
  • Send the author a pull request.

License

MIT

fix's People

Contributors

nohm avatar

Watchers

James Cloos avatar  avatar

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.