Skip to content

Commit 5e9a8e1

Browse files
GesangPJGesangPJ
committed
Update README.md
1 parent 614b6fe commit 5e9a8e1

File tree

1 file changed

+72
-72
lines changed

1 file changed

+72
-72
lines changed

‎README.md

+72-72
Original file line numberDiff line numberDiff line change
@@ -2,100 +2,100 @@
22

33
<a rel="license" href="http://creativecommons.org/licenses/by-nc-nd/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-nc-nd/4.0/88x31.png" /></a><br />This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-nc-nd/4.0/">Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License</a>.
44

5-
# KASBON MANAJER
5+
# DEBT MANAGER
66

7-
Aplikasi Manajemen Kasbon pengembangan lebih lanjut dari versi sebelumnya (Kasbon-JS),
8-
menggunakan NextJS 14 Full Stack dengan Database PostgreSQL atau SQLite (akan tersedia di Branch lain).
7+
Debt / Loan Management Application further development from the previous version (Kasbon-JS),
8+
using NextJS 14 Full Stack with PostgreSQL or SQLite Database (will be available on another branch).
99

1010
https://github.com/GesangPJ/KasbonManajer/assets/26625652/bd2fe23c-ba7d-4281-9fc3-c162a7805261
1111

12-
## Fitur Website
12+
## Website Features
1313

1414
1. App Router.
15-
2. Next-Auth untuk Autentikasi.
16-
3. Json Web Token (JWT) untuk mengamankan session.
17-
4. MUI DataGrid untuk penyajian data lebih baik.
18-
5. Multi-Role account, akun terbagi menjadi 2 tipe : Admin dan Karyawan.
19-
6. Bcrypt untuk password hashing.
20-
7. API Protection menggunakan JWT Token Validation.
21-
8. Pages protection menggunakan session.
22-
9. Admin Master Key autentikasi bagi admin untuk mengganti password akun dan data akun.
23-
24-
## Fitur Kasbon
25-
26-
1. Dashboard (Admin & Karyawan).
27-
2. Form tambah kasbon (Karyawan).
28-
3. Halaman Status Request.
29-
4. Halaman Status Bayar.
30-
5. Export kasbon ke PDF, Excel, JSON.
31-
6. Mengambil Laporan Kasbon per Bulan.
32-
7. Menampilkan jumlah total nilai kasbon yang diminta, yang telah disetujui, yang telah lunas, yang belum lunas.
33-
8. Halaman Bantuan yang berisi penjelasan setiap halaman dan bagaimana cara mengirim dan menampilkan data.
34-
9. Edit Data Akun Karyawan.
35-
10. Edit Data Akun Admin.
36-
11. Reset Password Akun Karyawan.
37-
12. Reset Password Akun Admin.
15+
2. Next-Auth for Authentication.
16+
3. Json Web Token (JWT) to secure sessions.
17+
4. MUI DataGrid for better data presentation.
18+
5. Multi-Role account, accounts are divided into 2 types: Admin and User (Employees).
19+
6. Bcrypt for password hashing.
20+
7. API Protection using JWT Token Validation.
21+
8. Pages protection using session.
22+
9. Admin Master Key authentication for admins to change account passwords and account data.
23+
24+
## Debt Features
25+
26+
1. Dashboard (Admin & Employee).
27+
2. Add debt form (Employee).
28+
3. Request Status Page.
29+
4. Payment Status Page.
30+
5. Export debts to PDF, Excel, JSON.
31+
6. Retrieve Monthly debt Report.
32+
7. Display the total debt value requested, approved, paid off, and unpaid.
33+
8. Help Page containing explanations of each page and how to submit and display data.
34+
9. Edit User Account Data.
35+
10. Edit Admin Account Data.
36+
11. Reset User Account Password.
37+
12. Reset Admin Account Password.
3838

3939
# Container Deploy
4040

41-
Docker compose sudah tersedia. Gunakan sesuai versi image (PostgreSQL / SQLite)
42-
jangan lupa dengan environment variables yang ada.
41+
Docker compose is available. Use according to image version (PostgreSQL / SQLite)
42+
don’t forget about the existing environment variables.
4343

4444
## Container Image
4545

46-
Container Image tersedia di repository package (ghcr.io)
46+
Container Image is available in the repository package (ghcr.io)
4747

