-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[#20] Extract the project architecture from the Contributing guidelin…
…e page
- Loading branch information
Showing
5 changed files
with
61 additions
and
55 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
This project uses TypeScript and [OCLIF](https://oclif.io/) to build the CLI, Jest for testing, and ESLint for code formatting and linting. | ||
|
||
### Dependencies and Prerequisites | ||
|
||
- [Node.js](https://nodejs.org/en/download/) 12.x or higher - 18.x LTS is recommended | ||
- NPM is preferred to use with this project | ||
|
||
### Project structure | ||
|
||
The project has the following main files and folders: | ||
|
||
```bash | ||
├── bin # the executable file for the CLI | ||
│ ├── dev # the executable file for the CLI in development mode | ||
│ └── run # the executable file for the CLI in production mode | ||
├── skeleton # the skeleton files for the project | ||
│ ├── addons # the skeleton files for common addons e.g. version control, CI/CD, etc. | ||
│ │ ├── aws # the skeleton files for AWS modules | ||
│ │ └── versionControl # the skeleton files for version control | ||
│ └── core # the skeleton folders | ||
│ ├── base # the skeleton files for the base folder | ||
│ └── shared # the skeleton files for the shared folder | ||
├── src # the source code of the CLI | ||
│ ├── commands # the commands of the CLI | ||
│ │ ├── generate | ||
│ │ └── installAddon | ||
│ ├── helpers # the helper functions of the CLI | ||
│ │ ├── childProcess.ts | ||
│ │ ├── file.ts | ||
│ │ └── terraform.ts | ||
│ ├── hooks # the hooks of the CLI | ||
│ │ └── postProcess.ts | ||
│ ├── index.ts # the entry point of the CLI | ||
│ └── templates # the code to generate the templates | ||
│ ├── addons # the code to generate the common addons e.g. version control, CI/CD, AWS, etc. | ||
│ └── core # the code to generate the main Terraform files e.g. `main.tf`, `variables.tf`, etc. | ||
└── test # the test helpers and configurations | ||
└── matchers # the custom matchers for Jest | ||
├── file.ts | ||
├── index.d.ts | ||
└── index.ts | ||
``` | ||
|
||
> [!NOTE]\ | ||
> The `skeleton` folder and the `templates` folder are the two main folders that are used to generate the project files | ||
- The `skeleton` folder contains the addon's files and folders ready to be directly copy-pasted into the generated project if the related addon has been selected. These files serve as a starting point or "skeleton" for the specific addon. | ||
|
||
- On the other hand, the `templates` folder houses the logic for determining which files need to be copied from the templates folder into the core project files. It includes instructions on what files should be formed based on the type of addon/module being added (common addons, AWS modules, or standard files). | ||
|
||
In summary, while the `skeleton` folder provides the files and folders needed for the addon, the `templates` folder handles the dynamic copying and integration of those files within the core project structure. |
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
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,5 +1,10 @@ | ||
## Table of Contents | ||
|
||
- [[Home]] | ||
- [[Getting-Started]] | ||
- [[Contributing|Contributing-guidelines]] | ||
- [[Getting Started]] | ||
|
||
## Architecture | ||
- [[Architecture Overview]] | ||
|
||
## Contributing | ||
- [[Contributing guidelines]] |
File renamed without changes