Spaces:
Sleeping
Sleeping
KevanSoon
commited on
Commit
·
2367ec0
1
Parent(s):
ec4d503
Adjusted README
Browse files
README.md
CHANGED
|
@@ -1,104 +1,4 @@
|
|
| 1 |
-
|
| 2 |
-
|
| 3 |
-
|
| 4 |
-
|
| 5 |
-
## ⚙️ Configuration
|
| 6 |
-
|
| 7 |
-
### Environment Variables
|
| 8 |
-
|
| 9 |
-
Create a `.env` file in the project root or set the following environment variables:
|
| 10 |
-
|
| 11 |
-
```env
|
| 12 |
-
# Database Configuration
|
| 13 |
-
SPRING_DATASOURCE_URL=your_url
|
| 14 |
-
SPRING_DATASOURCE_USERNAME=your_username
|
| 15 |
-
SPRING_DATASOURCE_PASSWORD=your_password
|
| 16 |
-
|
| 17 |
-
|
| 18 |
-
## 🚀 Running the Application
|
| 19 |
-
|
| 20 |
-
### Using Maven Wrapper (Recommended)
|
| 21 |
-
|
| 22 |
-
```bash
|
| 23 |
-
# On Unix/Linux/macOS
|
| 24 |
-
./mvnw spring-boot:run
|
| 25 |
-
|
| 26 |
-
# On Windows
|
| 27 |
-
mvnw.cmd spring-boot:run
|
| 28 |
-
```
|
| 29 |
-
|
| 30 |
-
### Using Maven
|
| 31 |
-
|
| 32 |
-
```bash
|
| 33 |
-
# Clean and install dependencies
|
| 34 |
-
mvn clean install
|
| 35 |
-
|
| 36 |
-
# Run the application
|
| 37 |
-
mvn spring-boot:run
|
| 38 |
-
```
|
| 39 |
-
|
| 40 |
-
### Using JAR file
|
| 41 |
-
|
| 42 |
-
```bash
|
| 43 |
-
# Build the JAR file
|
| 44 |
-
mvn clean package
|
| 45 |
-
|
| 46 |
-
# Run the JAR file
|
| 47 |
-
java -jar target/attendance-0.0.1-SNAPSHOT.jar
|
| 48 |
-
```
|
| 49 |
-
|
| 50 |
-
The application will start on `http://localhost:8080` by default.
|
| 51 |
-
|
| 52 |
-
### Accessing the Application
|
| 53 |
-
|
| 54 |
-
When you run the application locally, you'll be redirected to a login page due to Spring Security being enabled.
|
| 55 |
-
|
| 56 |
-
**Login Credentials:**
|
| 57 |
-
- **Username:** `user`
|
| 58 |
-
- **Password:** A new password is generated every time you run the project (check your terminal/console output)
|
| 59 |
-
|
| 60 |
-
The generated password will appear in the logs like this:
|
| 61 |
-
```
|
| 62 |
-
Using generated security password: a1b2c3d4-e5f6-7890-abcd-ef1234567890
|
| 63 |
-
```
|
| 64 |
-
|
| 65 |
-
Copy this password from your terminal to log into the application.
|
| 66 |
-
|
| 67 |
-
## 🔗 Application Monitoring
|
| 68 |
-
|
| 69 |
-
The application includes Spring Boot Actuator for basic monitoring:
|
| 70 |
-
|
| 71 |
-
- **Application Health**: `GET /actuator/health`
|
| 72 |
-
- **Application Info**: `GET /actuator/info`
|
| 73 |
-
- **Metrics**: `GET /actuator/metrics`
|
| 74 |
-
- **Prometheus Metrics**: `GET /actuator/prometheus`
|
| 75 |
-
|
| 76 |
-
## 🧪 Testing
|
| 77 |
-
|
| 78 |
-
### Run Unit Tests
|
| 79 |
-
|
| 80 |
-
```bash
|
| 81 |
-
# Using Maven Wrapper
|
| 82 |
-
./mvnw test
|
| 83 |
-
|
| 84 |
-
# Using Maven
|
| 85 |
-
mvn test
|
| 86 |
-
```
|
| 87 |
-
|
| 88 |
-
### Run Integration Tests
|
| 89 |
-
|
| 90 |
-
```bash
|
| 91 |
-
# Using Maven Wrapper
|
| 92 |
-
./mvnw verify
|
| 93 |
-
|
| 94 |
-
# Using Maven
|
| 95 |
-
mvn verify
|
| 96 |
-
```
|
| 97 |
-
|
| 98 |
-
## 🤝 Contributing
|
| 99 |
-
|
| 100 |
-
1. Fork the repository
|
| 101 |
-
2. Create a feature branch: `git checkout -b feature/amazing-feature`
|
| 102 |
-
3. Commit your changes: `git commit -m 'Add some amazing feature'`
|
| 103 |
-
4. Push to the branch: `git push origin feature/amazing-feature`
|
| 104 |
-
5. Open a Pull Request
|
|
|
|
| 1 |
+
---
|
| 2 |
+
sdk: docker
|
| 3 |
+
app_port: 7860
|
| 4 |
+
---
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|