https://github.com/osmanjimenez/custom-cli-schematics-utils
generador de schematics para la implementación de la arquitectura clean code en angular
https://github.com/osmanjimenez/custom-cli-schematics-utils
angular-cli custom-schematics typescript
Last synced: 3 days ago
JSON representation
generador de schematics para la implementación de la arquitectura clean code en angular
- Host: GitHub
- URL: https://github.com/osmanjimenez/custom-cli-schematics-utils
- Owner: OsmanJimenez
- Created: 2024-03-24T19:14:17.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-15T13:41:36.000Z (over 1 year ago)
- Last Synced: 2025-01-27T12:11:24.591Z (about 1 year ago)
- Topics: angular-cli, custom-schematics, typescript
- Language: TypeScript
- Homepage:
- Size: 65.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
CUSTOM-CLI-SCHEMATICS-UTILS
Developed with the software and tools below.
## 🔗 Quick Links
> - [📍 Overview](#-overview)
> - [📦 Features](#-features)
> - [📂 Repository Structure](#-repository-structure)
> - [🧩 Modules](#-modules)
> - [🚀 Getting Started](#-getting-started)
> - [⚙️ Installation](#️-installation)
> - [🤖 Running custom-cli-schematics-utils](#-running-custom-cli-schematics-utils)
> - [🧪 Tests](#-tests)
> - [🛠 Project Roadmap](#-project-roadmap)
> - [🤝 Contributing](#-contributing)
> - [📄 License](#-license)
> - [👏 Acknowledgments](#-acknowledgments)
---
## 📍 Overview
`overview`
---
## 📦 Features
`features`
---
## 📂 Repository Structure
```sh
└── custom-cli-schematics-utils/
├── README.md
├── package-lock.json
├── package.json
├── src
│ ├── architecture-clean-code
│ │ ├── files
│ │ │ ├── base
│ │ │ │ └── mapper.ts
│ │ │ ├── data
│ │ │ │ ├── data.module.ts
│ │ │ │ └── repositories
│ │ │ ├── domain
│ │ │ │ ├── base
│ │ │ │ ├── models
│ │ │ │ ├── repositories
│ │ │ │ └── usecases
│ │ │ └── presentation
│ │ │ └── __name@dasherize__
│ │ ├── index.ts
│ │ └── schema.json
│ ├── collection.json
│ └── custom-cli-schematics-utils
│ ├── index.ts
│ └── index_spec.ts
└── tsconfig.json
```
---
## 🧩 Modules
.
| File | Summary |
| --- | --- |
| [tsconfig.json](https://github.com/OsmanJimenez/custom-cli-schematics-utils/blob/master/tsconfig.json) | `tsconfig.json` |
| [package.json](https://github.com/OsmanJimenez/custom-cli-schematics-utils/blob/master/package.json) | `package.json` |
| [package-lock.json](https://github.com/OsmanJimenez/custom-cli-schematics-utils/blob/master/package-lock.json) | `package-lock.json` |
src
| File | Summary |
| --- | --- |
| [collection.json](https://github.com/OsmanJimenez/custom-cli-schematics-utils/blob/master/src/collection.json) | `src/collection.json` |
src.custom-cli-schematics-utils
| File | Summary |
| --- | --- |
| [index.ts](https://github.com/OsmanJimenez/custom-cli-schematics-utils/blob/master/src/custom-cli-schematics-utils/index.ts) | `src/custom-cli-schematics-utils/index.ts` |
| [index_spec.ts](https://github.com/OsmanJimenez/custom-cli-schematics-utils/blob/master/src/custom-cli-schematics-utils/index_spec.ts) | `src/custom-cli-schematics-utils/index_spec.ts` |
src.architecture-clean-code
| File | Summary |
| --- | --- |
| [schema.json](https://github.com/OsmanJimenez/custom-cli-schematics-utils/blob/master/src/architecture-clean-code/schema.json) | `src/architecture-clean-code/schema.json` |
| [index.ts](https://github.com/OsmanJimenez/custom-cli-schematics-utils/blob/master/src/architecture-clean-code/index.ts) | `src/architecture-clean-code/index.ts` |
src.architecture-clean-code.files.presentation.__name@dasherize__
| File | Summary |
| --- | --- |
| [__name@dasherize__.page.scss](https://github.com/OsmanJimenez/custom-cli-schematics-utils/blob/master/src/architecture-clean-code/files/presentation/__name@dasherize__/__name@dasherize__.page.scss) | `src/architecture-clean-code/files/presentation/__name@dasherize__/__name@dasherize__.page.scss` |
| [__name@dasherize__.page.html](https://github.com/OsmanJimenez/custom-cli-schematics-utils/blob/master/src/architecture-clean-code/files/presentation/__name@dasherize__/__name@dasherize__.page.html) | `src/architecture-clean-code/files/presentation/__name@dasherize__/__name@dasherize__.page.html` |
| [__name@dasherize__.page.spec.ts](https://github.com/OsmanJimenez/custom-cli-schematics-utils/blob/master/src/architecture-clean-code/files/presentation/__name@dasherize__/__name@dasherize__.page.spec.ts) | `src/architecture-clean-code/files/presentation/__name@dasherize__/__name@dasherize__.page.spec.ts` |
| [__name@dasherize__.page.ts](https://github.com/OsmanJimenez/custom-cli-schematics-utils/blob/master/src/architecture-clean-code/files/presentation/__name@dasherize__/__name@dasherize__.page.ts) | `src/architecture-clean-code/files/presentation/__name@dasherize__/__name@dasherize__.page.ts` |
src.architecture-clean-code.files.base
| File | Summary |
| --- | --- |
| [mapper.ts](https://github.com/OsmanJimenez/custom-cli-schematics-utils/blob/master/src/architecture-clean-code/files/base/mapper.ts) | `src/architecture-clean-code/files/base/mapper.ts` |
src.architecture-clean-code.files.domain.repositories
| File | Summary |
| --- | --- |
| [__name@dasherize__.repository.ts](https://github.com/OsmanJimenez/custom-cli-schematics-utils/blob/master/src/architecture-clean-code/files/domain/repositories/__name@dasherize__.repository.ts) | `src/architecture-clean-code/files/domain/repositories/__name@dasherize__.repository.ts` |
src.architecture-clean-code.files.domain.base
| File | Summary |
| --- | --- |
| [use-case.ts](https://github.com/OsmanJimenez/custom-cli-schematics-utils/blob/master/src/architecture-clean-code/files/domain/base/use-case.ts) | `src/architecture-clean-code/files/domain/base/use-case.ts` |
src.architecture-clean-code.files.domain.models
| File | Summary |
| --- | --- |
| [__name@dasherize__.model.ts](https://github.com/OsmanJimenez/custom-cli-schematics-utils/blob/master/src/architecture-clean-code/files/domain/models/__name@dasherize__.model.ts) | `src/architecture-clean-code/files/domain/models/__name@dasherize__.model.ts` |
src.architecture-clean-code.files.domain.usecases
| File | Summary |
| --- | --- |
| [__name@dasherize__.usecase.ts](https://github.com/OsmanJimenez/custom-cli-schematics-utils/blob/master/src/architecture-clean-code/files/domain/usecases/__name@dasherize__.usecase.ts) | `src/architecture-clean-code/files/domain/usecases/__name@dasherize__.usecase.ts` |
---
## 🚀 Getting Started
*__Requirements__*
Ensure you have the following dependencies installed on your system:
- __TypeScript__: `version x.y.z`
### ⚙️ Installation
1. Clone the custom-cli-schematics-utils repository:
```sh
git clone https://github.com/OsmanJimenez/custom-cli-schematics-utils
```
2. Change to the project directory:
```sh
cd custom-cli-schematics-utils
```
3. Install the dependencies:
```sh
npm install
```
### 🤖 Running custom-cli-schematics-utils
Use the following command to run custom-cli-schematics-utils:
```sh
npm run build && node dist/main.js
```
### 🧪 Tests
To execute tests, run:
```sh
npm test
```
---
## 🛠 Project Roadmap
- [X] `► INSERT-TASK-1`
- [ ] `► INSERT-TASK-2`
- [ ] `► ...`
---
## 🤝 Contributing
Contributions are welcome! Here are several ways you can contribute:
- __[Submit Pull Requests](https://github.com/OsmanJimenez/custom-cli-schematics-utils/blob/main/CONTRIBUTING.md)__: Review open PRs, and submit your own PRs.
- __[Join the Discussions](https://github.com/OsmanJimenez/custom-cli-schematics-utils/discussions)__: Share your insights, provide feedback, or ask questions.
- __[Report Issues](https://github.com/OsmanJimenez/custom-cli-schematics-utils/issues)__: Submit bugs found or log feature requests for Custom-cli-schematics-utils.
Contributing Guidelines
1. __Fork the Repository__: Start by forking the project repository to your GitHub account.
2. __Clone Locally__: Clone the forked repository to your local machine using a Git client.
```sh
git clone https://github.com/OsmanJimenez/custom-cli-schematics-utils
```
3. __Create a New Branch__: Always work on a new branch, giving it a descriptive name.
```sh
git checkout -b new-feature-x
```
4. __Make Your Changes__: Develop and test your changes locally.
5. __Commit Your Changes__: Commit with a clear message describing your updates.
```sh
git commit -m 'Implemented new feature x.'
```
6. __Push to GitHub__: Push the changes to your forked repository.
```sh
git push origin new-feature-x
```
7. __Submit a Pull Request__: Create a PR against the original project repository. Clearly describe the changes and their motivations.
Once your PR is reviewed and approved, it will be merged into the main branch.
---
## 📄 License
This project is protected under the [SELECT-A-LICENSE](https://choosealicense.com/licenses) License. For more details, refer to the [LICENSE](https://choosealicense.com/licenses/) file.
---
## 👏 Acknowledgments
- List any resources, contributors, inspiration, etc. here.
[__Return__](#-quick-links)
---
## 👤 Autor
**Osman Armando Jiménez Cortés**
[Portafolio profesional](https://osmanjimenez.com/)
[Perfil de GitHub](https://github.com/OsmanJimenez)
Ingeniero de Sistemas y Desarrollador Full Stack especializado en desarrollo web y aplicaciones móviles.