Merge pull request #6 from SpecLock/develop

Develop

Author: Jrgil20

README.md

@@ -0,0 +1,16 @@
+# ProjectFactory
+
+ProjectFactory is a Solidity-based project management system that allows the creation and management of projects with milestones. Each project can have multiple milestones, and the owner can add, complete, and approve these milestones.
+
+## Development
+
+The development of this project is planned and tracked in the testing branches. These branches contain the latest features and improvements under development.
+
+## Contracts
+
+- `Project`: Manages project milestones.
+- `ProjectFactory`: Creates and manages multiple projects.
+
+## Documentation
+
+For detailed API documentation, refer to the [ProjectFactory Documentation](docs/ProjectFactory.md).

contracts/projectfactory.sol

@@ -0,0 +1,132 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.4;
+
+/**
+ * @title Project
+ * @dev A contract to manage project milestones, allowing the owner to add, complete, and approve milestones.
+ */
+contract Project {
+    struct Milestone {
+        string title;
+        uint256 tentativeDate;
+        string description;
+        uint256 amount;
+        bool completed;
+    }
+
+    address public owner;
+    string public projectName;
+    string public projectDescription;
+    address payable public developerAddress;
+    uint256 public totalCapital;
+    Milestone[] public milestones;
+
+    event MilestoneAdded(uint256 indexed milestoneId, string title, uint256 amount);
+    event MilestoneCompleted(uint256 indexed milestoneId, string proof);
+    event MilestoneApproved(uint256 indexed milestoneId, uint256 amount);
+
+    modifier onlyOwner() {
+        require(msg.sender == owner, "Solo el owner puede ejecutar esta funcion");
+        _;
+    }
+
+    constructor(
+        string memory _projectName,
+        string memory _projectDescription,
+        address payable _developerAddress,
+        address _owner
+    ) {
+        owner = _owner;
+        projectName = _projectName;
+        projectDescription = _projectDescription;
+        developerAddress = _developerAddress;
+    }
+
+    function addMilestone(
+        string memory _title,
+        uint256 _tentativeDate,
+        string memory _description,
+        uint256 _amount
+    ) public onlyOwner {
+        milestones.push(Milestone({
+            title: _title,
+            tentativeDate: _tentativeDate,
+            description: _description,
+            amount: _amount,
+            completed: false
+        }));
+        emit MilestoneAdded(milestones.length - 1, _title, _amount);
+    }
+
+    function completeMilestone(uint256 _milestoneId, string memory _proof) public onlyOwner {
+        require(_milestoneId < milestones.length, "Milestone no existe");
+        milestones[_milestoneId].completed = true;
+        emit MilestoneCompleted(_milestoneId, _proof);
+    }
+
+    function approveMilestone(uint256 _milestoneId) public onlyOwner {
+        require(_milestoneId < milestones.length, "Milestone no existe");
+        require(milestones[_milestoneId].completed, "Milestone no esta completado");
+        developerAddress.transfer(milestones[_milestoneId].amount);
+        emit MilestoneApproved(_milestoneId, milestones[_milestoneId].amount);
+    }
+
+    receive() external payable {
+        totalCapital += msg.value;
+    }
+}
+
+contract ProjectFactory {
+    Project[] public projects;
+
+    function createProject(
+        string memory _projectName,
+        string memory _projectDescription,
+        address payable _developerAddress
+    ) public returns (address) {
+        Project newProject = new Project(
+            _projectName,
+            _projectDescription,
+            _developerAddress,
+            msg.sender
+        );
+        projects.push(newProject);
+        return address(newProject);
+    }
+
+    function getProjectsByOwner(address _owner) public view returns (Project[] memory) {
+        uint count;
+        for (uint i = 0; i < projects.length; i++) {
+            if (projects[i].owner() == _owner) {
+                count++;
+            }
+        }
+        Project[] memory result = new Project[](count);
+        uint index;
+        for (uint j = 0; j < projects.length; j++) {
+            if (projects[j].owner() == _owner) {
+                result[index] = projects[j];
+                index++;
+            }
+        }
+        return result;
+    }
+
+    function getProjectsByDeveloper(address _developer) public view returns (Project[] memory) {
+        uint count;
+        for (uint i = 0; i < projects.length; i++) {
+            if (projects[i].developerAddress() == _developer) {
+                count++;
+            }
+        }
+        Project[] memory result = new Project[](count);
+        uint index;
+        for (uint j = 0; j < projects.length; j++) {
+            if (projects[j].developerAddress() == _developer) {
+                result[index] = projects[j];
+                index++;
+            }
+        }
+        return result;
+    }
+}

docs/ProjectFactory.md

@@ -0,0 +1,96 @@
+# Solidity API
+
+## Project
+
+_A contract to manage project milestones, allowing the owner to add, complete, and approve milestones._
+
+### Contract
+Project : contracts/ProjectFactory.sol
+
+A contract to manage project milestones, allowing the owner to add, complete, and approve milestones.
+
+ --- 
+### Modifiers:
+### onlyOwner
+
+```solidity
+modifier onlyOwner()
+```
+
+ --- 
+### Functions:
+### constructor
+
+```solidity
+constructor(string _projectName, string _projectDescription, address payable _developerAddress) public
+```
+
+### addMilestone
+
+```solidity
+function addMilestone(string _title, uint256 _tentativeDate, string _description, uint256 _amount) public
+```
+
+### completeMilestone
+
+```solidity
+function completeMilestone(uint256 _milestoneId, string _proof) public
+```
+
+### approveMilestone
+
+```solidity
+function approveMilestone(uint256 _milestoneId) public
+```
+
+### receive
+
+```solidity
+receive() external payable
+```
+
+ --- 
+### Events:
+### MilestoneAdded
+
+```solidity
+event MilestoneAdded(uint256 milestoneId, string title, uint256 amount)
+```
+
+### MilestoneCompleted
+
+```solidity
+event MilestoneCompleted(uint256 milestoneId, string proof)
+```
+
+### MilestoneApproved
+
+```solidity
+event MilestoneApproved(uint256 milestoneId, uint256 amount)
+```
+
+## ProjectFactory
+
+### Contract
+ProjectFactory : contracts/ProjectFactory.sol
+
+ --- 
+### Functions:
+### createProject
+
+```solidity
+function createProject(string _projectName, string _projectDescription, address payable _developerAddress) public
+```
+
+### getProjectsByOwner
+
+```solidity
+function getProjectsByOwner(address _owner) public view returns (contract Project[])
+```
+
+### getProjectsByDeveloper
+
+```solidity
+function getProjectsByDeveloper(address _developer) public view returns (contract Project[])
+```
+