UF Alarm Clock

UF Alarm Clock Project.

Table of Contents

• UF Alarm Clock
• Table of Contents
• Installation
• Contributing
• Resources
• Maintainers

Installation

This project requires NodeJS and Git. Also, the Expo Go app is required on a mobile device. Make sure you have build-essential (Linux) or xcode-select (MacOS).

sudo apt install build-essential
// or...
xcode-select --install

Then, begin by cloning the repository:

git clone https://github.com/malangadan/Alarm-Clock.git

Navigate to the project directory and install the project dependencies:

cd Alarm-Clock
npm install

If your phone is on the same network as your computer run:

npm run start

If your phone is on a different network than your computer run:

npm run tunnel

Then scan the QR code that appears on the expo go app.

Contributing

To contribute to this repository, please follow the following steps:

1. Fork this project by going to the top-right corner of the page and clicking Fork.
2. Clone your Forked repository to your local machine in your desired folder. git clone <your-forked-repository>
3. Create your feature branch to work on changes. git checkout -b <your-feature-branch-name>
4. Commit your changes to your feature branch. git add <name-of-changed-file> git commit -m "<your-message>"
5. For your first push to the new branch use the following: git push --set-upstream origin <your-feature-branch-name> Otherwise to push to current branch use the following: git push
6. Open a pull request to the original repository.

Resources

For more help use the following links:

• Fork and Clone repository
• Feature Branch Workflow
• Comitting to Repository
• Pushing to Repository
• Opening Pull Requests

Maintainers

Maintained by the UF Open Source Club, can be contacted via Discord

Current Maintainers:

• Kaniel Vicencio @kanielv
• Max Meiler @MaximilianMeiler