Skip to content

Latest commit

 

History

History
51 lines (23 loc) · 1.36 KB

File metadata and controls

51 lines (23 loc) · 1.36 KB

Finddit

Getting started

Finddit is a React Native developed app using the expo development package. To get the app up and running, the user needs to start the client, backend and ngrok.

General Instructions

  • An Android/IOS device with the Expo Go app installed.
  • Ensure the device is connected to the same internet as the laptop.
  • A machine with the cloned Finddit repository.
  • Install project dependencies using npm i command.

Client

To run the client, run the following command from src/client dir

expo start

The user will see a QR code which can be scanned by the users device to launch the app inside of the Expo Go app.

Backend

To run the backend, run the following command from the src/backend dir

npm run start

Ngrok

Since our services are run locally, to create a bridge between the frontend and the backend, we expose the localhost backend through a NGROK tunnel.

To use NGROK, install NGROK on the machine and run the following command (ensure this is run after the backend is running):

ngrok http 3000

The URL returned by this command needs to be updated under src/client/constants.js

Final

You're all set to use the app. Hope you Finddit!