Hugging Face's logo

Spaces:
linguabot
/
ad-reflections
Sleeping

App Files Community
ad-reflections / AIRTABLE_SETUP.md
Tristan Yu
Rename site to 'Ad Reflections' - update branding in hf-space
3f4cb51
preview code
|
raw
history blame contribute delete
6.07 kB

🎓 Airtable Setup for Classroom Use

Your Ad Reflections is now ready for permanent student data storage using Airtable! Follow this guide to set up your classroom database.

🚀 Quick Setup (15 minutes)

Step 1: Create Airtable Account

  1. Go to airtable.com and sign up (free)
  2. Choose "Personal" plan (free for up to 1,200 records - perfect for classrooms)

Step 2: Create Your Transcreation Base

  1. Click "Create a base" → "Start from scratch"
  2. Name it: Ad Reflections - [Your Class Name]
  3. Rename the default table to: "Examples"

Step 3: Set Up Table Fields

Delete the default fields and create these exact field names:

Field Name Type Description
English Single line text Original English text
Mainland Single line text Mainland China adaptation
Taiwan Single line text Taiwan adaptation (optional)
Brand Single line text Company/brand name
Category Single select Product category
Description Long text Example description
Type Single select Content type (slogan, tagline, etc.)
CulturalNote Long text Cultural insights
DateAdded Date & time When example was added
Source Single line text Where example came from
Status Single select Review status
Contributor Single line text Student name (optional)
LastModified Date & time Last update time

Step 4: Configure Field Options

Category options (Single select):

  • Food & Beverage
  • Technology
  • Beauty & Cosmetics
  • Automotive
  • Fashion & Retail
  • Financial Services
  • Entertainment
  • Healthcare
  • Sports & Fitness
  • Travel & Tourism

Type options (Single select):

  • slogan
  • tagline
  • product_name
  • campaign_title
  • description

Status options (Single select):

  • pending
  • verified
  • needs_review

Step 5: Get API Credentials

  1. Click your profile icon (top right) → "Developer hub"
  2. Click "Create token"
  3. Name: Ad Reflections
  4. Scopes: Select "data.records:read" and "data.records:write"
  5. Select your base and table
  6. Click "Create token" and copy the token (starts with pat...)

Step 6: Get Base ID

  1. Go to airtable.com/api
  2. Click your base name
  3. Copy the Base ID from the URL (starts with app...)

Step 7: Configure Hugging Face Environment

  1. Go to your Hugging Face Space Settings
  2. Scroll to "Repository secrets"
  3. Add these three secrets:
AIRTABLE_API_KEY = pat_your_token_here
AIRTABLE_BASE_ID = app_your_base_id_here  
AIRTABLE_TABLE_NAME = Examples

Step 8: Restart Your Space

  1. Go to your Space → "Settings" → "Factory reboot"
  2. Wait for deployment (2-3 minutes)
  3. Your app will automatically import all 38 examples!

🎯 Classroom Benefits

For Teachers:

  • ✅ Easy Management: View all submissions in spreadsheet format
  • ✅ Real-time Monitoring: See student entries as they submit
  • ✅ Quality Control: Approve/edit entries before they go live
  • ✅ Data Export: Download CSV for grading/analysis
  • ✅ Collaboration: Share base with teaching assistants

For Students:

  • ✅ Instant Feedback: See their work appear immediately
  • ✅ Peer Learning: Browse classmates' examples
  • ✅ No Extra Accounts: Just use the web app
  • ✅ Permanent Storage: Work saved forever

📊 Managing Student Data

View All Submissions

Your Airtable base gives you a real-time dashboard of all student work:

  • Grid View: Spreadsheet-style overview
  • Form View: Clean submission interface
  • Calendar View: See submissions by date

Moderate Content

  1. Review Status: Mark examples as "verified" or "needs_review"
  2. Edit Entries: Fix typos or improve cultural notes
  3. Add Comments: Use the Description field for feedback

Export for Grading

  1. Click "Download CSV" in your Airtable view
  2. Import into Excel/Google Sheets for grading
  3. Track participation and quality

Classroom Analytics

Monitor your class progress:

  • Total submissions per student
  • Most popular brands/categories
  • Quality of cultural observations
  • Timeline of participation

🔧 Troubleshooting

No Data Appearing?

  1. Check Environment Variables are correct
  2. Verify Base ID starts with app
  3. Ensure API token has read/write permissions
  4. Restart your Hugging Face Space

Students Can't Submit?

  1. Check Airtable record limits (1,200 free)
  2. Verify all required fields exist
  3. Test API connection in Space logs

Need Help?

  • Check Hugging Face Space logs for errors
  • Verify field names match exactly (case-sensitive)
  • Ensure API token hasn't expired

🌟 Advanced Features

Custom Views for Different Classes

Create separate views for:

  • Semester 1: Filter by date range
  • Advanced Students: Filter by complexity
  • Needs Review: Show only pending submissions

Collaboration with TAs

  1. Share Base: Invite TAs with "Editor" permissions
  2. Comment System: Use Airtable comments for feedback
  3. Assignment Integration: Create forms for specific assignments

Integration with LMS

  • Export CSV data to import into your Learning Management System
  • Use Airtable's API to connect with other tools
  • Create automated reports for administration

🎉 Success!

Your Ad Reflections is now a powerful classroom tool with:

  • ✨ Permanent student data storage
  • 📊 Real-time teacher dashboard
  • 🔄 Seamless student experience
  • 📈 Built-in analytics and reporting

Students can now contribute transcreation examples that will be permanently available to future classes, building a collaborative learning resource that grows over time!

Support

If you need help with setup, check the Airtable documentation or create an issue in the repository.