-
Notifications
You must be signed in to change notification settings - Fork 180
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #515 from andrechristikan/development
fix: update package version, delete unrelated docs, fix email templat…
- Loading branch information
Showing
24 changed files
with
741 additions
and
2,479 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.