# Lumière (introduction)
This project aims to deliver a service to stream videos from a server to many devices.

The UI should be very simple and display films and series.

# User types
There are two types of users:
- administrator
  - can manage films and series
  - can manage users
- user (simple user)
  - can watch films and series

# Watching history
When a user watches a film or a series episode, the application registers each video progress, and if the user has already watched the video or not.

This last indicator can be reset (in case when the user wants to re-watch a series from the beginning).

# Adding films or series
At the first installation, the administrator has to define a folder path in the `.env` file. This folder path will be designated as "root folder" for the rest of this file.

Film and series files have to be copied in the root folder.

For series, the administrator has to create one folder in the root folder, and one folder inside this per season. 

## Examples
### Root folder
`/opt/lumière/files`

### Adding a film
- Film name: `Lord of the rings 1`
- Film filename: `lord_of_the_rings_1.mkv`
- File location: `/opt/lumière/files/lord_of_the_rings_1.mkv`

### Grouping films
To group films, create a folder in the root folder, and put the film files in it.

- Films to group:
  - `Lord of the rings 1`
    - Film filename: `lord_of_the_rings_1.mkv`
    - File location: `/opt/lumière/files/lord_of_the_ring/lord_of_the_rings_1.mkv`
  - `Lord of the rings 2`
      - Film filename: `lord_of_the_rings_2.mkv`
      - File location: `/opt/lumière/files/lord_of_the_ring/lord_of_the_rings_2.mkv`
  - `Lord of the rings 3`
      - Film filename: `lord_of_the_rings_3.mkv`
      - File location: `/opt/lumière/files/lord_of_the_ring/lord_of_the_rings_3.mkv`

### Series
Do the same thing as grouping films, but create sub folders for each season in the series name.

- Series name: `Young Sheldon`
  - Season 1:
    - Episode 1
      - Filename: `young_sheldon_S1_E1.mkv`
      - File location: `/opt/lumière/files/young_sheldon/season_1/young_sheldon_S1_E1.mkv`
    - Episode 2
        - Filename: `young_sheldon_S1_E2.mkv`
        - File location: `/opt/lumière/files/young_sheldon/season_1/young_sheldon_S1_E2.mkv`
    - etc.
  - Season 2:
      - Episode 1
          - Filename: `young_sheldon_S2_E1.mkv`
          - File location: `/opt/lumière/files/young_sheldon/season_2/young_sheldon_S2_E1.mkv`

# Adding film or series covers
Just put the picture's file aside the film or series episode video file.

## Example
- Film name: `Lord of the rings 1`
- Film filename: `lord_of_the_rings_1.mkv`
- File location: `/opt/lumière/files/lord_of_the_rings_1.mkv`
- Cover filename: `lord_of_the_rings_1.png`
- Cover file location: `/opt/lumière/files/lord_of_the_rings_1.png`