Skip to content

Latest commit

 

History

History
60 lines (42 loc) · 2.39 KB

Readme.md

File metadata and controls

60 lines (42 loc) · 2.39 KB
Raw

LUMSafar

A social hub application for LUMS students.

Developed using:

Build and Deployment Status

Client EAS Build Server Build and Test Heroku Deployment

Setting up dev environment

Requirements

  • PC running Windows/Mac/Linux
  • NodeJS
  • Expo CLI npm install --global expo-cli
  • Nodemon (Optional) npm install -g nodemon

Steps

  1. Clone the repository to local machine using git clone https://github.com/AhsanSarwar45/LUMSafar.
  2. Open the cloned directory in VSCode either manually or using code LUMSafar.

Client

  1. Navigate to client directory using cd client.
  2. Install required packages using npm ci. Go watch Better Caul Saul while your computer does its thing.
  3. Start Expo using expo start. Duh. npm start also works.

Server

  1. Navigate to client directory using cd server.
  2. Install required packages using npm ci.
  3. Start the server using npm run start, or if you have nodemon npm run start-n. With nodemon, the server gets automatically restarted when you save any changes.
  4. If you want to test the client with the local server instance, go to the .env file in the client/ directory and replace content with LUMSAFAR_SERVER_URL='http://<your ipv4 address>:3001'.

Running the Client

After running expo start, you can run the client either on a physical device or an emulator. The app will reload automatically when you save any changes.

Physical Device

  1. Download Expo Go app on your smartphone.
  2. Open developer tools at http://localhost:19002/ in your browser.
  3. Scan the QR code using Expo Go app.

Emulator

  1. Download Android Studio.
  2. Install an AVD Device. Refer to this guide.
  3. Start the AVD Device.
  4. After running npm start, press A and Expo will start the app on the emulator.