Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rampa2510/gitesy
A nodejs based cli which automates the creation of a local as well as remote repo on the code hosting websites
https://github.com/rampa2510/gitesy
cli command-line-tool javascript node-js nodejs terminal
Last synced: about 1 month ago
JSON representation
A nodejs based cli which automates the creation of a local as well as remote repo on the code hosting websites
- Host: GitHub
- URL: https://github.com/rampa2510/gitesy
- Owner: rampa2510
- License: mit
- Created: 2019-05-11T19:35:40.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-03T21:46:35.000Z (almost 2 years ago)
- Last Synced: 2024-10-01T08:17:01.504Z (about 2 months ago)
- Topics: cli, command-line-tool, javascript, node-js, nodejs, terminal
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/gitesy
- Size: 1.1 MB
- Stars: 4
- Watchers: 0
- Forks: 0
- Open Issues: 34
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# GITESY
> Automate your git workflow!!!
> Gone are the days when you used to create local and remote repo seperately
> Git , Github
[](https://developer.github.com/v3/) [](https://gitesy.com/) [](https://snyk.io/test/github/ram2510/gitesy?targetFile=package.json)
[](https://hits.dwyl.com/ram2510/gitesy)
[](https://saythanks.io/to/ram2510)
- devDependencies - 
- license - [](https://github.com/ram2510/gitesy/blob/master/LICENSE)
## Table of Contents
- [GITESY](#gitesy)
- [Table of Contents](#table-of-contents)
- [Example](#example)
- [Installation](#installation)
- [Clone](#clone)
- [Features](#features)
- [Usage](#usage)
- [Create a new repo](#create-a-new-repo)
- [Add a new template](#add-a-new-template)
- [Contributing](#contributing)
- [Prerequisites](#prerequisites)
- [Step 1](#step-1)
- [Step 2](#step-2)
- [Step 3](#step-3)
- [Ways to contribute](#ways-to-contribute)
- [Future plans](#future-plans)
- [Note -](#note)
- [Future plans](#future-plans )
---
## Example
```
gitesy -n
```
---
## Installation
Type this in your command prompt/terminal
```
npm i gitesy -g
```
please note - Install this as a global package otherwise this may not work as expected
---
### Clone
To clone this repo use
```
git clone https://github.com/ram2510/gitesy.git
```
When you clone this repo this is how your directory should look like
```
.
├── coverage
├── files
├── index.js
├── lib
├── LICENSE
├── node_modules
├── package.json
├── package-lock.json
├── README.md
└── templates
```
## Features
You can now create local as well as remote repo with a single command also you can use templates OR create your own template and add them
so that you can use it later
## Usage
### Create a new repo
- To create a local and remote repo use gitesy -n command with the name of the repo
```
gitesy -n test
```
- After which if you are using this for the first time you will see a prompt for entering your credentials like this
Enter them and then you will get prompts asking details of the repo fill them and then it will automatically create the repo. Then you will get the message and start working on the project !!!!
- If you are not using this for the first time you will see a prompt asking whether gitesy can use creds you entered previously
### Add a new template
- To Add a template create a template add the features and then use this command from the same directory
```
gitesy -a
```
---
## Contributing
> You can contribute to this project in various ways but let us follow the steps
### Prerequisites
> Install standard npm package you can learn more about it [here](https://standardjs.com)
```
npm install standard -g
```
> check whether the package is currently installed or not by using the command
```
standard -h
```
### Step 1
- **Option 1**
- 🍴 Fork this repo!
- **Option 2**
- 👯 Clone this repo to your local machine using `https://github.com/ram2510/gitesy.git`
### Step 2
- **HACK AWAY!** 🔨🔨🔨
### Step 3
- run the command ```npm run lint ``` which will run the standard --fix command as the script is mentioned in the package.json file. This will run the linter.
- 🔃 Create a new pull request using `https://github.com/ram2510/gitesy/compare/`.
### Ways to contribute
- Fix typo,
- Add documentation
- Add more templates. I am more experienced in node so i created node templates you can add other language templates and create a pr but please make the template in such a way that it tries to cover all genral cases
---
## Future plans
- [ ] Add suport for bitbucket and gitlab
- [ ] I am planning a feature where you can edit your package.json in your command line so that you don't need to configure it again
---
## Note -
If you are on a windows machine and you get an error stating that gitesy is not an internal recognised command you need to change your path to ```C:\Program Files\nodejs``` from ```C:\Users(your username)\AppData\Roaming\npm```. If the error still persists feel free to contact me
[](https://www.linkedin.com/in/ram2510) [](https://www.github.com/ram2510)