Sleep Tracker

This is a sleep tracker app that allows users to monitor their sleep patterns and track their progress towards better sleep. With this app, users can record their sleep duration, and quality.

About • Setup • Running the App • Technologies • Credits • License

About

Features

• Log overnight sleep
• Log tiredness during the day
• View logged data
• Data stored and updated in realtime

Setup

Overview

To get started, simply clone the repository and follow the instructions in the Installation section below. The app requires a Firebase account for database storage, so you will need to set up a Firebase project and configure the app accordingly.

Installation

1. Clone the repository to your machine using git clone.
2. Navigate to the sleeptracker folder in your terminal
3. Install dependencies by running the command

npm install

4. You should see a node_modules folder once all dependencies has been installed

Setting up Firebase

1. Create a Firebase Project with Firestore Database
   • Get started > Add project > 'projectName'
   • On the left there is a navigation tab select 'All Products'
     • Cloud Firestore > Create database > Start in test mode > 'yourSelectedLocation' > Enable
2. Add a firebase webapp to your recently created Project
   • On the left there is a navigation tab, on the right of Project Overview select the gear icon
     • Gear icon > Project settings
   • Scroll to the bottom, in the 'Your apps' section select the icon '</>' to create a web app
3. Copy the Firebase configuration code const firebaseConfig = { ... }
4. Paste this config into the file sleeptracker/src/environments.ts

Running the App

⚠️ Note: Before you are able to run the app, ensure you have installed all required dependencies by following the Installation section above

1. To run the app navigate to the sleeptracker folder in your terminal
2. Enter the command

ionic lab

Technologies

     

Credits

I made this program as a learning exercise with my friend, Yen.

License

This project is licensed under the MIT License - see the LICENSE file for details.