From 2f054927db9c12ba1198bfed0e628e0c5cdf764b Mon Sep 17 00:00:00 2001 From: Gregorio Chiko Putra Date: Sat, 23 Sep 2017 14:01:26 +0700 Subject: [PATCH] Added unfinished README --- README.md | 46 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 46 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..b8dd34f --- /dev/null +++ b/README.md @@ -0,0 +1,46 @@ +# Dokumentasi +Aplikasi berbasis web yang bertujuan menampilkan informasi berupa pengumuman kepada seluruh pihak pada [**Perguruan Tinggi LEPISI**][8c020676]. + + [8c020676]: http://lepisi.ac.id "LEPISI" + +## Tampilan + +### Tampilan Awal +Halaman yang pertama kali ditampilkan adalah halaman yang menampilkan pengumuman dalam ukuran teks yang besar. Jika jumlah pengumuman lebih dari 1, maka setiap pengumuman akan ditampilkan dengan metode animasi bergeser.
+Halaman inilah yang ditampilkan ke umum. + +#### Navigasi +Secara kasat mata, terlihat tidak ada tombol navigasi pada halaman awal. Tetapi, telah tersedia tombol untuk _masuk_ untuk _user_ yang memiliki hak untuk mengubah/menambahkan/menghapus sebuah pengumuman.
+Tombol ini berada di sisi kanan atas halaman, jika user mengarahkan kursor ke sisi tersebut, maka tombol tersebut akan terlihat. + +#### Resolusi +Seluruh halaman ditampilkan dalam bentuk `full-screen`, sehingga menyesuaikan ukuran layar. + +### Halaman Login/Masuk +Pada halaman ini, pengguna dapat memasukkan data akun mereka (`username` dan `password`) untuk mendapatkan hak akses untuk mengubah/menambahkan/menghapus pengumuman. + +### Halaman Administrator +Setelah pengguna memasukkan data dengan benar, maka pengguna akan dialihkan ke halaman awal dengan tampilan yang berbeda.
+Pada halaman ini ditampilkan seluruh pengumuman yang telah dibuat dalam bentuk `stack` atau berupa kotak-kotak. Pada halaman ini juga terdapat 2 navigasi yaitu `primary` dan `secondary`. + +#### Navigasi + +##### Primary +Tersedia tombol `home` pada sisi kiri atas.
+> NB: Pada _mobile view_, navigasi _primary_ tersembunyi oleh tombol _menu_ (3 garis horizontal) pada sisi kanan atas. + +###### Hak Akses User +Terdapat tombol _keluar_ yang terletak pada sisi kanan atas, yang berfungsi untuk melepaskan hak akses dari pengguna (`logout`). + +###### Hak Akses Root +Terdapat 3 tombol yang terletak pada sisi kanan atas, yaitu _kategori_, _user_, dan _keluar_.
+Tombol _kategori_ berfungsi untuk mengalihkan pengguna ke halaman _Kategori_.
+Tombol _user_ berfungsi untuk mengalihkan pengguna ke halaman registrasi _user_ baru. +Tombol _keluar_ berfungsi untuk melepaskan hak akses dari pengguna (`logout`). + +##### Secondary +Navigasi ini berupa 4 tombol _sortir (Semua, Aktif, Belum Aktif, Nonaktif)_, yang berguna untuk _men-sortir_ pengumuman yang ingin ditampilkan berdasarkan status pengumuman tersebut. + +#### Daftar Pengumuman +Setiap pengumuman ditampilkan dalam bentuk sebuah kotak yang memiliki warna sesuai warna dari kategori pengumuman tersebut.
+Posisi kotak paling kiri/awal (berbentuk +) merupakan tombol untuk menambahkan atau membuat pengumuman baru.