Skip to content

Commit ef39a2d

Browse files
committed
Add local web server, and docs for it
1 parent e24fab2 commit ef39a2d

File tree

4 files changed

+23
-5
lines changed

4 files changed

+23
-5
lines changed

Makefile

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
all:
2+
npm install
23
bower install
34
./build.sh

README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
**Generate PDF files in client-side JavaScript.**
66

7-
You can [catch me on twitter](http://twitter.com/MrRio): [@MrRio](http://twitter.com/MrRio) or head over to [my company's website](http://snapshotmedia.co.uk) for consultancy.
7+
You can [catch me on twitter](http://twitter.com/MrRio): [@MrRio](http://twitter.com/MrRio) or head over to [my company's website](http://parall.ax) for consultancy.
88

99
## Creating your first document
1010

@@ -25,6 +25,20 @@ doc.save('Test.pdf');
2525
git clone --recursive git://github.com/MrRio/jsPDF.git
2626
```
2727

28+
## Building
29+
30+
To build, simply run the 'make' command. This will fetch all npm and bower deps, then compile minified JS files.
31+
32+
## Running locally
33+
34+
Due to certain restrictions that local files have, you'll need to run a web server. Just run:
35+
36+
```
37+
npm start
38+
```
39+
40+
You can then access the site at localhost:8000
41+
2842
## Credits
2943

3044
Big thanks to Daniel Dotsenko from [Willow Systems Corporation](http://willow-systems.com) for making huge contributions to the codebase.

index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@
3737
<p class="muted" style="text-align: right;" id="dversion">Version 0.9.0rc2</p>
3838
</div>
3939
<h1 class="muted">jsPDF</h1>
40-
<h4>HTML5 JavaScript PDF generation library from <a href="http://twitter.com/MrRio">@MrRio</a> at <a href="http://snapshotmedia.co.uk">Snapshot Media</a></h4>
40+
<h4>HTML5 JavaScript PDF generation library from <a href="http://twitter.com/MrRio">@MrRio</a> at <a href="http://parall.ax">Parallax</a></h4>
4141
</div>
4242

4343
<div class="row-fluid">

package.json

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,11 @@
1616
"type": "git",
1717
"url": "https://github.com/MrRio/jsPDF.git"
1818
},
19-
"dependencies": {
20-
},
19+
"dependencies": {},
2120
"devDependencies": {
21+
"local-web-server": "^0.5.19"
22+
},
23+
"scripts": {
24+
"start": "ws"
2225
}
23-
}
26+
}

0 commit comments

Comments
 (0)