StudyBox-EIP/front-mobile

This is Studybox phone client.

StudyBox's Mobile App

• StudyBox's Mobile App
• Installation
  • Requirements
  • Start developing
    • IOS
    • Android
    • Run tests
    • Lint tbe Code
• Development Status
  • Badges
  • Sprint Progress
• Documentation
• Information
  • Developpers

Installation

First of all, to be able to use this project you need to download a phone emulator for both Android and IOS. We recommand using tools such as Android Studio for the Android version.

Requirements

NodeJS >= 16
NPM >= 7
JDK == 11

Environment

.env File Content

• API_URL={PROD OR DEV BACKEND URL}

Start developing

To start developing you need to go to the Studybox directory and download the dependencies trough npm.

$ cd Studybox

---

IOS

This is how you can run the project for IOS.

$ npm install
$ npm run start

to get the executable you need to run this in an other terminal:

$ npm run ios

---

Android

This is how you can run the project for Android.

$ npm install
$ npm run start

to get the executable you need to run this in an other terminal:

$ npm run android

---

Run tests

Testing is important. This is why this command exist to lauch tests trought out the code.

$ npm run test

---

Lint tbe Code

Lintage is very important for the visual clarity of your code. This is why there is command to make it easily.

$ npm run lint

Development Status

Badges

Workflows	Status
ESLint Linter
Jest Testing Policy

Sprint Progress

Documentation

Currently Unavailable

Information

Developpers

• Chief Programer: Nathan MOIGNARD
• Main Programer: Nathan MOIGNARD