Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tontonsb/photo-review
https://github.com/tontonsb/photo-review
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/tontonsb/photo-review
- Owner: tontonsb
- License: mit
- Created: 2024-05-05T19:30:08.000Z (8 months ago)
- Default Branch: master
- Last Pushed: 2024-07-14T19:01:07.000Z (6 months ago)
- Last Synced: 2024-07-15T18:21:09.455Z (6 months ago)
- Language: PHP
- Homepage: https://photoreview.glaive.pro
- Size: 14.4 MB
- Stars: 1
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PhotoReview
An app to split work of reviewing a lot of images.
Visitors can review images one by one, in random order.
At the moment of writing, app is live and in use here: https://photoreview.glaive.pro/
## Installation
You'll need git, PHP 8.3 and composer. Once you have them:
```sh
git clone https://github.com/tontonsb/photo-review.git
cd photo-review
composer install
composer quick-setup
```
## Running
Place some images or image folders in `storage/app/public/reviewables`,
register the new images in the database:
```sh
php artisan app:register-reviewables
# you can also store the image metadata in the database
# it will allow showing them on the map as well as remove the need for PHP to read the data every time
php artisan app:load-metadata
```
and launch the app:
```sh
php artisan serve
```
### Training images
Training/tutorial images should be put in the `tutorial` subfolder, then they
will not be included in the reviewing flow outside the tutorial.
To include images in the tutorial flow, you have to fill in the order field
(`tutorial_order`) in the database (`reviewables` tables). The displayable
texts can be specified in the `tutorial_info` field. There is no UI for
management of these values.
## Usage
The "public facade" is visible instantly.
The data "back" end is visible by visiting `/reviews`, nearly everything is
visible without logging in.
One can register by visiting `/register`. It will give no permissions, but
registered users are able to log in, log out and bind their progress to the account.
You can verify the registered users using CLI:
```sh
php artisan tinker
$user = User::where('email', '[email protected]')->first();
$user->verify();
```
or directly in the DB by putting the current timestamp in the `verified_at`.
The verified users are essentially admins — they can add comments to reviews,
change statuses, see the comment authors and see the review authors (if they
are registered).
## Development
Frontend development requires npm and some packages:
```sh
npm install
```
You can develop from then on and see live updates:
```sh
npm run dev
```
Or build the files to publish:
```sh
npm run build
```
## Production
### S3
To use files on a S3 compatible cloud, set `FILESYSTEM_REVIEWABLE=cloud_reviewables`
in your `.env` and fill in the `AWS_*` values.
### Database
The default setup uses SQLite. You can change it, the DB config works like on
any default Laravel app and we've tried not to use any vendor-specific SQL.
> [!NOTE]
> Project has been tried and is being used on MariaDB and SQLite.
### Matomo
This app has a Matomo integration, so fill in `MATOMO_URL` and `MATOMO_SITE_ID`
if you do have a Matomo instance and want to use it.
## TODO (sry, only in LV)
- [ ] Varētu reviewerim arī izmantot [Pico](https://picocss.com/s):
`@import '@picocss/pico';`, vienīgi layouts no jauna jātaisa un dialogam
markups jālabo. Tad būtu smukāks dizains un natīva darkmode atbalstītos...
- [x] Vajag iespēju ierakstīt pārbaudes rezultātu.
- [x] Varētu ieglabāt datubāzē bilžu metadatus nevis ģenerēt atvēršanas brīdī.
- [ ] Rodas vajadzība meklēt bildes pēc vietas, lai apskatītu vietu no cita leņķa.
- [x] Vai varbūt kāds vieglāks piegājiens ar "5 šai tuvākās bildes"? Minikartē atzīmēt ar linkiem? Pie saistītajām pielikt?
- [x] Kaut kur parādīt indikāciju, ka ir atlikti marķieri, jo viegli ielikt nejauši.
- [x] Pārskatījumu filtru pārtaisīt — rādīt jebko ar info. Un info vietā mby tikai ikonas 💬⚠️📌
- [x] Marķierus jāpadara redzamākus.
- [ ] Instrukcija "backend" sadaļām?
- [ ] Paroles atjaunošana.
- [ ] Atsevišķa sadaļa — fullscreen karte ar bilžu noseguma attēlojumu un linkiem uz bildēm.
- [ ] Pielikt /map arī nostaigātās līnijas.