urlsnail/README.md

79 lines
2.0 KiB
Markdown
Raw Normal View History

2024-05-25 14:25:37 +00:00
# url snail
2024-05-24 20:07:22 +00:00
2024-05-25 14:25:37 +00:00
A little project because I haven't made anything new in a while, I would like to learn Laravel, and maybe I don't need to use Pinboard.in any more.
2024-05-24 20:07:22 +00:00
2024-05-25 14:29:18 +00:00
![Screenshot of the bookmark index in url snail](https://i.abackstrom.com/share/urlsnail/screenshots/2024-05-25.webp)
2024-05-25 14:25:37 +00:00
## Ideas
2024-05-24 20:07:22 +00:00
2024-05-25 14:25:37 +00:00
* [x] Import from Pinboard.in JSON export
* [x] Bookmark permalink
* [x] Bookmark index
2024-05-25 17:21:34 +00:00
* [x] Bookmark pagination
2024-05-26 13:42:20 +00:00
* [x] Bookmark editing (title, description, url)
2024-05-29 21:07:23 +00:00
* [x] Bookmark tag editing
2024-05-30 19:24:50 +00:00
* [ ] Create new bookmark
2024-05-25 14:25:37 +00:00
* [ ] Tag cloud
2024-05-29 21:26:05 +00:00
* [x] Tag permalink
2024-05-25 14:25:37 +00:00
* [ ] Multi-user support
2024-05-24 20:07:22 +00:00
2024-05-25 15:00:47 +00:00
## Developing
Get the code:
```
git clone https://git.abackstrom.com/annika/urlsnail.git
cd urlsnail
```
Set up the Laravel `.env` file and SQLite database:
```
composer install
cp .env.example .env
php artisan key:generate
2024-05-26 21:53:09 +00:00
php artisan migrate # database schema
2024-05-25 15:00:47 +00:00
```
Build the CSS with Vite:
```
npm install
npm run build # `npm run dev` if you want css live reloading
```
Start the web server:
```
php artisan serve
```
2024-05-26 21:53:09 +00:00
If you need to process queued jobs (e.g. import bookmarks):
```
php artisan queue:work -v
```
2024-05-25 15:00:47 +00:00
### Laravel Herd
If you have [Laravel Herd](https://herd.laravel.com/) installed, you can clone the repository to one of your Herd
paths (e.g. `~/Herd`) and view the site at [http://urlsnail.test](http://urlsnail.test), no need
to run `php artisan serve`.
2024-05-25 14:25:37 +00:00
## License
2024-05-24 20:07:22 +00:00
2024-05-25 15:00:47 +00:00
This project is Copyright ©2024 Annika Backstrom.
2024-05-24 20:07:22 +00:00
2024-05-25 14:25:37 +00:00
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as
published by the Free Software Foundation, either version 3 of the
License, or (at your option) any later version.
2024-05-24 20:07:22 +00:00
2024-05-25 14:25:37 +00:00
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
2024-05-24 20:07:22 +00:00
2024-05-25 14:25:37 +00:00
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.