poeti8
40d7e0f8ea
2.4.6
|
5 年之前 | |
|---|---|---|
| client | 5 年之前 | |
| docs | 5 年之前 | |
| server | 5 年之前 | |
| static | 5 年之前 | |
| .babelrc | 6 年之前 | |
| .docker.env | 5 年之前 | |
| .dockerignore | 5 年之前 | |
| .eslintignore | 6 年之前 | |
| .eslintrc | 6 年之前 | |
| .example.env | 5 年之前 | |
| .gitignore | 6 年之前 | |
| .prettierrc | 6 年之前 | |
| .template.env | 6 年之前 | |
| .travis.yml | 5 年之前 | |
| Dockerfile | 5 年之前 | |
| LICENSE | 6 年之前 | |
| MIGRATION.md | 6 年之前 | |
| README.md | 5 年之前 | |
| docker-compose.yml | 5 年之前 | |
| global.d.ts | 5 年之前 | |
| knexfile.ts | 5 年之前 | |
| next.config.js | 5 年之前 | |
| nodemon.json | 6 年之前 | |
| package-lock.json | 5 年之前 | |
| package.json | 5 年之前 | |
| tsconfig.json | 6 年之前 | |
| wait-for-it.sh | 5 年之前 |
README.md
Kutt.it
Kutt is a modern URL shortener with support for custom domains. Shorten URLs, manage your links and view the click rate statistics.
Contributions and bug reports are welcome.
Migration from v1
The new version of Kutt is here. In version 2, we used TypeScript and we moved from Neo4j to PostgreSQL database in favor of performance and we're working on adding new features.
If you're coming from v1, refer to MIGRATION.md to migrate data from Neo4j to PostgreSQL.
Table of Contents
Key Features
- Free and open source.
- Custom domain support.
- Custom URLs for shortened links
- Setting password for links.
- Private statistics for shortened URLs.
- View and manage your links.
- RESTful API.
Stack
- Node (Web server)
- Express (Web server framework)
- Passport (Authentication)
- React (UI library)
- Next (Universal/server-side rendered React)
- Easy Peasy (State management)
- styled-components (CSS styling solution library)
- Recharts (Chart library)
- PostgreSQL (database)
- Redis (Cache layer)
Setup
You need to have Node.js, PostgreSQL and Redis installed.
- Clone this repository or download zip.
- Copy
.example.envto.envand fill it properly. - Install dependencies:
npm install. - Run for development:
npm run dev. - Run for production:
npm run buildthennpm start.
Docker
You need to run the app with the required envrironment variables listed in .example.env.
- Official Docker hub image.
- Or simply run
docker-compose upcommand and then the app should be ready on port "3000".
Browser Extensions
Download Kutt's extension for web browsers via below links. You can also find the source code on kutt-extension.
API
Visit API v2 documentation on docs.kutt.it
Integrations
ShareX
You can use Kutt as your default URL shortener in ShareX. If you host your custom instance of Kutt, refer to ShareX wiki on how to setup.
Alfred Workflow
Download Kutt's official workflow for Alfred app from alfred-kutt repository.
3rd Party packages
| Language | Link | Description |
|---|---|---|
| C# (.NET) | KuttSharp | .NET package for Kutt.it url shortener |
| Python | kutt-cli | Command-line client for Kutt written in Python |
| Ruby | kutt.rb | Kutt library written in Ruby |
| Rust | urlshortener | URL shortener library written in Rust |
| Rust | kutt-rs | Command line tool written in Rust |
| Node.js | node-kutt | Node.js client for Kutt.it url shortener |
| JavaScript | kutt-vscode | Visual Studio Code extention for Kutt |
| Java | kutt-desktop | A Cross platform Java desktop application for Kutt |
| Go | kutt-go | Go client for Kutt.it url shortener |
Contributing
Pull requests are welcome. You'll probably find lots of improvements to be made.
Open issues for feedback, requesting features, reporting bugs or discussing ideas.