https://github.com/abelpz/bible-lexical-editor
https://github.com/abelpz/bible-lexical-editor
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/abelpz/bible-lexical-editor
- Owner: abelpz
- Created: 2023-10-12T14:47:38.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-02-11T18:25:45.000Z (over 1 year ago)
- Last Synced: 2024-04-19T05:58:03.955Z (about 1 year ago)
- Language: TypeScript
- Size: 1.18 MB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# BibleLexicalEditor
## Developer Quick Start
1. Install [Volta](https://docs.volta.sh/guide/getting-started).
2. Install [Nx](https://nx.dev/) globally (note we intentionally use `npm` rather than `pnpm` for global installs, see [JavaScript Tool Manager](#javascript-tool-manager)):
```bash
npm i -g nx
```
3. Clone the monorepo:
```bash
git clone https://github.com/abelpz/bible-lexical-editor.git
cd bible-lexical-editor
pnpm install
```
4. Run one of the top level developer environments (see the **Nx Graph** below), e.g.:
```bash
nx dev perf-react
```
## JavaScript Tool Manager
You can use [Volta](https://volta.sh/) with this repo to use the right version of tools such as Node.js and PNPM.
If you don't use Volta just look at the `volta` property in [package.json](/package.json) to see the right tool versions to install in your preferred way.
NOTE: there is a [known limitation using PNPM with Volta](https://docs.volta.sh/advanced/pnpm). So to install packages globally, use NPM instead of PNPM (only for global installs). For an example, see step 2 of [Developer Quick Start](#developer-quick-start).
## Nx Monorepo Build System
```mermaid
---
title: Nx Graph
---
graph TB
R(perf-react) --> S(shared)
V(perf-vanilla) --> S
P(platform) --> SR
SR(shared-react) --> S
P --> S
```
✨ **This workspace has been generated by [Nx, a Smart, fast and extensible build system.](https://nx.dev)** ✨
### Nx Installed Globally?
If you haven't installed Nx globally (as recommended in step 2 of [Developer Quick Start](#developer-quick-start)), then just prefix each call to `nx` with `pnpm`, e.g. `pnpm nx build perf-react`.
### Running tasks
To execute tasks with Nx use the following syntax:
```bash
nx <...options>
# e.g.
nx build perf-react
```
You can also run multiple targets:
```bash
nx run-many -t
```
..or add `-p` to filter specific projects
```bash
nx run-many -t -p
```
Targets can be defined in the `package.json` or `projects.json`. Learn more [in the docs](https://nx.dev/core-features/run-tasks).
### Generate code
If you happen to use Nx plugins, you can leverage code generators that might come with it.
Run `nx list` to get a list of available plugins and whether they have generators. Then run `nx list ` to see what generators are available.
Learn more about [Nx generators on the docs](https://nx.dev/plugin-features/use-code-generators).
### Want better Editor Integration?
Have a look at the [Nx Console extensions](https://nx.dev/nx-console). It provides autocomplete support, a UI for exploring and running tasks & generators, and more! Available for VSCode, IntelliJ and comes with a LSP for Vim users.
### Ready to deploy?
Just run `nx build perf-react` to build that application. The build artifacts will be stored in the `dist/` directory, ready to be deployed.
### Set up CI!
Nx comes with local caching already built-in (check your `nx.json`). On CI you might want to go a step further.
- [Set up remote caching](https://nx.dev/core-features/share-your-cache)
- [Set up task distribution across multiple machines](https://nx.dev/core-features/distribute-task-execution)
- [Learn more how to setup CI](https://nx.dev/recipes/ci)
### Connect with us!
- [Join the community](https://nx.dev/community)
- [Subscribe to the Nx Youtube Channel](https://www.youtube.com/@nxdevtools)
- [Follow us on Twitter](https://twitter.com/nxdevtools)
## Testing
The unit tests run automatically on each GitHub PR (see [test.yml](/.github/workflows/test.yml)).
To run all TS unit tests:
```bash
nx run-many -t test
```
To run all TS unit tests for a single package (in this example the **shared** package):
```bash
nx test shared
```
To run all TS unit tests watching for file changes:
- On Windows:
```bash
nx watch --all -- nx test %NX_PROJECT_NAME%
```
- On Linux or macOS:
```bash
nx watch --all -- nx test \$NX_PROJECT_NAME
```
You can also use the [recommended VS Code extensions](/.vscode/extensions.json) to run tests there. This is particularly useful for running individual tests and debugging.
## Formatting, Linting and Typechecking
Formatting happens automatically when you commit. If you use VS Code with this repo's recommended extensions, files will be formatted when you save.
To check TypeScript for readability, maintainability, and functionality errors, and to check a few other files for proper formatting, run the following from the repo root (or just use VS Code with this repo's recommended extensions).
```bash
nx format:check # to check formatting
nx format:write # to fix formatting
nx run-many -t lint # to check linting
nx run-many -t typecheck # to check types
```
## Collaborative Web Development Environment
Thanks to [CodeSandbox](https://codesandbox.io/) for the instant dev environment: https://codesandbox.io/p/github/abelpz/bible-lexical-editor/main