Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mrbr/chess-tent
A virtual chess gym for everyone
https://github.com/mrbr/chess-tent
chess
Last synced: about 8 hours ago
JSON representation
A virtual chess gym for everyone
- Host: GitHub
- URL: https://github.com/mrbr/chess-tent
- Owner: MrBr
- License: agpl-3.0
- Created: 2022-11-12T18:40:02.000Z (about 2 years ago)
- Default Branch: development
- Last Pushed: 2024-02-24T23:04:21.000Z (11 months ago)
- Last Synced: 2025-01-29T00:21:52.824Z (about 10 hours ago)
- Topics: chess
- Language: TypeScript
- Homepage:
- Size: 15.1 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Chess Tent
### Setup instructions
Run these commands:
```shell script
yarn build:dev
docker-compose -f docker-compose.yml
```
Then open up 2 terminal windows and run following in each
```shell script
cd ./packages/server
yarn start
```
```shell script
cd ./packages/web
yarn start
```
Access the app at http://localhost:3000
### Modules
- Lerna monorepo (https://classic.yarnpkg.com/blog/2017/08/02/introducing-workspaces/, https://github.com/lerna/lerna)
List of packages:
- chessground (it is the fork of https://github.com/ornicar/chessground - library used for chess UI)
- core-module (modules management)
- models (models interfaces for mongoDB entity schemas and for redux state)
- normalization (used for state normalization)
- **server** - backend(BE) part of the app
- **types** - types for API, actions, state
- **web** - frontend(FE) part of the app
- playground (future ideas)
### Prerequisites
- **yarn** - package manager (https://yarnpkg.com/)
- **node.js** - js runtime environment (https://nodejs.org/en/download/)
- **mongodb** - database (https://www.mongodb.com/)
### Setup
1. install node.js https://nodejs.org/en/
2. install yarn package manager https://classic.yarnpkg.com/en/docs/install.
3. install mongodb
4. run mongodb
5. run `yarn install` or `yarn` in project root
6. run `yarn build:dev` in project root
7. run `start` script for wanted package
### Applications architecture
- **application** - used for global application types (types used by the application and the modules). In a way it represents simple and more complex global functions/classes of the application.
- **modules** - application type implementations (building blocks)
## .env file
Use `.env` file for local configuration. `server` and `web` have `.env` file where default variables like api domain, db url, aws keys and mailgun endpoint are defined.
## Testing
How and what to test.
### Infrastructure tests
An application infrastructure (interface) should be tested after defining types. The Infrastructure tests can be unit or integration depending on the tested part. The main difference between other tests is that these tests initialise whole application before testing.
### Unit and (module) Integration tests
Isolated inside a single module, test type depends on a tested part. Ideally should avoid initializing the application. Dependencies should be mocked, too many dependencies may be a sign that a system is too granular.
### E2E tests
Doesn't exist yet but should be implemented with Cypress. TBD
### Fixtures
As an application can be initialized for a `production` or `development`, it makes sense to implement a `test` environment with data and features that can be initialized. TBD
## Build for production
run `yarn build`. The output can be seen in the `build` folder.
## Stockfish (v.14) evaluation
In order for Stockfish 14 to work certain headers have to be defined on the top document (index.html).
```
'Cross-Origin-Opener-Policy': 'same-origin',
'Cross-Origin-Embedder-Policy': 'require-corp',
```
Craco is used to configure devServer and nginx for the production. More on this can be found at https://github.com/nmrugg/stockfish.js/issues/53
This issue was partially a reason for creating S3 proxy. The problem is to add needed headers to S3.
## Server
Details specific to chesstent.com setup
### SSL
Letsencryp
### Nginx
### S3 proxy
Used primarily for controlling the S3 headers. All in all it seems like useful thing for the future.