mirror of
https://github.com/xlorepdarkhelm/numinar-coding-project.git
synced 2026-09-07 02:08:25 -04:00
61 lines
1.4 KiB
Markdown
61 lines
1.4 KiB
Markdown
# Numinar Frontend
|
|
|
|
This is the frontend for the Numinar conference room booking system. It is a React application using TypeScript, Material-UI, and a REST API backend.
|
|
|
|
## Features
|
|
|
|
- View available conference rooms and their equipment
|
|
- Book rooms for specific times and invite users
|
|
- Real-time updates via Server-Sent Events (SSE) or polling
|
|
- Responsive UI with Material-UI components
|
|
- Centralized logging with loglevel
|
|
|
|
## Development
|
|
|
|
### Install dependencies
|
|
|
|
```sh
|
|
yarn install
|
|
```
|
|
|
|
### Start the development server
|
|
|
|
```sh
|
|
yarn start
|
|
```
|
|
|
|
The app will be available at [http://localhost:3000](http://localhost:3000).
|
|
|
|
### Run tests
|
|
|
|
```sh
|
|
yarn test
|
|
```
|
|
|
|
### Build for production
|
|
|
|
```sh
|
|
yarn build
|
|
```
|
|
|
|
## Environment Variables
|
|
|
|
- `REACT_APP_API_URL` - Base URL for the backend API (default: `http://localhost:8000`)
|
|
- `REACT_APP_LOG_LEVEL` - Logging level (`debug`, `info`, `warn`, `error`)
|
|
- `REACT_APP_BUSINESS_START` - Business hours start (default: `08:00`)
|
|
- `REACT_APP_BUSINESS_END` - Business hours end (default: `18:00`)
|
|
|
|
## Logging
|
|
|
|
All logs should use the centralized logger (`src/utils/logger.ts`). Do not use `console.log` directly.
|
|
|
|
## Code Style
|
|
|
|
- Use TypeScript and React best practices
|
|
- Document all components and exported functions with JSDoc or TypeScript doc comments
|
|
- Avoid use of `any` and `@ts-ignore` unless absolutely necessary
|
|
|
|
## License
|
|
|
|
MIT License
|