Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jupiterone/graph-nowsecure
A graph conversion tool for https://www.nowsecure.com/
https://github.com/jupiterone/graph-nowsecure
Last synced: 7 days ago
JSON representation
A graph conversion tool for https://www.nowsecure.com/
- Host: GitHub
- URL: https://github.com/jupiterone/graph-nowsecure
- Owner: JupiterOne
- License: mpl-2.0
- Created: 2020-05-20T23:22:38.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-01-02T19:12:39.000Z (11 months ago)
- Last Synced: 2024-01-02T20:27:01.657Z (11 months ago)
- Language: TypeScript
- Homepage:
- Size: 384 KB
- Stars: 0
- Watchers: 14
- Forks: 3
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# graph-nowsecure
## Development Environment
### Prerequisites
You must have Node.JS installed to run this project. If you don't already have
it installed, you can can download the installer
[here](https://nodejs.org/en/download/). You can alternatively install Node.JS
using a version manager like [fnm](https://github.com/Schniz/fnm) or
[nvm](https://github.com/nvm-sh/nvm).
### Setup
#### Installing dependencies
From the root of this project, run `npm install` to install dependencies. If you
have `yarn` installed, you can install dependencies by running `yarn`.
#### Loading credentials
Create a `.env` file at the root of this project and add environment variables
to match what is in `src/instanceConfigFields.json`. The `.env` file is ignored
by git, so you won't have to worry about accidentally pushing credentials.
Given this example configuration:
```json
{
"apiToken": {
"type": "string",
"mask": true
}
}
```
You would provide a `.env` file like this:
```bash
API_TOKEN=
```
The snake cased environment variables will automatically be converted and
applied to the camel cased configuration field. So for example, `CLIENT_ID` will
apply to the `clientId` config field, `CLIENT_SECRET` will apply to
`clientSecret`, and `MY_SUPER_SECRET_CONFIGURATION_VALUE` will apply to a
`mySuperSecretConfigurationValue` configuration field.
## Running the integration
To start collecting data, run `yarn start` from the root of the project. This
will load in your configuration and execute the steps stored in `src/steps`.
## Project structure
This is the expected project structure for running integrations.
```
src/
/instanceConfigFields.json
/validateInvocation.ts
/getStepStartStates.ts
steps/
exampleStep.ts
// add additional steps here
```
Each of the files listed above contribute to creating an
[integration configuration](https://github.com/JupiterOne/integration-sdk/blob/master/docs/development.md#the-integration-framework).
Additional files can be placed under `src` and referenced from each of the
integration files.
The template project hosted
[here](https://github.com/JupiterOne/integration-sdk/tree/master/template)
provides a simple example of how an integration can be setup.
## Development Docs
Please reference the `@jupiterone/integration-sdk`
[development documentation](https://github.com/JupiterOne/integration-sdk/blob/master/docs/development.md)
for more information on how to build integrations.