friendsofagape / autographa Goto Github PK

• Basic DB setup with refernceDB, translationDB and lookupsDB

files need to be added are : data_provider.js and Db_util

• Adding preloaded reference bibles (JSON) & also verify, ref_config and add bible Silhouette
• Update App.js File with db Setup on mount except react-intl and call the higher order component such as NavBar.js
• Create a Refernce directroy and make core function with all the setup for reference content(refer nav bar for refercence content db update and design of html content)

files need to be added:
reference/core/setup
AutographaStore.js

• File Manager Component contains Autographa Projects with drag and drop fn(can be a rcl)
• Custom Login Comp: Used for cloud auth (paratext)

Menu with list of:

• browse resources from local system (scripture burritos integration)
• Reference resource list eg: translation helps
• Search for respective resources

• Component to display user images or logos in customized way

A menu component to display recent activity and updated or download progress etc

Component to export the contents from autographa (HTML, USFM, PDF etc.)

• Components that contain project list with
• Starred
• Search
• Sort
• Edit
• delete
• Ability to fetch data for Website and electron
• Online _Parse server
• Offline_FileSystem
• It can have another modes field to differentiate projects(audio, mt, editor etc.)

• Create Independent component such as About, Loader Component, Search, Report Comp with props

files: About.js, Loader.js, Search.js
Report/ImportReport.js

• Create a Joint verse context menu as an independent component with functionality that connects to translation panel through storeContext.

file: JointVerse.js

• Create ReferenceSettinngTab and ReferenceImport and connect to usfm_to_Json with all db update functionality and file reading. And also connect the same to Setting icon as a tab container.

files: ReferenceSettinngTab, ReferenceImport

• Connect both the Import with ImportReport Component by passing props or useContext

• Drag and Drop from AG to Gitea.
• Drag and Drop from Gitea to AG.
• Tabs: Receives different cloud servers
• Custom listing tabs: Contains an independant custom listing tabs that is accessed by each cloud server for file selection

Functional components to receive MD raw file as per the usage and converts

Custom Cards are collapsible cards with custom set of menu for

• Custom Card
• USFM editor component
• Customize the menu, buttons and functions (eg: scroll lock, full screen) based on reference cards or editor cards(usfm editor)

The functional component receives props list and searches value

Implement Test

As the components are being developed and evolve, write the unit tests for the components with the updated UI.

Components contains set of sub components like:

• Font selector
• Font styling
• Font size selector

A tab is required in the electron app to select the offline or online login on the Login page.

Implement Signup page with the new UI. The details are for now only stored locally.

Integrating Translation-helps, bible reference and workspace RCL inside Autographa with necessary UI/UX changes.

• Composable Dialog that can receive any set of component, menu, classes etc

Implement the projects listing tab based on the new UI.

Setup top and side bar components and related code for Autographa.

• Create Footer Component with layout functionality and font slider and save translation function

file: Footer.js

• Create Download Component with all supp component(usfm export, 1col html, 2colhtml) and its supporting core files like Json to html and its design

USFM, 1-HTML, 2-HTML, Export Html, Export CSS etc

• Adding sync feature with corresponding helper files and UI
  • Paratext sync
  • Gitea component

Implement the new UI and the components required in the login page. Focus on offline mode of functioning now.

Add tests for all components as well as utility functions using Jest and Enzyme.

List of link for tutorial video and user manual

Phase 2

Implementation the new UI/UX

• Custom Menu tabs with definite tabs and its content varies with modes and cards

Modes: Each modes will have its own new project component passed inside Create New Project

• Online: Create New Project component should have a mode selection(Agmt/audio). Store: Inside vachanDB(projects details and file URL) and parse server (files with burrito meta)
• Offline: Create New Project component should have a mode selection. Store: Inside filesystem with burrito meta

• Create a setup to run autographa on the web browsers without modifying electron setup

1. Functional Component of the list which takes a set of metadata of list from file or any storage
2. It can be used with multiple props value for different scenarios
   (eg: starred and unstarred, sorting, a simple list of filenames or books inside finder, etc.)
3. should be capable of editing and deleting the list items

Implement profile details tab based on the new UI.

• Should receive a set of title and body props (list or can be component itself)
• Usage in multiple places as (custom language, custom license, custom canon specs, etc)

• Bookmark specific books and chapter
• Display all bookmarks on slider tab from a menu button

A component which receives short notification or status passed.

USFM file operation on parse for editor, backup of online versions, sync etc

• Create or upload multiple files on parse server with relation to users or projects
• fetch those files and display on editor page
• Backup the updated files on parse (eg: autosave)

1. It can be a hook useValidator which takes in the multiple field values and validates based on required criteria.
2. Returns success, errors, and warnings

Setup the basic Electron application setup with clean lint and build passing (also no Craco). This includes auto-update.

• Create Translation Component by setting up core DB setup and update

Files: core/setup.js

• Create an editable Translation Panel with the UI and basic fuctionality (highlighting)

File: TranslationPanel.js

• Create Statistic Componet that links to Translation panel with props or StoreContext

file: Statistics.js

• Make a translation settings and translation Import Component and connect it with usfm_to_json file with all the functionality for import and display and also connect with settings icon in the appBar and tabs of material

files: TranslationSettings.js, TranslationImport, USFM to JSON etc..

Consist of simple search with autocomplete with replace component and can be placed and displayed inside a custom pinned card or drawer

Note: Entire book or bible search needs some sort of saving or API search

Component with set of menu categories, list of common question and solutions. Logger file will be attached for a bug report.

Implement the new UI based create new project pane

Component for listing projects in the project listing page, Profile Page, and new projects components in Autographa.

A dialog contains autographa license, version etc

In the evolution of any code base there comes a time when it is time to pay off technical debt. For Autogrpaha this is the 2nd refactor with the newer React features and cleaner UI framework.

• Online: Component to save user data from parse server and password change/reset done through Kratos
• Offline: Component fetch values from FileSystem/LocalForage

Book reference RCL with context API

• Finding out common fns and keeping them as actions inside context

• Create Common settings file to call all the sub-components correspondingly

• Reference management list tab

• LTR and RTL of translation panel along with app Langauge change

• Auto Backup functionality

• Diff Count display

• Get Linter to pass

• Fix issue with navigation when we select same chapter of other books

• Update bookname translation on save

Basic search component and also has the capability for advanced search

• Connect the componets with corresponding icons and call accordingly each componets in navbar
• Add component booknameEditor, BookChapterNavigator with all corresponding functionality and also diff checker component

file: BookChapterNavigator.js, DiffChecker, BookNameEditor

• Create and add translation Help component with language selector
• Making app language Component and pass ID and props for all the translations and update parent app.js file accordingly

• Create a refernce panel with material UI makestyles and paper

file: ReferencePanel.JS

• Create a refernceSelector with menulist using materialUI and functionality to change reference accordingly

file: ReferenceSelector.js

• Make an navBar (AppBar) using materialUI with all the icons placed exactly as the previous UI.