You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
It should local configuration related to setup on local machine.
7
+
- .build/REMOVE_ME.md:
8
+
content: |
9
+
# .build Folder
10
+
11
+
This folder should contain all scripts related to build process (PowerShell, Docker compose…).
12
+
- .dockerignore:
13
+
content: |
14
+
node_modules
15
+
npm-debug.log
16
+
- .editorconfig:
17
+
content: |
18
+
# Editor configuration
19
+
root = true
5
20
6
-
This is a generic app that can be used as a starting point for new projects.
21
+
[*]
22
+
indent_style = space
23
+
indent_size = 2
24
+
end_of_line = lf
25
+
charset = utf-8
26
+
trim_trailing_whitespace = true
27
+
insert_final_newline = true
28
+
- .env:
29
+
content: |
30
+
# Environment variables
31
+
NODE_ENV=development
32
+
PORT=3000
33
+
- .env.example:
34
+
content: |
35
+
# Environment variables
36
+
NODE_ENV=development
37
+
PORT=3000
38
+
- .gitattributes:
39
+
content: |
40
+
# Auto detect text files and perform LF normalization
41
+
* text=auto
7
42
- .gitignore:
8
43
content: |
9
44
# Ignore files generated by the app
10
45
/node_modules
11
46
/dist
12
-
- .tf/states/environments/dev/main.tf:
13
-
content: "# Terraform configuration for the dev environment"
14
-
- .tf/states/environments/dev/providers.tf:
47
+
- .gitkeep:
48
+
content: ""
49
+
- .gitmodules:
15
50
content: |
16
-
provider "aws" {
17
-
region = "${ aws_region }"
18
-
}
19
-
- .tf/states/environments/prod/main.tf:
20
-
content: "# Terraform configuration for the prod environment"
21
-
- .tf/states/environments/prod/providers.tf:
51
+
# This file defines the submodules used by the repository
52
+
# See https://git-scm.com/docs/gitmodules
53
+
54
+
# Submodule for the app
55
+
[submodule "app"]
56
+
path = app
57
+
url =
58
+
- .github/CODEOWNERS:
22
59
content: |
23
-
provider "aws" {
24
-
region = "${ aws_region }"
25
-
}
26
-
- .tf/states/environments/stage/main.tf:
27
-
content: "# Terraform configuration for the stage environment"
28
-
- .tf/states/environments/stage/providers.tf:
60
+
# This file defines the code owners for the repository
61
+
# See https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/about-code-owners
62
+
63
+
# The owners of the repository
64
+
* @app-owner
65
+
.tf/* @devops-team
66
+
.github/* @devops-team
67
+
CODEOWNERS @devops-team
68
+
- .github/CODE_OF_CONDUCT.md:
29
69
content: |
30
-
provider "aws" {
31
-
region = "${ aws_region }"
32
-
}
33
-
- .tf/states/environments/qa/main.tf:
34
-
content: "# Terraform configuration for the qa environment"
35
-
- .tf/states/environments/qa/providers.tf:
70
+
# Code of Conduct
71
+
72
+
This project has adopted the [Contributor Covenant](https://www.contributor-covenant.org/), which is a code of conduct for open source projects. Please read the [full text](https://www.contributor-covenant.org/version/2/0/code_of_conduct/) so that you can understand what actions will and will not be tolerated.
73
+
- .github/CONTRIBUTING.md:
36
74
content: |
37
-
provider "aws" {
38
-
region = "${ aws_region }"
39
-
}
40
-
- .tf/states/init/main.tf:
41
-
content: "# Terraform configuration for the init environment"
42
-
- .tf/states/init/providers.tf:
75
+
# Contributing
76
+
77
+
If you would like to contribute to this project, please follow the guidelines below.
78
+
79
+
## Issues
80
+
81
+
- If you find a bug in the project, please open an issue on the [Issues](
If you discover a security vulnerability within this project, please report it to the app owner at <email>. All security vulnerabilities will be promptly addressed.
This is a generic app that can be used as a template for new projects.
248
+
249
+
## Contribute
250
+
251
+
If you would like to contribute to this project, please follow the guidelines in the [CONTRIBUTING.md](.github/CONTRIBUTING.md) file.
252
+
253
+
## License
254
+
255
+
This project is licensed under the terms of the [Apache 2.0](LICENSE) license.
256
+
- dep/REMOVE_ME.md:
257
+
content: |
258
+
# dep Folder
259
+
260
+
This is the directory where all your dependencies should be stored.
131
261
- docker-compose.yml:
132
262
content: |
133
263
version: '3'
@@ -142,13 +272,33 @@ structure:
142
272
- .:/app
143
273
environment:
144
274
- NODE_ENV=development
145
-
- .env.example:
275
+
- doc/REMOVE_ME.md:
146
276
content: |
147
-
# Environment variables
148
-
NODE_ENV=development
149
-
PORT=3000
150
-
- .env:
277
+
# doc Folder
278
+
279
+
The documentation folder
280
+
- res/REMOVE_ME.md:
151
281
content: |
152
-
# Environment variables
153
-
NODE_ENV=development
154
-
PORT=3000
282
+
# res Folder
283
+
284
+
For all static resources in your project. For example, images.
285
+
- samples/REMOVE_ME.md:
286
+
content: |
287
+
# samples Folder
288
+
289
+
Providing “Hello World” & Co code that supports the documentation.
290
+
- src/REMOVE_ME.md:
291
+
content: |
292
+
# src Folder
293
+
294
+
The source code folder! However, in languages that use headers (or if you have a framework for your application) don’t put those files in here.
295
+
- test/REMOVE_ME.md:
296
+
content: |
297
+
# test Folder
298
+
299
+
Unit tests, integration tests… go here.
300
+
- tools/REMOVE_ME.md:
301
+
content: |
302
+
# tools Folder
303
+
304
+
Convenience directory for your use. Should contain scripts to automate tasks in the project, for example, build scripts, rename scripts. Usually contains .sh, .cmd files for example.
0 commit comments