friendsofagape / autographa-roadmap Goto Github PK

Sprint 4 - Project Details View

• Book drop Down
• Token Panel
• Menu Bar
• Sources Reference Panel

Sprint 5 - Project Details View

• Token Edit
• Project Status Bar
• Occurrences Panel
• Translation Word Panel
• Integrate Book/Chapter drop down

Sprint 6 - Project Details View & Draft Page

• Project View Menu
• Draft Container
• Draft Menu Bar
• Draft view panel
• Print Draft Button

Sprint 7 & 8 - Release of 2nd Milestone

• Testing of the Project Details View and Draft Page

Release of 2nd Milestone by end of sprint 8

Reference Links:
Github-Zenhub: https://github.com/Bridgeconn/autographa-mt#zenhub
AgMT Components Breakup Figma

Sync (Cloud storage) - ProjectsPage

• 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

Navigation -HomePage

• Book reference rcl with context API

Custom modals - HomePage

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

Avatar - HomePage

• Component to display user images or logos in customized way

CRUD operation of File using Parse Server
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)

Text Formatter - HomePage
Components contains set of sub components like

• Font selector
• Font styling
• Font size selector

Search - HomePage

• 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

Print Or Export - HomePage

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

Notification - HomePage

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

Snackbars - HomePage

• A component which receives short notification or status passed

Sprint 1 - Learning

• Learn RCL's, ES6, Context API

Sprint 2 - Project List and Details View

• Start with Base project
• Project table/List View
• Project Details New/Edit Page

Sprint 3 - Project List and Details View

• Left Menu and Page Container
• Set up linting on commit or PR and on save file(vsconfig)
• Top bar
• Project Table Complete
• Project Details Page Complete

Sprint 4 - Release 1st Milestone

• Setup auto deploy on commit to Netlify for Testing
• Testing of the Project List and Details View

Release of 1st Milestone by end of sprint 4

Reference Links:
Github-Zenhub: https://github.com/Bridgeconn/autographa-mt#zenhub
AgMT Components Breakup Figma

Sync

• File Manager Component contains Autographa Projects with drag and drop function (Can be a RCL)
• Custom Login Comp: Used for Cloud Auth (Paratext)

Unit Tests

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

Ability to save projects file on user specified path
Allow user to select the path for saving the project hence making migration more seamlessly

• UI and placement of file selection and path display
• Functionality to save projects and project.meta on the specified location

Cards for reference and editor - HomePage
Custom Cards are collapsible cards with custom set of menu and functions for

• Translation helps RCL
• USFM editor component
• Vachan API based resources and its config
• Customize the menu, buttons and functions (Eg: scroll lock, full screen) based on reference cards or editor cards

Menu - HomePage

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

Select Resource - HomePage
Menu with list of:

• Reference resource list (commentary, maps, translation helps etc)
• File manager to browse resources from API's or local system explorer
• Search for respective resources

Comments, bookmarks - HomePage

• A Component with custom dialog or card with set of corresponding functionalities

Project Page with UI 2.0
Integrate Functionality for the following modules with the NewUI

• Sync
• ProjectList
• Search
• Profile
• BookChapterNavigation
• NewProject

USFM Editor Component

• Basic Usfm editor integration
• Linking Editor with Reference resources and navigation element
• Read and write with filesystem (projects directory)
• Fetch from parse server and update localforage
• Update locally stored data to parse server
• Implementation of Chapter-based editor navigation

Component & Unit Testing
Write the tests for the following components with New UI2.0 using jest, RTL.

• Sign Up and Login
• Profile
• ProjectsList
• Search
• NewProject
• Sync

Authentication Page

• Login (CustomLogin is a reusable component)
  Online: Login will be a component for the entire application, using Kratos for authentication
  Offline: Login will be component for entire application and creates a sessionID using JWT and stores inside indexedDB through localforage. Login page will used as sign up method.
• SignUp
  Online: Component and validation with authentication using Kratos and stores user data will be stored inside Vachan DB.

Projects Page

• Profile
  Online: Component to save user data from parse server and password change/reset done through Kratos
  Offline: Component fetch values from FileSystem/LocalForage
• Create New Project (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
• Projects
  Components that contains project list with edit, delete, starred, search and sort . It can have another modes field to differentiate projects(Audio, MT, Editor etc.)