-
Notifications
You must be signed in to change notification settings - Fork 11
Contributing
Édes Balázs edited this page Feb 13, 2016
·
2 revisions
#contributing
###requirements:
- You need git, node.js, NPM and Atom to be instaled.
-
npm install -g typescript
- This package is written in TypeScript -
npm install -g gulp
- gulp is used to (continously) build.ts
files. -
npm install -g typings
- typings is used to pull in TypeScript definitions of commonly used js libraries
###start development:
-
git clone https://github.com/bali182/autocomplete-json.git
- Clone the repo -
cd autocomplete-json
- Go to the freshly cloned folder. -
npm install
- Installs NPM dependencies. -
typings install
- Installs TypeScript definitions. -
apm link .
- This will tell Atom, to include this package. -
gulp watch
- Watches for all.ts
and.json
file changes inlib
.
###Preferably in another terminal/console
-
cd folder-with-json-files
- Go to a folder, where your test json files are. -
atom -d .
- Start Atom in this folder in development mode. -
CTRL (CMD) + ALT + I
- Open developer console.
###before pull request:
-
gulp build
- Cleans then populates thedist
folder. - Preferably squash the commits you worked on.