d3t-distribution/project-dependencies

There is no license information available for the latest version (v0.0.2) of this package.

v0.0.2 2021-12-03 16:59 UTC

Unknown License

• Hugo Duporge

README

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Roadmap
4. Contributing
5. License
6. Contact
7. Acknowledgments

About The Project

This project allows to easily manage dependencies between projects.

(back to top)

Built With

• PHP
• Docker
• Make

(back to top)

Getting Started

Prerequisites

On your machine you must have :

• Make
• Docker

Installation

Create a .dependencies file that must be in JSON format.
Here is an example of a file with a dependency.

{
  "my-project-name": {
    "path": "my-project-path",
    "repository": "[e-mail]:my-project.git"
  }
}

path must be relative to the parent directory.
repository git repository url.

Then edit your project make to add the following lines :

DEPENDENCIES=
CMD_start = docker run -ti --rm -v $(PWD)/../:/mnt/projects/ -e PROJECTNAME=my-project-name -e COMMAND=start -e DEPENDENCIES=${DEPENDENCIES} d3tdistribution/projet-dependencies

start: env
	$(shell ${CMD_start})

PROJECTNAME is the name of the project.
COMMAND is the command to execute for the dependent projets.
DEPENDENCIES is the list of dependent projects already started in order to avoid project circular dependencies.

Roadmap

• Clone dependencies repositories
• Change dependencies.json to .dependencies file
• Support .dependencies.local file
• Support absolute path

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)