Skip to content

Commit 1c51b7f

Browse files
committed
Update Contribution.md
1 parent 859b00b commit 1c51b7f

File tree

1 file changed

+4
-51
lines changed

1 file changed

+4
-51
lines changed

Diff for: CONTRIBUTION.md

+4-51
Original file line numberDiff line numberDiff line change
@@ -4,66 +4,19 @@ For the coding style guide, we use AirBnB [rules](https://github.com/airbnb/java
44

55
### Clone the source to your computer
66

7-
In order to work with this package locally when using Meteor 1.3 project, follow these instructions:
7+
In order to work with this package locally when using Meteor project, follow these instructions:
88

99
1. Clone this repository to any folder.
1010
Note that if you clone into Meteor project directory - you need to put the cloned folder inside a hidden file, so Meteor won't try to
1111
build it! Just create a folder that starts with `.` under your project root, it should look like that:
1212
````
1313
MyProject
14-
.local-work
15-
angular2-meteor
14+
.local-packages
15+
angular-meteor
1616
.meteor
1717
client
1818
server
1919
public
2020
````
2121

22-
2. Make sure that you already have `node_modules` directory under your root, if not — create it:
23-
````
24-
$ mkdir node_modules
25-
````
26-
27-
Also, make sure that you have a NPM project initialized in your directory (you should have `package.json`), if not — use:
28-
````
29-
$ npm init
30-
````
31-
32-
3. Make sure that you do not have angular2-meteor already - check under `node_modules` — if you do, delete it.
33-
34-
4. Now you have two options, you can specify the local copy in the `package.json` of your project, as follow:
35-
````json
36-
{
37-
"dependencies": {
38-
"angular2-meteor": "./local-work/angular2-meteor"
39-
}
40-
}
41-
````
42-
43-
And then make sure to run the NPM install command:
44-
````
45-
$ npm install
46-
````
47-
48-
**Or, ** you can link the directory using NPM command like tool, as follow:
49-
```
50-
$ npm link ./local-work/angular2-meteor
51-
```
52-
53-
### Building the project from sources
54-
55-
In order to use your local copy of Angular2-Meteor, you have two options:
56-
57-
1. Import the TypeScript source code from the package, for example:
58-
59-
````
60-
import {MeteorComponent} from 'angular2-meteor/modules/meteor_component.ts';
61-
````
62-
63-
2. Or, you can keep the same code you have now, but you will need to build Angular2-Meteor source code each change you perform, by
64-
running `npm run build`.
65-
66-
### Troubleshoot
67-
68-
When working with local package, note that you should never have two local packages of `angular2` package, you should have it only under `node_modules/angular2` of the root directory.
69-
In case of weird errors regarding missing direcrtives - make sure that you do not have a copy of `angular2` package under `node_modules/angular2-meteor/node_modules/angular2`!
22+
2. Run your project with enviromental variable `METEOR_PACKAGES_DIR=your_packages_folder` directory under your root.

0 commit comments

Comments
 (0)