kintsoogi/zip-project

Zip Project

Library to use and export USFM zip files.
View Demo and examples

· Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License

About The Project

Purpose

• Create functionality to open usfm zip files, edit them, and export them to a zip file.

Scope

• The goal of this library is to provide helper functions to open and export zipped usfm files. UI/UX design is minimal as to be kept reusable by in whatever user interface this functionality is used in.

(back to top)

Built With

• React.js

(back to top)

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 library in your app you will need to add it as a dependency with:

npm install zip-project

OR

yarn add zip-project

Also you will need to add the peer dependencies:

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

yarn add @mui/material @mui/styles @mui/icons-material  @mui/styled-engine npm:@mui/styled-engine-sc@latest react react-dom translation-helps-rcl

(back to top)

Usage/Integration

See Styleguidist link for many usage examples.

(back to top)

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. Clone the repo

   git clone https://github.com/kintsoogi/zip-project.git

3. Install NPM packages

   yarn

4. Create your Feature Branch (git checkout -b feature/AmazingFeature)

5. Commit your Changes (git commit -m 'Add some AmazingFeature')

6. Push to the Branch (git push origin feature/AmazingFeature)

7. Open a Pull Request

(back to top)

License

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

(back to top)

zip-project's Issues

Given Usfm data with BookIds, map usfm data to Bible books

• Create list of expected Bible book Id
• Map usfm data to this bookId skeleton list
• Checking to make sure data does not exceed or have duplicates of Bible books

Set BookId From Usfm Data

• Write function to get BookId from Usfm Text
• For each usfm text, get BookId and assign it to a key in the usfm object

Fill in missing Bible books with empty usfm files

• Create list of empty usfm files
• For BookIds missing from zip data, create a usfm object containing empty usfm file data

Export/Download zip file from usfm project data

• Create usfm files out of each usfm object
• Upload these usfm files to a zip and use JSZip to compress
• Export this zip file to a local machine