https://github.com/taystack/find-words
Small, full stack application. Graph solution to every combination of letters of a word.
https://github.com/taystack/find-words
Last synced: 3 months ago
JSON representation
Small, full stack application. Graph solution to every combination of letters of a word.
- Host: GitHub
- URL: https://github.com/taystack/find-words
- Owner: taystack
- Created: 2023-09-25T00:53:27.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-09-25T02:05:33.000Z (almost 2 years ago)
- Last Synced: 2025-04-10T00:55:21.235Z (3 months ago)
- Language: TypeScript
- Size: 1.64 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Word soup
Example Typescript application using both a backend server and a frontend server with a common package for type consistency.
This project utilizes `yarn workspaces` to manage all typescript packages.
## Installation
Ensure you are on the correct version of `node`. You can do this by running `node -v` and comparing against the `.nvmrc`.
```bash
node -v
cat .nvmrc
```
If you're running `nvm`, you can simply `nvm use`
```bash
nvm use
# Now using node v18.18.0 (npm v9.8.1)
```
This project uses yarn to install dependencies. From the `rootDir`
```bash
yarn
```
After running `yarn` a shared library will be built.
## Running
Run the entire suite.
```bash
yarn start
```
This command will do 3 things with `--watch`:
- Run a small React application on `localhost:3000`
- Run a small express node server on `localhost:3001`
- Build a small shared library.
Type a word into the large input and hit `Enter`. You will see the result of many combinations of the provided letters. Includes performance.
## Testing
A few tests are included with the shared library. Run all test suites with the test command.
```bash
yarn test
```
Alternatively, you can test each package in isolation.
```bash
yarn workspace frontend test
yarn workspace @local/find-words test
```