Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/fredy-rizo/tukit/llms.txt

Use this file to discover all available pages before exploring further.

TuKit is the backend API powering a marketplace for downloadable sporting uniform designs and typography. Built with Node.js, Express, and MongoDB, it provides everything you need to authenticate users, manage design products, and handle purchase orders — including payment proof uploads and admin confirmation workflows.

Quickstart

Get TuKit running locally in under 5 minutes

Configuration

Set up environment variables, database, and cloud storage

Authentication

Learn about JWT tokens and Google OAuth 2.0 flows

API Reference

Explore all endpoints for users, products, and orders

​
What TuKit Does

TuKit exposes three resource groups through a RESTful API:

Users

Register, verify, and authenticate users. Admin role management and account lifecycle.

Products

Upload and manage sporting designs — uniforms and typography — with free or paid access tiers.

Shopping Cart

Create orders, upload payment proofs, and track purchase confirmation status.

​
Get Started

1

Clone and install

Clone the repository and install Node.js dependencies.
2

Configure environment

Copy .env.example to .env and fill in your MongoDB URL, JWT secret, email credentials, and Google Cloud keys.
3

Start the server

Run npm run dev to launch the API on your configured port.
4

Make your first request

Register a user at POST /api/user/register and verify the account with the emailed code.
All API endpoints use POST requests. Protected routes require a token-access header containing a valid JWT issued at login.

Build docs developers (and LLMs) love

Get started for freeTalk to us