Skip to content

4GeeksAcademy/maxifer-TrackFlow

Repository files navigation

AI Engineering Company Project — Student Template

4Geeks Academy AI Engineering

Base template for transversal projects in the AI Engineering Career Program — 4Geeks Academy.

Instrucciones disponibles en español en README.es.md.


Purpose

This repository is the starter template for transversal projects. You will work on real company scenarios (Brasaland, TrackFlow, Nexova), building deliverables that map to course milestones (Web, Programming, Backend, Telemetry, RAG, Agents, Workflows, Real-time).

  • Create a template from this repository.
  • Replace the placeholder CONTEXT.md with your assigned company context.
  • Use skills/ and the directory-level README.md files as working guidance.

Current status of the template

The repository currently provides a base folder structure and documentation skeleton. It does not include runnable apps or global scripts yet.

  • CONTEXT.md is a placeholder and must be replaced with your assigned company context.
  • There is no root AGENTS.md yet.
  • Shared package metadata exists in packages/shared/package.json (@repo/shared-types), but no workspace runner is configured at root.

Repository structure

ai-engineering-company-project-monorepo/
├── README.md
├── README.es.md
├── CONTEXT.md                # Placeholder to be replaced with assigned context
├── agents/                   # Agent patterns/templates and tools docs
├── data/                     # raw, process, pipelines, eval
├── docs/                     # Project and architecture documentation
├── infra/                    # Docker, Terraform, deployment configs
├── internal/                 # CLIs, packaged migration scripts, internal utilities
├── mcps/                     # Model Context Protocol (MCP) Servers
├── packages/
│   └── shared/               # Shared package (@repo/shared-types)
├── scripts/                  # Script conventions/documentation
├── services/                 # APIs and background workers
├── shared/                   # Shared assets/conventions at repo level
├── skills/                   # Reusable agent skills
├── uis/                      # User interfaces (React, Next.js, Streamlit, HTML)
└── workflows/                # Automation/orchestration documentation

How to start

  1. Use this repository as a template and create your own project repo.
  2. Clone your repository (or open it in Codespaces).
  3. Replace CONTEXT.md with the full context for your assigned company.
  4. Review each top-level folder README.md to understand intended responsibilities (uis/, services/, data/, skills/, etc.).
  5. Start implementing milestone deliverables in uis/ and services/, reusing packages/shared/ and data/ as needed.

Quick Landing Preview in Local or Codespaces

If you want to preview the static HTML pages in this repo (index.html and application.html) from the root, run:

npx --yes serve -l 3000 .

Then open http://localhost:3000.


Milestones (reference)

Milestone Focus Typical deliverables
0 Prework Environment setup, first prompts
1 Web Corporate website, forms, SEO
2 Programming Business logic, scoring, calculations
3 AI-driven UI AI-generated interfaces
4 Next.js Portals, loyalty app, operations UI
5 Backend Central API (locations, menus, sales, etc.)
6 Telemetry Data pipeline, dashboards
7 RAG & Memory Semantic knowledge base, search
8 Agents Support, onboarding, training agents
9 Workflows n8n automations
10 Real-time Live dashboards, alerts, streaming

Links


Contributors

This template was built as part of the 4Geeks Academy AI Engineering Career Program by @marcogonzalo and @alezanchezr and many other contributors. Find out more about our AI Engineering Course, and other courses.

You can find other templates and resources like this at the 4Geeks Academy GitHub page.

This template is maintained by 4Geeks Academy for the AI Engineering track. For exclusive use in the programme.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages