r/p5.js-web-editor
1
0
Fork 0
Code Issues 1 Pull requests Releases 1 Wiki Activity
Web editor for P5.js, modified for workshops at Digital Playground.
754 commits 4 branches 1 tag 27 MiB
JavaScript 80.3%
CSS 19.4%
Shell 0.2%
Find a file
Andrew Nicolaou 2e62c6b288 Find (#359) 
* Styles CodeMirror Search box

* Switch to fork of search add-on

* Styles search box using custom markup

* Prev/Next search behaviour, highlighting current result

* Hide search modifiers until implemented

* Regexp search

* Style RegExp modifier button active state

* Styles search modifiers

* Wires up Case Sensitive search button

* Allows case insenstive regexp search

* Do not show underlying regexp query string when re-opening dialog

* Adds "Whole word" search

* Adds title and aria-label for tooltip and screenreaders

* Whole Word button shows correct active/inactive state

* Disables replace implementation which doesn't work

* Tidies up query parsing so it's less of a hack

- uses state to convert query text into a regexp
- avoids having to fake regexp using "/.../" syntax
- parsing is now in one place

* Uses shared metaKey function for Cmd/Ctrl key

* Adds find function to keyboard shortcuts modals

* Sets aria-checked to true/false to indicate button state

* Sets role=checkbox on checkbox-like buttons
2017-06-06 15:20:21 -04:00
client Find (#359) 2017-06-06 15:20:21 -04:00
server Accessibility (#361) 2017-05-31 15:23:30 -04:00
static Accessibility (#361) 2017-05-31 15:23:30 -04:00
.babelrc change dev/production babel configuration 2016-07-22 13:14:26 -04:00
.eslintignore start to add eslint, add repository to package.json 2016-06-22 19:59:12 -04:00
.eslintrc update eslint to latest version, fix lots of linting errors (#308) 2017-02-22 14:29:35 -05:00
.gitignore FINALLY fix #52, this will not work with redirecting to https when authenticating but we will cross that bridge when we get there 2016-11-29 15:51:16 -05:00
.gitmodules Move the interceptor code to a git module (#200) 2016-11-23 13:35:12 -05:00
backup.sh update instructions for backup.sh 2016-11-16 14:52:27 -05:00
cert_chain.crt add embed route, fix path parsing in PreviewFrame 2016-09-06 16:54:16 -04:00
contributing.md Create contributing.md 2016-12-20 16:16:01 -08:00
ecosystem.json update pm2 to use clusering mode 2017-04-07 00:01:58 -04:00
fetch-examples.js Fetch examples from p5 website repo (#203) 2016-12-01 18:57:50 -05:00
index.html #142 add webpack configuration to decrease loading speed 2016-11-08 18:11:12 -05:00
index.js #142 add webpack configuration to decrease loading speed 2016-11-08 18:11:12 -05:00
nodemon.json add nodemon, remove .env from being tracked 2016-06-22 18:48:45 -04:00
package.json Remove comments before using loopProtect on scripts (fixes #218) (#364) 2017-06-05 22:46:19 -04:00
README.md add step to download examples to development and production setup, #349 2017-05-24 12:08:12 -04:00
webpack.config.dev.js #339 add region to .env 2017-04-13 14:39:03 -04:00
webpack.config.prod.js enable sourcemap 2017-05-18 17:41:25 -04:00

README.md

p5.js Web Editor

This project is currently in development! It will be announced when there is a (public) beta release.

Development Installation

  1. Clone this repostory and cd into it
  2. $ git submodule init
  3. $ npm install
  4. Install MongoDB and make sure it is running
  5. Create a file called .env in the root of this directory that looks like
API_URL=/api
MONGO_URL=mongodb://localhost:27017/p5js-web-editor
PORT=8000
SESSION_SECRET=whatever_you_want_this_to_be_it_only_matters_for_production
AWS_ACCESS_KEY=<your-aws-access-key>
AWS_SECRET_KEY=<your-aws-secret-key>
AWS_REGION=<your-aws-region>
S3_BUCKET=<your-s3-bucket>
GITHUB_ID=<your-github-client-id>
GITHUB_SECRET=<your-github-client-secret>

If you don't care about being able to upload media files to S3 or Login with Github, you can drop in the file exactly how it is. Or, if you don't want to do that, just ask me to send you mine. Refer to this gist for creating an S3 bucket for testing, or if you don't want to do that, I can add you to one of my S3 buckets.

  1. $ npm run fetch-examples - this downloads the example sketches into a user called 'p5'
  2. $ npm start
  3. Navigate to http://localhost:8000 in your browser
  4. Install the React Developer Tools.
  5. Open and close the Redux DevTools using ctrl+h, and move them with ctrl+w

Testing SSL on your local machine

Please refer to this gist. This allows you to access the editor using both HTTP and HTTPS. Don't worry about this unless you need to make changes or test HTTPS behavior.

The automatic redirection to HTTPS is turned off by default in development. If you need to test this behavior, put FORCE_TO_HTTPS=true in your .env file.

Production Installation

  1. Clone this repostory and cd into it
  2. $ git submodule init
  3. $ npm install
  4. Install MongoDB and make sure it is running
  5. Create a file called .env in the root of this directory that looks like
API_URL=/api
MONGO_URL=mongodb://localhost:27017/p5js-web-editor
PORT=8000
SESSION_SECRET=make_this_a_long-random_string_like_maybe_126_characters_long
AWS_ACCESS_KEY=<your-aws-access-key>
AWS_SECRET_KEY=<your-aws-secret-key>
AWS_REGION=<your-aws-region>
S3_BUCKET=<your-s3-bucket>
GITHUB_ID=<your-github-client-id>
GITHUB_SECRET=<your-github-client-secret>

For production, you will need to have real Github and Amazon credentions. Refer to this gist for creating an S3 bucket for testing.

  1. $ npm run fetch-examples - this downloads the example sketches into a user called 'p5'
  2. $ npm run build
  3. $ npm run start:prod

For Production Setup with PM2

  1. $ npm install -g pm2
  2. $ pm2 start ecosystem.json

Accessibility Guidelines

Here is guide on how to use the accessible editor

The code for the p5.js web editor adheres to web accessibility standards. The following guidelines will help to ensure that accessibility continues to be a priority as development continues.

Code Structure

  • Screen Readers are an assistive technology for vision loss which helps users to navigate a web page. They are able to prioritize content based on the semantic meaning of HTML tags. Therefore, it is important to use specific tags, such as nav, ul, li, section, and so on. div is the least screen reader friendly tag. For example, here is the semantic meaning of the body tag
  • All buttons/links/windows need to be accessible by the keyboard ( By tabbing, pressing space etc.)
  • In cases where tags are not screen reader friendly, we can take advantage of tabIndex. Using tabIndex ensures that all elements are accessible via keyboard. code example
  • When opening a new window or pop up window, ensure the keyboard focus also moves to the new window. code example

Labeling

  • When creating button icons, images, or something without text (this does not include an HTML5 <button>), use aria-labels. code example
  • All <table>s need to have a summary attribute. This will ensure user is given context to what the table is. code example
  • uls and navs menus need to include a title. code example

For more information on accessibility see the teach access tutorial

Contribution Guide

I am currently open to contributors! Email me if you are looking for a task, or look at the open issues and reply that you are working on a task.

The p5.js Web Editor is built on a MERN stack - MongoDB, Express, React/Redux, and Node. For a reference to the file structure format I am using, please look at the Mern Starter and this comment.

This project uses an in-development p5.js interceptor library for accessibility as git submodule. Every time you run npm install, it will update the interceptor to HEAD, so it is important to do this often.

This project does not use CSS Modules, but uses Sass. I like to follow BEM rules for CSS naming conventions, write OOSCSS with placeholders and mixins, and follow the 7-1 Pattern for Sass.

I'm 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 remove 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.

AWS information

This project is currently hosted on an EC2 instance and uses S3 for media hosting.

Backups on the MongoDB are also hosted on an S3 bucket, based on the following gist. The backup script runs nightly via a cronjob at 8AM UTC/3AM EST/12AM PST. Backups are deleted after 30 days.

Dump of links I'm saving for reference