https://github.com/slashtechno/clock
My first full-stack project!
https://github.com/slashtechno/clock
Last synced: about 1 year ago
JSON representation
My first full-stack project!
- Host: GitHub
- URL: https://github.com/slashtechno/clock
- Owner: slashtechno
- License: mit
- Created: 2024-07-02T19:10:23.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-06T22:32:54.000Z (almost 2 years ago)
- Last Synced: 2025-02-13T08:29:50.585Z (over 1 year ago)
- Language: JavaScript
- Homepage: https://clock.angad.me/
- Size: 162 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Hello, time?
A simple, open-source clock that displays rhymes. Inspired by the Hack Club workshops [Simple Clock](https://workshops.hackclub.com/simple_clock/) and [JsonDB](https://workshops.hackclub.com/json_db/), along with the[ Poem/1](https://www.kickstarter.com/projects/genmon/poem-1-the-ai-poetry-clock), an "AI rhyming clock".
Public instance: [clock.angad.me](https://clock.angad.me/)
## Background
This is my first full-stack project and furthermore, my first JavaScript project. I'm welcome to feedback as I primarily used this project to learn and would love to know what I could have done better. However, I do think this project is usable. I can see this being used as live wallpaper or on E Ink displays such as e-readers.
## Usage
This assumes you have NodeJS installed
1. Clone the repository
- `git clone https://github.com/slashtechno/clock`
2. `cd clock`
3. Either copy or rename `.env.example` and fill it out
4. Install dependencies
- `npm install`
5. Build
- `npm run build`
6. Run!
- `npm run start`
### Docker
Alternatively, you can use Docker.
1. Clone the repository
- `git clone https://github.com/slashtechno/clock`
2. `cd clock`
3. Either copy or rename `.env.example` and fill it out
4. Launch the container
- `docker-compose up -d`