https://github.com/vanajmoorthy/caddy
🚗 An NPM package to automate the process of initialising a repo on GitHub.
https://github.com/vanajmoorthy/caddy
cli github npm
Last synced: 9 months ago
JSON representation
🚗 An NPM package to automate the process of initialising a repo on GitHub.
- Host: GitHub
- URL: https://github.com/vanajmoorthy/caddy
- Owner: vanajmoorthy
- License: mit
- Created: 2020-05-15T08:58:33.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-27T02:03:18.000Z (about 3 years ago)
- Last Synced: 2025-05-09T03:16:45.228Z (9 months ago)
- Topics: cli, github, npm
- Language: JavaScript
- Homepage:
- Size: 324 KB
- Stars: 4
- Watchers: 0
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Caddy 🚗
## It's Git, init?
### Table of contents
1. [Intro](#intro)
2. [Installation](#installation)
3. [Running Caddy](#running-caddy)
4. [About the name](#about-the-name)
5. [Can I contribute?](#can-i-contribute)
6. [License](#license)
### Intro
Caddy is a super small npm package to make initialising repositories on GitHub much easier.
Without Caddy, initialising a repository takes at least X steps
1. Open GitHub in your browser and navigate to your profile.
2. Create a new repository.
3. Run `git init` in a folder on your laptop.
4. Stage your files.
5. Write a commit message.
6. Add your GitHub repo as a remote url.
7. Push your code.
Sounds tedious, doesn't it?
Well with Caddy all of that can be reduces to one friendly command.
(Caddy can also be found on [npm](https://www.npmjs.com/package/@vanajmoorthy/caddy))
### Installation
Install Caddy via npm using the command
`npm install @vanajmoorthy/caddy -g`
### Running Caddy
Caddy is super simple to run. Just type in Caddy in your terminal, provide your GitHub credentials, and let Caddy do the rest!
Then you just input the your repo name and description.
_PS: Caddy even generates a custom .gitignore for you with the files of your choice!_
### About the name
**This is very stupid**
Caddies _support_ you. Just like this tool does.
And the first _automatic_ car ever released was a Cadillac, and this tool automates creating a GitHub repository for you.
To be entirely honest, I'm very up to name suggestions.
### Can I contribute?
I would absolutely love that! You can submit any pull requests you want, any added functionality or optimisation would be welcomed. I was also looking forward to bringing similar versions of Caddy to other native package managers, so any help with that would be great as well!
### License
Caddy lives under the MIT license