Skip to content

Commit f5a8fe4

Browse files
committed
docs: tweaked README
1 parent 95b36fc commit f5a8fe4

File tree

1 file changed

+5
-25
lines changed

1 file changed

+5
-25
lines changed

README.md

Lines changed: 5 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -18,47 +18,27 @@ Evsy is an open-source application that helps product teams, analysts, and devel
1818

1919

2020
**Future roadmap includes:**
21-
- Role-based access control (RBAC);
21+
- Role-based access control;
2222
- History of changes and event versioning;
2323
- Full-text search;
24-
- Draft and archived states for events;
25-
- Markdown-based descriptions;
2624
- ... and more!
2725

2826
## 🚀 Quick Start
2927
To run Evsy via Docker compose, just do:
3028
1. `cp .env.example .env`
3129
2. `make up`
3230

33-
> Make sure to review .env.example — it contains helpful comments for configuring your setup.
31+
> Make sure to review .env.example — there are comments that might be useful for configuring your setup.
3432
3533
## ⚙️ Tech Stack
34+
Evsy combines a Python FastAPI backend and a Vue3 frontend, developed and versioned together.
35+
3636
- Backend: FastAPI + Pydantic + SQLAlchemy + Alembic
3737
- Frontend: Vue 3 + Vite
3838
- Component library: [shadcn-vue](https://www.shadcn-vue.com/)
3939

40-
## 🧩 Project Structure
41-
Evsy is a project combining a Python FastAPI backend and a Vue3 frontend, developed and versioned together.
42-
43-
```
44-
evsy/
45-
├── backend/ # FastAPI backend (Poetry-managed)
46-
│ ├── app/ # Application code
47-
│ └── tests/ # Pytest
48-
├── frontend/ # Vue 3 + Vite frontend (npm-managed)
49-
│ ├── src/ # Application code
50-
│ └── public/ # Static assets
51-
├── .github/workflows/ # CI workflows
52-
├── VERSION # Current version of the project
53-
├── bump_version.py # Version bumping script (manual semantic versioning)
54-
├── Makefile # Developer commands (e.g. `make up`)
55-
├── docker-compose.yaml # Docker compose configuration
56-
├── Makefile # Developer commands (e.g. `make up`)
57-
└── README.md # Project overview
58-
```
59-
6040
## 🤝 Contributing
61-
We welcome all kinds of contributions code, ideas, design suggestions, and bug reports.
41+
We welcome all kinds of contributions: code, ideas, design suggestions, and bug reports.
6242
[Read the contributing guide →](CONTRIBUTING.md)
6343

6444
## Build Status

0 commit comments

Comments
 (0)