NLP-IBM-Debater / README.md
yassine-mhirsi's picture
Update README.md
e9d3b37 verified
metadata
title: NLP IBM Debater
emoji: 🐠
colorFrom: indigo
colorTo: red
sdk: static
pinned: false
app_build_command: npm run build
app_file: build/index.html
license: mit

NLP IBM Debater β€” React + Tailwind Workspace

An opinionated Create React App setup designed for fast iteration on NLP experiences. Tailwind CSS is wired in, and the app structure is organized for feature-first development.

Project structure

  • src/app/App.jsx β€” root composition.
  • src/app/layouts/MainLayout.jsx β€” shared shell with navigation and footer.
  • src/app/pages/HomePage.jsx β€” starter page showing layout and cards.
  • src/app/components/ β€” reusable UI (navigation/common).
  • src/app/data/ β€” UI copy and data stubs.
  • LLM_GUIDE.md β€” instructions for AI collaborators.
  • tailwind.config.js and postcss.config.js β€” Tailwind setup.

Scripts

  • npm start β€” run the dev server.
  • npm test β€” run tests in watch mode.
  • npm run build β€” production build.

Tailwind usage

Tailwind is configured via tailwind.config.js. Global styles live in src/index.css with Tailwind directives. Use utility classes for new UI and extend the config when adding design tokens.

Adding features

  1. Create a page in src/app/pages and wire it through App.jsx.
  2. Add shared UI to src/app/components.
  3. Store static copy or mock data in src/app/data.
  4. Write behavioral tests with React Testing Library.

For more collaboration guidance, see LLM_GUIDE.md.