scripture-tsv
v1.2.0
Published
<div id="top"></div>
Downloads
327
Readme
About The Project
Purpose
- The purpose of this project is to provide an API to interact with TSV data that pertain to certain scripture passages.
Problem
- 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.
Background
- TSV code that existed came from translation-helps-rcl
- 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.
Built With
Getting Started
To get a local copy up and running follow these simple example steps
Prerequisites
Things you need to use the software and how to install them.
npm
npm install npm@latest -g
Installation/First Steps
Clone the repo
git clone https://github.com/unfoldingWord/scripture-tsv.git
NOTE: alternativiely, the repo may be forked.
Install NPM packages
npm install
or
pnpm install
Running the Vite Sandbox
This library has vite installed to use a sandbox for quick development. The vite application will run whatever code is in src/App.jsx
- Edit the
App.jsx
file to contain whatever code you want to test - Run the Vite sandbox by running:
npm run dev
Using & Running Styleguide
To run a local copy of the styleguide, run
npm run styleguide
To build the styleguide into a folder called
styleguide
, runnpm run styleguide:build
Contributing
- Create a branch to contain your changes.
- Make changes, commit, and push to your branch.
- When changes are complete, create Pull Request (PR) and request they be reviewed and merged.
Usage/Integration
Roadmap
See the open issues for a full list of proposed features (and known issues).
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.
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.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature-github_username-AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
License
Distributed under the MIT License. See LICENSE for more information.
Contact
unfoldingWord - @unfoldingWord - [email protected]
Project Link: https://github.com/unfoldingWord/scripture-tsv