|
|
--- |
|
|
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`. |
|
|
|
