Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Link the docs to the website #43

Merged
merged 3 commits into from
Jul 15, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
21 changes: 7 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
<p align="center">
<a href="http://gacela-project.com/" title="Gacela Website">
<img src="docs/imgs/gacela-logo-blue.svg" width="350" alt="Gacela logo"/>
</a>
<img src="gacela-logo.svg" width="350" alt="Gacela logo"/>
</p>

<p align="center">
Expand Down Expand Up @@ -33,25 +31,20 @@ scalability. It will certainly encourage your modules to interact with each othe
rules:

- Different modules can interact **only** via their `Facade`.
- The `Facade` has access to the `Factory`.
- The `Factory` creates the objects from the module and has access to the Module's `Config`.
- The `Config` gets the values from your defined config files.
- The `DependencyProvider` uses the Locator to get the Facades from different modules.
- The [`Facade`](https://gacela-project.com/docs/facade/) has access to the `Factory`.
- The [`Factory`](https://gacela-project.com/docs/factory/) creates the objects from the module and has access to the Module's `Config`.
- The [`Config`](https://gacela-project.com/docs/config/) gets the values from your defined config files.
- The [`DependencyProvider`](https://gacela-project.com/docs/dependency-provider/) uses the Locator to get the Facades from different modules.

### Installation

```bash
composer require gacela-project/gacela
```

## Documentation
### Documentation

- [Basic concepts](docs/001_basic_concepts.md): What are the characteristics of a module?
- [Facade](docs/002_facade.md): The entry point of your module
- [Factory](docs/003_factory.md): The place where you create your domain services and objects
- [Config](docs/004_config.md): Reads the values defined in your config path
- [DependencyProvider](docs/005_dependency_provider.md): It defines the dependencies between modules
- [Code generator](docs/006_code_generator.md): Some commands out-of-the-box for generating code
You can check the full documentation in the official [website](https://gacela-project.com/).

### Examples

Expand Down
43 changes: 0 additions & 43 deletions docs/001_basic_concepts.md

This file was deleted.

41 changes: 0 additions & 41 deletions docs/002_facade.md

This file was deleted.

40 changes: 0 additions & 40 deletions docs/003_factory.md

This file was deleted.

119 changes: 0 additions & 119 deletions docs/004_config.md

This file was deleted.

48 changes: 0 additions & 48 deletions docs/005_dependency_provider.md

This file was deleted.

15 changes: 0 additions & 15 deletions docs/006_code_generator.md

This file was deleted.

14 changes: 0 additions & 14 deletions docs/README.md

This file was deleted.

File renamed without changes