Skip to content

Commit fe10769

Browse files
authored
Update README.md
1 parent d115911 commit fe10769

File tree

1 file changed

+43
-1
lines changed

1 file changed

+43
-1
lines changed

README.md

Lines changed: 43 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,46 @@
11
# es6console
22
Play around with ECMAScript (6 to 5) transformers, with an interactive console.
33

4-
http://es6console.com
4+
https://es6console.com
5+
6+
### Building
7+
8+
Build this project running Gulp (which runs Webpack behind the scenes)
9+
10+
```
11+
npm install
12+
gulp build
13+
```
14+
15+
### Development
16+
17+
There is a convenient gulp command for starting the backend and building the frontend.
18+
This also reloads any backend/frontend code if it is changed.
19+
20+
```
21+
gulp serve
22+
```
23+
24+
### Runtime / Framework(s):
25+
26+
- Babel
27+
- Gulp
28+
- Express
29+
- Postgresql
30+
31+
### File structure:
32+
33+
```
34+
.
35+
├── models # Database interface
36+
├── static
37+
│   ├── dist
38+
│   ├── examples
39+
│   ├── img
40+
│   ├── js # Frontend javascript src
41+
│   ├── sass # Sass styles
42+
│   └── style
43+
└── views
44+
└── api.js # API for retreiving stored snippets
45+
└── app.js # General express app for serving the webpage
46+
```

0 commit comments

Comments
 (0)