Browse Source

Swap readme, English by default

pull/8/head
Nafies Luthfi 8 years ago
parent
commit
0abaa21986
  1. 93
      readme.en.md
  2. 97
      readme.id.md
  3. 130
      readme.md

93
readme.en.md

@ -1,93 +0,0 @@
![Laravel](https://laravel.com/assets/img/components/logo-laravel.svg)
<h1 align="center">Genealogy Application</h1>
[![Build Status](https://travis-ci.org/nafiesl/silsilah.svg?branch=master)](https://travis-ci.org/nafiesl/silsilah)
> **Development in progress**
> In development progress, any changes of table structure **will be updated** directly to corresponding **migration file**.
## About
Genealogy (Silsilah) application to record our family members.
## Features
This application uses Bahasa Indonesia and English based on `config.locale`.
### Logic Concept
1. A person can have one father
2. A person can have one mother
3. A person can have one parent (couple of mother and father)
4. A person can have 0 to many childrens
5. A person can have 0 to many spouses (husbands or wife)
6. A couple can have 0 to many childrens (based on parent_id)
### Family Member Entry
1. Enter Name and Gender
2. Set Father
3. Set Mother
4. Add Spouse
5. Add Child
### Person Attribute
1. Nickname
2. Gender
3. Fullname
4. Date of birht
5. Date of death (or at least year of death)
6. Address
7. Phone Number
8. Email
### Couple Attribute (TODO)
1. Husband
2. Wife
3. Marriage Date
4. Divorce Date
5. Address
## How to Install
1. Clone the repo : `git clone https://github.com/nafiesl/silsilah.git`
2. `cd silsilah`
3. `composer install`
4. `cp .env.example .env`
5. `php artisan key:generate`
6. Create **database on MySQL**
7. **Set database credentials** on `.env` file
8. `php artisan migrate`
9. `php artisan serve`
10. Done (Register as new user to start using the application).
## Testing
This application built with testing (TDD) using in-memory sqlite database.
```bash
$ vendor/bin/phpunit
```
## Contributing
Feel free to submit Issue for bugs or sugestions and Pull Request.
## Screenshots
#### Family Tree
![Family Tree](public/images/02-pohon-keluarga.jpg "Family Tree")
#### Family Chart
![Family Chart](public/images/03-bagan-keluarga.jpg "Family Chart")
#### Search Family Member
![Search Family Member](public/images/01-cari-keluarga.jpg "Search Family Member")
#### User Profile
![User Profile](public/images/04-profil.jpg "User Profile")
#### Profile Form
![Profile Form](public/images/05-form-profil.jpg "Profile Form")
#### Profil Edit Form
![Profil Edit Form](public/images/06-edit-profil.jpg "Profil Edit Form")
#### Automated Testing
![Automated Testing](public/images/07-automated-testing.jpg "Automated Testing")
## License
The Laravel framework is open-sourced software licensed under the [MIT license](LICENSE).

97
readme.id.md

@ -0,0 +1,97 @@
![Laravel](https://laravel.com/assets/img/components/logo-laravel.svg)
<h1 align="center">Aplikasi Silsilah Keluarga</h1>
[![Build Status](https://travis-ci.org/nafiesl/silsilah.svg?branch=master)](https://travis-ci.org/nafiesl/silsilah)
> **Development in progress**
> Dalam proses development, perubahan struktur tabel akan **diubah langsung pada file migration** yang sesuai.
## Tentang
Aplikasi silsilah keluarga untuk mempermudah pendataan keluarga kita.
## Pemanfaatan
1. Melihat Silsilah keluarga
2. Melihat data ahli waris
## Fitur
Aplikasi ini menggunakan Bahasa Indonesia dan Bahasa Inggris, diatur pada `config.locale`.
### Konsep
1. Satu orang memiliki satu ayah (belum sebagai tentu orang tua)
2. Satu orang memiliki satu ibu (belum sebagai tentu orang tua)
3. satu orang memiliki satu orang tua
4. Satu orang memiliki 0 s/d beberapa anak
5. Satu orang bisa memiliki pasangan (Istri/Suami)
6. Satu pasangan bisa memiliki 0 s/d beberapa anak
7. Satu orang laki-laki bisa memiliki maksimal 4 pasangan yang tidak cerai (TODO)
8. Satu orang perempuan bisa memiliki maksimal 1 pasangan yang tidak cerai (TODO)
9. Satu orang perempuan yang suaminya meninggal otomatis set tanggal cerai (pada data pasangan) (TODO)
### Input ke sistem
1. Input Nama dan Jenis Kelamin
2. Tambah Ayah
3. Tambah Ibu
4. Tambah Pasangan
5. Tambah Anak
### Data Orang
1. Nama Panggilan
2. Jenis Kelamin
3. Nama Lengkap
4. Tanggal Lahir
5. Tanggal Meninggal (atau cukup tahun)
6. Alamat
7. Telp
8. Email
### Data Pasangan (TODO)
1. Suami
2. Istri
3. Tanggal menikah
4. Tanggal Cerai
5. Alamat
## Cara Install
1. Clone Repo, pada terminal : `git clone https://github.com/nafiesl/silsilah.git`
2. `cd silsilah`
3. `composer install`
4. `cp .env.example .env`
5. `php artisan key:generate`
6. Buat **database pada mysql** untuk aplikasi ini
7. **Setting database** pada file `.env`
8. `php artisan migrate`
9. `php artisan serve`
10. Selesai (Register user baru untuk mulai mengisi silsilah).
## Testing
Ingin mencoba automated testingnya? Silakan ketik perintah pada terminal: `vendor/bin/phpunit`
## Screenshots
#### Pohon Keluarga
![Pohon Keluarga](public/images/02-pohon-keluarga.jpg "Pohon Keluarga")
#### Bagan Keluarga
![Bagan Keluarga](public/images/03-bagan-keluarga.jpg "Bagan Keluarga")
#### Cari Keluarga
![Cari Keluarga](public/images/01-cari-keluarga.jpg "Cari Keluarga")
#### Profil
![Profil](public/images/04-profil.jpg "Profil")
#### Form Profil
![Form Profil](public/images/05-form-profil.jpg "Form Profil")
#### Edit Profil
![Edit Profil](public/images/06-edit-profil.jpg "Edit Profil")
#### Automated Testing
```bash
$ vendor/bin/phpunit
```
![Automated Testing](public/images/07-automated-testing.jpg "Automated Testing")
## License
The Laravel framework is open-sourced software licensed under the [MIT license](LICENSE).

130
readme.md

@ -1,98 +1,94 @@
![Laravel](https://laravel.com/assets/img/components/logo-laravel.svg)
<h1 align="center">Aplikasi Silsilah Keluarga</h1>
<h1 align="center">Genealogy Application</h1>
[![Build Status](https://travis-ci.org/nafiesl/silsilah.svg?branch=master)](https://travis-ci.org/nafiesl/silsilah)
> **Development in progress**
> Dalam proses development, perubahan struktur tabel akan **diubah langsung pada file migration** yang sesuai.
> In development progress, any changes of table structure **will be updated** directly to corresponding **migration file**.
>
> [Read English README](readme.en.md)
## Tentang
Aplikasi silsilah keluarga untuk mempermudah pendataan keluarga kita.
## Pemanfaatan
1. Melihat Silsilah keluarga
2. Melihat data ahli waris
## Fitur
Aplikasi ini menggunakan Bahasa Indonesia dan Bahasa Inggris, diatur pada `config.locale`.
### Konsep
1. Satu orang memiliki satu ayah (belum sebagai tentu orang tua)
2. Satu orang memiliki satu ibu (belum sebagai tentu orang tua)
3. satu orang memiliki satu orang tua
4. Satu orang memiliki 0 s/d beberapa anak
5. Satu orang bisa memiliki pasangan (Istri/Suami)
6. Satu pasangan bisa memiliki 0 s/d beberapa anak
7. Satu orang laki-laki bisa memiliki maksimal 4 pasangan yang tidak cerai (TODO)
8. Satu orang perempuan bisa memiliki maksimal 1 pasangan yang tidak cerai (TODO)
9. Satu orang perempuan yang suaminya meninggal otomatis set tanggal cerai (pada data pasangan) (TODO)
### Input ke sistem
1. Input Nama dan Jenis Kelamin
2. Tambah Ayah
3. Tambah Ibu
4. Tambah Pasangan
5. Tambah Anak
### Data Orang
1. Nama Panggilan
2. Jenis Kelamin
3. Nama Lengkap
4. Tanggal Lahir
5. Tanggal Meninggal (atau cukup tahun)
6. Alamat
7. Telp
> [Baca README Bahasa Indonesia](readme.id.md)
## About
Genealogy (Silsilah) application to record our family members.
## Features
This application uses Bahasa Indonesia and English based on `config.locale`.
### Logic Concept
1. A person can have one father
2. A person can have one mother
3. A person can have one parent (couple of mother and father)
4. A person can have 0 to many childrens
5. A person can have 0 to many spouses (husbands or wife)
6. A couple can have 0 to many childrens (based on parent_id)
### Family Member Entry
1. Enter Name and Gender
2. Set Father
3. Set Mother
4. Add Spouse
5. Add Child
### Person Attribute
1. Nickname
2. Gender
3. Fullname
4. Date of birht
5. Date of death (or at least year of death)
6. Address
7. Phone Number
8. Email
### Data Pasangan (TODO)
1. Suami
2. Istri
3. Tanggal menikah
4. Tanggal Cerai
5. Alamat
### Couple Attribute (TODO)
1. Husband
2. Wife
3. Marriage Date
4. Divorce Date
5. Address
## Cara Install
1. Clone Repo, pada terminal : `git clone https://github.com/nafiesl/silsilah.git`
## How to Install
1. Clone the repo : `git clone https://github.com/nafiesl/silsilah.git`
2. `cd silsilah`
3. `composer install`
4. `cp .env.example .env`
5. `php artisan key:generate`
6. Buat **database pada mysql** untuk aplikasi ini
7. **Setting database** pada file `.env`
6. Create **database on MySQL**
7. **Set database credentials** on `.env` file
8. `php artisan migrate`
9. `php artisan serve`
10. Selesai (Register user baru untuk mulai mengisi silsilah).
10. Done (Register as new user to start using the application).
## Testing
Ingin mencoba automated testingnya? Silakan ketik perintah pada terminal: `vendor/bin/phpunit`
This application built with testing (TDD) using in-memory sqlite database.
```bash
$ vendor/bin/phpunit
```
## Contributing
Feel free to submit Issue for bugs or sugestions and Pull Request.
## Screenshots
#### Pohon Keluarga
![Pohon Keluarga](public/images/02-pohon-keluarga.jpg "Pohon Keluarga")
#### Family Tree
![Family Tree](public/images/02-pohon-keluarga.jpg "Family Tree")
#### Bagan Keluarga
![Bagan Keluarga](public/images/03-bagan-keluarga.jpg "Bagan Keluarga")
#### Family Chart
![Family Chart](public/images/03-bagan-keluarga.jpg "Family Chart")
#### Cari Keluarga
![Cari Keluarga](public/images/01-cari-keluarga.jpg "Cari Keluarga")
#### Search Family Member
![Search Family Member](public/images/01-cari-keluarga.jpg "Search Family Member")
#### Profil
![Profil](public/images/04-profil.jpg "Profil")
#### User Profile
![User Profile](public/images/04-profil.jpg "User Profile")
#### Form Profil
![Form Profil](public/images/05-form-profil.jpg "Form Profil")
#### Profile Form
![Profile Form](public/images/05-form-profil.jpg "Profile Form")
#### Edit Profil
![Edit Profil](public/images/06-edit-profil.jpg "Edit Profil")
#### Profil Edit Form
![Profil Edit Form](public/images/06-edit-profil.jpg "Profil Edit Form")
#### Automated Testing
```bash
$ vendor/bin/phpunit
```
![Automated Testing](public/images/07-automated-testing.jpg "Automated Testing")
## License

Loading…
Cancel
Save