Skip to content

Commit fd7dc04

Browse files
070325 351AM Improvements
070325 351AM Improvements
1 parent f8abea5 commit fd7dc04

File tree

2 files changed

+44
-146
lines changed

2 files changed

+44
-146
lines changed

Installer/README.md

Lines changed: 0 additions & 108 deletions
This file was deleted.

README.md

Lines changed: 44 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -159,69 +159,75 @@ In short, the MIT License states:
159159

160160
<b>Make sure to</b>:
161161
- <b>Give credit to the owner</b> if the project is recompiled or recoded.
162-
- This code is <b>free to use, modify, and distribute. No fees.</b>
162+
- This code is <b>free to use, modify, and distribute for personal or academic use. NO FEES.</b>
163163
<br>
164164

165165

166166
<!-- ------ -->
167167

168-
## 🚀 **Download Installer (for Users)**
169-
**Download the installer of _Employee Payroll Management System_ below:**
168+
## 🚀 Installtion For End Users
170169

171-
> | **Version** | **Description** | **Download** |
172-
> |-------------|---------------------------|------------------------------------------------------------------------------|
173-
> | 2.0.0 | Initial Public Release | [Download Installer](https://mega.nz/file/yw4U2DgY#M9TaPobCsxQK0bNqMKvr4f69rBlSeB9ohrPu_7CWy5M) |
170+
### Requirements
171+
**You MUST install MySQL** unless you configure the system to use SQLite (see configuration below).
174172

175-
> _Follow the installation steps and feel free to explore the application._
176-
<br><br>
173+
### Download & Install
174+
| Version | Description | Download |
175+
|---------|-------------|----------|
176+
| 1.3 | Initial Release | [Download Installer](https://mega.nz/file/yw4U2DgY#M9TaPobCsxQK0bNqMKvr4f69rBlSeB9ohrPu_7CWy5M) |
177177

178-
<!-- ------ -->
179-
180-
## ⚙️ **Dependencies for Java Developers**
181-
Make sure the following are installed on your system:
182-
183-
- [Java JDK 11](https://mega.nz/file/msIwmYjC#qpJL7LFHxTwUkI3jauAH2GQE_xM8ULeVPojfSsZ0KAY)
184-
- [NetBeans Apache IDE v12.0](https://netbeans.apache.org/front/main/download/nb120/nb120/)
185-
- [MySQL Workbench](https://dev.mysql.com/downloads/workbench/) (for managing the MySQL database)
186-
187-
<br>
178+
### Quick Setup Steps
179+
1. **Install MySQL Server** from [mysql.com](https://dev.mysql.com/downloads/mysql/)
180+
2. **Download and run** the installer above
181+
3. **Configure database** (see configuration section below)
188182

189183
<!-- ------ -->
190184

191-
## ⚙️ **Download Source Code (for Java Developers)**
192-
193-
**Download Java Source Code [here](https://github.com/emmanpbarrameda/EmployeePayrollManagementSystem_Java-CODE/archive/refs/heads/main.zip)**
194-
> _Note: Make sure to install the required software listed in [Dependencies](#️-dependencies-for-java-developers)._
195-
196-
---
197-
198-
### 🛠 **Configuration Required**
185+
## 👨‍💻 For Developers
199186

200-
> 🗃️ The **MySQL database** is located in the `database` folder of the source code.
187+
### Prerequisites
188+
- [Java JDK 11+](https://mega.nz/file/msIwmYjC#qpJL7LFHxTwUkI3jauAH2GQE_xM8ULeVPojfSsZ0KAY)
189+
- [NetBeans IDE 12.0+](https://netbeans.apache.org/front/main/download/nb120/nb120/)
190+
- [MySQL Workbench](https://dev.mysql.com/downloads/workbench/)
201191

202-
To run the system using your local MySQL server:
203-
204-
1. Make sure **MySQL Workbench** is installed and running.
205-
2. Import the MySQL database from the `database` folder.
206-
3. Update the `config.properties` file located at the root of the project with your database settings.
192+
### Get Source Code
193+
```bash
194+
git clone https://github.com/emmanpbarrameda/EmployeePayrollManagementSystem_Java-CODE.git
195+
```
207196

208-
#### 📄 Sample `config.properties` file:
197+
## ⚙️ Database Configuration
209198

199+
### Option 1: MySQL (Recommended)
200+
1. **Install MySQL Server** and remember your root password
201+
2. **Import database** from the `database` folder using MySQL Workbench
202+
3. **Update `config.properties`:**
210203
```properties
211-
# Database configuration
212204
USE_MYSQL=true
213205
USE_EMBEDDED_SQLITE=false
214-
215206
MYSQL_HOST=localhost
216-
MYSQL_PORT=3305
207+
MYSQL_PORT=3306
217208
MYSQL_DATABASE=netbeanspayrollsystem
218209
MYSQL_USER=root
219-
MYSQL_PASSWORD=password
210+
MYSQL_PASSWORD=your_password_here
211+
```
220212

221-
# Path to SQLite (only used if USE_EMBEDDED_SQLITE=true)
213+
### Option 2: SQLite (No MySQL needed, NOT RECOMMENDED, BUGGY - FOR TESTING ONLY)
214+
**Update `config.properties`:**
215+
```properties
216+
USE_MYSQL=false
217+
USE_EMBEDDED_SQLITE=true
222218
EMBEDDED_SQLITE_PATH=/SystemDB/database.sqlite
223219
```
224220

221+
## 🔧 Troubleshooting
222+
223+
**Can't connect to database?**
224+
- Verify MySQL is running
225+
- Check your password in `config.properties`
226+
- Try SQLite option if MySQL issues persist
227+
228+
**App won't start?**
229+
- Ensure Java 11+ is installed
230+
- Check database configuration
225231

226232
<!-- ------ -->
227233

0 commit comments

Comments
 (0)