Skip to content

Latest commit

 

History

History
52 lines (39 loc) · 1.95 KB

README.md

File metadata and controls

52 lines (39 loc) · 1.95 KB

NOTE: This project was done for the course 1DT003 Computer Systems with Project Work at Uppsala University by the following members:


The Real Deal - Frontend

logo

This repository hosts the frontend of our project, The Real Deal, written in React Native and built and run using Expo and the backend application which communicates with this application can be found here.

First Time

When you've successfully cloned this repo, enter the src folder and run:

npm i

This installs all the dependencies this project requires. This process should not differ from MacOS, Linux or Windows assuming you've successfully installed NodeJS on your host machine.

Usage

To connect a client, enter the src folder from another terminal and simply run:

npm start

Then Expo will launch in your browser and you can choose between previewing in a browser or using a iOS/Android emulator. If you choose the browser your console should look something like this:

image

Documentation

To generate documentation, you can simply run:

npm run document

This will generate the src/out/ folder where index.html will contain all generated documentation.

Clean

To clean up temporary files or files that should not be commited, simply run:

npm run clean