Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/simonepri/act
✏️ Multi-purpose URI tracker.
https://github.com/simonepri/act
Last synced: about 1 month ago
JSON representation
✏️ Multi-purpose URI tracker.
- Host: GitHub
- URL: https://github.com/simonepri/act
- Owner: simonepri
- License: mit
- Created: 2018-10-07T17:55:10.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2021-08-02T04:14:57.000Z (about 3 years ago)
- Last Synced: 2024-07-18T14:42:56.076Z (2 months ago)
- Language: JavaScript
- Homepage: https://act.now.sh
- Size: 7.72 MB
- Stars: 6
- Watchers: 3
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: readme.md
- License: license
Awesome Lists containing this project
README
✏️ Multi-purpose URI tracker.
Coded with ❤️ by Simone Primarosa.
## Synopsis
Act is an API service that allows you to track user actions. An action is either a page/email view or a click on a link.
Each time a request is made to act, it automatically collects the timestamp, the device type, the operating system, the browser, the city, the region, and the country from where the request comes and then the data are written to the cloud storage of your choice and no data is stored on our side.
Currently, the only storage type supported is Google Sheets!
## Google Sheets
### Setup
1 - Open [Google Sheets][storage:gs].
2 - Create a new blank document.
3 - Share the document with [[email protected]][storage:gs-email].
4 - Copy the spreadsheet id from the URL bar.
5 - Use the spreadsheet id to make requests to act as shown below.
### Track views
Insert this image inside the page you want to track substituting `` and `` with the appropriate values.
```bash
```
**Example:**
Each time you [see this image](https://act.now.sh/gs/1gBD3pJ9LeJdZM1SyvRD7v077pkItVHl4laWhGeW93sE?a=Example%201) a new row is added at the end of [this spreadsheet](https://docs.google.com/spreadsheets/d/1gBD3pJ9LeJdZM1SyvRD7v077pkItVHl4laWhGeW93sE).
### Track clicks
Insert this inside the page substituting ``, ``, and `` with the appropriate values.
```bash
```
**Example:**
Each time you [click here](https://act.now.sh/gs/1gBD3pJ9LeJdZM1SyvRD7v077pkItVHl4laWhGeW93sE?a=Example%202&r=https://github.com/simonepri/act) a new row is added at the end of [this spreadsheet](https://docs.google.com/spreadsheets/d/1gBD3pJ9LeJdZM1SyvRD7v077pkItVHl4laWhGeW93sE).
### API
METHOD | URL | RESPONSE | BEHAVIOUR
-------|-----|----------|----------
GET | `https://act.now.sh/gs/` | A 1x1 transparent png image. | A new line is appended to the spreadsheet.
GET | `https://act.now.sh/gs/?a=` | A 1x1 transparent png image. | A new line is appended to the spreadsheet.
GET | `https://act.now.sh/gs/?r=` | A 302 redirect to the uri. | A new line is appended to the spreadsheet.
GET | `https://act.now.sh/gs/?a=&r=` | A 302 redirect to the uri. | A new line is appended to the spreadsheet.
## Other storage
Currently, act supports only Google Sheets, but contributions to extend its capabilities are welcome.
## Development
If you want to run it locally, you need to run the following commands.
```bash
git clone https://github.com/simonepri/act.git
cd act
npm i
npm start
```
## Authors
- **Simone Primarosa** - *Github* ([@simonepri][github:simonepri]) • *Twitter* ([@simoneprimarosa][twitter:simoneprimarosa])
See also the list of [contributors][contributors] who participated in this project.
## License
This project is licensed under the MIT License - see the [license][license] file for details.
[contributors]: https://github.com/simonepri/act/contributors
[license]: https://github.com/simonepri/act/tree/master/license
[contributing]: https://github.com/simonepri/act/tree/master/.github/contributing.md
[github:simonepri]: https://github.com/simonepri
[twitter:simoneprimarosa]: http://twitter.com/intent/user?screen_name=simoneprimarosa
[storage:gs]: https://docs.google.com/spreadsheets/
[storage:gs-email]: mailto:[email protected]