48-
- kasbon-manager-pg : adalah versi dengan PostgreSQL
49-
- kasbon-manager-sqlite : adalah versi dengan SQLite
48+
- debt-manager-pg : is the version with PostgreSQL
49+
- debt-manager-sqlite : is the version with SQLite
5050

5151
## SQLite Version
5252

53-
Versi SQLite tersedia di branch "SQLiteVersion"
53+
The SQLite version is available in the "SQLiteVersion" branch
5454

55-
file database SQLite berada di `/prisma/dev.db`
55+
SQLite database file is located at `/prisma/dev.db`
5656

57-
buka `schema.prisma` untuk mengganti koneksi dan schema.
57+
open schema.prisma to change the connection and schema.
5858

59-
Dengan menggunakan versi SQLite ini maka tidak perlu install database lain seperti PostgreSQL atau MySQL.
59+
Using this SQLite version does not require installing other databases like PostgreSQL or MySQL.
6060

61-
## Instalasi
61+
## Installation
6262

6363
### Install PostgreSQL Version
6464

65-
1. Clone repository ini.
66-
2. Buka folder repository di pc local anda.
67-
3. Ubah file `.env.example` >> `.env`
68-
4. Isi nilai `NEXTAUTH_SECRET` dengan menggunakan `openssl rand -base64 32` untuk generate secret key dan copy ke `NEXTAUTH_SECRET`
69-
5. Isi nilai `NEXTAUTH_URL` dengan `http://localhost:3000` jika dijalankan di local pc, atau domain lain jika dijalankan di hosting / cloud.
70-
6. Buka `schema.prisma` , jika anda menggunakan PostgreSQL secara lokal maka ganti nilai `url=` dengan `env("DATABASE_URL")`
71-
7. Kemudian Isi `DATABASE_URL` dengan contoh nilai : `postgresql://<nama akun>:<password>@localhost:<port>/<nama database>`
72-
8. Jika menggunakan PostgreSQL dari Vercel, maka ganti nilai `url=` dengan `env("POSTGRES_PRISMA_URL")` dan tambahkan `directUrl = env("POSTGRES_URL_NON_POOLING")` dibawahnya.
73-
9. Kemudian isi nilai `POSTGRES_PRISMA_URL` di file `.env` dengan URL dari PostgreSQL di Vercel, begitu juga dengan nilai `POSTGRES_URL_NON_POOLING`
74-
10. Isi nilai `ADMIN_KEY` dengan secret key anda sendiri (ini digunakan agar admin dapat mengganti nama / email / password akun lainnya.)
75-
11. Setelah semua terisi dan benar. maka jalankan `npm install`.
76-
12. Kemudian jalankan `npx prisma migrate deploy`.
77-
13. Kemudian jalankan `npx prisma generate`.
78-
14. Setelah selesai maka jalankan `npm run seedadmin` untuk membuat akun admin.
79-
15. Kemudian jalankan `npm run seedkaryawan` untuk membuat akun karyawan.
80-
16. Email dan Password dari kedua akun dapat dilihat dan diganti di `/prisma/seedAdmin.js` dan `/prisma/seedKaryawan.js`.
81-
17. Kemudian Build project dengan menjalankan `npm run build`.
65+
1. Clone this repository.
66+
2. Open the repository folder on your local PC.
67+
3. Change the file `.env.example` >> `.env`
68+
4. Fill in the `NEXTAUTH_SECRET` value using `openssl rand -base64 32` to generate a secret key and copy it to `NEXTAUTH_SECRET`
69+
5. Fill in the `NEXTAUTH_URL` value with `http://localhost:3000` if run on a local PC, or another domain if run on hosting/cloud.
70+
6. Open schema.prisma, if you are using PostgreSQL locally then change the `url=` value to `env("DATABASE_URL")`
71+
7. Then fill in DATABASE_URL with example value: `postgresql://<account name>:<password>@localhost:<port>/<database name>`
72+
8. If using PostgreSQL from Vercel, then change the `url=` value to `env("POSTGRES_PRISMA_URL")` and add `directUrl = env("POSTGRES_URL_NON_POOLING")` below it.
73+
9. Then fill in the `POSTGRES_PRISMA_URL` value in the `.env` file with the URL from PostgreSQL in Vercel, as well as the `POSTGRES_URL_NON_POOLING` value.
74+
10. Fill in the `ADMIN_KEY` value with your own secret key (this is used so that the admin can change the name/email/password of other accounts.)
75+
11. Once everything is filled in and correct, run `npm install`.
76+
12. Then run `npx prisma migrate deploy`.
77+
13. Then run `npx prisma generate`.
78+
14. Once done, run npm run seedadmin to create an admin account.
79+
15. Then run npm run seedkaryawan to create an user account.
80+
16. The email and password of both accounts can be seen and changed in `/prisma/seedAdmin.js` and `/prisma/seedKaryawan.js`.
81+
17. Then build the project by running `npm run build`.
8282

