Wolfinbarger / game-recommender

A full-stack web app that helps you discover awesome games to play with your friends or solo.
0 stars 0 forks source link

Issue 16: Replaced FastAPI with Django and migrated our existing models. #18

Closed FreakyNobleGas closed 9 months ago

FreakyNobleGas commented 9 months ago

Replaced FastAPI with Django and migrated our existing models for issue #16. The README in our api directory has instructions for setting up Django for local development.

I followed Django's tutorial in their official documentation to learn how to setup the framework.

The new folder structure: api/api - This is the Python package for the project and used to import anything inside the project. By default, this inner folder has the same name as the project. api/games - In Django, you create apps that are used within your project. This directory is the Games app which holds our models for Games, Multiplayer, and Platforms.

gitguardian[bot] commented 9 months ago

⚠️ GitGuardian has uncovered 2 secrets following the scan of your pull request.

Please consider investigating the findings and remediating the incidents. Failure to do so may lead to compromising the associated services or software components.

🔎 Detected hardcoded secrets in your pull request
| GitGuardian id | Secret | Commit | Filename | | | -------------- | ------------------------- | ---------------- | --------------- | -------------------- | | [8058468](https://dashboard.gitguardian.com/incidents/8058468?occurrence=114024291) | Django Secret Key | f3a6f420a9a59f9e5421bb2689d8a8c55c93c637 | src/api/api/settings.py | [View secret](https://github.com/Wolfinbarger/game-recommender/commit/f3a6f420a9a59f9e5421bb2689d8a8c55c93c637#diff-fea3df071f9eff4b2481e28094790f9f3c8986f3e8baeae27c634425bebe7dffR23) | | [8058468](https://dashboard.gitguardian.com/incidents/8058468?occurrence=114041586) | Django Secret Key | abdcf504d808a53331a88e154874a05e4c25d8bb | src/api/api/settings.py | [View secret](https://github.com/Wolfinbarger/game-recommender/commit/abdcf504d808a53331a88e154874a05e4c25d8bb#diff-fea3df071f9eff4b2481e28094790f9f3c8986f3e8baeae27c634425bebe7dffL23) |
🛠 Guidelines to remediate hardcoded secrets
1. Understand the implications of revoking this secret by investigating where it is used in your code. 2. Replace and store your secrets safely. [Learn here](https://blog.gitguardian.com/secrets-api-management?utm_source=product&utm_medium=GitHub_checks&utm_campaign=check_run_comment) the best practices. 3. Revoke and [rotate these secrets](https://docs.gitguardian.com/secrets-detection/detectors/specifics/secret_key_in_django_config#revoke-the-secret?utm_source=product&utm_medium=GitHub_checks&utm_campaign=check_run_comment). 4. If possible, [rewrite git history](https://blog.gitguardian.com/rewriting-git-history-cheatsheet?utm_source=product&utm_medium=GitHub_checks&utm_campaign=check_run_comment). Rewriting git history is not a trivial act. You might completely break other contributing developers' workflow and you risk accidentally deleting legitimate data. To avoid such incidents in the future consider - following these [best practices](https://blog.gitguardian.com/secrets-api-management/?utm_source=product&utm_medium=GitHub_checks&utm_campaign=check_run_comment) for managing and storing secrets including API keys and other credentials - install [secret detection on pre-commit](https://docs.gitguardian.com/ggshield-docs/integrations/git-hooks/pre-commit?utm_source=product&utm_medium=GitHub_checks&utm_campaign=check_run_comment) to catch secret before it leaves your machine and ease remediation.

🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.

Our GitHub checks need improvements? Share your feedbacks!

FreakyNobleGas commented 9 months ago

⚠️ GitGuardian has uncovered 2 secrets following the scan of your pull request.

Please consider investigating the findings and remediating the incidents. Failure to do so may lead to compromising the associated services or software components.

🔎 Detected hardcoded secrets in your pull request 🛠 Guidelines to remediate hardcoded secrets 🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.Our GitHub checks need improvements? Share your feedbacks!

Rotated this secret key locally. We're not deployed to any environment except local, so this is very low risk having this key exposed.