https://github.com/octokit/create-octokit-project.js
"npm init" script to create a new Octokit JS module
https://github.com/octokit/create-octokit-project.js
hacktoberfest octokit-js tooling
Last synced: 7 months ago
JSON representation
"npm init" script to create a new Octokit JS module
- Host: GitHub
- URL: https://github.com/octokit/create-octokit-project.js
- Owner: octokit
- License: mit
- Created: 2019-10-11T19:04:02.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2025-05-20T06:23:28.000Z (8 months ago)
- Last Synced: 2025-05-20T06:28:26.344Z (8 months ago)
- Topics: hacktoberfest, octokit-js, tooling
- Language: JavaScript
- Homepage:
- Size: 1.37 MB
- Stars: 17
- Watchers: 7
- Forks: 15
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# Create new Octokit JS project
> "[npm init](https://docs.npmjs.com/cli/v7/commands/npm-init)" script to create a new folder and repository for an Octokit JavaScript module (plugin, authentication strategy, or otherwise)
## Usage
```shell
npm init octokit-project
```
## What it does
- Creates a new folder on your machine
- Inits git in the new folder
- Add `LICENSE`, `CODE_OF_CONDUCT.md` and `README.md` files
- Creates a repository
- Adds repository as `git remote add origin `
- Push the 3 files to main
- Creates a new local branch called `initial-version`
- Creates a `package.json` and `package-lock.json`. Installs dev dependencies.
- Creates `.gitignore`, `tsconfig.json`
- Creates `test/smoke.test.ts`
- Creates actions for tests and automated releases
- Creates a pull request with further instructions
- Adds branch protection
## Contribute
Pull requests welcome! My longer term goal is to make this script useful for Octokit Plugin developers.
## License
[MIT](LICENSE)