This project ("Planit") was created as part of the course CSCC01, at the University of Toronto.
This app uses the NPM package manager as well as Node.js. Follow the instructions below to get setup.
Git Google Firebase Node.js React Native
Useful software: Android Emulator (E.G. Bluestacks) Visual Studio Code (preferred IDE of yinlinta)
- Visit the Node.js installations page at https://nodejs.org/en/download/
- Install the "LTS" version
- Follow through installation steps normally
- In the root directory, run
npm installin the terminal - Done.
- Go into the 'client' directory (
cd client) - Install all dependencies (
npm install)
- visit https://git-scm.com/downloads
- download the version you need
- setup user and email using: git config --global user.name "John Doe", git config --global user.email johndoe@example.com
Notes: run 'git fetch' to get the latest branches and histories for branches
- Go into client directory (
cd client) and run the app withnpm start - For Android devices, download the Expo App; for iOS, scan the QR code that appears.
- scan the QR code to visit or paste the lan address into the expo app
Alternative Installation:
- Install your OEM usb drivers
- Enable usb debugging on your phone (Android)
- Run npm start
- Run on android device or emulator
That's it! Any changes you make and save will show up on your device.
If you're having any issues, follow the React Native Setup Guide.
Note: The initial compile can be lengthy, however any subsequent changes you make will appear almost immediately Advice: You can run the expo application on any android emulator. Not all will run using the alternative but you can install the app and run off lan address
- Run
npm run devto start the server
The server be running in development mode at http://localhost:4000/.
- Create a new branch following the pattern "feature/US-AAAA/Title of user story" for user stories, "bugfix/DE-AAAA/Title of bug" where AAAA is the user story id. this will help us manage feature branches
- Once completed create a PR to develop branch. Then have a separate developer review your code before merge with develop
- Merge with master only occurs when preparing a submission build
https://git-scm.com/downloads https://facebook.github.io/react-native/ https://nodejs.org/en/ https://developer.android.com/studio/run/device.html#developer-device-options https://developer.android.com/studio/run/oem-usb.html https://forums.expo.io/t/running-new-app-with-bluestacks/2630