Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/watercubz/mtaai-core

✨ What is MTAAI-core or Marketing Tracking and Advertising Improvement through AI, is a service designed for new entrepreneurs through our platform that integrates AI. You will be able to connect your networks, whether Facebook and Instagram, and manage your advertising through AI.
https://github.com/watercubz/mtaai-core

ai gemini-api javascript react supabase tailwind

Last synced: about 2 months ago
JSON representation

Host: GitHub
URL: https://github.com/watercubz/mtaai-core
Owner: watercubz
License: other
Created: 2024-10-11T16:55:23.000Z (3 months ago)
Default Branch: master
Last Pushed: 2024-11-14T03:53:12.000Z (2 months ago)
Last Synced: 2024-11-14T04:29:26.183Z (2 months ago)
Topics: ai, gemini-api, javascript, react, supabase, tailwind
Language: JavaScript
Homepage: https://not-avalibe
Size: 3.83 MB
Stars: 1
Watchers: 1
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md

Awesome Lists containing this project

README

# 🌩️ MTAAI-core

What is MTAAI-core or Marketing Tracking and Advertising Improvement through AI, is a service designed for new entrepreneurs through our platform that integrates AI. You will be able to connect your networks, whether Facebook and Instagram, and manage your advertising through AI.

## 📖 Is it Open Source?

If **MTAAI-core** is open source, you can contribute by enhancing the app, adding new features, fixing bugs, and more. Your contributions help improve the project and benefit the community!

## ⚙️ Setup

## Prerequisites

- Ensure **Node.js** and **pnpm**, **npm**, or **yarn** are installed on your machine.
- [![Node.js](https://img.shields.io/badge/Node.js-43853D?logo=node.js&logoColor=white)](https://nodejs.org/)
- [![pnpm](https://img.shields.io/badge/pnpm-000000?logo=pnpm&logoColor=white)](https://pnpm.io/)
- [![npm](https://img.shields.io/badge/npm-CC3534?logo=npm&logoColor=white)](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
- [![Yarn](https://img.shields.io/badge/Yarn-2C8EBB?logo=yarn&logoColor=white)](https://classic.yarnpkg.com/en/docs/install/)

---

### Steps for Configuration

1. **Create a `.env` file** in the root of your project (if you don’t have one already).

2. **Add the following variables** to the `.env` file:

```env
VITE_GOOGLE_GEMINI_API="your_gemini-api-key" # e.g., "eru4uwu4422ueeesd32frt5434eerr"
VITE_SUPABASE_URL="your-supabase-url" # e.g., "https://supa.xdrovbk.co"
VITE_SUPABASE_ANON_KEY="your-supabase-anon-key"
```

## 🚀 Running the Project

To run the project, you can use any of the following package managers: pnpm, npm, or yarn. Here’s how to do it with each:

## Using pnpm

Make sure you have pnpm installed. If you haven't installed it yet, you can do so with:

```bash
npm install -g pnpm
```

Install dependencies and run the project:

```bash
pnpm i && pnpm run dev
```

Or, using npm:

```bash
npm i && npm run dev
```

Or, using yarn:

```bash
yarn add && yarn run dev
```

## 🐳 Setup Guide for Running **MTAAI-core** with Docker

Follow these steps to set up and run MTAAI-core using Docker.

## Prerequisites

- Ensure Docker and Docker Compose are installed on your machine.
- [Docker Installation Guide](https://docs.docker.com/get-docker/)
- [Docker Compose Installation Guide](https://docs.docker.com/compose/install/)
- [pnpm](https://pnpm.io/)

---

## Step 1: Clone the Repository

First, clone the repository to your local machine:

```bash
git clone github.com/your-name/MTAAI-core.git
cd MTAAI-core
```

## Step 2: Set Up Environment Variables

Create an .env file in the project root if one doesn’t already exist.
Add necessary environment variables for MTAAI-core, such as database credentials, API keys, and any other required configuration.
Example .env file:

Add any other necessary variables here

## Step 3: Build the Docker Images

Build the Docker images using Dockerfile:

```
docker build -t a watercubz/MTAAI-core.app
```

This command will create the necessary Docker images for the application and its dependencies (e.g., database, web server).

## Step 4: Run the Containers

Start the containers with Docker Compose:

```
docker-compose up
```

This command will launch all the necessary containers.
The app should now be accessible at http://localhost:5173 (or the port specified in your Docker configuration).

## Step 5: Verify the Setup

Open your browser and go to http://localhost:5173.

Verify that the application is running correctly.

Check the logs for any errors by running:

```
docker-compose logs -f
```

## Additional Commands

Stop the Containers: To stop the running containers, use:

```
docker-compose down
```

Rebuild the Containers: If you make changes to the Docker configuration or code, rebuild the images:

```
docker-compose up --build
```

## 🤝 Contribution Guide for **MTAAI-core**

Thank you for your interest in improving MTAAI-core! Please follow these three simple steps to submit your contributions:

## Step 1: Description of the Issue or Feature

- **Issue or Improvement**: Clearly explain the bug you found or the new feature you'd like to add.
- **Technical Details**: Include technical details such as your operating system, browser, or application version, if relevant.

Example:

```markdown
**Description**: The app freezes when trying to upload an image larger than 5MB.
**Technical Details**: Windows 10, Chrome 114, MTAAI-core version 1.2.3.
```

## Step 2: Create a New Branch

Create a new branch for your changes. It's best to use a descriptive name for your branch that reflects the work you're doing.

```
git checkout -b feature/your-feature-name
```

## Step 3: Screenshots of the Implemented Changes

Include screenshots or gifs that show the interface changes or the effect of your contribution. Images should be clear and, if possible, show both the issue before your changes and the final result.

Example:

Before: PHOTO

After: PHOTO

## Step 4: Description of the Changes Made

Detailed Explanation: Describe the changes you made in the code and why.
App Impact: Explain how your contribution improves the application or solves the problem.

**Description of Changes**:

- Increased the maximum upload size to 10MB to prevent freezing.
- Added an error message for oversized files.

**Impact**: Users now receive a warning if their file is too large, and the app no longer freezes.

That’s it! After following these steps, submit your pull request, and our team will review your contribution.

Thank you for making MTAAI-core a better application

## 📁 Project Structure

See Project Structure

[project Structure](./ARCHITECTURE.md)

---

By following these guidelines, you help us improve the project and make it better for everyone!