Skip to content

Latest commit

 

History

History
256 lines (178 loc) · 7.7 KB

README.md

File metadata and controls

256 lines (178 loc) · 7.7 KB

Contributors Forks Stargazers Issues MIT License


Logo

Scripture TSV

Library to create and edit TSV resources that pertain to a certain scripture.

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

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.

back to top

Built With

back to top

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

  1. Clone the repo

    git clone https://github.com/unfoldingWord/scripture-tsv.git

NOTE: alternativiely, the repo may be forked.

  1. 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

  1. Edit the App.jsx file to contain whatever code you want to test
  2. Run the Vite sandbox by running: 
    npm run dev

Using & Running Styleguide

  1. To run a local copy of the styleguide, run

    npm run styleguide

  2. To build the styleguide into a folder called styleguide, run

    npm run styleguide:build

Contributing

  1. Create a branch to contain your changes.
  2. Make changes, commit, and push to your branch.
  3. When changes are complete, create Pull Request (PR) and request they be reviewed and merged.

back to top

Usage/Integration

Roadmap

See the open issues for a full list of proposed features (and known issues).

back to top

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.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature-github_username-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

back to top

License

Distributed under the MIT License. See LICENSE for more information.

back to top

Contact

unfoldingWord - @unfoldingWord - [email protected]

Project Link: https://github.com/unfoldingWord/scripture-tsv

back to top

Acknowledgments

back to top