mirror of https://github.com/muety/wakapi.git
docs: readme
This commit is contained in:
Ferdinand Mütsch
GitHub
parent
6e2f3e6731
commit
45f372168d
26
README.md
26
README.md
|
|
@ -13,12 +13,12 @@
|
|||
|
||||
If you like this project, please consider supporting it 🙂. You can donate either through [buying me a coffee](https://buymeacoff.ee/n1try) or becoming a GitHub sponsor. Every little donation is highly appreciated and boosts the developers' motivation to keep improving Wakapi!
|
||||
|
||||
## Demo
|
||||
🔥 **New:** There is hosted [demo version](https://apps.muetsch.io/wakapi) available now. Go check it out! Please use responsibly.
|
||||
## 👀 Demo
|
||||
🔥 **New:** There is a hosted [demo version](https://apps.muetsch.io/wakapi) available now. Go check it out! Please use responsibly.
|
||||
|
||||
To use the demo version set `api_url = https://apps.muetsch.io/wakapi/api/heartbeat`. However, this hosted instance might be taken down again in the future, so you might potentially lose your data ❕
|
||||
|
||||
## Prerequisites
|
||||
## ⚙️ Prerequisites
|
||||
**On the server side:**
|
||||
* Go >= 1.13 (with `$GOPATH` properly set)
|
||||
* gcc (to compile [go-sqlite3](https://github.com/mattn/go-sqlite3))
|
||||
|
|
@ -30,7 +30,7 @@ To use the demo version set `api_url = https://apps.muetsch.io/wakapi/api/heartb
|
|||
**On your local machine:**
|
||||
* [WakaTime plugin](https://wakatime.com/plugins) for your editor / IDE
|
||||
|
||||
## Server Setup
|
||||
## ⌨️ Server Setup
|
||||
### Run from source
|
||||
1. Clone the project
|
||||
1. Copy `.env.example` to `.env` and set database credentials
|
||||
|
|
@ -49,7 +49,7 @@ docker run -d -p 3000:3000 --name wakapi n1try/wakapi
|
|||
|
||||
By default, SQLite is used as a database. To run Wakapi in Docker with MySQL or Postgres, see [Dockerfile](https://github.com/muety/wakapi/blob/master/Dockerfile) and [.env.example](https://github.com/muety/wakapi/blob/master/.env.example) for further options.
|
||||
|
||||
## Client Setup
|
||||
## 💻 Client Setup
|
||||
Wakapi relies on the open-source [WakaTime](https://github.com/wakatime/wakatime) client tools. In order to collect statistics to Wakapi, you need to set them up.
|
||||
|
||||
1. **Set up WakaTime** for your specific IDE or editor. Please refer to the respective [plugin guide](https://wakatime.com/plugins)
|
||||
|
|
@ -62,7 +62,7 @@ api_key = the_api_key_printed_to_the_console_after_starting_the_server`
|
|||
|
||||
You can view your API Key after logging in to the web interface.
|
||||
|
||||
## Customization
|
||||
## 🔵 Customization
|
||||
|
||||
### Aliases
|
||||
There is an option to add aliases for project names, editors, operating systems and languages. For instance, if you want to map two projects – `myapp-frontend` and `myapp-backend` – two a common project name – `myapp-web` – in your statistics, you can add project aliases.
|
||||
|
|
@ -80,7 +80,7 @@ INSERT INTO aliases (`type`, `user_id`, `key`, `value`) VALUES (0, 'your_usernam
|
|||
* OS ~ type **3**
|
||||
* Machine ~ type **4**
|
||||
|
||||
## API Endpoints
|
||||
## 🔧 API Endpoints
|
||||
The following API endpoints are available. A more detailed Swagger documentation is about to come ([#40](https://github.com/muety/wakapi/issues/40)).
|
||||
|
||||
* `POST /api/heartbeat`
|
||||
|
|
@ -90,7 +90,7 @@ The following API endpoints are available. A more detailed Swagger documentation
|
|||
* `GET /api/compat/v1/users/current/summaries` (see [Wakatime API docs](https://wakatime.com/developers#summaries))
|
||||
* `GET /api/health`
|
||||
|
||||
## Prometheus Export
|
||||
## ⤴️ Prometheus Export
|
||||
If you want to export your Wakapi statistics to Prometheus to view them in a Grafana dashboard or so please refer to an excellent tool called **[wakatime_exporter](https://github.com/MacroPower/wakatime_exporter)**.
|
||||
|
||||
[](https://github.com/MacroPower/wakatime_exporter)
|
||||
|
|
@ -99,15 +99,15 @@ It is a standalone webserver that connects to your Wakapi instance and exposes t
|
|||
|
||||
Simply configure the exporter with `WAKA_SCRAPE_URI` to equal `"https://wakapi.your-server.com/api/compat/wakatime/v1"` and set your API key accordingly.
|
||||
|
||||
## Badges
|
||||
## 🏷 Badges
|
||||
We recently introduced support for [Shields.io](https://shields.io) badges (see above). Visit your Wakapi server's settings page to see details.
|
||||
|
||||
|
||||
## Best Practices
|
||||
## 👍 Best Practices
|
||||
It is recommended to use wakapi behind a **reverse proxy**, like [Caddy](https://caddyserver.com) or _nginx_ to enable **TLS encryption** (HTTPS).
|
||||
However, if you want to expose your wakapi instance to the public anyway, you need to set `listen = 0.0.0.0` in `config.ini`
|
||||
|
||||
## Important Note
|
||||
## ⚠️ Important Note
|
||||
**This is not an alternative to using WakaTime.** It is just a custom, non-commercial, self-hosted application to collect coding statistics using the already existing editor plugins provided by the WakaTime community. It was created for personal use only and with the purpose of keeping the sovereignity of your own data. However, if you like the official product, **please support the authors and buy an official WakaTime subscription!**
|
||||
|
||||
## License
|
||||
## 📓 License
|
||||
GPL-v3 @ [Ferdinand Mütsch](https://muetsch.io)
|
||||
|
|
|
|||
Loading…
Reference in New Issue