Giter Club home page Giter Club logo

capstone_mobile's Introduction

Mobile

This repository contains the code for the base mobile application.

Requirements

The requirements are simple! You just need:

Run application for local development

To start the server, first create a .env file with all the environmental variables:

cp .env.example .env
nano .env  # Or use your favorite text editor

Then, install the dependencies:

yarn install

Finally, run project:

expo start

If you are using wsl, you need to start the project using tunneling (the expo CLI will need to install @expo/ngrok to manage the tunneling for you):

expo start --tunnel

Now, there are a couple ways you can use the app after starting the expo server. You can either install the Expo Go app in your phone and scan the QR code displayed after starting the expo server (notice that your phone and your computer must be connected to the same network for this to work) or you can use an iOS or Android emulator.

Environmental variables

There are some environmental variables that need to be added to the repository:

  • DEVELOPMENT_URL: Defines the development URL of the app. This URL gets used when the app is running on development mode. Defaults to http://{local-machine-ip}:8000, where {local-machine-ip} corresponds to the IP on the local network of the machine that started the expo server. Warning: this may be useless to wsl users, given that the subsystem runs on a completely different network than the physical machines.
  • GOOGLE_CLIENT_ID: Required on production. This is the client ID of the Google project that allows logins of the users through Google.

Aliases

There is an alias configured using babel. This alias allows you to import something from the src folder when you are deeply nested on another folder using @/MyComponent.jsx instead of having to use ../../../../../../../../MyComponent.jsx (@ is a shortcut to get to src).

Running the linters

This project includes two linters, namely ESLint and StyleLint. The former lints the JavaScript code, while the latter lints the styling code. These linters will need to be passing throughout the whole development, and will be enforced by the CI pipeline. You will first need to install all the dependencies to run the tests. To achieve this, run:

yarn install --frozen-lockfile

This will install all the node_modules without altering the yarn.lock file. Finally, you can run the linters using the make commands included:

make eslint
make stylelint

You can also format your code automagically using eslint. To do this, just run:

make eslint!

capstone_mobile's People

Contributors

absoto4 avatar arcoirisky avatar bpeirano1 avatar daleal avatar vicentegonz avatar

Watchers

 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.