readme: development instructions

This commit is contained in:
Annika Backstrom 2024-05-25 16:00:47 +01:00
parent b5a1d7b0d4
commit b6ac33f73e
Signed by: annika
GPG Key ID: 3561F004DE1D9AFE

View File

@ -15,9 +15,46 @@ A little project because I haven't made anything new in a while, I would like to
* [ ] Tag permalink
* [ ] Multi-user support
## 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
php artisan migrate
```
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
```
### 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`.
## License
This project is copyright ©2024 Annika Backstrom.
This project is Copyright ©2024 Annika Backstrom.
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as