caverav / auditforge

AuditForge is a pentest reporting application making it simple and easy to write your findings and generate a customizable report.
https://auditforge.feriadesoftware.cl
MIT License
1 stars 0 forks source link

✨ feat: use .env file for API url #100

Closed caverav closed 11 hours ago

caverav commented 4 days ago

Descripción

Se agrega el uso de variables de entorno para las URLs de la API

Motivación y Contexto

Está mal hardcodear las URLs, fixes #99

¿Cómo ha sido probado?

Probar el flujo de la aplicación, funcionando correctamente las llamadas a la API

Tipos de cambios

Lista de verificación:

Summary by CodeRabbit

coderabbitai[bot] commented 3 days ago
Walkthrough ## Walkthrough Se han realizado cambios significativos en el código del frontend para implementar el uso de variables de entorno, específicamente para la configuración de URLs de servicios. Se ha añadido un archivo `.env.example` como plantilla, y se ha modificado el `Dockerfile` para incluir el archivo `.env`. Además, se han actualizado múltiples archivos para que utilicen variables de entorno en lugar de URLs codificadas, mejorando así la flexibilidad del entorno de desarrollo y despliegue. ## Changes | Archivos | Resumen de cambios | |-------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------| | `.gitignore`, `frontend/.env.example`, `frontend/Dockerfile` | Se añadió `.env` al `.gitignore`, se creó un archivo `.env.example` con la variable `API_URL`, y se actualizó el `Dockerfile` para copiar el archivo `.env` en la imagen de Docker. | | `frontend/src/hooks/useAuth.tsx`, `frontend/src/routes/audits/edit/AuditRoot.tsx`, `frontend/src/services/audits.ts`, `frontend/src/services/data.ts`, `frontend/src/services/settings.ts`, `frontend/src/services/vulnerabilities.ts` | Se modificaron las constantes `API_URL` y se reemplazaron las URLs codificadas por referencias a `import.meta.env.VITE_API_URL`, mejorando la adaptabilidad del código a diferentes entornos. | ## Assessment against linked issues | Objetivo | Abordado | Explicación | |-----------------------------------------------|----------|------------------------------------------------------| | Uso de variables de entorno para IP's/puertos (#[99]) | ✅ | | | Implementación de un archivo `.env` en el frontend (#[99]) | ✅ | | | Modificación del endpoint en la función de logout (#[99]) | ❌ | No se menciona un cambio específico en la función de logout. |

Recent review details **Configuration used: CodeRabbit UI** **Review profile: ASSERTIVE**
Commits Files that changed from the base of the PR and between 24a75e89a413050d33253520f966c2a385039d3f and 314aaf151332396708607f126252c96a85c1afd3.
Files selected for processing (1) * frontend/src/routes/profile/profile.tsx (1 hunks)
Additional comments not posted (2)
frontend/src/routes/profile/profile.tsx (2)
`50-50`: **Excelente uso de variables de entorno para la URL de la API** El cambio a `import.meta.env.VITE_API_URL` mejora la flexibilidad y facilita la configuración en diferentes entornos. ¡Buen trabajo! --- `50-50`: **Asegurar la definición de VITE_API_URL en todos los entornos** Es importante confirmar que la variable de entorno `VITE_API_URL` esté definida en todos los entornos de ejecución para evitar errores en tiempo de ejecución.
--- Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?
Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): > :bangbang: **IMPORTANT** > Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged. - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: -- `@coderabbitai generate unit testing code for this file.` -- `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: -- `@coderabbitai generate interesting stats about this repository and render them as a table.` -- `@coderabbitai read src/utils.ts and generate unit testing code.` -- `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` -- `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (Invoked using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
Early access features: enabled We are currently testing the following features in early access: - **OpenAI `o1` for code reviews**: OpenAI's new `o1` model is being tested for code reviews. This model has advanced reasoning capabilities and can provide more detailed feedback on your code. Note: - You can enable or disable early access features from the CodeRabbit UI or by updating the CodeRabbit configuration file. - - Please join our [Discord Community](https://discord.com/invite/GsXnASn26c) to provide feedback and report issues on the [discussion post](https://discordapp.com/channels/1134356397673414807/1279579842131787838).
jllanosg commented 15 hours ago

xq la url debe ir con el nombre VITE_API_URL?

caverav commented 11 hours ago

xq la url debe ir con el nombre VITE_API_URL?

Se explica bien en la documentación (https://vitejs.dev/guide/env-and-mode) pero básicamente las variables iniciadas en VITE_ se exponen al cliente, cualquier otra no