A small word game project that emphasises the proper way to structure, test, and deploy a project containing multiple end-points and dependencies
word-game
: front end of the word gamesocketServer
: backend of the word game with support for realtime websocketsshared
: a utility library shared between front and back end to ensure game logic works in both online and offlineconfig
:eslint
configurations (includeseslint-config-next
andeslint-config-prettier
)tsconfig
:tsconfig.json
s used throughout the monorepo
This turborepo has some additional tools already setup for you:
- TypeScript for static type checking
- ESLint for code linting
- Jest test runner for all things JavaScript
- Prettier for code formatting
yarn install to install dependencies required by each app/package
To build all apps and packages, run the following command: requirements: nodejs version 16 or more, yarn v2/v3
cd wordly
yarn run build
To develop all apps and packages, run the following command:
cd wordly
yarn run dev
Main technologies used throughout the project: