Skip to content

CSUF-ACM/cues

Repository files navigation

Cues

Mobile application that tracks the user's daily good and bad habits. The application features a short, daily quiz that the user takes to provide the application with habit data. The application analyzes the data provided by the user and produces insightful information on the user's behavior.

Building the project

Download and install Node

https://nodejs.org/en/download/

Install Expo

Expo allows you to run the app on a simulator or mobile phone. Install npm with this command in your terminal: npm install -g expo-cli

Download and install git

https://git-scm.com/downloads

Clone the project

In your terminal, navigate to the directory in which to save the project: cd ~/Desktop/apps

Clone this GitHub repository with this command in your terminal: git clone https://github.com/CSUF-ACM/cues.git

Build the app with Expo

In your terminal, navigate to the new cues folder: cd cues Install package dependencies: npm install Build the project: npm start

Run the app on your smart phone or in a simulator

Install the Expo Client app on your smart phone to run the app on your phone. If you have a Mac, you can use the built-in Simulator program. In the terminal running Expo, type 'i' for iOS. If you have Unix or Windows, you can use the emulator from Android Studio. In the terminal running Expo, type 'a' for Android.


Contributing with GitHub

Remember that you must execute git commands from within the project directory. (Ex: cd ~/Desktop/apps/cues)

If you need help navigating the terminal please refer to this link: Linux Command Tutorial

To work on the project without disrupting the work of others or having your work disturbed, use git branch <branchname> to create a new branch, then use git checkout <branchname> to start working on your new branch

Saving your progress

To check the status of your repository, seeing what files have been modified or added, use git status to print a status message

After you've made some changes or created new files, use git add <file> or git add * to add all of your new/modified files to the stage

Once those files have been added, use git commit -m "Commit message here" to create the commit, then use git push origin <branchname> to push your commit to the remote repository

Merging your work

If you would like to have the code on your branch merged with the master, please submit a pull request on the git hub page https://github.com/CSUF-ACM/cues/pulls

If the pull request is accepted, your branch will be merged with the master branch

Additional help

If you need some more help with git commands, please visit Git Command Tutorial

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •