Git Product home page Git Product logo

storify's Introduction

Storify

Code Climate Test Coverage Issue Count CircleCI

Tech Stack

  • Ruby Version: 2.3.1p112
  • Rails Version: 5.0.1
  • PostGreSQL: 9.5.5
  • Solr Engine
  • Puma as App-server
  • Nginx as Webserver

Installation

In Production

  • Install Solr in Ubuntu
    • using lates Java runtime for solr
      • $ sudo apt-get install openjdk-8-jre
    • Install Tomcat & Solr (You can’t avoid this one)
      • $ sudo apt-get install solr-tomcat
    • start tomcat server
      • $ sudo /etc/init.d/tomcat7 start
      • [ ok ] Starting tomcat7 (via systemctl): tomcat7.service.
    • Ok it is done !
      • Solr server responds at http://localhost:8080/solr
      • and the config & index will be stored at : /usr/share/solr/
    • see this for more information
  • Deployment
    • Capistrano script is all set and ready
    • tweak according to your need; may be details like server IP, deploy branch. etc
    • cap production deploy IP=xx.85.xx.104

Note: Make sure the solr instance is up and running for every operations like db:reset, db:seed, or running application.

System Overview

You can find the Enhanced Entity Relationship Diagram(ERD) here.

Declaration

Storify uses Authy 2Factor Authentication's Onetouch and Softtoken scheme to authentication crutial events like payment verifications. It uses the authy-ruby gem.

It also uses Rails DB, so that you can view records in production and other environment. http://localhost:3000/rails/db

Hacks

If you wish to do the following jobs with single command then see below

  • Droping DB
  • Creating DB
  • Migration
  • Seed

Solution:

execute this command

$ echo "alias hard_reset_db='rails db:drop && rake db:create && rake db:migrate && rake db:reset'"  >> ~/.bash_aliases

or open the file ~/.bash_aliases and put the following content.

alias hard_reset='(echo "Dropping DB ..")&&(rails db:drop) && (rake db:create) && (rake db:migrate) && (echo "Seeding..")&&(rake db:seed)&&(echo "Done!")'

This will update your system's alias list. Now whenever you wish you can use it like

$ hard_reset_db

Contribute

Bug fixes

  • Fix the issue in a branch of your own fork of Storify.
  • Rebase your branch to include the latest changes from master. We do not accept pull requests with merge commits.
  • Open a pull request from your fork to master.
  • Make sure all the tests pass.
  • Update CHANGELOG.md

Architecture

Drawing

Drawing

Release

See RELEASE.md for information about how to make a new release.

Translation

As of now, Storify is only available in English.

Known issues

  • No known issues for now.

Documentation

Please refer the wiki page for documentations.

License

Storify is open source under the MIT license. See LICENSE for details.

storify's People

Contributors

shivabhusal avatar

Stargazers

 avatar

Watchers

 avatar

Forkers

jimacoff

storify's Issues

Create Project Architecture

  • ERR diagrams to be prepared prior
  • Class diagrams of services and modules required
  • this can be submitted at the time of project release, as it is only required by then. There can be significant amount of changes in project architecture in the course.

Implement a cart system

  • better view showing all items in the cart
  • add items to cart
  • checkout feature
    • on checkout, create order and lineitems

Use Twillio Authy for 2FA

No need to implement a payment gateway, instead use Twillio Authy for 2-factor authentication during a purchase. If 2-factor authentication is successfull, you should email the customer the product. It should support both Authy OneTouch and Authy SoftToken (as fallback)

Implement Search Engine using Solr

It should use standard practices for a shopping cart, and have appropriate search (using Solr) and filters on product pages (i.e. by category, by price)


  • Basic Solr configuration

  • Search toolbar in products's search result page. Slider installed with multi-selectable dropdown for categories

  • Pagination Implemented using Kaminari-Solr Integration. Bootstrap theme installed for Kaminari

  • Page navigation via sidebar-categories

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.