Skip to content

cs169-summer2017-team10/focus-lca-webapp

 
 

Repository files navigation

Focus LCA Web App

Build Status

Description

This website is meant to facilitate engineers in measuring the environmental impact of their products. A simple, easy to use UI will allow the users to easily add information about their products (parts, materials, shipping methods) which will then be analyzed and displayed with numerous graphs.

Heroku deployment: https://focus-lca-summer2017.herokuapp.com

Requirements

This project was initially implemented only with Ruby on Rails to manage both the backend and the frontend, as well as some JavaScript code.
In this iteration, we decided to separate the two, and since this app relies heavily on JavaScript code, we used AngularJS for the frontend and Rails only for the backend.
You can find some helpful links and resources at the end of this README to understand how the Rails pipeline can work with Bower and the installation of frameworks, libraries or dependencies such as AngularJS.

Install Ruby and Rails

Guide: http://railsapps.github.io/installrubyonrails-mac.html

Install Node and NPM

Guide: http://blog.teamtreehouse.com/install-node-js-npm-mac

Install Bower

npm install -g bower

Building and running the app

$ git clone https://github.com/cs169-summer2017-team10/focus-lca-webapp.git
$ cd focus-lca-webapp
$ bundle install --without production
$ rails db:setup
$ rake bower:install
$ rails s

Project hierarchy

Frontend (AngularJS)

└── app/
    ├── assets/
    │   ├── images/
    │   │   └── ...
    │   ├── javascripts/
    │   │   ├── controllers/
    │   │   │   └── ...
    │   │   ├── directives/
    │   │   │   └── ...
    │   │   ├── views/
    │   │   │   └── ...
    │   │   ├── app.js
    │   │   ├── application.js
    │   │   └── routes.js
    │   └── stylesheets/
    │       └── application.scss
    │
    └── views/
        └── application/
            └── index.html.erb

Backend (Ruby on Rails)

└── app/
    ├── controllers/
    │   ├── application_controller.rb
    │   ├── assemblies_controller.rb
    │   └── users_controller.rb
    │
    ├── models/
    │   ├── assembly.rb
    │   └── user.rb
    │
    └── serializers/
        └── user_serializer.rb

Resources

Troubleshooting

Misc

Pivotal Tracker Project

Faludi Design's website

Packages

No packages published

Languages

  • Ruby 50.7%
  • JavaScript 25.6%
  • HTML 17.9%
  • CSS 3.2%
  • Gherkin 2.6%