Skip to content

Commit

Permalink
chore: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
bemolxd authored Oct 22, 2022
1 parent 8d634ac commit 268b5e1
Showing 1 changed file with 20 additions and 4 deletions.
24 changes: 20 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,32 @@

Aplikacja stworzona w ramach pracy dyplomowej pt. "Opracowanie serwisu do rezerwacji i wypożyczeń sprzętu w Katedrze Systemów Multimedialnych".

## Założenia projektowe
## Funkcjonalność

Opracowanie serwisu ma na celu poprawę i usystematyzowanie procesu wypożyczania i rezerwacji sprzętu, w którego posiadaniu jest KSM. Po stronie zwykłego użytkownika system zapewnia `TODO`. Po stronie administratora (pracownika Katedry) system pozwala na `TODO`.
Opracowanie serwisu ma na celu poprawę i usystematyzowanie procesu wypożyczania i rezerwacji sprzętu, w którego posiadaniu jest KSM. Po stronie zwykłego użytkownika system zapewnia:

- wgląd do bazy urządzeń KSM,
- możliwość sprawdzenia dostępności sprzętu,
- możliwość stworzenia (poprzez dodanie urządzenia) zgłoszenia i przesłania go do pracownika KSM,
- wgląd do wszystkich swoich aktywnych i/lub kompletowanych zgłoszeń,
- wgląd do wszystkich swoich archiwalnych zgłoszeń.

Po stronie administratora (pracownika Katedry) system pozwala na:

- wgląd do bazy urządzeń KSM i modyfikowanie zawartości (dodawanie, edytowanie, usuwanie),
- możliwość sprawdzenia dostępności sprzętu,
- możliwość zarządania zgłoszeniami (odrzucanie, akceptacja -> finalizacja),
- wgląd do wszystkich przesłanych zgłoszeń,
- wgląd do wszystkich zarchiwizowanych zgłoszeń,
- wgląd do wszystkich użytkowników systemu i zarządzanie ich uprawnieniami,
- wgląd do wszystkich zgłoszeń danego użytkownika (widok szczegółu użytkownika).

## Uruchamianie aplikacji

W celu poprawnego uruchomienia aplikacji w środowisku testowym należy upewnić się, że usługa [API](https://github.com/bemolxd/swir-api) jest dostępna oraz ustawić odpowiednie parametry w pliku `.env`:
W celu poprawnego uruchomienia aplikacji w środowisku testowym należy upewnić się, że usługa [API](https://github.com/bemolxd/swir-api) jest dostępna oraz ustawić odpowiednie parametry w pliku `.env`, na przykład:

```
REACT_APP_API_URL='api_url'
REACT_APP_API_URL='http://localhost:5000'
REACT_APP_CLIENT_URL='http://localhost:5001'
```

Expand Down

0 comments on commit 268b5e1

Please sign in to comment.