-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit e656098
Showing
55 changed files
with
144,497 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
# See http://help.github.com/ignore-files/ for more about ignoring files. | ||
|
||
# compiled output | ||
dist | ||
tmp | ||
/out-tsc | ||
|
||
# dependencies | ||
node_modules | ||
|
||
# IDEs and editors | ||
/.idea | ||
.project | ||
.classpath | ||
.c9/ | ||
*.launch | ||
.settings/ | ||
*.sublime-workspace | ||
|
||
# IDE - VSCode | ||
.vscode/* | ||
!.vscode/settings.json | ||
!.vscode/tasks.json | ||
!.vscode/launch.json | ||
!.vscode/extensions.json | ||
|
||
# misc | ||
/.sass-cache | ||
/connect.lock | ||
/coverage | ||
/libpeerconnection.log | ||
npm-debug.log | ||
yarn-error.log | ||
testem.log | ||
/typings | ||
.yarn | ||
|
||
# System Files | ||
.DS_Store | ||
Thumbs.db |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
# Add files here to ignore them from prettier formatting | ||
|
||
/dist | ||
/coverage |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
{ | ||
"singleQuote": true | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
{ | ||
"recommendations": [ | ||
|
||
"nrwl.angular-console", | ||
"esbenp.prettier-vscode" | ||
] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
# HtmlUsfmEditor | ||
|
||
<a alt="Nx logo" href="https://nx.dev" target="_blank" rel="noreferrer"><img src="https://raw.githubusercontent.com/nrwl/nx/master/images/nx-logo.png" width="45"></a> | ||
|
||
✨ **This workspace has been generated by [Nx, a Smart, fast and extensible build system.](https://nx.dev)** ✨ | ||
|
||
## Understand this workspace | ||
|
||
Run `nx graph` to see a diagram of the dependencies of the projects. | ||
|
||
## Remote caching | ||
|
||
Run `npx nx connect-to-nx-cloud` to enable [remote caching](https://nx.app) and make CI faster. | ||
|
||
## Further help | ||
|
||
Visit the [Nx Documentation](https://nx.dev) to learn more. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
{ | ||
"extends": "nx/presets/npm.json", | ||
"$schema": "./node_modules/nx/schemas/nx-schema.json", | ||
"tasksRunnerOptions": { | ||
"default": { | ||
"runner": "@nrwl/nx-cloud", | ||
"options": { | ||
"cacheableOperations": [ | ||
"start", | ||
"build-dev", | ||
"build", | ||
"test", | ||
"prepublishOnly" | ||
], | ||
"accessToken": "ODNiMjM3NTQtZDQyYy00YmQ3LWI3OTktNDhkM2U0NDMzNDlmfHJlYWQtd3JpdGU=" | ||
} | ||
} | ||
}, | ||
"targetDefaults": { | ||
"build": { | ||
"dependsOn": [ | ||
"^build" | ||
] | ||
}, | ||
"start": { | ||
"dependsOn": [ | ||
"^build" | ||
] | ||
}, | ||
"build-dev": { | ||
"dependsOn": [ | ||
"^build" | ||
] | ||
} | ||
}, | ||
"affected": { | ||
"defaultBase": "master" | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
{ | ||
"name": "html-usfm-editor", | ||
"version": "0.0.0", | ||
"license": "MIT", | ||
"private": true, | ||
"devDependencies": { | ||
"@babel/cli": "^7.17.10", | ||
"@babel/core": "^7.17.10", | ||
"@babel/runtime": "7.13.8", | ||
"@nrwl/nx-cloud": "latest", | ||
"@testing-library/jest-dom": "^5.11.4", | ||
"@testing-library/react": "^11.1.0", | ||
"@testing-library/user-event": "^12.1.10", | ||
"babel-loader": "^8.2.2", | ||
"eslint": "^7.32.0", | ||
"eslint-config-prettier": "^8.4.0", | ||
"eslint-plugin-import": "^2.26.0", | ||
"eslint-plugin-jest": "^26.1.5", | ||
"eslint-plugin-prettier": "^4.0.0", | ||
"eslint-plugin-react": "^7.30.1", | ||
"eslint-plugin-react-hooks": "^4.2.0", | ||
"eslint-plugin-test-selectors": "^2.0.3", | ||
"nx": "15.7.0", | ||
"prettier": "^2.6.2", | ||
"react-docgen": "^5.4.3", | ||
"react-scripts": "^5.0.1", | ||
"react-styleguidist": "^13.0.0" | ||
}, | ||
"workspaces": [ | ||
"packages/*" | ||
] | ||
} |
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
MIT License | ||
|
||
Copyright (c) 2020 unfoldingWord | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,184 @@ | ||
<div id="top"></div> | ||
|
||
|
||
<!-- PROJECT SHIELDS --> | ||
<!-- | ||
*** I'm using markdown "reference style" links for readability. | ||
*** Reference links are enclosed in brackets [ ] instead of parentheses ( ). | ||
*** See the bottom of this document for the declaration of the reference variables | ||
*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use. | ||
*** https://www.markdownguide.org/basic-syntax/#reference-style-links | ||
--> | ||
[![Contributors][contributors-shield]](https://github.com/unfoldingWord/uw-editor/graphs/contributors) | ||
[![Forks][forks-shield]](https://github.com/unfoldingWord/uw-editor/network/members) | ||
[![Stargazers][stars-shield]](https://github.com/unfoldingWord/uw-editor/stargazers) | ||
[![Issues][issues-shield]](https://github.com/unfoldingWord/uw-editor/issues) | ||
[![MIT License][license-shield]](https://github.com/unfoldingWord/uw-editor/blob/main/LICENSE) | ||
[![LinkedIn][linkedin-shield]](https://www.linkedin.com/company/unfoldingword/) | ||
|
||
|
||
|
||
<!-- PROJECT LOGO --> | ||
<br /> | ||
<div align="center"> | ||
<a href="https://uw-editor.netlify.app/"> | ||
<img src="images/uW.png" alt="Logo" width="300" height="50"> | ||
</a> | ||
|
||
<h3 align="center">uW Editor</h3> | ||
|
||
<p align="center"> | ||
A reusable biblical text editor | ||
<br /> | ||
<a href="https://uw-editor.netlify.app/"><strong>View Demo and examples</strong></a> | ||
<br /> | ||
<br /> | ||
· | ||
<a href="https://github.com/unfoldingWord/uw-editor/issues">Report Bug</a> | ||
· | ||
<a href="https://github.com/unfoldingWord/uw-editor/issues">Request Feature</a> | ||
</p> | ||
</div> | ||
|
||
|
||
|
||
<!-- TABLE OF CONTENTS --> | ||
<details> | ||
<summary>Table of Contents</summary> | ||
<ol> | ||
<li> | ||
<a href="#about-the-project">About The Project</a> | ||
<ul> | ||
<li><a href="#built-with">Built With</a></li> | ||
</ul> | ||
</li> | ||
<li> | ||
<a href="#getting-started">Getting Started</a> | ||
<ul> | ||
<li><a href="#installation">Installation</a></li> | ||
</ul> | ||
</li> | ||
<li><a href="#usage">Usage</a></li> | ||
<li><a href="#roadmap">Roadmap</a></li> | ||
<li><a href="#contributing">Contributing</a></li> | ||
<li><a href="#license">License</a></li> | ||
</ol> | ||
</details> | ||
|
||
|
||
|
||
<!-- ABOUT THE PROJECT --> | ||
## About The Project | ||
|
||
![Product Name Screen Shot](./images/screenshot.png) | ||
|
||
|
||
**Purpose** | ||
- Create a re-usable editor component that can be integrated into application to support editing scripture text in USFM format. | ||
|
||
**Scope** | ||
- Mostly this is a wrapper for the [XELAH](https://github.com/xelahjs/xelah) text editor. uW editor is mostly responsible for the UI, toolbar, etc and XELAH supplies the text editor. | ||
|
||
<p align="right">(<a href="#top">back to top</a>)</p> | ||
|
||
|
||
|
||
### Built With | ||
|
||
* [React.js](https://reactjs.org/) | ||
|
||
<p align="right">(<a href="#top">back to top</a>)</p> | ||
|
||
|
||
|
||
<!-- GETTING STARTED --> | ||
## Getting Started | ||
|
||
This is an example of how you may give instructions on setting up your project locally. | ||
To get a local copy up and running follow these simple example steps. | ||
|
||
|
||
### Installation/First Steps | ||
|
||
If you wish to use this editor in your app you will need to add it as a dependency with: | ||
```sh | ||
npm install uw-editor | ||
``` | ||
OR | ||
```shell | ||
yarn add uw-editor | ||
``` | ||
Also you will need to add the peer dependencies: | ||
```shell | ||
npm install @mui/material @mui/styles @mui/icons-material @mui/styled-engine npm:@mui/styled-engine-sc@latest react react-dom translation-helps-rcl | ||
``` | ||
OR | ||
```shell | ||
yarn add @mui/material @mui/styles @mui/icons-material @mui/styled-engine npm:@mui/styled-engine-sc@latest react react-dom translation-helps-rcl | ||
``` | ||
<p align="right">(<a href="#top">back to top</a>)</p> | ||
|
||
<!-- USAGE EXAMPLES --> | ||
## Usage/Integration | ||
|
||
See [Styleguidist link](https://uw-editor.netlify.app/) for many usage examples. | ||
|
||
<p align="right">(<a href="#top">back to top</a>)</p> | ||
|
||
<!-- ROADMAP --> | ||
## Roadmap | ||
|
||
See the [open issues](https://github.com/unfoldingWord/uw-editor/issues) for a full list of proposed features (and known issues). | ||
|
||
<p align="right">(<a href="#top">back to top</a>)</p> | ||
|
||
<!-- CONTRIBUTING --> | ||
## Contributing | ||
|
||
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**. [Guidelines for external contributions.](https://forum.door43.org) | ||
|
||
You can also simply open an issue with the tag "enhancement". | ||
Don't forget to give the project a star! Thanks again! | ||
|
||
If you would like to fork the repo and create a pull request. | ||
|
||
1. Fork the Project | ||
2. Clone the repo | ||
```sh | ||
git clone https://github.com/unfoldingWord/uw-editor.git | ||
``` | ||
3. Install NPM packages | ||
```sh | ||
yarn | ||
``` | ||
|
||
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`) | ||
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`) | ||
4. Push to the Branch (`git push origin feature/AmazingFeature`) | ||
5. Open a Pull Request | ||
|
||
<p align="right">(<a href="#top">back to top</a>)</p> | ||
|
||
<!-- LICENSE --> | ||
## License | ||
|
||
Distributed under the MIT License. See `LICENSE` for more information. | ||
|
||
<p align="right">(<a href="#top">back to top</a>)</p> | ||
|
||
|
||
<!-- MARKDOWN LINKS & IMAGES --> | ||
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links --> | ||
[contributors-shield]: https://img.shields.io/github/contributors/unfoldingWord/uw-editor.svg?style=for-the-badge | ||
[contributors-url]: https://github.com/unfoldingWord/uw-editor/graphs/contributors | ||
[forks-shield]: https://img.shields.io/github/forks/unfoldingWord/uw-editor.svg?style=for-the-badge | ||
[forks-url]: https://github.com/unfoldingWord/uw-editor/network/members | ||
[stars-shield]: https://img.shields.io/github/stars/unfoldingWord/uw-editor.svg?style=for-the-badge | ||
[stars-url]: https://github.com/unfoldingWord/uw-editor/stargazers | ||
[issues-shield]: https://img.shields.io/github/issues/unfoldingWord/uw-editor.svg?style=for-the-badge | ||
[issues-url]: https://github.com/unfoldingWord/uw-editor/issues | ||
[license-shield]: https://img.shields.io/github/license/unfoldingWord/uw-editor.svg?style=for-the-badge | ||
[license-url]: https://github.com/unfoldingWord/uw-editor/blob/master/LICENSE.txt | ||
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555 | ||
[linkedin-url]: https://linkedin.com/in/linkedin_username | ||
[product-screenshot]: images/screenshot.png |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
{ | ||
"presets": [ | ||
"@babel/env", | ||
"@babel/react" | ||
], | ||
"plugins": [ | ||
"@babel/plugin-proposal-nullish-coalescing-operator", | ||
"@babel/plugin-proposal-object-rest-spread", | ||
"@babel/plugin-proposal-optional-chaining", | ||
"@babel/plugin-syntax-logical-assignment-operators" | ||
] | ||
} |
Oops, something went wrong.