Git Product home page Git Product logo

tin-marin-app's Introduction

Tin Marín App

Tin Marín App es una aplicación móvil que tiene como objetivo colocar los servicios del museo de los niños a disposición de todo público para generar una base de conocimientos sólida en los visitantes.

Tecnologías

Entorno de desarrollo:

Dependiendo del dispositivo con el que desees trabajar para desarrollar en React Native, será la configuración que deberás realizar.

Debido a que el proyecto fué solicitado únicamente para Android, cualquier sistema operativo (Windows, Linux, Unix), será útil.

Un breve resumen de los pasos a realizar ya que son apartados que tienen su propia documentación oficial:

  1. Descargar e instalar las siguientes dependencias: -NodeJS. -JDK. -Android-Studio.

  2. Configurar entornos de desarrollo: Configuración de entorno.

Instalando paquetes.

El proyecto utiliza librerías de terceros de código abierto, que permiten evitar que reinventemos la rueda. Para encontrar todas estas dependencias, las puedes ubicar en la carpeta raíz del proyecto, en el archivo llamado "package.json".

Para instalar las librerías abre una consola que utilice el manejador de paquetes de node "npm" y digita en la consola: npm install

Este proceso puede tardar, ya que va a descargar todas estas dependencias y las almacenará en la carpeta "node_modules" ubicada en la raíz del proyecto.

Levantando la aplicación.

Si lograste configurar bien tu entorno de desarrollo, no deberías tener ningún problema hasta este punto. En una terminal digita el siguiente comando: npm run android

Sucederá lo siguiente:

  1. Levantará una consola Metro Bundler, que es el motor que traducirá los códigos javascript, a código nativo Android o iOS.

  2. Levantará un emulador virtual que previamente configuraste en Android Studio al configurar tu entorno de desarrollo. Si prefieres usar un dispositivo físico, visita el apartado Run on Physical Device.

  3. Instalará en el dispositivo Android la aplicación y dependerá totalmente de Metro Bundler. Esto significa que la aplicación está configurada para el entorno de desarrollo, y no para un entono de producción.

  4. Una vez instalada se levantará la aplicación corriendo en tu dispositivo.

Toma en cuenta que el comando utilizado es un acortado del comando oficial utilizado en la documentación con react native cli: react-native run-android o si no instalaste esta herramienta de forma global la puedes utilizar desde la carpet "node_modules" anteponiendo el comando npx: npx react-native run-android.

Documentación Manual Técnico.

Disponemos de un manual técnico automatizado. Utilizamos ESDoc para hacer las anotaciones que permiten generar la Wiki de forma rápida.

Para generar la documentación basta con correr el siguiente comando: npm run docs

Va a tardar un momento hasta devolvernos el control de la consola. Como resultado, se creará una carpeta llamada "docs" en la raíz del proyecto. Es un sitio estático al cuál puedes acceder manualmente y abriendo el archivo "index.html"; o si deseas hacerlo desde consola puedes ejecutar el siguiente comando:

start ./docs/index.html (Windows)

tin-marin-app's People

Contributors

deryan98 avatar cjburgos21 avatar crcr97 avatar azzarcm avatar

Stargazers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.