-
Notifications
You must be signed in to change notification settings - Fork 136
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
163f4e6
commit cfaa9f2
Showing
1 changed file
with
8 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,14 +1,16 @@ | ||
# `expensify-common` | ||
This is a collection of JS libraries and components which are used across various Expensify projects. These libraries are provided as-is, and the repos which use them will need to do their own bundling, minifying, and uglifying. | ||
This is a collection of JS/TS libraries and components which are used across various Expensify projects. These libraries are provided as-is, and the repos which use them will need to do their own bundling, minifying, and uglifying. | ||
|
||
# Installation | ||
1. Clone this repo to a directory of your choosing | ||
2. Run `npm install` to install all the dependencies | ||
`expensify-common` is published to [`npm`](https://www.npmjs.com/package/expensify-common) | ||
|
||
```shell | ||
npm install expensify-common | ||
``` | ||
|
||
# Development | ||
* Write all code as ES6. | ||
* Always lint your code with `npm run grunt watch` | ||
* Make sure you're using http://editorconfig.org/ | ||
* Always lint your code with `npm run lint` | ||
|
||
## Testing your code while you are developing | ||
The best way to test your code while you are developing changes is via `npm link`. | ||
|
@@ -28,7 +30,7 @@ Alternatively, you can edit files directly in a project's `node_modules` then ap | |
1. They will review and accept your changes, merge them, then deploy a new version | ||
|
||
# Deploying a Change (Expensify Only) | ||
Once the PR has been merged, update the `package.json` commit hash in any repos with a dependency on the code being changed in expensify-common, don't forget to run a `npm install` so `package-lock.json` is also updated. Be sure to check the repos below to confirm whether or not they are affected by your changes! | ||
Once the PR has been merged, install the new version of the package with `npm install [email protected]` command. Be sure to check the repos below to confirm whether or not they are affected by your changes! | ||
- Expensify/Web-Expensify | ||
- Expensify/Web-Secure | ||
- Expensify/Mobile-Expensify | ||
|