Skip to content

Commit 9c17780

Browse files
Update README.md
1 parent 3bc47fb commit 9c17780

File tree

1 file changed

+2
-81
lines changed

1 file changed

+2
-81
lines changed

backend/README.md

Lines changed: 2 additions & 81 deletions
Original file line numberDiff line numberDiff line change
@@ -135,6 +135,7 @@ Check the `pyproject.toml` as the main configuration file for the following pack
135135
**INFO**: The testing report is automatically generated and saved in ``
136136

137137
* Step 1: Run PyTest:
138+
138139
```shell
139140
pytest
140141
```
@@ -154,86 +155,6 @@ Server | Database | Test | Linter | Others
154155
[asgi_lifespan](https://pypi.org/project/asgi-lifespan/) | - | | [colorama](https://pypi.org/project/colorama/) | [loguru](https://github.com/Delgan/loguru)
155156
[httpx](https://www.python-httpx.org/) | - | - | - | [python-jose](https://python-jose.readthedocs.io/en/latest/)
156157
[trio](https://pypi.org/project/trio/) | - | - | - | [pathlib](https://pathlib.readthedocs.io/en/pep428/)
157-
- | - | - | - | [python-slugify](https://pypi.org/project/python-slugify/)
158-
159-
---
160-
161-
## Project Structure
162-
163-
```shell
164-
backend/
165-
├── coverage/
166-
├── src/
167-
├── api/
168-
├── dependencies/ # Dependency injections
169-
├── session.py
170-
├──repository.py
171-
├── routes/ # Endpoints
172-
├── account.py # Account routes
173-
├── authentication.py # Signup and Signin routes
174-
├── endpoints.py # Endpoint registration
175-
├── config/
176-
├── settings/
177-
├── base.py # Base settings / settings parent class
178-
├── development.py # Development settings
179-
├── environments.py # Enum with PROD, DEV, STAGE environment
180-
├── production.py # Production settings
181-
├── staging.py # Test settings
182-
├── events.py # Registration of global events
183-
├── manager.py # Manage get settings
184-
├── models/
185-
├── domains/
186-
├── account.py # Account class for database entity
187-
├── schemas/
188-
├── account.py # Account classes for data validation objects
189-
├── base.py # Base class for data validation objects
190-
├── repository/
191-
├── crud/
192-
├── account.py # C. R. U. D. operations for Account entity
193-
├── base.py # Base class for C. R. U. D. operations
194-
├── migrations/
195-
├── versions/
196-
├── env.py # Generated via alembic for automigration
197-
├── script.py.mako # Generated via alembic
198-
├── base.py # Entry point for alembic automigration
199-
├── database.py # Database class with engine and session
200-
├── events.py # Registration of database events
201-
├── table.py # Custom SQLAlchemy Base class
202-
├── security/
203-
├── hashing/
204-
├── hash.py # Hash functions with passlib
205-
├── password.py # Password generator with hash functions
206-
├── authorizations/
207-
├── jwt.py # Generate JWT tokens with python-jose
208-
├── verifications/
209-
├── credentials.py # Check for attributes' availability
210-
├── utilities/
211-
├── exceptions/
212-
├── http/
213-
├── http_exc_400.py # Custom 400 error handling functions
214-
├── http_exc_401.py # Custom 401 error handling functions
215-
├── http_exc_403.py # Custom 403 error handling functions
216-
├── http_exc_404.py # Custom 404 error handling functions
217-
├── database.py # Custom `Exception` class
218-
├── password.py # Custom `Exception` class
219-
├── formatters/
220-
├── datetime_formatter.py # Reformat datetime into the ISO form
221-
├── field_formatter.py # Reformat snake_case to camelCase
222-
├── messages/
223-
├── http/
224-
├── http_exc_details.py # Custom message for HTTP exceptions
225-
├── main.py # Our main backend server app
226-
tests/
227-
├── end_to_end_tests/ # End-to-end tests
228-
├── integration_tests/ # Integration tests
229-
├── security_tests/ # Security-related tests
230-
├── unit_tests/ # Unit tests
231-
├── test_src.py # Testing the src directory's version
232-
conftest.py # The fixture codes and other base test codes
233-
alembic.ini # Automatic databse migration configuration
234-
pyproject.toml # Linter and test main configuration file
235-
README.md # Documentaiton for backend app
236-
requirements.txt # Packages installed for backend app
237-
```
158+
\- | - | - | - | [python-slugify](https://pypi.org/project/python-slugify/)
238159

239160
---

0 commit comments

Comments
 (0)