Skip to content

Commit c4da8fb

Browse files
igorbenavigorbenav
authored
Update README.md
1 parent b12f409 commit c4da8fb

File tree

1 file changed

+55
-55
lines changed

1 file changed

+55
-55
lines changed

‎README.md‎

Lines changed: 55 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -236,70 +236,70 @@ ___
236236
### 9.1 Project Structure
237237
```sh
238238
.
239-
├── .env # Environment variables file for configuration and secrets.
240-
├── __init__.py # An initialization file for the package.
241-
├── alembic.ini # Configuration file for Alembic (database migration tool).
242-
├── app # Main application directory.
243-
│ ├── __init__.py # Initialization file for the app package.
244-
│ ├── api # Folder containing API-related logic.
245-
│ │ ├── __init__.py # Initialization file for the api package.
246-
│ │ ├── dependencies.py # Defines dependencies that can be reused across the API endpoints.
247-
│ │ ├── exceptions.py # Contains custom exceptions for the API.
248-
│ │ └── v1 # Version 1 of the API.
249-
│ │ ├── __init__.py # Initialization file for the v1 package.
250-
│ │ ├── login.py # API routes related to user login.
251-
│ │ ├── posts.py # API routes related to posts.
252-
│ │ ├── tasks.py # API routes related to background tasks.
253-
│ │ └── users.py # API routes related to user management.
239+
├── .env # Environment variables file for configuration and secrets.
240+
├── __init__.py # An initialization file for the package.
241+
├── alembic.ini # Configuration file for Alembic (database migration tool).
242+
├── app # Main application directory.
243+
│ ├── __init__.py # Initialization file for the app package.
244+
│ ├── api # Folder containing API-related logic.
245+
│ │ ├── __init__.py # Initialization file for the api package.
246+
│ │ ├── dependencies.py # Defines dependencies that can be reused across the API endpoints.
247+
│ │ ├── exceptions.py # Contains custom exceptions for the API.
248+
│ │ └── v1 # Version 1 of the API.
249+
│ │ ├── __init__.py # Initialization file for the v1 package.
250+
│ │ ├── login.py # API routes related to user login.
251+
│ │ ├── posts.py # API routes related to posts.
252+
│ │ ├── tasks.py # API routes related to background tasks.
253+
│ │ └── users.py # API routes related to user management.
254254
│ │
255-
│ ├── core # Core utilities and configurations for the application.
256-
│ │ ├── __init__.py # Initialization file for the core package.
257-
│ │ ├── cache.py # Utilities related to caching.
258-
│ │ ├── config.py # Application configuration settings.
259-
│ │ ├── database.py # Database connectivity and session management.
260-
│ │ ├── exceptions.py # Contains core custom exceptions for the application.
261-
│ │ ├── models.py # Base models for the application.
262-
│ │ ├── queue.py # Utilities related to task queues.
263-
│ │ └── security.py # Security utilities like password hashing and token generation.
255+
│ ├── core # Core utilities and configurations for the application.
256+
│ │ ├── __init__.py # Initialization file for the core package.
257+
│ │ ├── cache.py # Utilities related to caching.
258+
│ │ ├── config.py # Application configuration settings.
259+
│ │ ├── database.py # Database connectivity and session management.
260+
│ │ ├── exceptions.py # Contains core custom exceptions for the application.
261+
│ │ ├── models.py # Base models for the application.
262+
│ │ ├── queue.py # Utilities related to task queues.
263+
│ │ └── security.py # Security utilities like password hashing and token generation.
264264
│ │
265-
│ ├── crud # CRUD operations for the application.
266-
│ │ ├── __init__.py # Initialization file for the crud package.
267-
│ │ ├── crud_base.py # Base CRUD operations class that can be extended by other CRUD modules.
268-
│ │ ├── crud_posts.py # CRUD operations for posts.
269-
│ │ └── crud_users.py # CRUD operations for users.
265+
│ ├── crud # CRUD operations for the application.
266+
│ │ ├── __init__.py # Initialization file for the crud package.
267+
│ │ ├── crud_base.py # Base CRUD operations class that can be extended by other CRUD modules.
268+
│ │ ├── crud_posts.py # CRUD operations for posts.
269+
│ │ └── crud_users.py # CRUD operations for users.
270270
│ │
271-
│ ├── main.py # Entry point for the FastAPI application.
271+
│ ├── main.py # Entry point for the FastAPI application.
272272
│ │
273-
│ ├── models # ORM models for the application.
274-
│ │ ├── __init__.py # Initialization file for the models package.
275-
│ │ ├── post.py # ORM model for posts.
276-
│ │ └── user.py # ORM model for users.
273+
│ ├── models # ORM models for the application.
274+
│ │ ├── __init__.py # Initialization file for the models package.
275+
│ │ ├── post.py # ORM model for posts.
276+
│ │ └── user.py # ORM model for users.
277277
│ │
278-
│ ├── schemas # Pydantic schemas for data validation.
279-
│ │ ├── __init__.py # Initialization file for the schemas package.
280-
│ │ ├── job.py # Schemas related to background jobs.
281-
│ │ ├── post.py # Schemas related to posts.
282-
│ │ └── user.py # Schemas related to users.
278+
│ ├── schemas # Pydantic schemas for data validation.
279+
│ │ ├── __init__.py # Initialization file for the schemas package.
280+
│ │ ├── job.py # Schemas related to background jobs.
281+
│ │ ├── post.py # Schemas related to posts.
282+
│ │ └── user.py # Schemas related to users.
283283
│ │
284-
│ └── worker.py # Worker script for handling background tasks.
284+
│ └── worker.py # Worker script for handling background tasks.
285285
│
286-
├── migrations # Directory for Alembic migrations.
287-
│ ├── README # General info and guidelines for migrations.
288-
│ ├── env.py # Environment configurations for Alembic.
289-
│ ├── script.py.mako # Template script for migration generation.
290-
│ └── versions # Folder containing individual migration scripts.
291-
│ └── README.MD # Readme for the versions directory.
286+
├── migrations # Directory for Alembic migrations.
287+
│ ├── README # General info and guidelines for migrations.
288+
│ ├── env.py # Environment configurations for Alembic.
289+
│ ├── script.py.mako # Template script for migration generation.
290+
│ └── versions # Folder containing individual migration scripts.
291+
│ └── README.MD # Readme for the versions directory.
292292
│
293-
├── poetry.lock # Lock file for Poetry, ensuring consistent dependencies.
294-
├── pyproject.toml # Configuration file for Poetry, lists project dependencies.
295-
├── scripts # Utility scripts for the project.
296-
│ └── create_first_superuser.py # Script to create the first superuser in the application.
293+
├── poetry.lock # Lock file for Poetry, ensuring consistent dependencies.
294+
├── pyproject.toml # Configuration file for Poetry, lists project dependencies.
295+
├── scripts # Utility scripts for the project.
296+
│ └── create_first_superuser.py # Script to create the first superuser in the application.
297297
│
298-
└── tests # Directory containing all the tests.
299-
├── __init__.py # Initialization file for the tests package.
300-
├── conftest.py # Configuration and fixtures for pytest.
301-
├── helper.py # Helper functions for writing tests.
302-
└── test_user.py # Tests related to the user model and endpoints.
298+
└── tests # Directory containing all the tests.
299+
├── __init__.py # Initialization file for the tests package.
300+
├── conftest.py # Configuration and fixtures for pytest.
301+
├── helper.py # Helper functions for writing tests.
302+
└── test_user.py # Tests related to the user model and endpoints.
303303
```
304304

305305
### 9.2 Database Model

0 commit comments

Comments
 (0)