TransHub_backend / README.md
linguabot's picture
Upload folder using huggingface_hub
da819ac verified
metadata
title: Transcreation Backend
emoji: 🔧
colorFrom: blue
colorTo: indigo
sdk: docker
pinned: false

Cultural Shift Sandbox - Backend API

A Node.js/Express backend API for the Cultural Shift Sandbox, a web-based tool for postgraduate translation students to practice transcreation and intercultural mediation.

Features

  • User Authentication: Login and registration system
  • Tutorial Tasks: Weekly tutorial assignments with translation briefs
  • Weekly Practice: Practice exercises with cultural mediation tasks
  • Submission Management: Create and manage translation submissions
  • Voting System: Vote on peer submissions
  • Admin Panel: Manage content and users (admin only)
  • Search Functionality: Search through source texts and submissions

Tech Stack

  • Node.js 18 with Express
  • MongoDB with Mongoose ODM
  • JWT Authentication (simplified token system)
  • Rate Limiting for API protection
  • CORS enabled for frontend communication
  • Docker for containerization

Environment Variables

Set these in your Space settings:

  • MONGODB_URI: Your MongoDB Atlas connection string
  • NODE_ENV: production
  • PORT: 5000 (default)

API Endpoints

Authentication

  • POST /api/auth/register - User registration
  • POST /api/auth/login - User login
  • GET /api/auth/profile - Get user profile

Source Texts

  • GET /api/source-texts/tutorial-tasks - Get tutorial tasks
  • GET /api/source-texts/weekly-practice - Get weekly practice texts
  • POST /api/source-texts - Create new source text (admin)

Submissions

  • GET /api/submissions/voteable - Get submissions for voting
  • GET /api/submissions/my-submissions - Get user's submissions
  • POST /api/submissions - Create new submission
  • POST /api/submissions/:id/vote - Vote on submission

Search

  • GET /api/search - Search source texts and submissions

Health Check

  • GET /api/health - API health status
  • GET /health - Simple health check

Development

This Space serves the backend API for the Cultural Shift Sandbox application. The frontend should be deployed separately and configured to communicate with this API.


Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference Build trigger: 2025-08-28T12:42:29Z

Build trigger: 2025-09-01T14:21:53Z