Skip to content
This repository has been archived by the owner on May 31, 2019. It is now read-only.

Helpful Hints and Suggestions

Hannah Nordgren edited this page Nov 14, 2018 · 2 revisions

Helpful Hints and Suggestions

Creating React Components

This application uses the webpacker. Documentation on creating components can be found there.

This project comes with an example component for use, if desired. It can be found in app/javascript/pages/home/index.jsx.

Creating Non-React Javascript Files

If not using react for front end components, vanilla javascript files can be placed in either the javascript directory or the asset pipeline folder under app/assets/javascripts.

If the former is used, webpack will process the javascript. If the latter is chosen, sprockets will be used to process the javascript. Use whichever directory feels most appropriate.

State Management

Redux has been added but not implemented in this project. We prefer to use this state management tool.

All actions and reducers should go into the javascript directory outside the asset pipeline.

Styling Elements

This application uses the sass-rails gem. No additional configuration has been added. Please review the documentation before starting.

The CSS manifest can be found in the stylesheets directory under app/assets/stylesheets/application.scss. In this file some of the base vimeo styles have been added for convenience.

The SCSS file does not need to compile while working in order to check styles on the fly.

File and style organization is a matter of personal preference.

Completing The Project

The repository does NOT need to be deployed in order to complete the project. The finished project should be able to run locally and meet the requirements as posted in the readme of this repository.

When this criteria has been met, please submit a pull request and email the people listed below in the FAQ section with a link to the PR.