Merge pull request #515 from andrechristikan/development

fix: update package version, delete unrelated docs, fix email templat…

README.md

@@ -38,7 +38,7 @@
     - [Others](#others)
   - [Third Party Integration](#third-party-integration)
   - [Installation](#installation)
-  - [API Spec](#api-spec)
+  - [Swagger](#swagger)
   - [License](#license)
   - [Contribute](#contribute)
   - [Contact](#contact)
@@ -47,6 +47,7 @@
 
 > Very limited documentation
 
+* There have been some breaking changes between v5 and v6.
 * The features will be relate with AWS / Amazon web service
 * Stateless Authorization
 * Must run MongoDB as a `replication set` for `database transactions`.
@@ -61,7 +62,7 @@
 ## Todo
 
 * [x] Refactor to version 6, more straightforward
-* [ ] Add message remaining
+* [x] Add message remaining
 * [ ] Refactor unit test
 * [ ] Update Documentation, add behaviors
 * [ ] Update Documentation, and include an diagram for easier comprehension
@@ -176,10 +177,9 @@ Describes which version.
 
 Installation will describe in difference doc. [here][doc-installation].
 
-## API Spec
+## Swagger
 
-You can check The API Spec after running this project. Url `localhost:3000/docs`.
-`x-api-key` is `v8VB0yY887lMpTA2VJMV:zeZbtGTugBTn3Qd5UXtSZBwt7gn3bg`
+You can check The Swagger after running this project. Url `localhost:3000/docs` and don't for get to put `x-api-key` on header.
 
 ## License
 
@@ -225,7 +225,7 @@ If your code behind commit with the original / main / master branch, please upda
 
 <!-- CONTACTS -->
 [author-linkedin]: https://linkedin.com/in/andrechristikan
-[author-email]: mailto:[email protected]
+[author-email]: mailto:[email protected]
 [author-github]: https://github.com/andrechristikan
 
 <!-- Repo LINKS -->
@@ -234,11 +234,6 @@ If your code behind commit with the original / main / master branch, please upda
 [ack-forks]: https://github.com/andrechristikan/ack-nestjs-boilerplate/network/members
 [ack-contributors]: https://github.com/andrechristikan/ack-nestjs-boilerplate/graphs/contributors
 
-<!-- Other Repo Links -->
-[ack]: https://github.com/andrechristikan/ack-nestjs-boilerplate
-[ack-typeorm]: https://github.com/andrechristikan/nestjs-boilerplate-typeorm
-[ack-kafka]: https://github.com/andrechristikan/ack-nestjs-boilerplate-kafka
-
 <!-- license -->
 [license]: LICENSE.md
 

docs/README.md

@@ -1,13 +1,92 @@
-# Documentation
+# Installation
 
-Documentation of ack-nestjs-boilerplate
+## Getting Started
 
-## Installation
+Before start, we need to install some packages and tools.
+The recommended version is the LTS version for every tool and package.
 
-Installation will describe in difference doc. [here][doc-installation].
+> Make sure to check that the tools have been installed successfully.
 
-## API Spec
+1. [NodeJs][ref-nodejs]
+2. [MongoDB][ref-mongodb]
+3. [Yarn][ref-yarn]
+4. [Git][ref-git]
 
-You can check The API Spec after running this project. Url `localhost:3000/docs`.
+### Clone Repo
 
-[doc-installation]: /docs/installation.md
+Clone the project with git.
+
+```bash
+git clone https://github.com/andrechristikan/ack-nestjs-boilerplate.git
+```
+
+### Install Dependencies
+
+This project needs some dependencies. Let's go install it.
+
+```bash
+yarn install
+```
+
+### Create environment
+
+Make your own environment file with a copy of `env.example` and adjust values to suit your own environment.
+
+```bash
+cp .env.example .env
+```
+
+### Test
+
+> Next development will add e2e test
+
+The project only provide `unit testing`.
+
+```bash
+yarn test
+```
+
+## Run Project
+
+Finally, Cheers 🍻🍻 !!! you passed all steps.
+
+Now you can run the project.
+
+```bash
+yarn start:dev
+```
+
+## Run Project with Docker
+
+For docker installation, we need more tools to be installed.
+
+1. [Docker][ref-docker]
+2. [Docker-Compose][ref-dockercompose]
+
+### Create environment
+
+Make your own environment file with a copy of `env.example` and adjust values to suit your own environment.
+
+```bash
+cp .env.example .env
+```
+
+then run
+
+```bash
+docker-compose up -d
+```
+
+## Database Migration
+
+This project need to do migration for running. [Read this][ack-database-migration-doc]
+
+
+[ack-database-migration-doc]: /docs/database_migration.md
+
+<!-- Reference -->
+[ref-mongodb]: https://docs.mongodb.com/
+[ref-nodejs]: https://nodejs.org/
+[ref-docker]: https://docs.docker.com
+[ref-dockercompose]: https://docs.docker.com/compose/
+[ref-git]: https://git-scm.com

docs/database/database_migration.md → docs/database_migration.md

@@ -18,8 +18,8 @@ yarn rollback
 ```
 
 # API Key Test
-api key: `2ihKDneb9jQGgidAOqfO`
-api key secret: `ZLCtDd2rh3TAyVhfAeo3JOPvWfAsTp0Oq6rHl69D`
+api key: `v8VB0yY887lMpTA2VJMV`
+api key secret: `zeZbtGTugBTn3Qd5UXtSZBwt7gn3bg`
 
 # User Test
 
@@ -37,16 +37,4 @@ api key secret: `ZLCtDd2rh3TAyVhfAeo3JOPvWfAsTp0Oq6rHl69D`
    - password: `aaAA@123`
 
 <!-- Reference -->
-[ref-nestjs]: http://nestjs.com
-[ref-mongoose]: https://mongoosejs.com
-[ref-mongodb]: https://docs.mongodb.com/
-[ref-nodejs]: https://nodejs.org/
-[ref-typescript]: https://www.typescriptlang.org/
-[ref-docker]: https://docs.docker.com
-[ref-dockercompose]: https://docs.docker.com/compose/
-[ref-yarn]: https://yarnpkg.com
-[ref-12factor]: https://12factor.net
 [ref-nestjscommand]: https://gitlab.com/aa900031/nestjs-command
-[ref-jwt]: https://jwt.io
-[ref-jest]: https://jestjs.io/docs/getting-started
-[ref-git]: https://git-scm.com