Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Updated Project Description and Table of Contents for ReadMe #321

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Updated Project Description and Table of Contents for ReadMe #321

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
54823ed
my branch + readme updates
ubebabe Oct 2, 2023
38c8631
more readme updates
ubebabe Oct 2, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,29 @@

The tool that lets you bootstrap aiohttp application with best practices ready for development.

### What is an aiohttp application?

An aiohttp application is a web application or API built using the aiohttp framework, designed for asynchronous programming in Python. It is capable of handling concurrent requests efficiently and is well-suited for building modern, high-performance web applications and services.

The tool involves following best practices to ensure code maintainability, performance, security, and scalability, such as:
* Proper Project Structure
* Middleware Usage for common tasks like authentication, CORS handling, request/response logging, and error handling.
* Unit tests using aiohttp's built-in testing framework or libraries like pytest-aiohttp.
* WebSocket Support, includes built-in WebSocket support
* Support for serving static files such as CSS, JavaScript, and images.

**Here is a screenshot of our interfaces**
![Example](https://raw.githubusercontent.com/aio-libs/create-aio-app/master/assets/assets.png)

## Table of Contents
[Installation](#Installation)
[Usage](#Usage)
[Salient Features](#Salient-Features)
[Options](#Options)
[Contributing](#Contributing)

<a name="Installation"/>

## Installation

Requires python3.6 - python3.7 and docker-compose
Expand All @@ -20,6 +40,8 @@ Requires python3.6 - python3.7 and docker-compose
pip install create-aio-app
```

<a name="Usage"/>

## Usage

```bash
Expand All @@ -46,6 +68,8 @@ make run # start your project

Then, navigate in your browser to `http://localhost:8080/`

<a name="Salient-Features"/>

## Salient Features

- [aiohttp](https://aiohttp.readthedocs.io/en/stable/) - the best python framework :)
Expand All @@ -63,6 +87,8 @@ Then, navigate in your browser to `http://localhost:8080/`
- [docker-compose](https://docs.docker.com/compose/) - tool for defining and running multi-container Docker applications
- [py-spy](https://github.com/benfred/py-spy) - Sampling profiler for Python programs

<a name="Options"/>

## Options

`--without-postgres` - remove postgres and all of its requirements
Expand All @@ -71,6 +97,8 @@ Then, navigate in your browser to `http://localhost:8080/`

`--uvloop` - uvloop event loop for aiohttp

<a name="Contributing"/>

## Contributing

`create-aio-app` is a boilerplate from aiohttp community for aiohttp
Expand Down