update README and add npm start script
This commit is contained in:
parent
5858914559
commit
d833ff9f19
2 changed files with 23 additions and 3 deletions
25
README.md
25
README.md
|
@ -1,8 +1,27 @@
|
||||||
MERN Stack - MongoDB, Express, React/Redux, Node
|
#p5.js Web Editor
|
||||||
https://github.com/Hashnode/mern-starter
|
|
||||||
|
|
||||||
|
This project is currently in the early stages of development! It will definitely be announced when it is in alpha/beta/etc.
|
||||||
|
|
||||||
|
##Installation and Setup
|
||||||
|
|
||||||
|
As this project is currently being developed, there is only development mode.
|
||||||
|
|
||||||
|
1. Clone this repostory
|
||||||
|
2. `npm install`
|
||||||
|
3. `npm start`
|
||||||
|
4. Navigate to http://localhost:8000 on your browser
|
||||||
|
|
||||||
|
##Technology Stack
|
||||||
|
* MERN - MongoDB, Express, React/Redux, Node
|
||||||
|
* Webpack
|
||||||
|
* Sass
|
||||||
|
|
||||||
|
##Dump of links I'm saving for reference
|
||||||
|
|
||||||
|
* https://github.com/Hashnode/mern-starter
|
||||||
* https://sass-guidelin.es/#the-7-1-pattern
|
* https://sass-guidelin.es/#the-7-1-pattern
|
||||||
* https://github.com/petehunt/react-howto
|
* https://github.com/petehunt/react-howto
|
||||||
* https://github.com/gajus/react-css-modules
|
* https://github.com/gajus/react-css-modules
|
||||||
* https://github.com/jsbin/jsbin (especially look at the console)
|
* https://github.com/jsbin/jsbin (especially look at the console)
|
||||||
* Need to figure out how to solve the XSS issue, https://github.com/jsbin/jsbin/wiki/Best-practices-for-building-your-own-live-paste-bin
|
* Need to figure out how to solve the XSS issue, https://github.com/jsbin/jsbin/wiki/Best-practices-for-building-your-own-live-paste-bin
|
||||||
|
* https://www.npmjs.com/package/express-subdomain
|
|
@ -4,6 +4,7 @@
|
||||||
"description": "The web editor for p5.js.",
|
"description": "The web editor for p5.js.",
|
||||||
"main": "server.js",
|
"main": "server.js",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
|
"start": "node index.js",
|
||||||
"test": "echo \"Error: no test specified\" && exit 1"
|
"test": "echo \"Error: no test specified\" && exit 1"
|
||||||
},
|
},
|
||||||
"author": "Cassie Tarakajian",
|
"author": "Cassie Tarakajian",
|
||||||
|
|
Loading…
Reference in a new issue