Get Started

Academic® es la app para colegios y universidades líder en México. Lleva tu experiencia escolar a su máximo potencial.

Getting Started

Sigue estos pasos para comenzar a trabajar con este proyecto en tu entorno de desarrollo local.

Requisitos Previos

Antes de empezar, asegúrate de que tengas instalados los siguientes requisitos:

Flutter (versión 3.27 o superior)
Dart (versión 3.6 o superior)

Instalación

Clona el repositorio desde GitHub:

git clone https://github.com/bit-mx/academic-app

Navega al directorio del proyecto:
Terminal window
```
cd academic_app
```
Instala las dependencias del proyecto:
Terminal window
```
flutter pub get
```

Configuración

Para poner en funcionamiento este proyecto, debes seguir estos pasos de configuración:

Archivo .env:

Crea un archivo .env en la raíz del proyecto, basándote en el archivo .env.example proporcionado. Este archivo .env debe contener las variables de entorno necesarias para tu proyecto, como credenciales de API, claves secretas, etc. Asegúrate de completar todas las variables requeridas de acuerdo con las especificaciones del proyecto.
Archivo firebase-messaging-sw.js:

Agrega el archivo firebase-messaging-sw.js en la raíz del proyecto. Si el líder del proyecto te proporciona este archivo, colócalo directamente en la raíz del proyecto. Este archivo es esencial para la funcionalidad de Firebase Messaging.
Archivo key.properties (Android):

En la carpeta android, agrega el archivo key.properties. Este archivo es necesario para la configuración de claves de firma y otros ajustes específicos de Android. Asegúrate de que el líder del proyecto te otorgue este archivo con las configuraciones adecuadas.
Archivo key.jks (Android/app):

En la carpeta android/app, agrega el archivo key.jks. Este archivo se utiliza para la firma de aplicaciones Android y es crítico para la distribución de la aplicación en la tienda de Google Play. Asegúrate de obtener este archivo del líder del proyecto con las claves de firma necesarias.

Una vez que hayas completado estos pasos de configuración, el proyecto debería estar listo para funcionar correctamente. Asegúrate de mantener los archivos de configuración seguros y no los compartas públicamente en repositorios de código abierto.

Ejecución

Una vez que hayas completado la instalación y configuración, puedes ejecutar la aplicación con el siguiente comando:

flutter run

Esto lanzará la aplicación en un emulador o en un dispositivo físico, según tu configuración.

Preguntas y Problemas

Si tienes preguntas o encuentras algún problema, no dudes en checar la documentación o en abrir un issue en GitHub.

¡Gracias por usar Academic App!