{"id":14982927,"url":"https://github.com/khanhduzz/sun-rise","last_synced_at":"2025-07-01T09:05:58.648Z","repository":{"id":254295301,"uuid":"846115145","full_name":"khanhduzz/sun-rise","owner":"khanhduzz","description":"Sun Rise - The budgeting service system","archived":false,"fork":false,"pushed_at":"2025-06-30T08:27:15.000Z","size":5862,"stargazers_count":4,"open_issues_count":19,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-06-30T09:26:24.493Z","etag":null,"topics":["docker","github-action","java","spring-mvc","thymeleaf"],"latest_commit_sha":null,"homepage":"https://sun-rise-latest.onrender.com/sun/auth/login","language":"CSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/khanhduzz.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-08-22T15:01:19.000Z","updated_at":"2025-06-30T08:27:18.000Z","dependencies_parsed_at":"2024-10-25T12:58:33.360Z","dependency_job_id":"bf3ab048-08a9-40c3-bef0-c1e8424301ed","html_url":"https://github.com/khanhduzz/sun-rise","commit_stats":{"total_commits":135,"total_committers":8,"mean_commits":16.875,"dds":0.4666666666666667,"last_synced_commit":"2a3dcc94d08f96a3bf1f2207c930796379a5935d"},"previous_names":["khanhduzz/sun-rise"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/khanhduzz/sun-rise","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/khanhduzz%2Fsun-rise","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/khanhduzz%2Fsun-rise/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/khanhduzz%2Fsun-rise/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/khanhduzz%2Fsun-rise/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/khanhduzz","download_url":"https://codeload.github.com/khanhduzz/sun-rise/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/khanhduzz%2Fsun-rise/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262933276,"owners_count":23386779,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docker","github-action","java","spring-mvc","thymeleaf"],"created_at":"2024-09-24T14:06:26.566Z","updated_at":"2025-07-01T09:05:58.635Z","avatar_url":"https://github.com/khanhduzz.png","language":"CSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Budgeting Service System\nBudgeting Service System is a project provides features for tracking and managing budget, money, users, and trading transactions.\n\n_This is currently in refactoring code, cannot perform now_\n\n[![sun-rise](https://github.com/khanhduzz/sun-rise/actions/workflows/pipeline-sun.yml/badge.svg)](https://github.com/khanhduzz/sun-rise/actions/workflows/pipeline-sun.yml)\n[![codecov](https://codecov.io/github/khanhduzz/sun-rise/graph/badge.svg?token=GJEDWMOLU9)](https://codecov.io/github/khanhduzz/sun-rise)\n\n[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=khanhduzz_sun-rise\u0026metric=alert_status)](https://sonarcloud.io/summary/new_code?id=khanhduzz_sun-rise) [![Bugs](https://sonarcloud.io/api/project_badges/measure?project=khanhduzz_sun-rise\u0026metric=bugs)](https://sonarcloud.io/summary/new_code?id=khanhduzz_sun-rise) [![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=khanhduzz_sun-rise\u0026metric=code_smells)](https://sonarcloud.io/summary/new_code?id=khanhduzz_sun-rise) [![Duplicated Lines (%)](https://sonarcloud.io/api/project_badges/measure?project=khanhduzz_sun-rise\u0026metric=duplicated_lines_density)](https://sonarcloud.io/summary/new_code?id=khanhduzz_sun-rise) [![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=khanhduzz_sun-rise\u0026metric=reliability_rating)](https://sonarcloud.io/summary/new_code?id=khanhduzz_sun-rise) [![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=khanhduzz_sun-rise\u0026metric=security_rating)](https://sonarcloud.io/summary/new_code?id=khanhduzz_sun-rise) [![Technical Debt](https://sonarcloud.io/api/project_badges/measure?project=khanhduzz_sun-rise\u0026metric=sqale_index)](https://sonarcloud.io/summary/new_code?id=khanhduzz_sun-rise) [![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=khanhduzz_sun-rise\u0026metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=khanhduzz_sun-rise) [![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=khanhduzz_sun-rise\u0026metric=vulnerabilities)](https://sonarcloud.io/summary/new_code?id=khanhduzz_sun-rise) [![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=khanhduzz_sun-rise\u0026metric=ncloc)](https://sonarcloud.io/summary/new_code?id=khanhduzz_sun-rise)\n\n\u003cdiv style=\"text-align: center;\"\u003e\n  \u003cimg width=\"491\" alt=\"Screenshot 2024-08-22 at 21 34 38\" src=\"https://github.com/user-attachments/assets/cbd54394-b9be-4ca9-a12c-e774efd4e52e\"\u003e\n\u003c/div\u003e\n\n# Technologies\n- Java 17\n- Spring boot 3.3.3\n- Swagger\n- PostgreSQL\n- Thymeleaf\n- Bootstrap\n- Jquery\n- Docker\n- Sonar cloud for checking clean code.\n\n\u003e *_Running:_* You can run this project with Docker container\n\u003e - Run docker on your local machine.\n\n[//]: # (\u003e - Run `mvn clean install` to create `.jar` file)\n\u003e - Go to the project, run `docker compose pull` if you want to update images or just `docker compose up` on `terminal/command promt`, then waiting for project starting\n\u003e - The project is run on: `localhost:8086/sun/`\n\u003e - The postgres container is run on: `localhost:5432`\\\n\u003e   Default user:\\\n\u003e     `username: admin`\\\n\u003e     `password: admin`  \n\u003e - The PgAdmin is run on: `localhost:8081`\\\n\u003e   Defaul pgAdmin user:\\\n\u003e     `username: admin@sun.com`\\\n\u003e     `password: admin`\\\n\u003e   After login to `PgAmin -\u003e Register -\u003e Create new -\u003e Create postgres database`\n\n# Current Feature\n- Init the spring boot project, setup README.md, MIT license\n- Configure Github action, apply Pull request rules\n- Setup packages, initial models and relationships\n- Added checkstyle, ci pipeline for checking maven build and test.\n- Added docker config to create docker image and container.\n- Able to run in local and with docker\n\n# Architecture\n\u003cimg width=\"1307\" alt=\"Screenshot 2024-09-13 at 21 21 04\" src=\"https://github.com/user-attachments/assets/34f1230e-e4f6-41b6-b9b4-c8cc1e7d7634\"\u003e\n\n\n# Database Modeling\n![detb-service-diagram](https://github.com/user-attachments/assets/f60b95b4-bb9a-44cb-8e95-3b5f1987e2d1)\n\n# Setting Up and Running at Local\n\n## Configuration\n\nInclude setup steps for PostgreSQL database connection, and any other necessary configurations.\n\n1. Set up PostgreSQL:\n\n    - Install PostgreSQL on your system.\n    - Create a new PostgreSQL database for your application.\n    \n2. Set up environment variable:\n\n    - Clone file **.env.sample** to the new file with name: **.env**\n    - Update environment variable in file **.env**\n\n## Run\n0. Remember checkstyle\n```bash\n   ./mvnw checkstyle:checkstyle\n```\n1. Build the Project\n```bash\n    ./mvnw clean install  \n```\n2. Run the Application\n```bash\n    ./mvnw spring-boot:run\n```\n3. Note\n\n   - Test account:\n   ```bash\n       email: sun@sun.com\n       password: test1234\n    ```\n# References\n\n## Documentation \u0026 Tools\n1. **Spring Boot Documentation**:\n   - [Spring Boot Reference Documentation](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/)\n\n2. **Swagger Documentation**:\n   - [Swagger OpenAPI Specification](https://swagger.io/specification/)\n\n3. **PostgreSQL Documentation**:\n   - [PostgreSQL Official Documentation](https://www.postgresql.org/docs/)\n\n4. **Thymeleaf Documentation**:\n   - [Thymeleaf Documentation](https://www.thymeleaf.org/documentation.html)\n\n5. **Bootstrap Documentation**:\n   - [Bootstrap Official Documentation](https://getbootstrap.com/docs/5.3/getting-started/introduction/)\n\n6. **jQuery Documentation**:\n   - [jQuery API Documentation](https://api.jquery.com/)\n\n7. **Docker Documentation**:\n   - [Docker Documentation](https://docs.docker.com/)\n\n8. **SonarCloud Documentation**:\n   - [SonarCloud Documentation](https://sonarcloud.io/documentation/)\n\n## Development \u0026 Deployment\n1. **Maven Documentation**:\n   - [Maven Project Documentation](https://maven.apache.org/guides/index.html)\n\n2. **GitHub Actions Documentation**:\n   - [GitHub Actions Documentation](https://docs.github.com/en/actions)\n\n3. **PgAdmin Documentation**:\n   - [PgAdmin Documentation](https://www.pgadmin.org/docs/)\n\n## Best Practices \u0026 Standards\n1. **Clean Code**:\n   - [Clean Code by Robert C. Martin](https://www.amazon.com/Clean-Code-Handbook-Software-Craftsmanship/dp/0132350882)\n\n2. **Checkstyle Documentation**:\n   - [Checkstyle Documentation](https://checkstyle.sourceforge.io/)\n\n3. **MIT License**:\n   - [MIT License Text](https://opensource.org/licenses/MIT)\n\n## Additional Learning Resources\n1. **Java 17 Official Documentation**:\n   - [Java 17 Documentation](https://docs.oracle.com/en/java/javase/17/)\n\n2. **SonarQube Documentation**:\n   - [SonarQube Documentation](https://docs.sonarqube.org/latest/)\n\n3. **JPA \u0026 Hibernate Documentation**:\n   - [Java Persistence API (JPA) Documentation](https://www.oracle.com/java/technologies/persistence-jsp.html)\n   - [Hibernate ORM Documentation](https://hibernate.org/orm/documentation/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkhanhduzz%2Fsun-rise","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkhanhduzz%2Fsun-rise","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkhanhduzz%2Fsun-rise/lists"}