You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -63,7 +63,7 @@ The above listed technologies are just the main ones. There are other technologi
63
63
*[Pre-Commit CI](https://pre-commit.ci/) $\rightarrow$ Continuous integration for our Pre-Commit hook that fixes and updates our hook versions.
64
64
*[CodeCov](https://about.codecov.io/) $\rightarrow$ A platform that analyze the result of your automated tests.
65
65
*[PyTest](https://docs.pytest.org/en/7.2.x/) $\rightarrow$ The testing framework for Python code.
66
-
*[DBDiagram](https://dbdiagram.io/home) $\rightarrow$ A platform that lets your design your database by writing SQL and converting it into ERD. This paltform provides a complete symbol for entity relationships (not like many other platforms!).
66
+
*[DBDiagram](https://dbdiagram.io/home) $\rightarrow$ A platform that lets your design your database by writing SQL and converting it into ERD. This platform provides a complete symbol for entity relationships (not like many other platforms!).
67
67
*[GitHub Actions](https://github.com/features/actions) $\rightarrow$ The platform to setup our CI/CD by GitHub.
68
68
*[SQLAlchemy 2.0](https://docs.sqlalchemy.org/en/20/orm/extensions/asyncio.html) $\rightarrow$ The go-to database interface library for Python. The 2.0 is the most recent update where it provides asynchronous setup.
69
69
*[CODEOWNERS](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners) $\rightarrow$ A file for distributing the responsibilities in our project to each team/team mate.
@@ -81,7 +81,7 @@ For the backend application:
81
81
* PostgreSQL database connection with asynchronous SQLAlchemy 2.0 in `backend/src/repository/database.py`.
82
82
* A custom SQLAlchemy Base class in `backend/src/repository/table.py`
83
83
* PostgreSQL database connection with asynchronous SQLAlchemy 2.0 in `backend/src/repository/database.py`.
84
-
* Database-related events e.g. databse table registration by app startup in `backend/src/repository/events.py`.
84
+
* Database-related events e.g. database table registration by app startup in `backend/src/repository/events.py`.
85
85
* C. R. U. D. methods for `Account` object in `backend/src/repository/crud/account.py`.
86
86
* Table classes registration file in `backend/src/repository/base.py`.
87
87
* Alembic setup for auto generating asynchronous database migrations in `backend/src/repository/migration/**`.
@@ -181,7 +181,7 @@ This backend application is setup with `Docker`. Nevertheless, you can see the f
181
181
docker-compose build
182
182
docker-compose up
183
183
184
-
# Everytime you write a new code, update your container with:
184
+
# Every time you write a new code, update your container with:
185
185
docker-compose up -d --build
186
186
```
187
187
@@ -208,7 +208,7 @@ This backend application is setup with `Docker`. Nevertheless, you can see the f
208
208
```shell
209
209
.github/
210
210
├── workflows/
211
-
├── ci-backend.yaml # A CI file for the backend app that consits of `build`, `code-style`, and `test`
211
+
├── ci-backend.yaml # A CI file for the backend app that consists of `build`, `code-style`, and `test`
212
212
├── CODEOWNERS # A configuration file to distribute code responsibility
213
213
├── semantic.yaml # A configuration file for ensuring an automated semantic commit message
214
214
@@ -282,16 +282,16 @@ backend/
282
282
├── test_src.py # Testing the src directory's version
283
283
├── conftest.py # The fixture codes and other base test codes
284
284
├── Dockerfile # Docker cpnfiguration file for backend application
285
-
├── README.md #Documentaiton for backend app
285
+
├── README.md #Documentation for backend app
286
286
├── entrypoint.sh # A script to restart backend app container if postgres is not started
0 commit comments