{"id":26415135,"url":"https://github.com/dotchoco/navi","last_synced_at":"2025-03-18T00:17:36.522Z","repository":{"id":225960639,"uuid":"767235574","full_name":"DotChoco/Navi","owner":"DotChoco","description":"It's an REST API was used in an web app for UDEM (Morelia's University) using Django Rest Framework.","archived":false,"fork":false,"pushed_at":"2024-04-17T13:32:09.000Z","size":61,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-12-19T04:39:12.710Z","etag":null,"topics":[],"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/DotChoco.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","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-03-04T23:44:34.000Z","updated_at":"2024-07-16T03:44:35.000Z","dependencies_parsed_at":"2024-03-18T23:29:53.131Z","dependency_job_id":"c73362b0-1235-4b62-8eae-cce71bf8ee2c","html_url":"https://github.com/DotChoco/Navi","commit_stats":null,"previous_names":["mrchocoreto/navi","dotchoco/navi"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DotChoco%2FNavi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DotChoco%2FNavi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DotChoco%2FNavi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DotChoco%2FNavi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DotChoco","download_url":"https://codeload.github.com/DotChoco/Navi/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244130309,"owners_count":20402756,"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":"2025-03-18T00:17:35.935Z","updated_at":"2025-03-18T00:17:36.509Z","avatar_url":"https://github.com/DotChoco.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Navi\n\n## About\nNavi it's an API REST created in python using Django and Django Rest Framework. This project was used in an web app for UDEM (Morelia's Univerty).\n\n## Installation \n\nClone the repository\n\n```sh\ngit clone https://github.com/MrChocoreto/Navi.git \n```\n\n## Setup Project\nYou might have python 3.12.2 intalled in your device.\n\nYou can ensure that is installed using this comand\n```sh\npython --version\n```\nIf you dont have install this version go to the official page to download.\n\n[python.org/downloads](https://www.python.org/downloads/)\n\n### Dependencies\n\u003e[!NOTE]\n\u003eTo create the environment the command works same for Linux and Windows. \n\n\u003e[!NOTE]\n\u003eI recommend create the environment if you're only work in local \n\n\n\nFirst you have to create your environment to have more control in the project\n```sh\npython -m venv env\n```\nNow you have execute the environment before to install the dependencies. To execute this commands you need be in the project path. \n\n#### Windows\n\n```sh\n./env/Scripts/activate\n```\n\n#### Linux\n```sh\nsource ./env/bin/activate\n```\n\nAfter that,              you need install the next dependencies:\n- setuptools\n\n```sh\npip install setuptools\n```\n- django\n\n```sh\npip install django \n```\n- django rest framework\n\n```sh\npip install djangorestframework\n```\n- coreapi\n\n```sh\npip install coreapi\n```\n\n- mysql\n\n```sh\npip install mysqlclient\n```\n\n### DataBase Setup\n\nTo use the database you need create the next configuration in MariaDB\n\n- user: ```navi```\n- password: ```1\u003efCT)},dfVZ6Rbv9q*.```\n- port: ```3306```\n- host: ```localhost```\n\nTo create the user in database if is not created:\n```sql\nCREATE USER 'navi'@localhost IDENTIFIED BY '1\u003efCT)},dfVZ6Rbv9q*.';\n```\nThen, give it the correct access to the database\n```sql\nGRANT USAGE ON *.* TO 'navi'@localhost IDENTIFIED BY '1\u003efCT)},dfVZ6Rbv9q*.';\n```\nGive the user access to the database\n```sql\nGRANT ALL ON `navi`.* TO 'navi'@localhost;\n```\nApply the changes\n```sql\nFLUSH PRIVILEGES;\n```\n\n#### Optional configurations\nIf you are using vscode, there are recommend extensions, one of them is pylint, you have to install pylint-django in your\nenvironment\n```sh\npip install pylint-django\n```\n\nAfter that, you have to modify the configuration of pylint in vscode, and add the following args,\nyou add this at ```Configuration -\u003e pylint -\u003e Pylint:args``` in VSCode UI\n```sh\n\"pylintArgs\": [\"--load-plugins=pylint_django\" ]\n```\n\n### Initialize API\n\nAfter to run the API you might do the next commands.\n```sh\npython manage.py makemigrations\n```\n```sh\npython manage.py migrate\n```\n\n\nFor the test in local you have to write this command.\n```sh\npython manage.py runserver\n```\n\n### Exit Environment\n\nIf you want to exit of your environment you need put the next command:\n\n```sh\ndeactivate\n```\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdotchoco%2Fnavi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdotchoco%2Fnavi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdotchoco%2Fnavi/lists"}