Skip to content

Commit fed8b94

Browse files
committed
πŸ“ (README.md): restructure technology stack section for clarity and add subsections for backend, frontend, CI/CD, and deployment
1 parent 2aec36d commit fed8b94

File tree

1 file changed

+45
-33
lines changed

1 file changed

+45
-33
lines changed

β€ŽREADME.md

Lines changed: 45 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -27,41 +27,53 @@
2727

2828
## Technology Stack and Features
2929

30-
- ⚑ [**FastAPI**](https://fastapi.tiangolo.com) for the Python backend API.
31-
- πŸ“¦ [**Poetry**](https://python-poetry.org) for dependency management.
32-
- 🐢 [**Ruff**](https://github.com/astral-sh/ruff) for linting.
33-
- πŸ“ [**Pydantic**](https://docs.pydantic.dev) for data validation.
34-
- πŸ—ƒ [**SQLite**](https://www.sqlite.org) as database.
35-
- πŸ†“ **ORM Free**: Use raw SQL queries by leveraging the repository pattern.
36-
- πŸ›  [**SQLift**](https://github.com/SpaceShaman/SQLift) for database migrations.
37-
- πŸš€ [**Nuxt.js**](https://nuxt.com) for the frontend.
38-
- 🟦 [**TypeScript**](https://www.typescriptlang.org) for static type checking.
39-
- πŸ–Œ [**Prettier**](https://prettier.io) for code formatting.
40-
- ✨ [**ESLint**](https://eslint.org) for linting.
41-
- 🎨 [**TailwindCSS**](https://tailwindcss.com) for styling.
42-
- 🧩 [**daisyUI**](https://daisyui.com) for ready-to-use [**TailwindCSS**](https://tailwindcss.com) components.
43-
- πŸ” Middleware for authentication.
44-
- πŸ“ Form validation via [**VeeValidate**](https://vee-validate.logaretm.com) and [**Yup**](https://yup-docs.vercel.app/)
45-
- 🎨 Theme selector with 32 themes from [**daisyUI**](https://daisyui.com).
46-
- 🚨 Alerts and toasts via simple utility functions.
47-
- ❌ Call `showErrorAlert('message')` to show an error message.
48-
- βœ… Call `showSuccessAlert('message')` to show a success message.
49-
- πŸ’‘ Call `showInfoAlert('message')` to show an info message.
50-
- ⚠️ Call `showWarningAlert('message')` to show a warning message.
30+
### Backend
31+
32+
- ⚑ [**FastAPI**](https://fastapi.tiangolo.com) as the backend framework.
33+
- πŸ“¦ Dependency management with [**Poetry**](https://python-poetry.org).
34+
- 🐢 Code linting using [**Ruff**](https://github.com/astral-sh/ruff).
35+
- πŸ“ Data validation with [**Pydantic**](https://docs.pydantic.dev).
36+
- πŸ—ƒ [**SQLite**](https://www.sqlite.org) as the database.
37+
- πŸ†“ **ORM free** approach using raw SQL queries with the repository pattern.
38+
- πŸ›  Database migrations with [**SQLift**](https://github.com/SpaceShaman/SQLift).
5139
- πŸ”‘ **JWT** (JSON Web Token) authentication.
5240
- πŸ“ Registration with email based account activation.
5341
- πŸ”’ Secure password hashing.
54-
- πŸ“« Email based password recovery.
55-
- πŸ“§ SMTP email integration for sending emails.
56-
- βœ‰οΈ Jinja templates for email messages.
57-
- βœ… Tests with [Pytest](https://pytest.org).
58-
- 🚒 Deployment instructions using Docker Compose.
59-
- 🚦 [**Traefik**](https://doc.traefik.io/traefik) as reverse proxy.
60-
- πŸ”„ **CI/CD** with GitHub Actions
61-
- πŸ§ͺ Automated testing before deployment
62-
- πŸ“Š Code coverage reporting with Codecov
63-
- πŸš€ Continuous integration and deployment pipeline
64-
- πŸ“¦ Ready-to-use workflow configurations in `.github/workflows/`
42+
- πŸ“« Password recovery via email.
43+
- πŸ“§ SMTP integration for sending emails.
44+
- βœ‰οΈ Email templates using Jinja.
45+
- βœ… Unit testing with [**Pytest**](https://pytest.org).
46+
47+
### Frontend
48+
49+
- πŸš€ [**Nuxt.js**](https://nuxt.com) as the frontend framework.
50+
- 🟦 [**TypeScript**](https://www.typescriptlang.org) for static type checking.
51+
- πŸ–Œ Code formatting with [**Prettier**](https://prettier.io).
52+
- ✨ Code linting using [**ESLint**](https://eslint.org).
53+
- 🎨 Styling with [**TailwindCSS**](https://tailwindcss.com).
54+
- 🧩 Ready-to-use components from [**daisyUI**](https://daisyui.com).
55+
- πŸ” Middleware for authentication handling.
56+
- πŸ“ Form validation with [**VeeValidate**](https://vee-validate.logaretm.com) and [**Yup**](https://yup-docs.vercel.app/).
57+
- 🎨 Theme selector with 32 themes from [**daisyUI**](https://daisyui.com).
58+
- 🚨 Utility functions for alerts and notifications.
59+
- ❌ Call `showErrorAlert('message')` to show an error message.
60+
- βœ… Call `showSuccessAlert('message')` to show a success message.
61+
- πŸ’‘ Call `showInfoAlert('message')` to show an info message.
62+
- ⚠️ Call `showWarningAlert('message')` to show a warning message.
63+
64+
### CI/CD
65+
66+
- πŸ”„ CI/CD pipeline with GitHub Actions.
67+
- πŸ§ͺ Automated testing before deployment.
68+
- πŸ“Š Code coverage reporting with [**Codecov**](https://about.codecov.io)
69+
- πŸš€ Ready-to-use workflow configurations in [.github/workflows/](.github/workflows/)
70+
71+
### Deployment
72+
73+
- 🚒 Deployment instructions using [**Docker Compose**](https://docs.docker.com/compose).
74+
- 🚦 [**Traefik**](https://doc.traefik.io/traefik) as a reverse proxy.
75+
76+
## Screenshots
6577

6678
### Login Page
6779

@@ -127,7 +139,7 @@ docker-compose -f docker-compose.dev.yml up
127139
docker-compose up
128140
```
129141

130-
### CI/CD
142+
### CI/CD configuration
131143

132144
This project has a CI/CD pipeline with GitHub Actions.
133145
You can see the workflow configuration in [.github/workflows/](.github/workflows/).

0 commit comments

Comments
Β (0)