Magi

---

Is a system to manage process and generate reports for a marketing agency. This also leads to produce reports.

📝 Table of Contents

• About
• Getting Started
• Usage
• Built Using
• Authors

🏁 Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

For each app we have different prerequisites

The API

• PHP ^7.4.9
• Composer ^2.1.9
• Mysql ^8

The UI

• Node 16.20.2 (do not use higher version)
• Yarn ^1.22.19

You can also run it in a Docker container

yarn run docker:start

Installing

Just run this command

yarn run dev:prepare

yarn run dev:start

🎈 Usage

We have some alignments to work Clean Code.

• Keep the consistency of the code.
• Easy to Follow Comments with Complete Parameter and Return Information.
• Write code that adheres to the Single Responsibility Principle.

⛏️ Built Using

• MySQL - Database
• Laravel - Server Framework
• React - Web Framework
• NodeJs - Server Environment

Nice to have on VsCode

• PHP Intelephense - PHP Extension
• Prettier - Code formatter Extension

✍️ Authors

• @sefas90

See also the list of contributors who participated in this project.