Skip to content

Latest commit

 

History

History
131 lines (92 loc) · 4.56 KB

README.md

File metadata and controls

131 lines (92 loc) · 4.56 KB
Raw

💥⏰ UF Alarm Clock ⏰💥

GitHub last commit GitHub issues GitHub forks GitHub stars GitHub license NodeJS npm


Welcome to the UF Alarm Clock Project! This innovative alarm clock is designed to revolutionize your mornings by incorporating unique features to ensure you wake up on time and stay alert.

Alarms Word Clock

🚀 Goal

The goal of the UF Alarm Clock project is to create an alarm clock that not only emulates all the features of a traditional alarm clock but also introduces novel functionalities to make waking up a more effective and engaging experience. Our aim is to provide users with the ability to configure various punishments for not waking up and implement innovative methods for detecting if a user is awake, thereby promoting better sleep habits and ensuring timely awakenings.

Table of Contents

📥 Installation

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

Client

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

If you do not intend on making any changes, clone the original repository:

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

If you do intend on making changes, fork the project then copy the code from your personal repository::

git clone https://github.com/YOUR-USERNAME/Alarm-Clock.git

Navigate to the project client directory and install the project dependencies:

cd  Alarm-Clock/client
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.

Server

Install Golang version 1.23.1

go install golang.org/dl/go1.23.1@latest
go1.23.1 download

Navigate to the project server directory

cd Alarm-Clock/server

Run server

go1.23.1 run ./server.go

🤝 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:

🧑‍💼 Maintainers

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

Current Maintainers:

  • Kaniel Vicencio @kanielv
  • Max Meiler @MaximilianMeiler