Skip to content

Commit 2b8eef1

Browse files
authored
Merge pull request #105 from talyssonoc/revert-100-update-docs-to-use-docker-compose-commands
Revert "Update docs to use docker compose commands"
2 parents 62999f0 + 4abd2da commit 2b8eef1

File tree

8 files changed

+4
-86
lines changed

8 files changed

+4
-86
lines changed

.gitignore

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,5 @@ dist/
33
.index/
44
*.log
55
.idea/
6-
coverage/
7-
.vscode/*
8-
!.vscode/launch.json
6+
.vscode/
7+
coverage/

.vscode/launch.json

Lines changed: 0 additions & 29 deletions
This file was deleted.

README.md

Lines changed: 1 addition & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -10,29 +10,10 @@ This version of the boilerplate is still in beta, so might contain abstractions
1010

1111
## How to run the server
1212

13-
### Requisites
14-
* To run the project wit Docker you need to have Docker installed in your computer: [Docker](https://docs.docker.com/engine/install/)
15-
* To run locally you need to have project dependencies installed globally in your machine
16-
1713
During development, the project can be run in two different ways.
1814

19-
### With Docker
20-
2115
If you want to just run the application in development mode, use the following command:
2216

23-
```sh
24-
$ docker compose up
25-
```
26-
27-
To run the application in debug mode in a way that the execution will stop when a debugger statement is called, use:
28-
29-
```sh
30-
$ docker-compose -f docker-compose.yaml -f docker-compose.debug.yaml up
31-
```
32-
33-
### Locally
34-
35-
If you want to just run the application in development mode, use the following command:
3617
```sh
3718
$ yarn dev
3819
```
@@ -63,19 +44,9 @@ $ yarn remote [server address] [REPL port]
6344

6445
## Tests
6546

66-
The boilerplate is prepared to run tests using Jest. We usually group the tests in folders called `__tests__` (following Jest convention) for each module of the application. To run the tests use the following commands:
47+
The boilerplate is prepared to run tests using Jest. We usually group the tests in folders called `__tests__` (following Jest convention) for each module of the application. To run the tests use the following command:
6748

68-
### With Docker
6949
```sh
70-
$ docker compose up
71-
72-
$ yarn test
73-
```
74-
75-
### Locally
76-
```sh
77-
$ yarn dev
78-
7950
$ yarn test
8051
```
8152

@@ -110,17 +81,6 @@ This boilerplate follows ideas from multiple good software development practices
11081

11182
To run your app in production mode, you'll need to follow these steps:
11283

113-
### With Docker
114-
115-
1. Define any environment variable important for production
116-
2. Go to `docker-compose.production.yaml` file, and add necessary configurations
117-
3. Run the following command:
118-
```sh
119-
$ docker-compose -f docker-compose.yaml -f docker-compose.production.yaml up
120-
```
121-
122-
### Locally
123-
12484
1. Build the application with `yarn build`
12585
2. Define any environment variable important for production
12686
3. Start the app with `yarn start`

docker-compose.debug.yaml

Lines changed: 0 additions & 6 deletions
This file was deleted.

docker-compose.production.yaml

Lines changed: 0 additions & 3 deletions
This file was deleted.

docker-compose.yaml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@ services:
1212
- .:/api
1313
ports:
1414
- 3000:3000
15-
- 2580:2580
1615
environment:
1716
HOST: 0.0.0.0
1817
DB_HOST: mongodb://node-api-boilerplate-mongodb:27017

package.json

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,10 +58,9 @@
5858
},
5959
"scripts": {
6060
"prebuild": "rimraf dist",
61-
"start": "node . --transpile-only --files .| pino-pretty -c -l",
6261
"build": "tsc -p tsconfig.prod.json",
6362
"dev": "tsnd --transpile-only --files src/index.ts | pino-pretty -c -l",
64-
"debug": "tsnd --transpile-only --inspect=0.0.0.0:9229 --nolazy --files src/index.ts | pino-pretty -c -l",
63+
"debug": "tsnd --transpile-only --inspect --files src/index.ts | pino-pretty -c -l",
6564
"cli": "tsnd --transpile-only --files src/index.ts --cli",
6665
"remote": "ts-node bin/replClient.ts",
6766
"test": "jest"

tsconfig.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@
88
"outDir": "./dist",
99
"rootDir": "./src",
1010
"removeComments": false,
11-
"inlineSourceMap": true,
1211
"strict": true,
1312
"noImplicitAny": false,
1413
"noUnusedLocals": true,

0 commit comments

Comments
 (0)