diff --git a/README.md b/README.md index 82300b7c..d3086efd 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,12 @@ -
+ + +Free, Open-Source Code Tracker + -Hackatime -Hackatime + +
+ +# **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) @@ -11,6 +16,58 @@
+ +**[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. + + +A visual of some of the supported IDEs + +**Code in your favorite IDE with over 60 IDEs supported!** + + +showcase of statistics + +**Get detailed statistics by language, project, date, and more!** + +--- + + + +
+ + *Having issues? Reach out on the _#hackatime-help_ channel on [slack!](https://slack.hackclub.com/)* + +
+ +## 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. + +
+ ## Local development Please read [DEVELOPMENT.md](DEVELOPMENT.md) for instructions on setting up and running the project locally.