Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ivynya authored Dec 23, 2021
1 parent f4c80c4 commit eb4f9d5
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,16 @@
# analytics
[![https://maintained.cc/SDBagel/Analytics/1](https://maintained.cc/SDBagel/Analytics/1)](https://ivy.direct/template-analytics)

Self-host, Notion-integrated simple analytics API.
Notion-integrated simple analytics API.

> ⚠️ This is self-hosted. You're going to need a little bit of server knowledge and a domain if you want this running on the web.
## Setup
1. Duplicate the Notion page and [find the database ID](https://developers.notion.com/docs/working-with-databases)
2. [Create a new Notion integration](https://www.notion.so/my-integrations), copy the API token, and invite it to your duplicated Notion page
3. Clone this repo and create a `.env` file with the ID and token, according to `.env.example`
4. Run `docker build -t analytics .` and `docker run -p 8000:8000 -d analytics`
5. Make a `POST` request to `http://localhost:8000/v1/campaign/promo1` to see it work.

## Manage from Notion

Expand All @@ -27,4 +30,4 @@ Additional properties may be added to the Notion table (e.g. a multi-select for

## Invalid Campaigns

Invalid campaign calls will return a 400 non-existent redirect error.
Invalid campaign calls will return a 400 non-existent redirect error.

0 comments on commit eb4f9d5

Please sign in to comment.