Skip to content

Commit a98ef30

Browse files
committed
update README.md for improved clarity and structure
1 parent 96adcd5 commit a98ef30

File tree

1 file changed

+21
-21
lines changed

1 file changed

+21
-21
lines changed

README.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,28 @@
11
# Full Stack FastAPI Template
22

3-
<a href="https://github.com/fastapi/full-stack-fastapi-template/actions?query=workflow%3ATest" target="_blank"><img src="https://github.com/fastapi/full-stack-fastapi-template/workflows/Test/badge.svg" alt="Test"></a>
4-
<a href="https://coverage-badge.samuelcolvin.workers.dev/redirect/fastapi/full-stack-fastapi-template" target="_blank"><img src="https://coverage-badge.samuelcolvin.workers.dev/fastapi/full-stack-fastapi-template.svg" alt="Coverage"></a>
3+
[![Test](https://github.com/fastapi/full-stack-fastapi-template/workflows/Test/badge.svg)](https://github.com/fastapi/full-stack-fastapi-template/actions?query=workflow%3ATest)
4+
[![Coverage](https://coverage-badge.samuelcolvin.workers.dev/fastapi/full-stack-fastapi-template.svg)](https://coverage-badge.samuelcolvin.workers.dev/redirect/fastapi/full-stack-fastapi-template)
55

66
## Technology Stack and Features
77

8-
- [**FastAPI**](https://fastapi.tiangolo.com) for the Python backend API.
9-
- 🧰 [SQLModel](https://sqlmodel.tiangolo.com) for the Python SQL database interactions (ORM).
10-
- 🔍 [Pydantic](https://docs.pydantic.dev), used by FastAPI, for the data validation and settings management.
11-
- 💾 [PostgreSQL](https://www.postgresql.org) as the SQL database.
12-
- 🚀 [React](https://react.dev) for the frontend.
13-
- 💃 Using TypeScript, hooks, Vite, and other parts of a modern frontend stack.
14-
- 🎨 [Chakra UI](https://chakra-ui.com) for the frontend components.
15-
- 🤖 An automatically generated frontend client.
16-
- 🧪 [Playwright](https://playwright.dev) for End-to-End testing.
17-
- 🦇 Dark mode support.
18-
- 🐋 [Docker Compose](https://www.docker.com) for development and production.
19-
- 🔒 Secure password hashing by default.
20-
- 🔑 JWT (JSON Web Token) authentication.
21-
- 📫 Email based password recovery.
22-
- Tests with [Pytest](https://pytest.org).
23-
- 📞 [Traefik](https://traefik.io) as a reverse proxy / load balancer.
24-
- 🚢 Deployment instructions using Docker Compose, including how to set up a frontend Traefik proxy to handle automatic HTTPS certificates.
25-
- 🏭 CI (continuous integration) and CD (continuous deployment) based on GitHub Actions.
8+
- [**FastAPI**](https://fastapi.tiangolo.com) for the Python backend API.
9+
- [SQLModel](https://sqlmodel.tiangolo.com) for the Python SQL database interactions (ORM).
10+
- [Pydantic](https://docs.pydantic.dev), used by FastAPI, for the data validation and settings management.
11+
- [PostgreSQL](https://www.postgresql.org) as the SQL database.
12+
- [React](https://react.dev) for the frontend.
13+
- Using TypeScript, hooks, Vite, and other parts of a modern frontend stack.
14+
- [Chakra UI](https://chakra-ui.com) for the frontend components.
15+
- An automatically generated frontend client.
16+
- [Playwright](https://playwright.dev) for End-to-End testing.
17+
- Dark mode support.
18+
- [Docker Compose](https://www.docker.com) for development and production.
19+
- Secure password hashing by default.
20+
- JWT (JSON Web Token) authentication.
21+
- Email based password recovery.
22+
- Tests with [Pytest](https://pytest.org).
23+
- [Traefik](https://traefik.io) as a reverse proxy / load balancer.
24+
- Deployment instructions using Docker Compose, including how to set up a frontend Traefik proxy to handle automatic HTTPS certificates.
25+
- CI (continuous integration) and CD (continuous deployment) based on GitHub Actions.
2626

2727
### Dashboard Login
2828

@@ -56,7 +56,7 @@
5656

5757
You can **just fork or clone** this repository and use it as is.
5858

59-
It just works.
59+
It just works.
6060

6161
### How to Use a Private Repository
6262

0 commit comments

Comments
 (0)