{"id":17432074,"url":"https://github.com/devaziz0/sbaclean","last_synced_at":"2025-03-28T01:15:40.588Z","repository":{"id":121997592,"uuid":"208451438","full_name":"devaziz0/SbaClean","owner":"devaziz0","description":null,"archived":false,"fork":false,"pushed_at":"2019-09-14T14:50:46.000Z","size":18011,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-02-02T02:45:58.946Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"CSS","has_issues":false,"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/devaziz0.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":"2019-09-14T14:24:31.000Z","updated_at":"2019-09-16T02:48:04.000Z","dependencies_parsed_at":"2024-08-28T04:02:34.666Z","dependency_job_id":null,"html_url":"https://github.com/devaziz0/SbaClean","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devaziz0%2FSbaClean","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devaziz0%2FSbaClean/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devaziz0%2FSbaClean/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devaziz0%2FSbaClean/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/devaziz0","download_url":"https://codeload.github.com/devaziz0/SbaClean/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245949652,"owners_count":20698925,"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":[],"created_at":"2024-10-17T08:23:59.336Z","updated_at":"2025-03-28T01:15:40.573Z","avatar_url":"https://github.com/devaziz0.png","language":"CSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"# SbaClean\n\nSbaClean is a project that link **Sidi Bel Abbes City hall** and its **citizens** witch are able to report any anomaly found.\n\n# SbaClean Back End\n\nThe project Back End is built using `Django` and `Django Rest Freamwork` all the requirement are included in the  `requirements.txt`.\n\nthe project is composed of 5 django apps:\n - Account\n - Address\n - Post\n - Anomaly\n - Event\n\n## Setting up the Back End\n\nClone the project using `git`\n\n    git clone github.com/ilyes24/SbaClean\n    python manage.py makemigrations\n    python manage.py migrate\nDownload the project requirements\n\n\tpip install -r requirements.txt\n\t\nFIRE IT UP!\n\n    pyhton manage.py runserver\n## API Road-Map\n\n**SwaggerUI**\n\n    method : GET\n    URL : hostname/api/v1/\n\n**Register**\n    \n    method : POST\n    URL : hostname/api/v1/accounts/register/\n\n**Get Token**\n\n    method : POST \n    URL : hostname/api-token-auth/\n    \n`add Token to the HTTP method header\n[Authorization Token 9d92c2fa2f220e4b1d6fdb7c773d838c1f33883d]`\n    \n**List Users**\n    \n    method : GET\n    URL : hostname/api/v1/accounts/\n\n**Retrieve and Update User**\n    \n    method : GET and (PUT | PATCH) \n    URL : hostname/api/v1/accounts/\u003cpk\u003e\n    \n**List and Create State**\n    \n    method : GET and POST\n    URL : hostname/api/v1/address/state/\n\n**Retrieve, Update and Delete a State**\n    \n    method : GET, (PUT || PATCH) and DELETE\n    URL : hostname/api/v1/address/state/\u003cpk\u003e\n    \n**Filtering State By `name` and|or `code`**\n\n    method : GET\n    URL : hostname/api/v1/address/state?name=XXX\u0026code=00\n    \"`name` contains XXX\" \"`zip_code` exact value 00\"\n    \n**List and Create City**\n    \n    method : GET and POST\n    URL : hostname/api/v1/address/city/\n\n**Retrieve, Update and Delete a City**\n    \n    method : GET, (PUT || PATCH) and DELETE\n    URL : hostname/api/v1/address/city/\u003cpk\u003e\n    \n**Filtering City By `name` and|or `zip_code`**\n\n    method : GET\n    URL : hostname/api/v1/address/city?name=XXX\u0026zipcode=00\u0026state=11\n    \"`name` contains XXX\" \"`zip_code` exact value 00\" \"`state` exact value 11\"\n    \n**List and Create Post**\n    \n    method : GET and POST\n    URL : hostname/api/v1/posts/post/\n\n**Retrieve, Update and Delete a Post**\n    \n    method : GET, (PUT || PATCH) and DELETE\n    URL : hostname/api/v1/posts/post/\u003cpk\u003e\n    \n**Filtering Post**\n\n    method : GET\n    URL : hostname/api/v1/posts/post?owner=idOwner\u0026title=title\u0026city=idCity\u0026discription=azerty\n    \"`owner` exact idOwner\" \"`title` exact title\" \"`city` exact idCity\" \"`discription` exact azerty\"\n    \n**List and Create Comment**\n    \n    method : GET and POST\n    URL : hostname/api/v1/posts/comment/\n\n**Retrieve, Update and Delete a Comment**\n    \n    method : GET, (PUT || PATCH) and DELETE\n    URL : hostname/api/v1/posts/comment/\u003cpk\u003e\n\n**Filtering Comment By user and|or post**\n\n    method : GET\n    URL : hostname/api/v1/posts/comment?owner=idOwner\u0026post=idPost\n    \"`owner` exact idOwner\" \"`post` exact idPost\"\n\n**List and Create Reaction**\n    \n    method : GET and POST\n    URL : hostname/api/v1/posts/reaction/\n\n**Retrieve, Update and Delete a Reaction**\n    \n    method : GET, (PUT || PATCH) and DELETE\n    URL : hostname/api/v1/posts/reaction/\u003cpk\u003e\n    \n**Filtering Reaction By user and|or post**\n\n    method : GET\n    URL : hostname/api/v1/posts/reaction?owner=idOwner\u0026post=idPost\n    \"`owner` exact idOwner\" \"`post` exact idPost\"\n\n**List and Create Anomaly**\n    \n    method : GET and POST\n    URL : hostname/api/v1/anomalys/\n\n**Retrieve, Update and Delete a Anomaly**\n    \n    method : GET, (PUT || PATCH) and DELETE\n    URL : hostname/api/v1/anomalys/\u003cpk\u003e\n    \n**Filtering Anomaly**\n\n    method : GET\n    URL : hostname/api/v1/anomalys?post=idPost\u0026owner=idOwner\u0026title=title\u0026city=idCity\u0026discription=azerty\n    \"`post` exact idPost\" \"`owner` exact idOwner\" \"`title` exact title\" \"`city` exact idCity\" \"`discription` exact azerty\"\n\n**List and Create Anomaly Signal**\n    \n    method : GET and POST\n    URL : hostname/api/v1/anomalys/signal\n\n**Retrieve, Update and Delete a Anomaly Signal**\n    \n    method : GET, (PUT || PATCH) and DELETE\n    URL : hostname/api/v1/anomalys/signal/\u003cpk\u003e\n    \n**Filtering Anomaly**\n\n    method : GET\n    URL : hostname/api/v1/anomalys/signal?post=idPost\u0026signaledByBy=idUser\u0026owner=idOwner\u0026title=title\u0026city=idCity\u0026discription=azerty\n    \"`post` exact idPost\" \"`signaledBy` exact idUser\" \"`owner` exact idOwner\" \"`title` exact title\" \"`city` exact idCity\" \"`discription` exact azerty\"\n\n**List and Create Event**\n    \n    method : GET and POST\n    URL : hostname/api/v1/events/\n\n**Retrieve, Update and Delete a Event**\n    \n    method : GET, (PUT || PATCH) and DELETE\n    URL : hostname/api/v1/events/\u003cpk\u003e\n    \n**Filtering Event**\n\n    method : GET\n    URL : hostname/api/v1/events?post=idPost\u0026date=yyyy-mm-dd\u0026owner=idOwner\u0026title=title\u0026city=idCity\u0026discription=azerty\n    \"`post` exact idPost\" \"`date` littelOrEqual to yyyy-mm-dd\" \"`owner` exact idOwner\" \"`title` exact title\" \"`city` exact idCity\" \"`discription` exact azerty\"\n    \n**List and Create EventParticipation**\n    \n    method : GET and POST\n    URL : hostname/api/v1/events/participate\n\n**Retrieve, Update and Delete a EventParticipation**\n    \n    method : GET, (PUT || PATCH) and DELETE\n    URL : hostname/api/v1/events/participate\u003cpk\u003e\n    \n**Filtering EventParticipation**\n\n    method : GET\n    URL : hostname/api/v1/events/participate?post=idPost\u0026user=idUser\u0026date=yyyy-mm-dd\u0026owner=idOwner\u0026title=title\u0026city=idCity\u0026discription=azerty\n    \"`post` exact idPost\" \"`user` exact idUser\" \"`date` littelOrEqual to yyyy-mm-dd\" \"`owner` exact idOwner\" \"`title` exact title\" \"`city` exact idCity\" \"`discription` exact azerty\"\n\n**Get User Ranking**\n\n    method : GET\n    Parameters : limit, (user|city)\n    URL : hostname/api/v1/accounts/ranking/?limit=5\u0026user=1 OR hostname/api/v1/accounts/ranking/?limit=5\u0026city=1\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevaziz0%2Fsbaclean","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdevaziz0%2Fsbaclean","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevaziz0%2Fsbaclean/lists"}