https://github.com/codeclimate/create-codeclimate-connector
Template for Code Climate Connectors
https://github.com/codeclimate/create-codeclimate-connector
engineering-data-platform velocity
Last synced: 3 months ago
JSON representation
Template for Code Climate Connectors
- Host: GitHub
- URL: https://github.com/codeclimate/create-codeclimate-connector
- Owner: codeclimate
- License: apache-2.0
- Created: 2020-02-26T17:00:00.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2022-04-03T20:43:36.000Z (almost 4 years ago)
- Last Synced: 2025-07-08T20:06:36.211Z (7 months ago)
- Topics: engineering-data-platform, velocity
- Language: TypeScript
- Homepage: https://github.com/codeclimate/platform
- Size: 156 KB
- Stars: 6
- Watchers: 9
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Code Climate Connector Scaffolding
Create a new Code Climate Connector
## Getting Started
### Create your Connector package
#### Yarn
`yarn create codeclimate-connector `
#### npx
`npx create-codeclimate-connector `
### Implementing
Running one of the above commands will create a project in the directory
`codeclimate-connector-`. The project will be setup with some
scaffolding and stubbed unit tests, and is setup to use TypeScript.
To start implementing logic, take a look at the created `src/Client.ts` in your
project. You can also refer to the created `README.md` for some suggestions on
how to proceed.