Added unfinished README

This commit is contained in:
Gregorio Chiko Putra 2017-09-23 14:01:26 +07:00
parent fa28202a2c
commit 2f054927db

46
README.md Normal file
View File

@ -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.<br>
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.<br>
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.<br>
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.<br>
> 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_.<br>
Tombol _kategori_ berfungsi untuk mengalihkan pengguna ke halaman _Kategori_.<br>
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.<br>
Posisi kotak paling kiri/awal (berbentuk +) merupakan tombol untuk menambahkan atau membuat pengumuman baru.