https://github.com/ordercloud-api/angular-cms-components
⛔️ DEPRECATED - NO LONGER MAINTAINED
https://github.com/ordercloud-api/angular-cms-components
angular ordercloud ordercloud-cms-api
Last synced: 3 months ago
JSON representation
⛔️ DEPRECATED - NO LONGER MAINTAINED
- Host: GitHub
- URL: https://github.com/ordercloud-api/angular-cms-components
- Owner: ordercloud-api
- Created: 2020-07-16T15:26:28.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-12T20:51:28.000Z (about 3 years ago)
- Last Synced: 2025-06-01T21:15:52.214Z (10 months ago)
- Topics: angular, ordercloud, ordercloud-cms-api
- Language: TypeScript
- Homepage: https://ordercloud-api.github.io/angular-cms-components
- Size: 13.2 MB
- Stars: 0
- Watchers: 8
- Forks: 9
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](http://unmaintained.tech/)
# DEPRECATED
This project is no longer maintained.
## Requirements
* Angular version 10 - may work with older versions but has not been tested
## Installation
1. Install the component library
```
npm i --save @ordercloud/angular-cms-components@beta
```
2. Install the required peer dependencies
```
npm i --save bootstrap @ng-bootstrap/ng-bootstrap tinymce @tinymce/tinymce-angular axios case jquery @ordercloud/headstart-sdk ordercloud-javascript-sdk ngx-spinner
```
3. In your module import either `CmsAdminModule` for access to admin/buyer components or `CmsBuyerModule` for just the buyer components. Here we're registering `CmsAdminModule` for access to all components
```typescript
import { CmsAdminModule, Configuration } from '@ordercloud/angular-cms-components';
@NgModule({
declarations: [...],
imports: [
CmsAdminModule,
...
],
providers: [...],
bootstrap: [AppComponent]
})
export class AppModule {}
```
If your app uses the [shared module pattern](https://www.pluralsight.com/guides/using-shared-modules-in-angular) you'll want to import it in your shared module *instead* (don't forget to export it as well)
```typescript
import { CmsAdminModule, Configuration } from '@ordercloud/angular-cms-components';
@NgModule({
declarations: [...],
imports: [
CmsAdminModule,
...
],
exports: [
CmsAdminModule,
...
],
providers: [...],
})
export class SharedModule {}
```
4. In angular.json add an entry to the assets array
- `{"glob": "**/*","input": "node_modules/tinymce","output": "/tinymce/"}`
5. In the root of your app import tinymce and the ordercloud plugin for tinymce
- ```typescript
import 'tinymce/tinymce';
import '@ordercloud/angular-cms-components/plugin.min.js';
```
Now you can use any of the components in your application
## 🚀 Releasing
Assuming you are a maintainer you can follow these instructions to release a new version of the library.
1. Add and commit your changes
2. Run `npm run build` to build docs
3. Verify the version has been bumped and adheres to [semantic versioning](https://semver.org/).
- Version should be updated in both package.json and projects/lib/package.json.
- Version update should be its own commit
- Use following format for the commmit: `:bookmark: {VERSION}`
4. Push changes to master
5. Create and publish a new release on github
6. Publish on npm by running `npm run publish-please`
- Defaults to pre-release. It is recommended to do a pre-release first to vet changes
- For normal releases update the `publishTag` in `.publishrc` to `latest` and then run `npm run publish-please`
7. Have a beer!
If you need to override `publish-please` and just use `npm publish` you can do so by first removing `"prepublishOnly": "publish-please guard"` from package.json and then running `npm publish`
## 👨💻👩💻 Developer Setup (as of 8/13/2020)
1. To start, [clone the repo](https://github.com/ordercloud-api/angular-cms-components).
2. Next, you need to set the token, manually. Login to [OC Portal](https://portal.ordercloud.io/console) and impersonate the user whose context you are using for development.
3. With the `Network` tab open, send a `/me` request and view the `Authorization` field within the Headers section.
4. Copy the token after "Bearer".
5. Now navigate to line 10 in [storybook-base-configuration.ts](projects/lib/src/stories/storybook-base-configuration.ts) and replace the existing token.
**Keep in mind:** this token will expire, so you will need to repeat this process.