fix: structure
This commit is contained in:
@@ -1,60 +1,41 @@
|
||||
# NowchessFrontend
|
||||
# NowChess Frontend
|
||||
|
||||
This project was generated using [Angular CLI](https://github.com/angular/angular-cli) version 20.3.24.
|
||||
Angular 20 frontend for the NowChess board UI.
|
||||
|
||||
## Development server
|
||||
## Tech stack
|
||||
|
||||
To start a local development server, run:
|
||||
- Angular standalone components and route-based pages
|
||||
- HTTP and streaming integration for live game updates
|
||||
- Asset sprites loaded from `arabian-chess/`
|
||||
|
||||
## Project structure
|
||||
|
||||
- `src/app/pages` page-level containers (`welcome`, `game`)
|
||||
- `src/app/components` reusable UI pieces (`chess-board`, `chess-piece`)
|
||||
- `src/app/services` API and stream integration (`GameApiService`)
|
||||
- `src/app/models` shared API/domain types
|
||||
- `src/app/core/chess` chess domain utilities (FEN parsing and square lookup)
|
||||
- `src/environments` environment-specific API base URLs
|
||||
|
||||
## Run locally
|
||||
|
||||
```bash
|
||||
npm install
|
||||
npm start
|
||||
npm install
|
||||
npm start
|
||||
```
|
||||
|
||||
Once the server is running, open your browser and navigate to `http://localhost:4200/`. The application will automatically reload whenever you modify any of the source files.
|
||||
Open `http://localhost:4200`.
|
||||
|
||||
## Code scaffolding
|
||||
Development environment defaults to:
|
||||
|
||||
Angular CLI includes powerful code scaffolding tools. To generate a new component, run:
|
||||
- API: `http://localhost:8080`
|
||||
- WebSocket: `ws://localhost:8080`
|
||||
|
||||
`src/environments/environment.ts` is production-oriented (`production: true`) and `src/environments/environment.development.ts` is development-oriented (`production: false`).
|
||||
|
||||
## Build and test
|
||||
|
||||
```bash
|
||||
ng generate component component-name
|
||||
npm run build
|
||||
npm test
|
||||
```
|
||||
|
||||
For a complete list of available schematics (such as `components`, `directives`, or `pipes`), run:
|
||||
|
||||
```bash
|
||||
ng generate --help
|
||||
```
|
||||
|
||||
## Building
|
||||
|
||||
To build the project run:
|
||||
|
||||
```bash
|
||||
ng build
|
||||
```
|
||||
|
||||
This will compile your project and store the build artifacts in the `dist/` directory. By default, the production build optimizes your application for performance and speed.
|
||||
|
||||
## Running unit tests
|
||||
|
||||
To execute unit tests with the [Karma](https://karma-runner.github.io) test runner, use the following command:
|
||||
|
||||
```bash
|
||||
ng test
|
||||
```
|
||||
|
||||
## Running end-to-end tests
|
||||
|
||||
For end-to-end (e2e) testing, run:
|
||||
|
||||
```bash
|
||||
ng e2e
|
||||
```
|
||||
|
||||
Angular CLI does not come with an end-to-end testing framework by default. You can choose one that suits your needs.
|
||||
|
||||
## Additional Resources
|
||||
|
||||
For more information on using the Angular CLI, including detailed command references, visit the [Angular CLI Overview and Command Reference](https://angular.dev/tools/cli) page.
|
||||
|
||||
Reference in New Issue
Block a user