{"id":25622614,"url":"https://github.com/unfoldingword/scripture-tsv","last_synced_at":"2025-02-22T10:19:59.001Z","repository":{"id":183820233,"uuid":"667953646","full_name":"unfoldingWord/scripture-tsv","owner":"unfoldingWord","description":"Library for adding, editing, and removing TSV rows","archived":false,"fork":false,"pushed_at":"2024-05-08T19:09:17.000Z","size":324,"stargazers_count":0,"open_issues_count":2,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-08-10T21:15:38.682Z","etag":null,"topics":["scripture-open-components"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/unfoldingWord.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-07-18T17:13:41.000Z","updated_at":"2024-05-07T12:40:37.000Z","dependencies_parsed_at":"2023-07-25T23:43:07.455Z","dependency_job_id":"491c4b8e-6109-4903-8cb7-071656682b81","html_url":"https://github.com/unfoldingWord/scripture-tsv","commit_stats":null,"previous_names":["unfoldingword/scripture-tsv"],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/unfoldingWord%2Fscripture-tsv","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/unfoldingWord%2Fscripture-tsv/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/unfoldingWord%2Fscripture-tsv/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/unfoldingWord%2Fscripture-tsv/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/unfoldingWord","download_url":"https://codeload.github.com/unfoldingWord/scripture-tsv/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240157810,"owners_count":19757032,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["scripture-open-components"],"created_at":"2025-02-22T10:19:58.498Z","updated_at":"2025-02-22T10:19:58.992Z","avatar_url":"https://github.com/unfoldingWord.png","language":"TypeScript","readme":"\u003cdiv id=\"top\"\u003e\u003c/div\u003e\n\n\u003c!-- PROJECT SHIELDS --\u003e\n\u003c!--\n*** I'm using markdown \"reference style\" links for readability.\n*** Reference links are enclosed in brackets [ ] instead of parentheses ( ).\n*** See the bottom of this document for the declaration of the reference variables\n*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.\n*** https://www.markdownguide.org/basic-syntax/#reference-style-links\n--\u003e\n\n[![Contributors][contributors-shield]][contributors-url]\n[![Forks][forks-shield]][forks-url]\n[![Stargazers][stars-shield]][stars-url]\n[![Issues][issues-shield]][issues-url]\n[![MIT License][license-shield]][license-url]\n\n\u003c!-- PROJECT LOGO --\u003e\n\u003cbr /\u003e\n\u003cdiv align=\"center\"\u003e\n  \u003ca href=\"https://github.com/unfoldingword/next-js-template/public/uwLogo.png\"\u003e\n    \u003cimg src=\"images/logo.png\" alt=\"Logo\" width=\"80\" height=\"80\"\u003e\n  \u003c/a\u003e\n\n\u003ch3 align=\"center\"\u003eScripture TSV\u003c/h3\u003e\n  \u003c!-- TODO: Implement links to styleguide --\u003e\n  \u003cp align=\"center\"\u003e\n    Library to create and edit TSV resources that pertain to a certain scripture. \n    \u003c!-- \u003cbr /\u003e\n    \u003ca href=\"https://github.com/unfoldingWord-box3/next-js-template\"\u003e\u003cstrong\u003eExplore the docs »\u003c/strong\u003e\u003c/a\u003e\n    \u003cbr /\u003e\n    \u003cbr /\u003e\n    \u003ca href=\"https://github.com/unfoldingWord-box3/next-js-template\"\u003eView Demo\u003c/a\u003e\n    ·\n    \u003ca href=\"https://github.com/unfoldingWord/scripture-tsv/issues\"\u003eReport Bug\u003c/a\u003e\n    ·\n    \u003ca href=\"https://github.com/unfoldingWord/scripture-tsv/issues\"\u003eRequest Feature\u003c/a\u003e --\u003e\n  \u003c/p\u003e \n\u003c/div\u003e\n\n\u003c!-- TABLE OF CONTENTS --\u003e\n\u003cdetails\u003e\n  \u003csummary\u003eTable of Contents\u003c/summary\u003e\n  \u003col\u003e\n    \u003cli\u003e\n      \u003ca href=\"#about-the-project\"\u003eAbout The Project\u003c/a\u003e\n      \u003cul\u003e\n        \u003cli\u003e\u003ca href=\"#built-with\"\u003eBuilt With\u003c/a\u003e\u003c/li\u003e\n      \u003c/ul\u003e\n    \u003c/li\u003e\n    \u003cli\u003e\n      \u003ca href=\"#getting-started\"\u003eGetting Started\u003c/a\u003e\n      \u003cul\u003e\n        \u003cli\u003e\u003ca href=\"#prerequisites\"\u003ePrerequisites\u003c/a\u003e\u003c/li\u003e\n        \u003cli\u003e\u003ca href=\"#installation\"\u003eInstallation\u003c/a\u003e\u003c/li\u003e\n      \u003c/ul\u003e\n    \u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#usage\"\u003eUsage\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#roadmap\"\u003eRoadmap\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#contributing\"\u003eContributing\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#license\"\u003eLicense\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#contact\"\u003eContact\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#acknowledgments\"\u003eAcknowledgments\u003c/a\u003e\u003c/li\u003e\n  \u003c/ol\u003e\n\u003c/details\u003e\n\n\u003c!-- ABOUT THE PROJECT --\u003e\n\n## About The Project\n\n\u003c!-- TODO: Input screenshot? --\u003e\n\u003c!-- [![Product Name Screen Shot][product-screenshot]](https://example.com) --\u003e\n\n**Purpose**\n\n- The purpose of this project is to provide an API to interact with TSV data that pertain to certain scripture passages.\n\n**Problem**\n\n- TSV resources within our applications did not have the ability to add another TSV row. Users had the ability to see existing TSV items (Existing translation notes, translation words, etc.), but did not have the ability to add/delete/move them as needed.\n\n**Background**\n\n- TSV code that existed came from translation-helps-rcl\n- There was a function within THelps to create a TSVs object state and then to edit a TSV item. However, there was no functionality to add, delete, or move a TSV item.\n\n\u003cp align=\"right\"\u003e\u003ca href=\"#top\"\u003eback to top\u003c/a\u003e\u003c/p\u003e\n\n### Built With\n\n- [React.js](https://reactjs.org/)\n- [Material UI](https://mui.com/material-ui/)\n- [Vite](https://vitejs.dev/)\n- [React Styleguidist](https://react-styleguidist.js.org/)\n\n\u003cp align=\"right\"\u003e\u003ca href=\"#top\"\u003eback to top\u003c/a\u003e\u003c/p\u003e\n\n\u003c!-- GETTING STARTED --\u003e\n\n## Getting Started\n\nTo get a local copy up and running follow these simple example steps\n\n### Prerequisites\n\nThings you need to use the software and how to install them.\n\n- npm\n\n  ```sh\n  npm install npm@latest -g\n  ```\n\n### Installation/First Steps\n\n1. Clone the repo\n\n   ```sh\n   git clone https://github.com/unfoldingWord/scripture-tsv.git\n   ```\n\n\u003e NOTE: alternativiely, the repo may be forked.\n\n2. Install NPM packages\n\n   ```sh\n   npm install\n   ```\n\n   or\n\n   ```sh\n   pnpm install\n   ```\n\n### Running the Vite Sandbox\n\nThis library has vite installed to use a sandbox for quick development. The vite application will run whatever code is in `src/App.jsx`\n\n1. Edit the `App.jsx` file to contain whatever code you want to test\n2. Run the Vite sandbox by running:\n   ```sh\n   npm run dev\n   ```\n\n### Using \u0026 Running Styleguide\n\n1. To run a local copy of the styleguide, run\n\n   ```sh\n   npm run styleguide\n   ```\n\n2. To build the styleguide into a folder called `styleguide`, run\n\n   ```js\n   npm run styleguide:build\n   ```\n\n### Contributing\n\n1. Create a branch to contain your changes.\n2. Make changes, commit, and push to your branch.\n3. When changes are complete, create Pull Request (PR) and request they be reviewed and merged.\n\n\u003cp align=\"right\"\u003e\u003ca href=\"#top\"\u003eback to top\u003c/a\u003e\u003c/p\u003e\n\n\u003c!-- USAGE EXAMPLES --\u003e\n\n## Usage/Integration\n\n\u003c!-- ## Using the Tutorials\n\nTBD... here point to one or more tutorials showing how to use the template to actually develop something useful...\n\nPotential Ideas:\n\n- Using the Bible Reference RCL with Proskomma\n- Using the Translation Helps RCL to display content\n\n\u003cp align=\"right\"\u003e\u003ca href=\"#top\"\u003eback to top\u003c/a\u003e\u003c/p\u003e --\u003e\n\n\u003c!-- ROADMAP --\u003e\n\n## Roadmap\n\n\u003c!-- - [ ] POC\n- [ ] Prototype\n- [ ] MVP --\u003e\n\nSee the [open issues](https://github.com/unfoldingWord/scripture-tsv/issues) for a full list of proposed features (and known issues).\n\n\u003cp align=\"right\"\u003e\u003ca href=\"#top\"\u003eback to top\u003c/a\u003e\u003c/p\u003e\n\n\u003c!-- CONTRIBUTING --\u003e\n\n## Contributing\n\nContributions 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)\n\nYou can also simply open an issue with the tag \"enhancement\".\nDon't forget to give the project a star! Thanks again!\n\nIf you would like to fork the repo and create a pull request.\n\n1. Fork the Project\n2. Create your Feature Branch (`git checkout -b feature-github_username-AmazingFeature`)\n3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)\n4. Push to the Branch (`git push origin feature/AmazingFeature`)\n5. Open a Pull Request\n\n\u003cp align=\"right\"\u003e\u003ca href=\"#top\"\u003eback to top\u003c/a\u003e\u003c/p\u003e\n\n\u003c!-- LICENSE --\u003e\n\n## License\n\nDistributed under the MIT License. See [LICENSE](LICENSE) for more information.\n\n\u003cp align=\"right\"\u003e\u003ca href=\"#top\"\u003eback to top\u003c/a\u003e\u003c/p\u003e\n\n\u003c!-- CONTACT --\u003e\n\n## Contact\n\nunfoldingWord - [@unfoldingWord](https://twitter.com/unfoldingWord) - info@unfoldingWord.org\n\nProject Link: [https://github.com/unfoldingWord/scripture-tsv](https://github.com/unfoldingWord/scripture-tsv)\n\n\u003cp align=\"right\"\u003e\u003ca href=\"#top\"\u003eback to top\u003c/a\u003e\u003c/p\u003e\n\n\u003c!-- ACKNOWLEDGMENTS --\u003e\n\n## Acknowledgments\n\n\u003c!-- - []()\n- []()\n- []() --\u003e\n\n\u003cp align=\"right\"\u003e\u003ca href=\"#top\"\u003eback to top\u003c/a\u003e\u003c/p\u003e\n\n\u003c!-- MARKDOWN LINKS \u0026 IMAGES --\u003e\n\u003c!-- https://www.markdownguide.org/basic-syntax/#reference-style-links --\u003e\n\n[contributors-shield]: https://img.shields.io/github/contributors/unfoldingWord-box3/next-js-template.svg?style=for-the-badge\n[contributors-url]: https://github.com/unfoldingWord/scripture-tsv/graphs/contributors\n[forks-shield]: https://img.shields.io/github/forks/unfoldingWord-box3/next-js-template.svg?style=for-the-badge\n[forks-url]: https://github.com/unfoldingWord/scripture-tsv/network/members\n[stars-shield]: https://img.shields.io/github/stars/unfoldingWord-box3/next-js-template.svg?style=for-the-badge\n[stars-url]: https://github.com/unfoldingWord/scripture-tsv/stargazers\n[issues-shield]: https://img.shields.io/github/issues/unfoldingWord-box3/next-js-template.svg?style=for-the-badge\n[issues-url]: https://github.com/unfoldingWord/scripture-tsv/issues\n[license-shield]: https://img.shields.io/github/license/unfoldingWord-box3/next-js-template.svg?style=for-the-badge\n[license-url]: https://github.com/unfoldingWord/scripture-tsv/blob/master/LICENSE\n[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge\u0026logo=linkedin\u0026colorB=555\n[product-screenshot]: images/screenshot.png\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Funfoldingword%2Fscripture-tsv","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Funfoldingword%2Fscripture-tsv","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Funfoldingword%2Fscripture-tsv/lists"}