Skip to content

Commit 3b5d123

Browse files
Update README.md - reflect admin panel move to raystack-admin
- Remove references to built-in admin panel - Add link to raystack-admin example project - Update description to emphasize minimal core framework - Note that jinja2 is optional - Update FastAPI references to Starlette
1 parent d29e0c2 commit 3b5d123

File tree

1 file changed

+22
-14
lines changed

1 file changed

+22
-14
lines changed

README.md

Lines changed: 22 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -5,29 +5,31 @@
55
![License](https://img.shields.io/pypi/l/raystack)
66
![Downloads](https://img.shields.io/pypi/dm/raystack)
77

8-
**Raystack** is a modern, high-performance Python web framework that merges the asynchronous power of FastAPI with the battle-tested structure and development convenience inspired by Django. Forget the compromises between speed and ease of development — with Raystack, you get the best of both worlds!
8+
**Raystack** is a modern, lightweight Python web framework that merges the asynchronous power of Starlette with the battle-tested structure and development convenience inspired by Django. A clean, minimal framework that gives you the best of both worlds!
99

1010
## ✨ Why Choose Raystack?
1111

12-
Do you love FastAPI's speed but miss Django's organized project structure? Do you want a powerful ORM with built-in async support and a familiar admin panel? Raystack is built for you! It's ideal for:
12+
Do you love Starlette's speed but miss Django's organized project structure? Do you want a powerful ORM with built-in async support? Raystack is built for you! It's ideal for:
1313

14-
* **High-Performance APIs and Microservices**: Leverage FastAPI's capabilities for blazing-fast and concurrent request handling.
15-
* **Rapid Development of Full-Featured Web Applications**: Benefit from a ready-to-use project structure, templating, admin panel, and CLI tools.
14+
* **High-Performance APIs and Microservices**: Leverage Starlette's capabilities for blazing-fast and concurrent request handling.
15+
* **Rapid Development of Web Applications**: Benefit from a ready-to-use project structure, optional templating, and CLI tools.
1616
* **Developers Transitioning from Django**: Get up to speed instantly with familiar "app" concepts, ORM, and management commands.
1717
* **Projects Requiring a Flexible and Robust ORM**: SQLAlchemy under the hood gives you full control over your database.
18+
* **Minimal Dependencies**: Core framework without heavy dependencies - add only what you need.
1819

1920
## 🌟 Key Features
2021

21-
* **FastAPI at its Core**: Experience incredible speed and asynchronous performance for your web applications.
22+
* **Starlette at its Core**: Experience incredible speed and asynchronous performance for your web applications.
2223
* **Django-Inspired Project Structure**: Organize your project with "apps" for clean, modular, and maintainable code.
2324
* **Universal SQLAlchemy ORM**: A powerful and flexible ORM with a unified API for both synchronous and asynchronous operations.
2425
* **Smart Database Management (Alembic)**: Seamless database migrations for effortless schema evolution.
25-
* **Jinja2 Templating**: A robust and flexible templating engine for dynamic HTML rendering.
26-
* **Built-in Admin Panel**: A ready-to-use, customizable administrative interface for easy data management.
26+
* **Optional Jinja2 Templating**: Add templating support when needed (jinja2 is optional).
27+
* **OpenAPI/Swagger Documentation**: Automatic API documentation at `/docs` endpoint.
2728
* **Convenient CLI Commands**: Create projects and apps, run the server, manage migrations, and more—all from your command line.
2829
* **Async-First Design**: Full support for asynchronous views and database operations with minimal effort.
2930
* **Multi-Database Support**: Connect to SQLite, PostgreSQL, MySQL, and other databases with easy switching between sync and async drivers.
3031
* **Extensible Architecture**: Easily integrate your own apps, middleware, and commands to tailor the framework to your needs.
32+
* **Minimal Core**: Lightweight framework with only essential dependencies - add features as needed.
3133

3234
## ⚡ Quick Start
3335

@@ -155,16 +157,18 @@ count = await UserModel.objects.count()
155157
exists = await UserModel.objects.filter(email="[email protected]").exists()
156158
```
157159

158-
## 🖼️ Screenshots
160+
## 🔌 Admin Panel & Authentication
159161

160-
**Home Page:**
161-
![Home Page](.docs/img/first_page.jpg)
162+
Raystack core framework is minimal and doesn't include an admin panel by default. However, we provide a complete example project with admin interface and authentication:
162163

163-
**Login Page:**
164-
![Login Page](.docs/img/login_page.jpg)
164+
**👉 [raystack-admin](https://github.com/ForceFledgling/raystack-admin)** - A full-featured example project with:
165+
* Administrative interface
166+
* User authentication and authorization
167+
* User and group management
168+
* Session and JWT authentication
169+
* Ready-to-use templates and static files
165170

166-
**Admin Panel:**
167-
![Admin Page](.docs/img/admin_page.jpg)
171+
You can use `raystack-admin` as a reference implementation or starting point for your own admin interface.
168172

169173
## 📚 Documentation
170174

@@ -176,6 +180,10 @@ exists = await UserModel.objects.filter(email="[email protected]").exists()
176180
* [Extending Raystack](.docs/extending.md)
177181
* [FAQ](.docs/faq.md)
178182

183+
## 🔗 Related Projects
184+
185+
* **[raystack-admin](https://github.com/ForceFledgling/raystack-admin)** - Example project with admin interface and authentication
186+
179187
## 🤝 Contributing
180188

181189
Pull requests and issues are welcome! See [GitHub](https://github.com/ForceFledgling/raystack).

0 commit comments

Comments
 (0)