Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/quisido/word-scramble
game to unscramble words
https://github.com/quisido/word-scramble
Last synced: 20 days ago
JSON representation
game to unscramble words
- Host: GitHub
- URL: https://github.com/quisido/word-scramble
- Owner: quisido
- License: other
- Created: 2022-08-05T03:09:05.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-08-08T18:52:42.000Z (over 2 years ago)
- Last Synced: 2024-10-26T21:42:21.362Z (2 months ago)
- Language: TypeScript
- Size: 1.21 MB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: docs/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Monorepo template
The monorepo template is a GitHub repository template that preconfigures common
front end dependencies for best practices and abstracts them in an extensible
manner.
| Problem | Goal |
| ------------------------------------------------ | -------------------------------------------------------- |
| **Front end engineers...** | **Front end engineers...** |
| ... spend too much time managing configurations. | ... should spend more time writing great applications. |
| ... only harness a subset of best practices. | ... have best practices available at no additional cost. |
| ... have difficulty integrating dependencies. | ... have dependencies integrated seamlessly. |
The front end ecosystem should _just work_.
## Features
- **Cloudflare purge** for _cache busting_
- **CodeQL** for _security analysis_
- **Cypress** for _end-to-end testing_
- **ESLint** for _linting_
- **GitHub Actions** for _continuous integration_ and _continuous delivery_
- **GitHub Packages** and **NPM** for _package publishing_
- **GitHub Pages** for _static asset deployments_
- **Jest** for _unit testing_
- **Node** (latest) for _compatibility_
- **NYC** for _code coverage reports_
- **Prettier** for _code formatting_
- **React Scripts** for _application development_
- **Rollup** for _module bundling_
- **Sentry release** for _source mapping_
- **TypeScript** for _static typing_
- **Visual Studio Code** for _code editing_
- **Yarn** (latest) for _workspaces_
All with _zero configuration_ and _completely extensible_ if deviation is
desired.
---
[](https://github.com/monorepo-template/monorepo-template/actions/workflows/index.yml)
[](https://github.com/monorepo-template/monorepo-template/actions/workflows/example-next-application.yml)
[](https://github.com/monorepo-template/monorepo-template/actions/workflows/example-react-application.yml)
[](https://dashboard.cypress.io/projects/4akrvv/runs)
[](https://github.com/monorepo-template/monorepo-template/actions/workflows/example-react-module.yml)
[](https://www.npmjs.com/package/@monorepo-template/example-react-module)
[](https://www.npmjs.com/package/@monorepo-template/example-react-module)
[](https://www.npmjs.com/package/@monorepo-template/example-react-module)
## Documentation
- [Getting started](https://github.com/monorepo-template/monorepo-template/blob/main/docs/GETTING_STARTED.md)
- [Adding a React application](https://github.com/monorepo-template/monorepo-template/blob/main/docs/REACT_APPLICATION.md)
- [Adding a React module](https://github.com/monorepo-template/monorepo-template/blob/main/docs/REACT_MODULE.md)
- [Contributing](https://github.com/monorepo-template/monorepo-template/blob/main/docs/CONTRIBUTING.md)
- [Debugging](https://github.com/monorepo-template/monorepo-template/blob/main/docs/DEBUGGING.md)
- [Dependencies](https://github.com/monorepo-template/dependencies#monorepo-template-dependencies)
## Packages
### Next application
- To build the application, run `yarn example-next-application:build`.
- To end-to-end test your application, run
`yarn example-next-application:cypress:start` to first run the development
server with code coverage reporting enabled, then run
`yarn example-next-application:cypress:run`.
- To lint your changes to the application, run
`yarn example-next-application:eslint`.
- To unit test your changes to the application, run
`yarn example-next-application:jest`.
- To unit test your changes to the application in watch mode, run
`yarn example-next-application:jest:watch`.
- To start the application development server, run
`yarn example-next-application:start`.
### React application
- To build the application, run `yarn example-react-application:build`.
- To report Cypress's and Jest's combined test coverage, run
`yarn example-react-application:coverage`. The combined report will be located
in `/packages/example-react-application/coverage/`.
- To end-to-end test your application, run
`yarn example-react-application:cypress:start` to first run the development
server with code coverage reporting enabled, then run
`yarn example-react-application:cypress:run`.
- To lint your changes to the application, run
`yarn example-react-application:eslint`.
- To unit test your changes to the application, run
`yarn example-react-application:jest`.
- To unit test your changes to the application in watch mode, run
`yarn example-react-application:jest:watch`.
- To start the application development server, run
`yarn example-react-application:start`.
### React module
- To lint your changes to the module, run `yarn example-react-module:eslint`.
- To automatically fix lint errors in the module, run
`yarn example-react-module:eslint:fix`.
- To unit test your changes to the module, run `yarn example-react-module:jest`.
- To unit test your changes to the module in watch mode, run
`yarn example-react-module:jest:watch`.
- To build the module, run `yarn example-react-module:rollup`.
- To build the module in watch mode, run
`yarn example-react-module:rollup:watch`.