https://github.com/1407arjun/cli-shorturl-template
A personalised CLI-based URL shortner using GitHub actions and Next.js
https://github.com/1407arjun/cli-shorturl-template
cli github-actions nextjs template url-shortener
Last synced: 2 months ago
JSON representation
A personalised CLI-based URL shortner using GitHub actions and Next.js
- Host: GitHub
- URL: https://github.com/1407arjun/cli-shorturl-template
- Owner: 1407arjun
- License: gpl-3.0
- Created: 2022-06-28T09:23:36.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2022-07-15T10:34:12.000Z (about 4 years ago)
- Last Synced: 2025-02-15T08:31:09.884Z (over 1 year ago)
- Topics: cli, github-actions, nextjs, template, url-shortener
- Language: JavaScript
- Homepage:
- Size: 46.9 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# cli-shorturl
A personalised CLI-based URL shortner using GitHub actions and Next.js
## Setup
> All registered URLs are stored in `urls.json`
### Add the environment variables to your `.bashrc` or `.zshrc`
```sh
export GITHUB_PAT=
export BASE_URL=
```
### Add the package to `PATH`
```sh
cd url-shortner
npm link
```
### Update your Git config in `.github/workflows/ci.yml`
```sh
git config --global user.email ""
git config --global user.name ""
```
### Deployment
[](https://vercel.com/new/git/external?repository-url=https%3A%2F%2Fgithub.com%2F1407arjun%2Fcli-shorturl-template%2Ftree%2Fmain)
## Getting started
### Adding a URL
```sh
shorturl add
```
### Removing a URL
```sh
shorturl remove
```
### Listing all registered URLs
```sh
shorturl list
```
### Checking a URL
```sh
shorturl check all
```
### Checking for a particular URL field
```sh
shorturl check
```