{"id":21596959,"url":"https://github.com/chathuminibandara/notecollector","last_synced_at":"2026-05-20T02:40:31.011Z","repository":{"id":255814301,"uuid":"853668043","full_name":"ChathuminiBandara/NoteCollector","owner":"ChathuminiBandara","description":"This is a Note Collector API built using the Spring Framework. It serves as a backend system for managing notes and provides an organized structure with layers such as DTO, Controller, Service, Entity, Config, and more. The server runs on Tomcat.","archived":false,"fork":false,"pushed_at":"2024-10-14T17:25:31.000Z","size":116,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-01-24T17:35:10.130Z","etag":null,"topics":["customexception","customstatuscode","java","mit-license","notecollector-springfw","spring","spring-web","spring-web-mvc"],"latest_commit_sha":null,"homepage":"","language":"Java","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/ChathuminiBandara.png","metadata":{"files":{"readme":"README.MD","changelog":null,"contributing":null,"funding":null,"license":null,"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-09-07T07:29:47.000Z","updated_at":"2024-10-14T17:25:35.000Z","dependencies_parsed_at":"2025-01-24T17:40:40.386Z","dependency_job_id":null,"html_url":"https://github.com/ChathuminiBandara/NoteCollector","commit_stats":null,"previous_names":["chathuminibandara/notecollector"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ChathuminiBandara%2FNoteCollector","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ChathuminiBandara%2FNoteCollector/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ChathuminiBandara%2FNoteCollector/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ChathuminiBandara%2FNoteCollector/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ChathuminiBandara","download_url":"https://codeload.github.com/ChathuminiBandara/NoteCollector/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244207747,"owners_count":20416109,"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":["customexception","customstatuscode","java","mit-license","notecollector-springfw","spring","spring-web","spring-web-mvc"],"created_at":"2024-11-24T18:07:29.205Z","updated_at":"2026-05-20T02:40:25.989Z","avatar_url":"https://github.com/ChathuminiBandara.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n```markdown\n# Note Collector API\n\nThis is a Note Collector API built using the Spring Framework. It serves as a backend system for managing notes and provides an organized structure with layers such as DTO, Controller, Service, Entity, Config, and more. The server runs on Tomcat.\n\n## Table of Contents\n\n- [Features](#features)\n- [Tech Stack](#tech-stack)\n- [Project Structure](#project-structure)\n- [Getting Started](#getting-started)\n- [API Endpoints](#api-endpoints)\n- [License](#license)\n\n## Features\n\n- Create, read, update, and delete (CRUD) notes.\n- API designed following REST principles.\n- Custom error handling using exceptions.\n- Modular structure for maintainability.\n\n## Tech Stack\n\n- Java\n- Spring Boot\n- Tomcat Server\n- MySQL (or any preferred database)\n\n## Project Structure\n\n## Project Structure\n\n```bash\n/src\n│\n├── /config         # Configuration classes for Spring Beans, Security, etc.\n├── /controller     # REST Controllers to handle incoming requests\n├── /dto            # Data Transfer Objects to encapsulate request/response\n├── /entity         # JPA Entities mapped to the database\n├── /exception      # Custom exception handling and error responses\n├── /service        # Service classes that hold business logic\n├── /util           # Utility classes for common functionality\n└── /AppInit.java   # Main class to launch the Spring Boot application\n\n\n## Getting Started\n\n### Prerequisites\n\n- Java 17+\n- Maven or Gradle for dependency management.\n- A database such as MySQL.\n\n### Installation\n\n1. Clone the repository:\n\n   ```bash\n   git clone https://github.com/ChathuminiBandara/NoteCollector.git\n   ```\n\n2. Navigate to the project directory:\n\n   ```bash\n   cd note-collector-api\n   ```\n\n3. Configure the database connection in `application.properties`:\n\n   ```properties\n   spring.datasource.url=jdbc:mysql://localhost:3306/note_db\n   spring.datasource.username=root\n   spring.datasource.password=yourpassword\n   ```\n\n4. Build and run the application:\n\n   ```bash\n   mvn clean install\n   mvn spring-boot:run\n   ```\n\n5. The API will run at `http://localhost:8080`.\n\n## API Endpoints\n\n| Method | Endpoint                    | Description              |\n|--------|-----------------------------|--------------------------|\n| GET    | `/api/v1/notes`             | Retrieve all notes       |\n| POST   | `/api/v1/notes`             | Create a new note        |\n| GET    | `/api/v1/notes/{noteId}`    | Get a note by ID         |\n| PUT    | `/api/v1/notes/{noteId}`    | Update a note by ID      |\n| DELETE | `/api/v1/notes/{noteId}`    | Delete a note by ID      |\n\n## Custom Status Codes\n\n- **201**: Resource created successfully.\n- **204**: Resource deleted successfully.\n- **400**: Bad request or validation error.\n- **404**: Resource not found.\n- **500**: Internal server error.\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](https://github.com/ChathuminiBandara/NoteCollector/blob/master/Licence.txt) file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchathuminibandara%2Fnotecollector","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fchathuminibandara%2Fnotecollector","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchathuminibandara%2Fnotecollector/lists"}