Skip to content

Commit fe56d3b

Browse files
authored
README.md: Fix typos (#5)
1 parent 56f91fb commit fe56d3b

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ The above listed technologies are just the main ones. There are other technologi
6363
* [Pre-Commit CI](https://pre-commit.ci/) $\rightarrow$ Continuous integration for our Pre-Commit hook that fixes and updates our hook versions.
6464
* [CodeCov](https://about.codecov.io/) $\rightarrow$ A platform that analyze the result of your automated tests.
6565
* [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!).
6767
* [GitHub Actions](https://github.com/features/actions) $\rightarrow$ The platform to setup our CI/CD by GitHub.
6868
* [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.
6969
* [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:
8181
* PostgreSQL database connection with asynchronous SQLAlchemy 2.0 in `backend/src/repository/database.py`.
8282
* A custom SQLAlchemy Base class in `backend/src/repository/table.py`
8383
* 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`.
8585
* C. R. U. D. methods for `Account` object in `backend/src/repository/crud/account.py`.
8686
* Table classes registration file in `backend/src/repository/base.py`.
8787
* 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
181181
docker-compose build
182182
docker-compose up
183183
184-
# Everytime you write a new code, update your container with:
184+
# Every time you write a new code, update your container with:
185185
docker-compose up -d --build
186186
```
187187
@@ -208,7 +208,7 @@ This backend application is setup with `Docker`. Nevertheless, you can see the f
208208
```shell
209209
.github/
210210
├── 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`
212212
├── CODEOWNERS # A configuration file to distribute code responsibility
213213
├── semantic.yaml # A configuration file for ensuring an automated semantic commit message
214214
@@ -282,16 +282,16 @@ backend/
282282
├── test_src.py # Testing the src directory's version
283283
├── conftest.py # The fixture codes and other base test codes
284284
├── Dockerfile # Docker cpnfiguration file for backend application
285-
├── README.md # Documentaiton for backend app
285+
├── README.md # Documentation for backend app
286286
├── entrypoint.sh # A script to restart backend app container if postgres is not started
287-
├── alembic.ini # Automatic databse migration configuration
287+
├── alembic.ini # Automatic database migration configuration
288288
├── pyproject.toml # Linter and test main configuration file
289289
├── requirements.txt # Packages installed for backend app
290290
.dockerignore # A file that list files to be excluded in Docker container
291291
.gitignore # A file that list files to be excluded in GitHub repository
292292
.pre-commit-config.yaml # A file with Python linter hooks to ensure conventional commit when committing
293293
LICENSE.md # A license to use this template repository (delete this file after using this repository)
294-
README.md # The main documnetation file for this template repository
294+
README.md # The main documentation file for this template repository
295295
codecov.yaml # The configuration file for automated testing CI with codecov.io
296296
docker-compose.yaml # The main configuration file for setting up a multi-container Docker
297297
```

0 commit comments

Comments
 (0)