Skip to content

adebola-io/enjoy-your-day

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

THIS PROJECT IS 60% COMPLETE.

Icon of Enjoy Your Day, a square white outline with dot-circled eyes and a smiley face, slightly tilted to the right.

Enjoy Your Day, Everyday.

Enjoy Your Day is a simple offline web app for tracking daily goals. It is a proof-of-concept app for @adbl/unfinished, a lightweight web framework.

🚀 Deployment

The stage application is deployed on dev.enjoyyourday.live/.

✨ Features

  • 📝 Simple and intuitive interface.
  • 📈 Personalized set for each day.
  • 📊 Tracks your progress and provides recommendations.
  • 📦 Easy to use and customizable.

🏁 Getting Started

🛠️ Prerequisites

The app is a progressive web application. Majority of the functionality lies in the client that runs in the browser. This client is built using the following technologies, among others:

🖥️ System Dependencies

Ensure you have the following dependencies installed on your system:

  • Node.js (version 14 or higher)
  • Bun
  • Rust
  • Cargo
  • pkg-config and libssl-dev (required for building some Rust dependencies)

🎨 Design

The draft UI design is available on Figma here.

📥 Getting Started

To get started, you need to clone the repository and install the dependencies.

git clone https://github.com/adebola-io/enjoy-your-day.git

🌐 Environment Variables

The following environment variables are required for the client:

  • VITE_API_URL: The URL of the Notification Scheduler API server.

The following are required for the server:

  • ADMIN_PASSWORD: A password for the admin user, for testing notifications.
  • PORT: The port to run the server on.

Ensure these variables are set in your environment before running the project.

🚀 Running the Project

Client

To run the client, run the following command in the client folder:

bun run dev

Server

To run the server, run the following command in the server folder:

cargo build

To run the server, run the following command in the server folder:

cargo run

🤝 Contributing

Contributions are welcome! If you have any suggestions or improvements, please open an issue or submit a pull request.

📄 License

Enjoy Your Day is licensed under the Functional Source License, Version 1.1, Apache 2.0 Future License.