{"id":22200669,"url":"https://github.com/mjeammet/dapy-p10_softdesk","last_synced_at":"2025-03-24T23:49:58.592Z","repository":{"id":39825786,"uuid":"423933010","full_name":"mjeammet/DAPY-P10_SoftDesk","owner":"mjeammet","description":"OpenClassrooms student project. Building an API with Django REST Framework.","archived":false,"fork":false,"pushed_at":"2023-04-21T21:51:13.000Z","size":90,"stargazers_count":1,"open_issues_count":3,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-30T03:14:07.416Z","etag":null,"topics":["api-rest","django-rest-framework","openclassrooms","student-project"],"latest_commit_sha":null,"homepage":"","language":"Python","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/mjeammet.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":"2021-11-02T17:13:01.000Z","updated_at":"2024-08-04T12:21:30.000Z","dependencies_parsed_at":"2024-12-02T15:37:35.491Z","dependency_job_id":"dd53e122-9c2a-4a56-a692-bd3dc06626e0","html_url":"https://github.com/mjeammet/DAPY-P10_SoftDesk","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/mjeammet%2FDAPY-P10_SoftDesk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mjeammet%2FDAPY-P10_SoftDesk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mjeammet%2FDAPY-P10_SoftDesk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mjeammet%2FDAPY-P10_SoftDesk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mjeammet","download_url":"https://codeload.github.com/mjeammet/DAPY-P10_SoftDesk/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245372367,"owners_count":20604490,"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":["api-rest","django-rest-framework","openclassrooms","student-project"],"created_at":"2024-12-02T15:36:09.288Z","updated_at":"2025-03-24T23:49:58.576Z","avatar_url":"https://github.com/mjeammet.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"![SoftDesk_logo](https://user.oc-static.com/upload/2020/09/22/16007803099977_P8%20%281%29.png)\r\n\r\n# General info\r\n\r\nA private API to manage SoftDesk's issues tracking system. \r\n\r\n# Usage\r\n\r\n## Installation\r\n\r\n```\r\n# Clone this repo\r\n$ git clone https://github.com/mjeammet/DAPY-P10_SoftDesk.git\r\n\r\n# Create environment\r\n$ python -m venv env\r\n\r\n# Activate environment\r\n$ python -m pip install --upgrade pip\r\n\r\n# Upgrade pip and install packages into the environment to ensure proper behaviour:\r\n$ source env/bin/acivate\r\n$ pip install -r requirements.txt\r\n```\r\n\r\n## Create database\r\n\r\nIn order to initialise database, use commands\r\n```\r\n# To write migrations files\r\n$ python manage.py makemigrations issues_tracker\r\n\r\n# Migrate\r\n$ python manage.py migrate\r\n```\r\n\r\nYour database is now created but empty. You can use signup endpoint to create users or create superuser with:\r\n```\r\n$ python manage.py createsuperuser\r\n```\r\n\r\n## Run server\r\n\r\nAfter sourcing environment, simply run\r\n```\r\n$ python manage.py runserver\r\n```\r\n\r\nServer will start at [http://127.0.0.1:8000](http://127.0.0.1:8000).\r\n\r\n## Features and permissions\r\n\r\n| Action | Permission |\r\n|-|-|\r\n| Create an account | Everyone |\r\n| Login | Everyone |\r\n| Create a project | Every authenticated user |\r\n| Add/remove contributors to project | Project owner |\r\n| Create issues and comments | Project contributor |\r\n| List/read issues and comments | Project contributor |\r\n| Modify or delete project, issue and comment | Project/Issue/Comment author |\r\n| * | Superuser |\r\n\r\n# API documentation \r\n\r\nAPI documentation can be found on [https://documenter.getpostman.com/view/17508081/UVJbJy2v](https://documenter.getpostman.com/view/17508081/UVJbJy2v)\r\n\r\n# Code consistency\r\n\r\nCode consistency was ascertained using flake8 package.\r\n\r\n`flake8 --format=html --htmldir=flake8_report` to generate a new report.\r\n\r\n# Credits\r\n\r\nThis program uses the following packages:\r\n- Djando Rest Framework\r\n- Nested routers\r\n- flake8\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmjeammet%2Fdapy-p10_softdesk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmjeammet%2Fdapy-p10_softdesk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmjeammet%2Fdapy-p10_softdesk/lists"}