8383
### Install SQLite Version
8484

85-
1. Clone repository branch `SQLiteVersion`
86-
2. Buka folder repository di pc local anda.
87-
3. Ubah file `.env.example` >> `.env`.
88-
4. Isi nilai `NEXTAUTH_SECRET` dengan menggunakan `openssl rand -base64 32` untuk generate secret key dan copy ke `NEXTAUTH_SECRET`.
89-
5. Isi nilai `NEXTAUTH_URL` dengan `http://localhost:3000` jika dijalankan di local pc, atau domain lain jika dijalankan di hosting / cloud.
90-
6. Buka `schema.prisma` dan pastikan bahwa `provider = "sqlite"` dan `url = "file:./dev.db"` ini berarti Prisma menggunakan SQlite sebagai database dan file database terletak di `/prisma/dev.db`.
91-
7. Isi nilai `ADMIN_KEY` dengan secret key anda sendiri (ini digunakan agar admin dapat mengganti nama / email / password akun lainnya.)
92-
8. Setelah semua terisi dan benar. maka jalankan `npm install`.
93-
9. Kemudian jalankan `npx prisma migrate deploy`.
94-
10. Kemudian jalankan `npx prisma generate`.
95-
11. Setelah selesai maka jalankan `npm run seedadmin` untuk membuat akun admin.
96-
12. Kemudian jalankan `npm run seedkaryawan` untuk membuat akun karyawan.
97-
13. Email dan Password dari kedua akun dapat dilihat dan diganti di `/prisma/seedAdmin.js` dan `/prisma/seedKaryawan.js`.
98-
14. Kemudian Build project dengan menjalankan `npm run build`.
85+
1. Clone the SQLiteVersion branch repository.
86+
2. Open the repository folder on your local PC.
87+
3. Change the file `.env.example` >> `.env`.
88+
4. Fill in the `NEXTAUTH_SECRET` value using openssl rand -base64 32 to generate a secret key and copy it to `NEXTAUTH_SECRET`.
89+
5. Fill in the `NEXTAUTH_URL` value with `http://localhost:3000` if run on a local PC, or another domain if run on hosting/cloud.
90+
6. Open schema.prisma and make sure that `provider = "sqlite"` and `url = "file:./dev.db"` which means Prisma uses SQLite as the database and the database file is located in `/prisma/dev.db`.
91+
7. Fill in the `ADMIN_KEY` value with your own secret key (this is used so that the admin can change the name/email/password of other accounts.)
92+
8. Once everything is filled in and correct, run `npm install`.
93+
9. Then run `npx prisma migrate deploy`.
94+
10. Then run `npx prisma generate`.
95+
11. Once done, run `npm run seedadmin` to create an admin account.
96+
12. Then run `npm run seedkaryawan` to create an user account.
97+
13. The email and password of both accounts can be seen and changed in `/prisma/seedAdmin.js` and `/prisma/seedKaryawan.js`
98+
14. Then build the project by running `npm run build`.
9999

100100
## Changelog
101101

@@ -108,9 +108,9 @@ Dengan menggunakan versi SQLite ini maka tidak perlu install database lain seper
108108

109109
### v.1.2.7 Update Patch #4
110110

111-
- Add Bantuan page.
112-
- Add Dokumentasi API page.
113-
- Add Tentang Page.
111+
- Add Help page.
112+
- Add API Documentation.
113+
- Add About Page.
114114
- Sidebar Update.
115115
- Refactor some codes.
116116

@@ -135,4 +135,4 @@ Dengan menggunakan versi SQLite ini maka tidak perlu install database lain seper
135135

136136
- Rilis pertama.
137137
- PostgreSQL Version.
138-
- Semua fitur kasbon (tambah, ganti status, ambil laporan perbulan, export ke pdf ; excel ; json).
138+
- All Debt Version (Add, status change, get monthly report, export to pdf ; excel ; json).

0 commit comments

Comments
 (0)