Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 60 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,12 @@
<div align="center">
<!-- Why comment a markdown README you might ask? I don't know to be honest. I guess I'm a little bored :b -->

<img width="3504" height="2240" alt="Free, Open-Source Code Tracker" src="https://github.com/user-attachments/assets/8689e4a8-13f5-4b83-ae8c-b10b6db9c50c" /> <!-- Header -->


<img width="456" alt="Hackatime" src="https://github.com/user-attachments/assets/b3036ced-a7ea-4d03-8feb-816a83572e3a#gh-light-mode-only" />
<img width="456" alt="Hackatime" src="https://github.com/user-attachments/assets/1d237c55-d349-44d3-93e6-d9dbb627e4dc#gh-dark-mode-only" />
<!-- Header text -->
<div align="center">

# **Hackatime**

[![Ping](https://uptime.hackclub.com/api/badge/4/ping)](https://uptime.hackclub.com/status/hackatime)
[![Status](https://uptime.hackclub.com/api/badge/4/status)](https://uptime.hackclub.com/status/hackatime)
Expand All @@ -11,6 +16,58 @@

</div>

<!-- Main Content -->
**[Hackatime](https://hackatime.hackclub.com)** allows you to track the time you code, see daily and weekly coding leaderboards, and get statistics on projects, languages, and more.

<!-- IDES -->
<img width="3504" height="2240" alt="A visual of some of the supported IDEs" src="https://github.com/user-attachments/assets/3d80cc2f-28ae-4215-a302-22f7f0e6f191" />

**Code in your favorite IDE with over 60 IDEs supported!**

<!-- Statistics -->
<img width="3504" height="2240" alt="showcase of statistics" src="https://github.com/user-attachments/assets/e03a6b8a-fe19-44ad-8d70-c6ff246b0420" />

**Get detailed statistics by language, project, date, and more!**

---

<!-- Help -->

<div align="center">

*Having issues? Reach out on the _#hackatime-help_ channel on [slack!](https://slack.hackclub.com/)*

</div>

## Local development

```sh
# Set it up...
$ git clone https://github.com/hackclub/hackatime && cd hackatime

# Set your config
$ cp .env.example .env
```

Edit your `.env` file to include the following:

```env
# Database configurations - these work with the Docker setup
DATABASE_URL=postgres://postgres:secureorpheus123@db:5432/app_development
WAKATIME_DATABASE_URL=postgres://postgres:secureorpheus123@db:5432/app_development
SAILORS_LOG_DATABASE_URL=postgres://postgres:secureorpheus123@db:5432/app_development

# Generate these with `rails secret` or use these for development
SECRET_KEY_BASE=alallalalallalalallalalalladlalllalal
ENCRYPTION_PRIMARY_KEY=32characterrandomstring12345678901
ENCRYPTION_DETERMINISTIC_KEY=32characterrandomstring12345678902
ENCRYPTION_KEY_DERIVATION_SALT=16charssalt1234
```

Comment out the `LOOPS_API_KEY` for the local letter opener, otherwise the app will try to send out a email and fail.

</div>

## Local development

Please read [DEVELOPMENT.md](DEVELOPMENT.md) for instructions on setting up and running the project locally.