Skip to content

Commit 1523d33

Browse files
jeffdyerclaude
andcommitted
Update README with language documentation
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent c541f06 commit 1523d33

1 file changed

Lines changed: 16 additions & 21 deletions

File tree

packages/api/README.md

Lines changed: 16 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,25 @@
1-
# React + TypeScript + Vite
1+
# L0166
22

3-
This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
3+
L0166 is a **spreadsheet-based assessment language**. It creates interactive spreadsheets where users fill in cells and their answers are validated against expected values.
44

5-
Currently, two official plugins are available:
5+
Use it for quizzes, exercises, and any assessment where you need a grid of inputs with grading.
66

7-
- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
8-
- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
7+
## Features
98

10-
## Expanding the ESLint configuration
9+
- Cell validation with expected values
10+
- Formulas (`=SUM`, `=AVERAGE`, `=ROUND`, `=IF`)
11+
- Parameterized templates for randomized assessments
12+
- Rich styling (fonts, colors, borders)
1113

12-
If you are developing a production application, we recommend updating the configuration to enable type aware lint rules:
14+
## Documentation
1315

14-
- Configure the top-level `parserOptions` property like this:
16+
See [`spec/`](./spec/) for the full language specification and examples.
1517

16-
```js
17-
export default {
18-
// other rules...
19-
parserOptions: {
20-
ecmaVersion: 'latest',
21-
sourceType: 'module',
22-
project: ['./tsconfig.json', './tsconfig.node.json'],
23-
tsconfigRootDir: __dirname,
24-
},
25-
}
18+
## Getting started
19+
20+
```bash
21+
npm install
22+
npm start
2623
```
2724

28-
- Replace `plugin:@typescript-eslint/recommended` to `plugin:@typescript-eslint/recommended-type-checked` or `plugin:@typescript-eslint/strict-type-checked`
29-
- Optionally add `plugin:@typescript-eslint/stylistic-type-checked`
30-
- Install [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and add `plugin:react/recommended` & `plugin:react/jsx-runtime` to the `extends` list
25+
Runs on port 50166.

0 commit comments

Comments
 (0)