https://github.com/victor141516/mfus-node
My f****** URL shortener
https://github.com/victor141516/mfus-node
shortener url url-shortener
Last synced: 2 months ago
JSON representation
My f****** URL shortener
- Host: GitHub
- URL: https://github.com/victor141516/mfus-node
- Owner: victor141516
- Created: 2022-04-23T18:59:44.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2023-01-24T16:43:42.000Z (over 2 years ago)
- Last Synced: 2025-01-29T09:41:00.712Z (4 months ago)
- Topics: shortener, url, url-shortener
- Language: TypeScript
- Homepage: https://mfus.tk
- Size: 284 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# mfus.lol - Link shortener
This is a simple link shortener using an optimized-for-shortness-and-legibility short URL generation algorithm.
## Installation
### Development
There is a convenience script that runs docker-compose so that you can run the app and have hot reload (just for frontend for now) by running:
```sh
./run dev
```
Then you'll need to bootstrap the database. To do so, there is a migrations directory in `backend/migrations`. You'll have to feed the database with those files in order somehow.
### Production
It's the same as development, but the run command is the following:
```sh
./run
```
## Screenshots
## Roadmap
- [ ] Improve migration system
- [ ] Add hot reloading for backend
- [ ] Make a the URL hostname configurable (or dynamic)
- [ ] Add a backoffice for admins
- [ ] Add user registration support and user dashboard like [Pckd](https://github.com/Just-Moh-it/Pckd)