/safesteps-backend

Mobile App and Backend

Primary LanguageJavaScriptMIT LicenseMIT

safesteps-software

About

The purpose of this repository is to write code for the backend of the Safesteps app. This includes weather API integration and database management. For the purpose of this semester, this repo is not integral to the full product since the backend is minimal as of right now, but we will expand this in the spring semester.

Required Software

To get started running this project you will need to have the following setup to your computer:

-Node.js Version 19 or greater -VS Code or any code editor that can run React Native Apps -Have the Expo Go app installed on your mobile devices

Here are the links for the any of the softwares that you would required to be installed

Getting Started

  1. Clone this repository to your local desktop:

    git clone git@github.com:rithvik-doshi/safesteps-software.git
  2. change the directory to where you clone your repository on your Desktop

    cd "\safesteps-software"
  3. Change the directory to the frontend directory in order to install all the dependencies for the app

    cd ".\safesteps-software\frontend\safesteps\"

Running the app

Once you have cloned the repository from github, here are the next steps you will follow

  1. Open the terminal on your computer and run the following commands:

  2. Install the project dependencies for the app under the directory above

    npm install 
  3. Install Expo framework on your computer

    npm install -g expo-cli
  4. Start the development server on your computer

    npx expo start

How to view the app from your phone

Once your server is up and running, make sure your computer and phone are connected to the same WiFi in order to connect the app. There will be a QR code for you to scan and will launch the Expo app on your phone.