{"id":19646821,"url":"https://github.com/ralph-souza/students_registration_api","last_synced_at":"2025-06-17T15:40:32.255Z","repository":{"id":157349990,"uuid":"577692569","full_name":"Ralph-souza/students_registration_API","owner":"Ralph-souza","description":"A starting project that gather students info for registration purposes.","archived":false,"fork":false,"pushed_at":"2023-01-12T21:42:54.000Z","size":41,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-27T00:17:39.962Z","etag":null,"topics":["django-rest-framework","makefile","pytest","python","python-poetry","unittest"],"latest_commit_sha":null,"homepage":"","language":"Python","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/Ralph-souza.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":"2022-12-13T10:06:30.000Z","updated_at":"2022-12-15T20:16:37.000Z","dependencies_parsed_at":null,"dependency_job_id":"8e15154b-e057-4658-af16-9e0797d5bdaf","html_url":"https://github.com/Ralph-souza/students_registration_API","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Ralph-souza/students_registration_API","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ralph-souza%2Fstudents_registration_API","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ralph-souza%2Fstudents_registration_API/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ralph-souza%2Fstudents_registration_API/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ralph-souza%2Fstudents_registration_API/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Ralph-souza","download_url":"https://codeload.github.com/Ralph-souza/students_registration_API/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ralph-souza%2Fstudents_registration_API/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260390092,"owners_count":23001863,"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":["django-rest-framework","makefile","pytest","python","python-poetry","unittest"],"created_at":"2024-11-11T14:40:52.484Z","updated_at":"2025-06-17T15:40:27.237Z","avatar_url":"https://github.com/Ralph-souza.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Students Registration API\n\nThis is a simple API project that should provide a CRUD for archiving students registration info.\n\n## Usage\n\nIn order to run the application:\n\nTo build image\n```commandline\ndocker build -t student-registration-image:latest .\n```\n\nTo run the container\n```commandline\ndocker compose up -d\n```\n\n## Data Base Structure\n\n\u003cdiv style=\"display: inline-block\"\u003e\u003c/br\u003e\n    \u003cimg alt=\"DB Diagram\" align=\"center\" src='https://drive.google.com/file/d/1QjwkEH85OtjmY6fNm8cJR-KKsrtgqoda/view?usp=share_link'\u003e\n\u003c/div\u003e\u003c/br\u003e\n\n## Endpoints\n\nThere are 2(two) endpoints here:\n\n```commandline\n{\n    \"student\": \"http://127.0.0.1:8000/v1/api/student/\",\n    \"registration\": \"http://127.0.0.1:8000/v1/api/registration/\"\n}\n```\nThose endpoints provides unique payloads, the first one provides basic information about the student, creating this\none allow us to create the registration. The payload from it has the following structure:\n\n```commandline\n{\n    \"id\": \"f5869422-5a0e-444c-8e9d-99f00ffd63d9\",\n    \"name\": \"Some student`s name\",\n    \"id_doc\": \"99999999999\",\n    \"created_at\": \"2022-12-13T18:28:47.371501-03:00\"\n}\n```\n\nThe second one will provide information about the student registration. The payload structure to this one is:\n\n```commandline\n{\n    \"id\": 1,\n    \"email\": \"some_student@domain.com\",\n    \"phone\": \"Some student phone number\",\n    \"gender\": \"male\",\n    \"degree\": \"other\",\n    \"contact_name\": \"Some student`s second or responsible contact\",\n    \"contact_number\": \"Responsible contact number\",\n    \"relationship\": \"mother\",\n    \"student\": \"5456ce9d-8a91-430d-8a01-db0ed614077e\"\n}\n```\n\nTo successfully create this registration profile we must have the \"student\" ID generated by the first one.\n\n## HTTP Requests Collection\n\nThe links bellow allow you to download each collection`s .json file.\n\n[Student Registration Collection](https://drive.google.com/uc?export=view\u0026id=1PFiODE3eKAsQ9-HgMN7RunJAHqa1Dw9s)\u003c/br\u003e\n\n## License\n\n[MIT](https://choosealicense.com/licenses/mit/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fralph-souza%2Fstudents_registration_api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fralph-souza%2Fstudents_registration_api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fralph-souza%2Fstudents_registration_api/lists"}