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.
322 commits 4 branches 1 tag 27 MiB
JavaScript 80.3%
CSS 19.4%
Shell 0.2%
Find a file
catarak 8713e297dd add about modal to link to github
2016-08-22 12:35:59 -04:00
client add about modal to link to github 2016-08-22 12:35:59 -04:00
server add about modal to link to github 2016-08-22 12:35:59 -04:00
static include JSONs in local 2016-08-19 12:44:44 -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 fix a ton of eslint errors 2016-06-23 18:29:55 -04:00
.gitignore update gitignore 2016-07-18 00:33:30 -04:00
ecosystem.json add ecosystem.json for pm2 configuration 2016-06-28 17:37:02 -04:00
index.html add srcdoc polyfill again, maybe this time it will work 2016-07-11 17:21:20 -04:00
index.js add dotenv, start to add signup 2016-06-20 17:46:42 -04:00
nodemon.json add nodemon, remove .env from being tracked 2016-06-22 18:48:45 -04:00
package.json add resizers 2016-08-11 15:41:13 -04:00
README.md minor readme link edit 2016-08-01 18:43:22 +10:00
webpack.config.dev.js add avenir next 2016-08-18 14:22:47 -04:00
webpack.config.prod.js add fonts to prod webpack 2016-08-19 13:13:17 -04:00

README.md

#p5.js Web Editor

This project is currently in the early stages of development! It will definitely be announced when it is in alpha/beta/etc.

##Development Installation

  1. Clone this repostory and cd into it
  2. $ npm install
  3. Install MongoDB and make sure it is running
  4. Create a file called .env in the root of this directory that looks like
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>
S3_BUCKET=<your-s3-bucket>

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 will send you my AWS credentials. 5. $ npm start 6. Navigate to http://localhost:8000 in your browser 7. Install the React Developer Tools. 8. Open and close the Redux DevTools using ctrl+h, and move them with ctrl+w

##Production Installation

  1. Clone this repostory and cd into it
  2. $ npm install
  3. Install MongoDB and make sure it is running
  4. Create a file called .env in the root of this directory that looks like
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>
S3_BUCKET=<your-s3-bucket>

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 will send you my AWS credentials. 5. $ npm run build 6. $ npm run start:prod

###For Production Setup with PM2

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

##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 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 new to using ESLint, but I decided on a configuration based on some 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.

##Dump of links I'm saving for reference