Skip to content

Commit 54529ec

Browse files
Updated the README.md for grammatical typos. (#8)
1 parent 3eb5555 commit 54529ec

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

README.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828

2929
<br>
3030

31-
This is a template repository aimed to kick start your project with a setup from a real-world application! This template utilizes the following tech-stack:
31+
This is a template repository aimed to kick-start your project with a setup from a real-world application! This template utilizes the following tech stack:
3232

3333
* 🐳 [Dockerized](https://www.docker.com/)
3434
* 🐘 [Asynchronous PostgreSQL](https://www.postgresql.org/docs/current/libpq-async.html)
@@ -51,24 +51,24 @@ Well, the easy answer is **Asynchronousity** and **Speed**!
5151

5252
## Other Technologies
5353

54-
The above listed technologies are just the main ones. There are other technologies utilized in this project template to ensure that your application is robust and provides the best-possible development environment for your team! These technologies are:
54+
The above-listed technologies are just the main ones. There are other technologies utilized in this project template to ensure that your application is robust and provides the best possible development environment for your team! These technologies are:
5555

5656
* [TOML](https://toml.io/en/) $\rightarrow$ The one-for-all configuration file. This makes it simpler to setup our project.
5757
* [Pyenv](https://github.com/pyenv/pyenv) $\rightarrow$ The simplest way to manage our Python versions.
5858
* [Pyenv-VirtualEnv](https://github.com/pyenv/pyenv-virtualenv) $\rightarrow$ The plugin for `Pyenv` to manage the virtual environment for our packages.
59-
* [Pre-Commit](https://pre-commit.com/) $\rightarrow$ Git hook scripts to identify issues and quality of your code before pushing it to GitHub. These hooks are implemented for the following linting pakcages:
60-
* [Black (Python)](https://black.readthedocs.io/en/stable/) $\rightarrow$ Manage your code style with auto formatting and parallel continuous integration runner for Python.
59+
* [Pre-Commit](https://pre-commit.com/) $\rightarrow$ Git hook scripts to identify issues and quality of your code before pushing it to GitHub. These hooks are implemented for the following linting packages:
60+
* [Black (Python)](https://black.readthedocs.io/en/stable/) $\rightarrow$ Manage your code style with auto-formatting and parallel continuous integration runner for Python.
6161
* [Isort (Python)](https://pycqa.github.io/isort/) $\rightarrow$ Sort your `import` for clarity. Also for Python.
62-
* [MyPy (Python)](https://mypy.readthedocs.io/en/stable/) $\rightarrow$ A static type checker for Python that helps you write a cleaner code.
62+
* [MyPy (Python)](https://mypy.readthedocs.io/en/stable/) $\rightarrow$ A static type checker for Python that helps you to write cleaner code.
6363
* [Pre-Commit CI](https://pre-commit.ci/) $\rightarrow$ Continuous integration for our Pre-Commit hook that fixes and updates our hook versions.
64-
* [CodeCov](https://about.codecov.io/) $\rightarrow$ A platform that analyze the result of your automated tests.
64+
* [CodeCov](https://about.codecov.io/) $\rightarrow$ A platform that analyzes the result of your automated tests.
6565
* [PyTest](https://docs.pytest.org/en/7.2.x/) $\rightarrow$ The testing framework for Python code.
6666
* [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.
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-
* [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.
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 an asynchronous setup.
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/teammate.
7070

71-
My choice for a project development worklow is usually the [Trunk-Based Development](https://trunkbaseddevelopment.com/) because of the straight forward approach in the collaboration workflow, hence the name `trunk` for the main branch repository instead of `master` or `main`.
71+
My choice for a project development workflow is usually the [Trunk-Based Development](https://trunkbaseddevelopment.com/) because of the straightforward approach in the collaboration workflow, hence the name `trunk` for the main branch repository instead of `master` or `main`.
7272

7373
## What Code is included?
7474

@@ -84,7 +84,7 @@ For the backend application:
8484
* 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`.
87-
* Alembic setup for auto generating asynchronous database migrations in `backend/src/repository/migration/**`.
87+
* Alembic setup for auto-generating asynchronous database migrations in `backend/src/repository/migration/**`.
8888
* Alembic main configuration file in `backend/alembic.ini`.
8989
* Dependency injection for database session and repository in `backend/src/api/**`.
9090
* API endpoints for `Account` signup and signin in `backend/src/api/routes/authentication.py`.
@@ -94,15 +94,15 @@ For the backend application:
9494
* Helper functions, string messages, and error handling in `backend/src/utilities/**`.
9595
* A comprehensive FastAPI application initialization in `backend/src/main.py`.
9696

97-
For testing I have prepared the following simple code to kick start your test-driven development:
97+
For testing, I have prepared the following simple code to kick-start your test-driven development:
9898
* A simple replication of the backend application for testing purposes and the asynchronous test client in `backend/tests/conftest.py`.
9999
* 2 simple test functions to test the backend application initialization in `tests/unit_tests/test_src.py`.
100100

101101
For the DevOps:
102102
* A simple `build` job to test the compilation of the source code for the backend application in `.github/workflows/ci-backend.yaml`.
103103
* A simple linting job called `code-style` with black, isort, flake8, and mypy in `.github/workflows/ci-backend.yaml`.
104104
* An automated testing with `PyTest` and an automated test reporting with `Codecov` in in `.github/workflows/ci-backend.yaml`.
105-
* A source code responsibility distribution file in `.github/CODEOWNERS` (Please change the username into your own).
105+
* A source code responsibility distribution file in `.github/CODEOWNERS` (Please change the username to your own).
106106
* A `YAML` file for an automated semantic commit message in `.github/workflows/ci-backend.yaml`.
107107
* An automated test report monitoring via `Codecov` in `codecov.yaml`
108108
* A CI for automatically updating all linter version in the pre-commit `YAML` file in `.pre-commit-config.YAML`.
@@ -114,7 +114,7 @@ For containerization:
114114

115115
For the team development environment:
116116
* A pre-commit hooks for `Black`, `Isort`, and `MyPy` to ensure the conventional commit message before pushing an updated code into the remote repository in `.pre-commit-config.YAML`.
117-
* All secret variables are listed in `.env.example`. You need to copy these variables and set the values respectively to yoour need and save them in a new `.env` in the the root directory.
117+
* All secret variables are listed in `.env.example`. You need to copy these variables and set the values respectively to your need and save them in a new `.env` in the root directory.
118118

119119
## Setup Guide
120120

@@ -156,9 +156,9 @@ This backend application is setup with `Docker`. Nevertheless, you can see the f
156156
```
157157

158158
5. Backend app credentials setup:
159-
If you are not used to VIM or Linux CLI, then ignore the `echo` command and do it manually. All the secret variables for this template is located in `.env.example`.
159+
If you are not used to VIM or Linux CLI, then ignore the `echo` command and do it manually. All the secret variables for this template are located in `.env.example`.
160160

161-
If you want to have another names for the secret variables, don't forget to change them also in:
161+
If you want to have another name for the secret variables, don't forget to change them also in:
162162
163163
* `backend/src/config/base.py`
164164
* `docker-compose.yaml`
@@ -171,7 +171,7 @@ This backend application is setup with `Docker`. Nevertheless, you can see the f
171171
```
172172
173173
6. `CODEOWNERS` setup:
174-
Go to `.github/` and open `CODEOWNERS` file. This file is to assign the code to specific team member so you can distribute the weights of the project clearly.
174+
Go to `.github/` and open `CODEOWNERS` file. This file is to assign the code to a specific team member so you can distribute the weights of the project clearly.
175175
176176
7. Docker setup:
177177
```shell
@@ -281,7 +281,7 @@ backend/
281281
├── unit_tests/ # Unit tests
282282
├── test_src.py # Testing the src directory's version
283283
├── conftest.py # The fixture codes and other base test codes
284-
├── Dockerfile # Docker cpnfiguration file for backend application
284+
├── Dockerfile # Docker configuration file for backend application
285285
├── README.md # Documentation for backend app
286286
├── entrypoint.sh # A script to restart backend app container if postgres is not started
287287
├── alembic.ini # Automatic database migration configuration

0 commit comments

Comments
 (0)