r/p5.js-web-editor
1
0
Fork 0
Code Issues 1 Pull requests Releases 1 Wiki Activity
p5.js-web-editor/developer_docs/development.md
Cassie Tarakajian 8495a59e36
Development documentation (#705) 
* delete unused files, move webpack configs to their own directory

* start of improved developer documentation, moving everything to developer_docs/ directory

* documentation updates
2018-09-26 16:14:06 -04:00

1.6 KiB
Raw Blame History

Development

A guide for adding code to this project.

Installation

Follow the installation guide.

Design

Design proposed and theme changes are present at: Zeplin.

Technologies Used

MERN stack - MongoDB, Express, React/Redux, and Node.

  • For a reference to the file structure format this project is using, please look at the Mern Starter.

  • This project does not use CSS Modules, styled-components, or other CSS-in-JS libraries, but uses Sass. BEM guidelines and naming conventions are followed.

  • For common and reusable styles, write OOSCSS (Object-Oriented SCSS) with placeholders and mixins. For organizing styles, follow the 7-1 Pattern for Sass.

  • We're using ES6 and transpiling to ES5 using Babel.

  • For reference to the JavaScript style guide, see the Airbnb Style Guide, React ESLint Plugin.

  • The ESLint configuration is based on a few popular React/Redux boilerplates. Open to suggestions on this. If in development, you're getting annoyed with ESLint, you can temporarily remove the eslint-loader it from webpack/config.dev.js in the JavaScript loader, or disable any line from eslint by commenting at the end of the line // eslint-disable-line.