Create README.md

README.md

@@ -0,0 +1,62 @@
+## Project setup
+    git clone https://github.com/KrystianOg/PatientRegistrySystem.git
+    cd PatientRegistrySystem
+    python -m venv venv
+    venv\Scripts\activate
+    pip install -r requirements.txt
+    pip install -r requirements-dev.txt
+    python manage.py migrate
+
+
+# Wytyczne projektowe
+## 1. Temat projektu
+    Rejestracja pacjentów do lekarza przychodni specjalistycznej [?]
+## 2. Zawartość dokumentacji projektowej
+1. Wstępny opis projektu i uzasadnienie jego realizacji
+2. Wymawania funkcjonalne
+3. Wykorzystane technologie\
+    * Django\
+    * React\
+    * PostgreSQL\
+    * Mobilka [?] TODO: update that when we decide on mobile technology
+4. Harmnonogram implementacji\
+    * Stworzenie bazy danych\
+    * Stworzenie API\
+    * Stworzenie frontendu webowego\
+    * Stworzenie frontendu mobilnego\
+5. Architektura informacji\
+    * [Tutaj wkleić schemat bazy danych i jej opis] # TODO: update that
+6. Projekt interfejsu programistycznego\
+    * [Tutaj to nie wiem co ma być tbh..] # TODO: uddate that obviously
+7. Graficzny projekt interfejsu użytkownika\
+    * [Tutaj wkleić schemat interfejsu użytkownika] # TODO: update that
+8. Opis implementacji\
+    * [Tutaj wkleić opis implementacji] # TODO: update that\
+    * [Interfejs programistyczny, aplikacja mobilna, aplikacja webowa]
+9. Podsumowanie projektu\
+    * zrealizowane zalożenia\
+    * możliwość rozwoju projektu
+## 3. Kroki milowe projektu
+### 3.1 Wybor tematu projektu
+1. Sklad grupy:
+   * Krystian Ogonowski - 256307
+   * Paweł Krasicki - indeks
+2. Temat projektu
+3. Wstepny opis projektu (1-2 strony)
+4. Wymagania funkcjonalne
+5. Deklaracja technologii realizacji
+6. Harmonogram implementacji (Wykres Ganta)
+### 3.2 Architektura informacji i projekt interfejsu programistycznego
+1. Schemat bazy danych z tekstowym opisem każdej tabeli
+2. Techniczny opis interfejsu programistycznego lub jego wykorzystywanej części (API)
+3. Graficzny projekt interfejsu użytkownika wraz z zaznaczeniem relacji pomiędzy zaprojektowanymi widokami
+### 3.3 Graficzny projekt interfejsu użytkownika
+1. Techniczna dokumentacja oprogramowania realizowanego w ramach projektu.
+### 3.4 Raport końcowy i prezentacja - ostatnie zajęcia projektowe
+1. Spójny dokument zawierający wszystkie elementy z Sekcji 2. Dopuszczam oddanie projektu wcześniej niż na ostatnich zajęciach
+2. Prezentacja projektu
+## 4. Ocenianie
+ocena = 0.7P + 0.3W\
+
+Ocena z raportu końcowego i finalna ocena z projektu zostanie wystawiona na ostatnich zajęciach
+projektowych.