{"id":23116322,"url":"https://github.com/anirudhsharma777/school_directory","last_synced_at":"2026-04-10T22:32:10.252Z","repository":{"id":264769596,"uuid":"875567715","full_name":"AnirudhSharma777/School_Directory","owner":"AnirudhSharma777","description":"It's a Simple School Directory with some CRUD Operations. I Build This using Spring boot framework which is Very popular framework for backend and it is widely used in IT sector. For Database I used Postgresql. You all might wounding why I am use postgresql why not sql or mongodb. Answer is simple I build this for learning purpose....","archived":false,"fork":false,"pushed_at":"2024-10-25T06:00:36.000Z","size":68,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-09T13:13:02.034Z","etag":null,"topics":["docker","docker-compose","gradle-plugin","java","junit5","mokito","postgresql-database","spring-boot"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/AnirudhSharma777.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-10-20T10:34:55.000Z","updated_at":"2024-10-25T06:00:40.000Z","dependencies_parsed_at":"2024-11-26T08:36:47.117Z","dependency_job_id":"bfe97be8-69ef-47b2-9b78-9b988a842c00","html_url":"https://github.com/AnirudhSharma777/School_Directory","commit_stats":null,"previous_names":["anirudhsharma777/school_directory"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AnirudhSharma777%2FSchool_Directory","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AnirudhSharma777%2FSchool_Directory/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AnirudhSharma777%2FSchool_Directory/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AnirudhSharma777%2FSchool_Directory/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AnirudhSharma777","download_url":"https://codeload.github.com/AnirudhSharma777/School_Directory/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247105375,"owners_count":20884428,"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","docker-compose","gradle-plugin","java","junit5","mokito","postgresql-database","spring-boot"],"created_at":"2024-12-17T04:15:59.720Z","updated_at":"2026-04-10T22:32:05.206Z","avatar_url":"https://github.com/AnirudhSharma777.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Spring Boot + PostgreSQL Project\n\nThis project is a **backend service** built with **Spring Boot** and **PostgreSQL** as the relational database. It leverages modern Java (targeting Java 23) and aims to deliver scalable APIs, with Docker support for containerized deployment.\n\n## 🚀 Getting Started\n\nThese instructions will help you run the project locally or within a Docker container.\n\n### Prerequisites\n\nMake sure you have the following tools installed:\n\n- [Docker](https://www.docker.com/)\n- [Docker Compose](https://docs.docker.com/compose/)\n- Java 23 (JDK)\n\n### ⚙️ Run the Project\n\nTo run the application using Docker:\n\n```bash\ndocker-compose up\n```\n\nThis command will:\n\n1. Spin up the **Spring Boot application**.\n2. Start a **PostgreSQL database** as a container.\n3. Automatically link the application to the database.\n\n---\n\n## 🗂 ER Diagram\n\nBelow is the **ER diagram** representing the relational structure of the PostgreSQL database used in this project:\n\n![ER Diagram](https://github.com/user-attachments/assets/9ece30eb-e2b3-4b6a-862b-13840186f240)\n\n---\n\n## 📂 Project Structure\n\n```\n/src\n  ├── main\n  │   ├── java\n  │   │   └── com.example            # Java source code\n  │   │       ├── controller         # API Controllers\n  │   │       ├── service            # Business Logic\n  │   │       └── repository         # Database Access Layer\n  │   └── resources\n  │       ├── application.yml        # Application Configuration\n  │       └── schema.sql             # Database Schema Initialization\n/docker-compose.yml                  # Docker Compose Configuration\n```\n\n---\n\n## 🔧 Configuration\n\n- **Database**: PostgreSQL  \n  Default configuration is provided in `application.yml`. Modify if needed.\n\n- **Port**:  \n  The application runs on `http://localhost:8080`.\n\n---\n\n## 📜 API Documentation\n\n- **Base URL**: `http://localhost:8080`\n- Example API Routes:\n  - `GET /shools` - Retrieve all School\n  - `POST /schools` - Create a new School\n  - `GET /Students` - Retrieve all Students\n  - `POST /students` - Create a new Student\n  - `PUT /students/{id}` - Update an item\n  - `DELETE /students/{id}` - Delete a existing student\n\n---\n\n## 🤝 Contributing\n\nContributions are welcome! If you'd like to contribute, follow these steps:\n\n1. Fork the repository.\n2. Create a feature branch: `git checkout -b feature-name`.\n3. Commit changes: `git commit -m 'Add some feature'`.\n4. Push to the branch: `git push origin feature-name`.\n5. Open a Pull Request.\n\n---\n\n## 📄 License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n---\n\n## 🛠 Technologies Used\n\n- **Spring Boot**\n- **PostgreSQL**\n- **Java 23**\n- **Docker \u0026 Docker Compose**\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fanirudhsharma777%2Fschool_directory","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fanirudhsharma777%2Fschool_directory","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fanirudhsharma777%2Fschool_directory/lists"}