Skip to content

Jiwei99/ProductivityWarrior

 
 

Repository files navigation

ProductivityWarrior

Inline docs Maintenance JavaScript React Native iOS Android

Description

  • This is a project for NUS CP2106 Orbital

Poster

Poster

Links

README

Video Demo

Level of Achievement

  • Apollo 11

Motivations

Currently, there are too many productivity apps out there with varied functions, and they are not catered to students specifically. Thus, for students, they have to download multiple applications to use their functions together.

Some of such productivity apps are to-do apps, calendar apps, “anti-distraction” apps. With so many different apps, it would be hard to keep track of everything and there is a loss in productivity. Furthermore, there is also a lack of an application that helps students keep track of their University progress, such as what modules they would need to take, and their CAP. As a result, students often have to visit the NUS Faculty website or EduRec frequently to source for these information, which is inefficient.

With a single application catered to students that implements all of these features, it would be a lot more convenient for students.

Aim

We hope to make the student life more efficient and productive through the development of an “all in one” productivity app.

Scope of Project

  • A mobile application that provides the functionality stated above. A local database that stores the user information and settings. Calendar: Basic calendar that allows users to add events / delete events, and users will get a push notification when the event is about to happen.

  • To-Do List: A todo list where users are able to add tasks that needs to be completed by a certain date. Some key functions of the to-do list are adding task by date, strikethrough when the task is completed and deletion of the task. Users will also be able to add the task to a category, and add tags to the task.

  • Module / Cap Tracker: A page that allows users to key in the mods they have completed, the amount of MC and the grade they have gotten. The mods keyed in will be stored in a local database which will calculate the user’s CAP and display it on the same screen along with the completed modules.

  • Anti-distraction Feature: Anti-distraction feature will feature a blackout screen with a user-settable countdown timer. During this countdown period, the Do Not Disturb function of the phone will be activated and notifications will be turned off. At the end of the timer, normal usage will be restored.

Technologies

  • React Native

Installation

  1. Install NodeJS on your computer
  • Mac: Open terminal and run
brew install node
  • Windows: Download and install NodeJS LTS Client from https://nodejs.org/
  1. Install the Expo Client by opening terminal and running
npm install expo-cli --global
  1. Clone the github repository using
git clone https://github.com/Th-429B/ProductivityWarrior.git
  1. Open it with your IDE of choice
  2. Run the command expo start in the terminal to load the metro bundler localhost
  3. Load and run the application on a smartphone or simulator
  • iPhone: Download Expo Go from the App Store. Open the iPhone camera and scan the QR code on the metro bundler localhost, and click on the link to load and open the app in Expo Go
  • Android: Download Expo Go from the Play Store. Open Expo Go and scan the QR code with the Expo Go app to load and open the app.
  • iOS Simulator (Mac Only): Download Xcode from the Mac App Store onto the Mac. On the metro bundler local host, click on 'Run on iOS simulator' and wait for both the iOS Simulator and app to load. For more details, refer to https://docs.expo.io/workflow/ios-simulator/
  • Android Emulator: Refer to the setup documentation at https://docs.expo.io/workflow/android-studio-emulator/
  1. Voila! The application is now running!

About

CP2106 Orbital 2021

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 100.0%