You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+15-17Lines changed: 15 additions & 17 deletions
Original file line number
Diff line number
Diff line change
@@ -6,12 +6,11 @@ This project is currently in development! It will be announced when there is a (
6
6
7
7
1. Fork this repository.
8
8
2. Clone the forked repostory and cd into it
9
-
3.`$ git submodule init`
10
-
4.`$ npm install`
11
-
5. Install MongoDB and make sure it is running
9
+
3.`$ npm install`
10
+
4. Install MongoDB and make sure it is running
12
11
* For Mac OSX with [homebrew](http://brew.sh/): `brew install mongodb` then `brew services start mongodb`
13
12
* For Windows and Linux: [MongoDB Installation](https://docs.mongodb.com/manual/installation/)
14
-
6. Create a file called `.env` in the root of this directory that looks like
13
+
5. Create a file called `.env` in the root of this directory that looks like
15
14
16
15
```
17
16
API_URL=/api
@@ -29,10 +28,10 @@ This project is currently in development! It will be announced when there is a (
29
28
30
29
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](https://gist.github.com/catarak/70c9301f0fd1ac2d6b58de03f61997e3) 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.
31
30
32
-
7.`$ npm run fetch-examples` - this downloads the example sketches into a user called 'p5'
33
-
8.`$ npm start`
34
-
9. Navigate to [http://localhost:8000](http://localhost:8000) in your browser
35
-
10. Install the [React Developer Tools](https://chrome.google.com/webstore/detail/react-developer-tools/fmkadmapgofadopljbjfkapdkoienihi?hl=en).
31
+
6.`$ npm run fetch-examples` - this downloads the example sketches into a user called 'p5'
32
+
7.`$ npm start`
33
+
8. Navigate to [http://localhost:8000](http://localhost:8000) in your browser
34
+
9. Install the [React Developer Tools](https://chrome.google.com/webstore/detail/react-developer-tools/fmkadmapgofadopljbjfkapdkoienihi?hl=en).
36
35
10. Open and close the Redux DevTools using `ctrl+h`, and move them with `ctrl+w`
37
36
38
37
### Testing SSL on your local machine
@@ -68,10 +67,9 @@ If you don't have the full server environment running, you can launch a one-off
68
67
69
68
## Production Installation
70
69
1. Clone this repostory and `cd` into it
71
-
2.`$ git submodule init`
72
-
3.`$ npm install`
73
-
4. Install MongoDB and make sure it is running
74
-
5. Create a file called `.env` in the root of this directory that looks like
70
+
2.`$ npm install`
71
+
3. Install MongoDB and make sure it is running
72
+
4. Create a file called `.env` in the root of this directory that looks like
75
73
76
74
```
77
75
API_URL=/api
@@ -91,9 +89,9 @@ If you don't have the full server environment running, you can launch a one-off
91
89
```
92
90
For production, you will need to have real Github and Amazon credentions. Refer to [this gist](https://gist.github.com/catarak/70c9301f0fd1ac2d6b58de03f61997e3) for creating an S3 bucket for testing.
93
91
94
-
6.`$ npm run fetch-examples` - this downloads the example sketches into a user called 'p5'
95
-
7.`$ npm run build`
96
-
8.`$ npm run start:prod`
92
+
5.`$ npm run fetch-examples` - this downloads the example sketches into a user called 'p5'
Here is guide on [how to use the accessible editor](https://gist.github.com/MathuraMG/e86666b7b41fbc8c078bad9aff3f666d)
120
+
Here is guide on [how to use the accessible editor](https://gist.github.com/MathuraMG/e86666b7b41fbc8c078bad9aff3f666d) and here is an overview of the [p5-accessibility.js](https://github.com/MathuraMG/p5-accessibility/blob/master/README.md) library that makes p5.js sketches accessible to screen readers.
123
121
124
122
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.
125
123
@@ -146,7 +144,7 @@ See [CONTRIBUTING.md](https://github.com/processing/p5.js-web-editor/blob/master
146
144
147
145
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](https://github.com/Hashnode/mern-starter) and [this comment](https://github.com/Hashnode/mern-starter/issues/90#issuecomment-221553573).
148
146
149
-
This project uses an in-development [p5.js interceptor library](https://github.com/MathuraMG/p5-interceptor) 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.
147
+
This project uses an in-development [p5-accessibility.js library](https://github.com/MathuraMG/p5-accessibility) for accessibility.
150
148
151
149
This project does not use CSS Modules, but uses Sass. I like to follow [BEM rules](http://getbem.com/) for CSS naming conventions, write OOSCSS with placeholders and mixins, and follow the [7-1 Pattern](https://sass-guidelin.es/#the-7-1-pattern) for Sass.
0 commit comments