Skip to content

Restructure dependencies #98

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 26, 2021
Merged

Restructure dependencies #98

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e75cd56
Move axios, lodash, etc. prod dependencies to dev + peer dependencies…
brandongregoryscott Feb 14, 2021
a8d0db2
Update README to reflect updated peer dependency usage and merge w/ e…
brandongregoryscott Feb 14, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 9 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,7 @@ yarn add andculturecode-javascript-core --dev
From there you can import the variety of modules.

```typescript
import {
CollectionUtils,
CoreUtils
} from "andculturecode-javascript-core";
import { CollectionUtils, CoreUtils } from "andculturecode-javascript-core";
```

You can also reference the global distribution package within a website which gives you access to the `AndcultureCode` namespace. See the example below
Expand All @@ -32,12 +29,17 @@ You can also reference the global distribution package within a website which gi
<script src="https://unpkg.com/browse/andculturecode-javascript-core@[version-number]/dist/global/index.js"></script>

<script>
var myAuthObject = AndcultureCode.RouteUtils.queryStringToObject('#token=bada55cafe')
var myAuthObject = AndcultureCode.RouteUtils.queryStringToObject(
"#token=bada55cafe"
);
</script>

```

**NOTE** - This source code relies on several peer dependencies, most of which are not included in this bundled global distribution. You will likely want to reference these in your website prior to referencing the `andculture-javascript-core` global package. See [test-global-distribution.html](./test-global-distribution.html) for the full list of dependencies. Also note that peer dependencies are only required if your code will be executing code paths that utilize any of those peer dependencies.
## Peer dependencies

This package wraps several external packages for our own configuration and ease of use, such as `axios`, `i18next`, `lodash`, etc. If you are using the standard distribution of this package, these will need to be installed alongside this package, even if you do not plan on leveraging features that rely on them.

If using the global distribution, you will likely want to reference these in your website prior to referencing this package. See [test-global-distribution.html](./test-global-distribution.html) for the full list of dependencies. Unlike the standard distribution, peer dependencies are only required if your code will be executing code paths that rely on those packages.

## Documentation

Expand Down
Loading