https://github.com/swetrix/swetrix-fe
Frontend for the main website of Swetrix (swetrix.com).
https://github.com/swetrix/swetrix-fe
analytics docker privacy react remix remix-run self-hosted selfhosted swetrix web-analytics
Last synced: 10 months ago
JSON representation
Frontend for the main website of Swetrix (swetrix.com).
- Host: GitHub
- URL: https://github.com/swetrix/swetrix-fe
- Owner: Swetrix
- License: agpl-3.0
- Created: 2021-03-18T21:47:46.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2024-04-28T15:06:34.000Z (about 2 years ago)
- Last Synced: 2024-05-01T11:38:57.319Z (about 2 years ago)
- Topics: analytics, docker, privacy, react, remix, remix-run, self-hosted, selfhosted, swetrix, web-analytics
- Language: TypeScript
- Homepage: https://swetrix.com
- Size: 25.6 MB
- Stars: 47
- Watchers: 3
- Forks: 19
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Funding: .github/funding.yml
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
> [!NOTE]
> This repository has been archived as it has been merged with our backend repository to create a monorepo. The frontend source code can be found [here](https://github.com/Swetrix/swetrix/tree/main/web).
[](https://hub.docker.com/r/swetrix/swetrix-fe)
[](https://github.com/swetrix/swetrix-fe/issues)
## Description
Swetrix is a privacy-oriented, simple and fully cookie-less web analytics service.\
It provides lots of metrics like unique visitors, live visitors monitoring, custom events, pageviews and many more.
The service also supports many other features, like dashboard metrics & GDPR exports, email reports and more.
The project's purpose is to fight web analytics giants like Google Analytics while providing better quality and experience of using service.
## License
Swetrix is released under the AGPL v3.0 licence, see [LICENSE](LICENSE).
## Install Swetrix
See the API installation process at https://github.com/Swetrix/swetrix-api#readme. \
To selfhost the frontend part of Swetrix, you simply need to set up `.env` variables, install the dependencies (`npm i`), build the code (`npm run build`) and host it as a regular React application ([how to host react apps](https://create-react-app.dev/docs/deployment/)).\
On production, swetrix.com uses Cloudflare Pages to host the frontend part of the application.\
The minimum supported NodeJS version is v14.
### Docker Setup
Swetrix provides a Docker Image based on Alpine, Nginx and Node.
To use it you just just pull `swetrix/swetrixfe` from dockerhub.
#### Docker Environment Variables
The following environment variables are available, alongside their default values.
`API_URL` = `https://example.com/` | The URL of the Swetrix API
`TZ` = `Etc/UTC` | Sets the Timezone of the Container
## Bugs and security
Swetrix is open to pull-requests. Feel free to propose new features or submit bug requests via pull reuqests.\
For severe security issues, please contact us at security@swetrix.com
## Contributions
Contributions are welcome! You can find and pick any task on our [public roadmap](https://github.com/orgs/Swetrix/projects/2) page.\
Feel free to also offer any feature or improvement proposal, all of it is highly appreciated!\
You can also contribute translations on your [Crowdin](https://crowdin.com/project/swetrix) page.
## Contact
You can contact us via email at contact@swetrix.com
## Donate
You can support the project by donating us at https://ko-fi.com/andriir \
We can only run our services by once again asking for your financial support!