1
0
mirror of https://github.com/jiahaog/Nativefier synced 2024-06-28 07:50:49 +02:00
Nativefier/docs/development.md
Jia Hao Goh 36e34c95a5 Remove $ from docs
This allows shell commands to be copy and pasted easily
2017-04-09 10:36:27 +08:00

53 lines
637 B
Markdown

# Development
## Environment Setup
First clone the project
```bash
git clone https://github.com/jiahaog/nativefier.git
cd nativefier
```
Install dependencies
```bash
# OSX and Linux
npm run dev-up
# Windows
npm install
cd app
npm install
```
Don't forget to compile source files:
```bash
npm run build
```
You can set up symlinks so that you can run `nativefier` for your local changes
```bash
npm link
```
After doing so, you can then run Nativefier with your test parameters
```bash
nativefier <...>
```
Or you can automatically watch the files for changes with:
```bash
npm run watch
```
## Tests
```bash
npm test
```