|
1 | | -# evsy |
| 1 | +# Evsy |
2 | 2 | Evsy is a lightweight admin panel for managing and documenting product analytics events and their properties. |
3 | 3 |
|
4 | 4 | (!) Evsy is currently in active development. Expect rapid improvements and frequent updates! |
5 | 5 |
|
6 | 6 | ## ✨ About |
7 | | -Evsy is an open-source application for managing analytics events — |
8 | | -including event descriptions, their attributes (fields), and tags. |
| 7 | +Evsy is an open-source application for managing analytics events — including event descriptions, their attributes (fields), and tags. |
9 | 8 |
|
10 | | -It helps product teams, analysts, and developers structure and document all key events in a convenient, extensible way. |
| 9 | +It helps product teams, analysts, and developers structure and document their events in a convenient, extensible way. |
11 | 10 |
|
12 | 11 | ## 📚 Features |
13 | | -- Manage events: create, update, delete, tag them. |
14 | | -- Manage fields: document event attributes. |
15 | | -- Manage tags: group related events together. |
16 | | -- Dark/light theme switcher. |
| 12 | +- Create and document events and fields. |
| 13 | +- Organize them by type, tag, or team. |
| 14 | +- Export events to Swagger schemas. |
| 15 | +- Sign up via email/password or OAuth2 (GitHub & Google) |
17 | 16 |
|
18 | 17 | **Future roadmap includes:** |
19 | | -- Field examples; |
20 | | -- Audit log (history of changes); |
21 | | -- Session and user management; |
22 | | -- Teams and organizations support; |
23 | | -- SaaS hosting. |
| 18 | +- Roles and user management; |
| 19 | +- Audit log (history of changes) and event versioning; |
| 20 | +- Full-text search; |
| 21 | +- Additional event states (`draft`, `archived`); |
| 22 | +- Markdown descriptions; |
| 23 | +- Grafana integration; |
| 24 | +- ... and more! |
24 | 25 |
|
25 | 26 | ## 🚀 Quick Start |
26 | 27 | To run Evsy via Docker compose, do: |
|
55 | 56 | ``` |
56 | 57 |
|
57 | 58 | ## 🤝 Contributing |
58 | | -We welcome all kinds of contributions — from code to ideas, design suggestions, and bug reports. |
| 59 | +We welcome all kinds of contributions — code, ideas, design suggestions, and bug reports. |
59 | 60 | [Read the contributing guide →](CONTRIBUTING.md) |
60 | 61 |
|
61 | 62 | ## Build Status |
|
0 commit comments