Skip to content

Commit 7d0798e

Browse files
authored
fix readme spelling mistakes
1 parent 731a3ad commit 7d0798e

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

README.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -15,16 +15,16 @@ This open-source project is for you(community). Our Team at [AfterAcademy](https
1515
The main focus will be to create a maintainable and highly testable architecture.
1616
<br>
1717
Following are the features of this project:
18-
* **This backend in written in Typescript**: The type safety at build time and having intellisense for it in the IDE like vscode is unparallel to productivity. We have found production bug reduced to significant amount, since most of the code vulnarabilties are identified during the build phase itself.
19-
* **Separation of concern principle is applied**: Each component has been given a particular role. The role of the components are mutually exclusive. This makes the project easy to be unit tested.
20-
* **Feature enpasulation is adopted**: The files or components those are related to a particular feature has been grouped together unless that components is required in multiple features. This enhances the ability to share code across projects.
21-
* **Centralised Error handling is done**: We have created a framework where all the errors are handled centrally. This reduces the ambiguity in the developement when the project grow larger.
22-
* **Centralised Response handling is done**: Similar to Error handling we have response handling framework. This makes it very convinient to apply a common API response pattern.
23-
* **Mongodb is used through Mongoose**: Mongodb really fits very well to the node.js application. Being nosql, fast, and scalable makes it ideal for the modern web applications.
24-
* **Async execution is adopted**: We have used async/await for the promises and made sure to use non blocking version of all the functions with few exceptions.
18+
* **This backend is written in Typescript**: The type safety at build time and having intellisense for it in the IDE like vscode is unparalleled to productivity. We have found production bug reduced to a significant amount since most of the code vulnerabilities are identified during the build phase itself.
19+
* **Separation of concern principle is applied**: Each component has been given a particular role. The role of the components is mutually exclusive. This makes the project easy to be unit tested.
20+
* **Feature encapsulation is adopted**: The files or components that are related to a particular feature have been grouped unless those components are required in multiple features. This enhances the ability to share code across projects.
21+
* **Centralised Error handling is done**: We have created a framework where all the errors are handled centrally. This reduces the ambiguity in the development when the project grows larger.
22+
* **Centralised Response handling is done**: Similar to Error handling we have a response handling framework. This makes it very convenient to apply a common API response pattern.
23+
* **Mongodb is used through Mongoose**: Mongodb fits very well to the node.js application. Being NoSQL, fast, and scalable makes it ideal for modern web applications.
24+
* **Async execution is adopted**: We have used async/await for the promises and made sure to use the non-blocking version of all the functions with few exceptions.
2525
* **Docker compose has been configured**: We have created the Dockerfile to provide the easy deployability without any setup and configurations.
26-
* **Unit test is favoured**: The tests has been written to test the functions and routes without the need of the database server. Integration tests has also been done but unit test is favoured.
27-
* **A pure backend project**: We have experienced that when a backend is developed clubed with a frontend then in the future it become really difficult to scale. We would want to create a separate backend project that servers many websites and mobile apps.
26+
* **Unit test is favored**: The tests have been written to test the functions and routes without the need of the database server. Integration tests has also been done but the unit test is favored.
27+
* **A pure backend project**: We have experienced that when a backend is developed clubbed with a frontend then in the future it becomes really difficult to scale. We would want to create a separate backend project that servers many websites and mobile apps.
2828

2929
## 3RE Architecture: Router, RouteHandler, ResponseHandler, ErrorHandler
3030
<p align="center">
@@ -55,7 +55,7 @@ Following are the features of this project:
5555

5656
## How to build and run this project
5757

58-
* Install using Docker Componse [**Recomended Method**]
58+
* Install using Docker Compose [**Recommended Method**]
5959
* Clone this repo.
6060
* Make a copy of **.env.example** file to **.env**.
6161
* Make a copy of **keys/private.pem.example** file to **keys/private.pem**.
@@ -67,17 +67,17 @@ Following are the features of this project:
6767
* *If having any issue* then make sure 3000 port is not occupied else provide a different port in **.env** file.
6868
* *If having any issue* then make sure 27017 port is not occupied else provide a different port in **.env** file.
6969
* Run The Tests
70-
* Install nodejs and npm on your local machine.
71-
* From the root of the project execute in terminal `npm install`.
72-
* *Use latest version of node on local machine if build fails*.
70+
* Install node.js and npm on your local machine.
71+
* From the root of the project executes in terminal `npm install`.
72+
* *Use the latest version of node on the local machine if the build fails*.
7373
* To run the tests execute `npm test`.
7474
* Install Without Docker [**2nd Method**]
75-
* Install mongodb on your local.
75+
* Install MongoDB on your local.
7676
* Do step 1 to 5 as listed for **Install using Docker Componse**.
7777
* Do step 1 to 3 as listed for **Run The Tests**.
78-
* Create users in mongodb and seed the data taking reference from the **addons/init-mongo.js**
78+
* Create users in MongoDB and seed the data taking reference from the **addons/init-mongo.js**
7979
* Change the `DB_HOST` to `localhost` in **.env** and **tests/.env.test** files.
80-
* Execute `npm start` and You will be able to access the api from http://localhost:3000
80+
* Execute `npm start` and You will be able to access the API from http://localhost:3000
8181
* To run the tests execute `npm test`.
8282

8383
## Explore Online Tutorials and Courses To Learn More by AfterAcademy

0 commit comments

Comments
 (0)