|
1 | 1 | # DevNet Framework |
2 | | -This dependency is the main repository of **DevNet Framework**, and it includes the following packages: |
3 | | -- [devnet/core](https://github.com/DevNet-Framework/core) a runtime and base class library that is essential for all DevNet applications and packages. |
4 | | -- [devnet/cli](https://github.com/DevNet-Framework/cli) a command-line interface tool, for creating console applications and managing DevNet projects. |
5 | | -- [devnet/web](https://github.com/DevNet-Framework/web) a collection of web components that helps to create modern web applications and web APIs. |
6 | | -- [devnet/entity](https://github.com/DevNet-Framework/entity) an object-relational mapping system that helps to manipulate databases in an object-oriented way. |
| 2 | +This dependency is a meta-package that will install all the libraries of **DevNet Framework** |
7 | 3 |
|
8 | 4 | ## Requirements |
9 | 5 | - [PHP](https://www.php.net/) version 8.1 or higher |
10 | 6 | - [Composer](https://getcomposer.org/) version 2.0 or higher |
11 | 7 |
|
12 | | -## Installation |
13 | | -You can install DevNet Framework in your project, by running the following command in the terminal: |
14 | | - |
15 | | -```bash |
16 | | -composer require devnet/framework |
17 | | -``` |
| 8 | +>**Note:** If you are using composer on a Linux operating system, please make sure that you have added the path "composer/vendor/bin" to the system environment variables in the ".bashrc" file as follows: |
| 9 | +>`echo 'export PATH="$PATH:$HOME/.config/composer/vendor/bin"' >> ~/.bashrc` |
18 | 10 |
|
19 | | -You can install DevNet Framework globally in your system, by run the following command in the terminal: |
| 11 | +## Installation |
| 12 | +You can install DevNet Framework globally in your system, by running the following command in the terminal: |
20 | 13 | ``` |
21 | 14 | composer global require devnet/framework |
22 | 15 | ``` |
23 | 16 |
|
24 | | ->**Note:** when you install composer in Linux operating system, please do not forget to add composer/vendor/bin into the system environment variables inside the file .bashrc like this: |
25 | | ->`echo 'export PATH="$PATH:$HOME/.config/composer/vendor/bin"' >> ~/.bashrc` |
| 17 | +Or, you can install DevNet Framework locally in your project, by running the following command: |
| 18 | +``` |
| 19 | +composer require devnet/framework |
| 20 | +``` |
26 | 21 |
|
27 | 22 | ## Documentation |
28 | 23 | Full documentation on how to use **DevNet Framework** is available at [devnet-framework.github.io](https://devnet-framework.github.io) |
|
0 commit comments