lil/README.md

1# lil - another url shortening service 2 3lil is a URL shortening service built with the promise of 4never saving any user-data. It uses random [captcha's](https://www.npmjs.com/package/svg-captcha) to validate users and a username of the user's choice to do user sessions. 5 6An instance of it can be found over at [one0.xyz](https://www.one0.xyz/). 7 8The [old branch](https://github.com/aktsbot/lil/tree/old) has the vue+sequelize codebase. 9 10## Getting started 11 12``` 13$ cp .env.example .env 14$ sqlite3 lil.db < sql/000-all-tables.sql 15$ npm i 16$ npm start 17``` 18 19Open http://localhost:3030. 20 21## Extras 22 231. Using lil from your terminal 24 25 Have `curl` installed on your machine. Then copy over `extras/lil` to somewhere 26 in your `$PATH`. 27 28 ``` 29 $ cp extras/lil ~/bin 30 $ # usage 31 $ lil "https://www.warp.dev/pricing" 32 $ lil "https://www.warp.dev/pricing" warp 33 ``` 34 35 To add your `~/bin` in your `$PATH`, put this in your `~/.profile` file 36 37 ```sh 38 [ -d $HOME/bin ] && export PATH="${HOME}/bin:${PATH}" 39 ``` 40 412. There is a sample `nginx` config in the `extras` folder. 42 433. Migrating from 1.0.0 to 2.0.0 44 45 Get the old database and then run 46 47 ``` 48 node extras/mig.js lil.old.db 49 ``` 50 51 This will insert all active urls and users from the old database into the current one.