Scrap & Trace Mobile Application (React Native/JavaScript)

Install Instructions

As a part of the Scrap and Trace project for our third year group project, we developed a mobile application for Android and iOS devices. This application was developed using React Native, a framework for developing mobile applications using JavaScript. This repository contains the source code for the application. To get started with the application, you will need to install the following:

• Node.js
• npm
• npx
• Expo Go
• Visual Studio Code
• Git

To get started, you will first need to install Visual Studio Code. You can download the installer for your operating system from here. Once installed, it is recommended that you install the following extensions:

• React Native Tools (by Microsoft) - This extension provides support for React Native development in Visual Studio Code.
• React-Native/React/Redux snippets for es6/es7 (by EQuimper) - This extension provides snippets for React Native development in Visual Studio Code.
• ES7+ React/Redux/React-Native snippets (by dsznajder) - This extension provides snippets for React Native development in Visual Studio Code.
• WSL (by Microsoft) - This extension provides support for the Windows Subsystem for Linux (WSL) in Visual Studio Code. (This is only required if you are using Windows.)

Next, clone the repository from GitHub. You can do this by running the following command in your terminal or using the Visual Studio Code Git interface:

git clone git@github.com:scrap-and-trace/ScrapAppReact.git

Note that at this time, the repository is private, so you will need to have access to the repository in order to clone it. It will be made public once the project is complete.

Once you have downloaded the repository, you will need to install nvm, which is a Node Version Manager. This will allow you to easily switch between different versions of Node.js. You can install nvm by running the following command on Unix-like systems such as GNU/Linux and macOS:

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.35.3/install.sh | bash

You can also install Node.js directly through your distribution's package manager.

Note that on Windows, the team recommended that you install nvm using the Windows Subsystem for Linux (WSL). You can find instructions on how to do this here. Once you have installed WSL, you can install nvm by running the following command:

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.35.3/install.sh | bash

Alternatively, you can install nvm-windows by downloading the installer from here.

Once nvm has been installed, you will need to install Node.js. You can do this by running the following command:

nvm install node

This will install the latest version of Node.js, which is typically what the app will be using. Once installed, you can check that Node.js has been installed by running nvm ls.

Now, navigate to the directory where you cloned the repository. Once there, you will need to install the dependencies for the project. Specifically, you will need to install npx, which is a package runner built for Node.js, utilised by Expo CLI, which is the tool we will be using to run the app. You can install npx by running the following command:

npm install -g npx

Once npx has been installed, open the project in Visual Studio Code. NPX will automatically install the dependencies for the project. You can get started by running the following command:

npx expo start

This will start the development server for the app. You can then scan the QR code using the Expo Go app on your mobile device to run the app. Expo Go is available for both Android and iOS devices. You can download it from the Google Play Store or the App Store. Note that you will need to be connected to the same network as your computer in order to run the app. Once you have scanned the QR code, the app will start running on your device.

It is important to note that the app will not work properly unless you have the backend server running and correctly configured.