webapp/README.en.md

50 lines
1.2 KiB
Markdown
Raw Normal View History

2024-10-08 20:31:12 +00:00
# Discoursio Webapp
2024-07-13 07:01:41 +00:00
2024-10-08 20:31:12 +00:00
## Technology Stack
2024-07-13 07:01:41 +00:00
2024-10-08 20:31:12 +00:00
- [TypeScript](https://www.typescriptlang.org/)
- [SolidJS](https://www.solidjs.com/)
- [Vinxi](https://vinxi.vercel.app/)
- [SCSS](https://sass-lang.com/)
- [URQL](https://formidable.com/open-source/urql/)
- [i18next](https://www.i18next.com/)
- [Tiptap](https://tiptap.dev/)
- [Playwright](https://playwright.dev/)
- [Storybook](https://storybook.js.org/)
- [Stylelint](https://stylelint.io/)
- [Biome](https://biomejs.dev/)
2024-07-13 07:01:41 +00:00
2024-10-08 20:31:12 +00:00
## Development
2024-07-13 07:01:41 +00:00
2024-10-08 20:31:12 +00:00
### How to start
2024-07-13 07:01:41 +00:00
2024-10-08 20:31:12 +00:00
1. Clone the repository
2. Install dependencies: `bun i` (or npm/pnpm/yarn)
3. Create a `.env` file (variables with `PUBLIC_` are used in `/src/utils/config.ts`)
2024-07-13 07:01:41 +00:00
2024-10-08 20:31:12 +00:00
### Main commands
2024-07-13 07:01:41 +00:00
2024-10-08 20:31:12 +00:00
```bash
bun run dev # Start development server
bun run build # Build for production
bun run typecheck # Type checking
bun run fix # Fix styles and linting
bun run storybook # Start Storybook
```
2024-07-13 07:01:41 +00:00
2024-10-08 20:31:12 +00:00
## Testing
2024-07-13 07:01:41 +00:00
2024-10-08 20:31:12 +00:00
### E2E tests (Playwright)
2024-07-13 07:01:41 +00:00
2024-10-08 20:31:12 +00:00
```bash
bun run e2e:install # Install E2E dependencies
bun run e2e:tests # Run tests
bun run e2e:tests:ci # Run tests in CI
```
2024-07-13 07:01:41 +00:00
2024-10-08 20:31:12 +00:00
## CI/CD
2024-07-13 07:01:41 +00:00
2024-10-08 20:31:12 +00:00
Tests are executed in GitHub Actions. Make sure `BASE_URL` is correctly configured in CI.
2024-07-13 07:01:41 +00:00
## Version: 0.9.7