{"id":26022769,"url":"https://github.com/madihanazir/students-api","last_synced_at":"2026-05-13T23:35:51.278Z","repository":{"id":278896519,"uuid":"937106883","full_name":"madihanazir/students-api","owner":"madihanazir","description":"Students API is a lightweight and efficient RESTful API built with Go and SQLite, designed to manage student records. It provides essential CRUD operations (Create, Read, Update, Delete) along with a HEAD request to check if a student exists without fetching their full details.","archived":false,"fork":false,"pushed_at":"2025-02-22T11:46:49.000Z","size":23,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-02-22T12:18:29.316Z","etag":null,"topics":["backend","backend-api","golang","restful-api","sqlite","tableplus"],"latest_commit_sha":null,"homepage":"","language":"Go","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/madihanazir.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":"2025-02-22T10:58:11.000Z","updated_at":"2025-02-22T11:54:09.000Z","dependencies_parsed_at":"2025-02-22T12:18:33.348Z","dependency_job_id":"a26b4bc6-73f3-424c-aefa-39237692b5db","html_url":"https://github.com/madihanazir/students-api","commit_stats":null,"previous_names":["madihanazir/students-api"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/madihanazir%2Fstudents-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/madihanazir%2Fstudents-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/madihanazir%2Fstudents-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/madihanazir%2Fstudents-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/madihanazir","download_url":"https://codeload.github.com/madihanazir/students-api/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242189959,"owners_count":20086669,"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":["backend","backend-api","golang","restful-api","sqlite","tableplus"],"created_at":"2025-03-06T10:26:23.452Z","updated_at":"2025-10-14T06:07:41.535Z","avatar_url":"https://github.com/madihanazir.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 📚 Students API\n\nA simple RESTful API to manage students using SQLite as the database. This project implements basic CRUD operations (Create, Read, Update, Delete) along with additional HTTP methods like `HEAD` to check if a student exists.\n\n## ✨ Features  \n\n- **Create**: Add a new student.  \n- **Read**: Retrieve student details by ID or list all students.  \n- **Update**: Modify an existing student's details.  \n- **Delete**: Remove a student from the database.  \n- **Existence Check**: Use the `HEAD` request to verify if a student exists without retrieving full data.  \n\n---\n## ⚙️ Prerequisites  \n\nBefore running the project, ensure you have:  \n\n- [Go](https://golang.org/doc/install) (version 1.18+).  \n- SQLite3 installed for database management.  \n- [Postman](https://www.postman.com/) or any HTTP client for API testing.  \n\n---\n## 🚀 Installation  \n\n### 1️⃣ Clone the Repository  \n\n```sh```\ngit clone https://github.com/madihanazir/students-api.git\ncd students-api\n### 2️⃣ Install Dependencies\n\ngo mod tidy\n\n### 3️⃣ SQLite Setup\nSQLite is used as the database, and the required tables will be created automatically when the application runs.\n\nIf you want to inspect the database or perform manual queries, install SQLite by following the instructions here.\n\n### ⚙️ Configuration\nThe project supports configuration via a .env file. Create one and add the following environment variables (optional):\nEdit\nHTTP_SERVER_ADDR=\":8080\"\nSTORAGE_PATH=\"storage/storage.db\"\n\n### ▶️ Running the Application\nStart the API server with:\ngo run cmd/main.go\nThe API will be available at: http://localhost:8080.\n\n### 🛠️ API Testing with Postman\n✅ Install Postman\nDownload and install Postman.\n✅ How to Use Postman for API Testing\nStart the server:\n\n\ngo run cmd/main.go\nSend API requests:\n\n# Use Postman to make GET, POST, PUT, DELETE, and HEAD requests to test the API.\n### 🗄️ Database Setup \u0026 Visualization\nOption 1: Using TablePlus (Recommended)\nDownload TablePlus for your OS.\nOpen TablePlus and click \"Create a new connection\".\nSelect \"SQLite\", then choose storage/storage.db.\nClick \"Connect\" to explore and manage the database visually.\n### 📬 Contact\nFor any questions or suggestions, feel free to reach out:\n📧 madihan541@gmail.com\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmadihanazir%2Fstudents-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmadihanazir%2Fstudents-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmadihanazir%2Fstudents-api/lists"}