You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+6-6Lines changed: 6 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -19,12 +19,6 @@ Ellar is based on [Starlette (ASGI toolkit)](https://www.starlette.io/), a light
19
19
While Ellar provides a high level of abstraction on top of Starlette, it still incorporates some of its features, as well as those of FastAPI.
20
20
If you are familiar with these frameworks, you will find it easy to understand and use Ellar.
21
21
22
-
## Dependencies
23
-
- Python >= 3.7
24
-
- Starlette
25
-
- Injector
26
-
- Pydantic
27
-
28
22
## Features Summary
29
23
30
24
-**Easy to Use**: Ellar has a simple and intuitive API that makes it easy to get started with building a fast and scalable web applications or web APIs in Python.
@@ -37,6 +31,12 @@ If you are familiar with these frameworks, you will find it easy to understand a
37
31
-**Modularity**: Ellar follows a modular architecture inspired by NestJS, making it easy to organize your code into reusable modules.
38
32
-**Asynchronous programming**: It allows you to takes advantage of Python's `async/await` feature to write efficient and fast code that can handle large numbers of concurrent requests
Copy file name to clipboardExpand all lines: docs/index.md
+13-12Lines changed: 13 additions & 12 deletions
Original file line number
Diff line number
Diff line change
@@ -24,6 +24,19 @@ Ellar was heavily inspired by [NestJS](https://docs.nestjs.com/) in its simplici
24
24
It also adopted some concepts of [FastAPI](https://fastapi.tiangolo.com/) in handling request parameters and data serialization with pydantic.
25
25
With that said, the aim of Ellar focuses on a high level of abstraction of framework APIs, project structures, architectures, and speed of handling requests.
26
26
27
+
28
+
## Features Summary
29
+
30
+
-**Easy to Use**: Ellar has a simple and intuitive API that makes it easy to get started with building a fast and scalable web applications or web APIs in Python.
31
+
-**Dependency Injection (DI)**: It comes with DI system makes it easy to manage dependencies and reduce coupling between components.
32
+
-**Pydantic Integration**: It is properly integrated with Pydantic, a popular Python library for data validation, to ensure that input data is valid.
33
+
-**Templating with Jinja2**: Ellar provides built-in support for Jinja2 templates, making it easy to create dynamic web pages.
34
+
-**OpenAPI Documentation**: It comes with built-in support for OpenAPI documentation, making it easy to generate `Swagger` or `ReDoc` documentation for your API. And more can be added with ease if necessary.
35
+
-**Controller (MVC) Architecture**: Ellar's controller architecture follows the Model-View-Controller (MVC) pattern, making it easy to organize your code.
36
+
-**Guards for Authentication and Authorization**: It provides built-in support for guards, allowing you to easily implement authentication and authorization in your application.
37
+
-**Modularity**: Ellar follows a modular architecture inspired by NestJS, making it easy to organize your code into reusable modules.
38
+
-**Asynchronous programming**: It allows you to takes advantage of Python's `async/await` feature to write efficient and fast code that can handle large numbers of concurrent requests
39
+
27
40
## Installation
28
41
To get started, you need to scaffold a project using [Ellar-CLI](https://eadwincode.github.io/ellar-cli/) toolkit. This is recommended for a first-time user.
29
42
The scaffolded project is more like a guide to project setup.
Open your browser and navigate to [`http://localhost:8000/`](http://localhost:8000/).
42
55

43
56
44
-
## Features Summary
45
-
46
-
-**Easy to Use**: Ellar has a simple and intuitive API that makes it easy to get started with building a fast and scalable web applications or web APIs in Python.
47
-
-**Dependency Injection (DI)**: It comes with DI system makes it easy to manage dependencies and reduce coupling between components.
48
-
-**Pydantic Integration**: It is properly integrated with Pydantic, a popular Python library for data validation, to ensure that input data is valid.
49
-
-**Templating with Jinja2**: Ellar provides built-in support for Jinja2 templates, making it easy to create dynamic web pages.
50
-
-**OpenAPI Documentation**: It comes with built-in support for OpenAPI documentation, making it easy to generate `Swagger` or `ReDoc` documentation for your API. And more can be added with ease if necessary.
51
-
-**Controller (MVC) Architecture**: Ellar's controller architecture follows the Model-View-Controller (MVC) pattern, making it easy to organize your code.
52
-
-**Guards for Authentication and Authorization**: It provides built-in support for guards, allowing you to easily implement authentication and authorization in your application.
53
-
-**Modularity**: Ellar follows a modular architecture inspired by NestJS, making it easy to organize your code into reusable modules.
54
-
-**Asynchronous programming**: It allows you to takes advantage of Python's `async/await` feature to write efficient and fast code that can handle large numbers of concurrent requests
0 commit comments