Translate into technical documentation so a developer can understand this and know what…
- User
Translate into technical documentation so a developer can understand this and know what and how to build this also include suggestions: using free and open source resources, objective:
I want to create an advanced and feature rich multi device useable browser app, that is a shared contact directory of family friends, family members, family businesses owners, private family member association, women family volunteers for Family matters. Family planning teams, family lineage connection, etc the app should capture relevant data. have a splash screen, password protected login screen, a self-serve registration screen where the user can pick their login password for the app, administrator login, the administrator username and password are different than the regular user password and username, this app should be able to support multiple users at the same time using a synchronism, to keep the cost low on this app no server should be required, this app should fully work off of JavaScript that is able to be ran from a browser, this app should have a built-in JavaScript database, this app should have encrypted capability powered by JavaScript, browser application will be stored in a cloud space such as Google drive, yep she provide the ability to generate various family reports, create various documents related to Family matters, estate planning matters, been trust related matters, etc. the app should also have the ability to convert data to a open source spreadsheet format, open source ,
other elements of the app:
forms, buttons, search, export data, upload data,
additional features:
no duplicate data, display up and coming birthdays, anniversaries, accomplishments, promotions,
have a separate menu called aid or help request, allow all members to view help and aid requests allow all members to post help in a request allow all members to respond to help innate quest all help and aid requests will be in this area for 60 days then automatically become categorized by the age of the posting then deleted after 90 days
allow photos to be loaded via social media such as primarily LinkedIn, Facebook, tiktok
use available on the web emojis for buttons such as save State use a hard disk, upload use Network emoji,
when a button is hovered over from a desktop computer or hard pressed by a mobile device such as Android or iPhone include tips on what happens if this button is pressed
allow a modal popup to be displayed when an action is performed such as deleting a contact " are you sure you want to perform this action?" after the user selects yes perform the action close the motor box and go back to the screen refresh, if the user hits no cancel the action the modal popup goes away,
- Assistant
Technical Documentation for Family Contact Directory Web Application
Objective
Develop an advanced, feature-rich browser application serving as a shared contact directory for family and friends, including features that cater to family matters, lineage connections, and volunteer activities.
Technical Requirements
Technology Stack
- Frontend Language: JavaScript, HTML5, CSS3
- Database: Browser-based (e.g., IndexedDB or LocalStorage)
- File Storage: Google Drive API for cloud storage (optional)
- Frameworks: Consider using free and open-source frameworks (e.g., React, Vue.js, or Angular) for efficient component management.
Key Features
-
User Authentication
- Splash Screen: An introductory screen with branding (family logo, app name).
- Login Screen: Password protected with fields for username and password.
- Self-Serve Registration: Allow users to create their own accounts with unique usernames and passwords.
- Admin Panel: Separate login for administrators with distinct credentials.
-
Data Management
- No Duplicate Data: Implement checks to prevent adding duplicate contacts.
- Data CRUD Operations: Users can create, read, update, and delete contacts.
- Search Functionality: Efficient searching through contacts using keywords.
-
Event Tracking
- Display Upcoming Events: Show birthdays, anniversaries, and accomplishments.
- Help & Aid Requests:
- Users can post and respond to requests.
- Store requests for 60 days before auto-categorization, with deletion after 90 days.
-
Data Export
- Export Functionality: Enable users to convert their contacts into open-source spreadsheet formats (e.g., CSV, XLSX).
-
Visual Enhancements
- Emojis for Buttons: Utilize web-based emojis for icons (e.g., disk for save, cloud for upload).
- Tooltip on Button Hover/Press: Provide action descriptions on hover (desktop) or long press (mobile).
Modals
- Implement modal popups for confirmation actions (e.g., "Are you sure you want to delete this contact?"):
- On confirmation, perform the action and refresh the screen.
- On cancellation, simply close the modal.
Photo Upload
- Allow users to upload photos from social media platforms like LinkedIn and Facebook.
Suggested Open Source Tools and Libraries
-
Frontend Development:
- React.js / Vue.js / Angular: For building user interfaces
- Bootstrap / Tailwind CSS: For designing responsive layouts.
-
Database:
- IndexedDB: A browser-native database to store user data locally.
-
Cloud Storage:
- Google Drive API: For storing and retrieving documents, reports.
-
User Authentication:
- Firebase Authentication: A potential option for secure user login systems.
-
File Upload:
- FilePond: A lightweight JavaScript library to handle file uploads, can integrate with existing file storage solutions.
Development Steps
1. Project Setup
- Initialize a new JavaScript project using your preferred framework (React, Vue, etc.).
- Set up package management (npm/yarn for managing dependencies).
2. Design User Interface
- Create components for login, registration, contact display, help requests, event management, and modals.
3. Implement Backend Logic
- Use IndexedDB or LocalStorage for storing contacts and events within the browser.
- Implement functions for CRUD operations.
4. User Authentication
- Build the login and registration forms. Set up user authentication using chosen methods.
5. Event Management
- Design and implement the logic for upcoming events, birthday management, and aid requests.
6. Integrate Third-party APIs
- Implement and test the Google Drive API for document generation and storage.
- Add the functionality to upload photos from social media.
7. Testing and Quality Assurance
- Conduct thorough testing for functionalities, usability, and security.
- Perform cross-platform testing to ensure compatibility across browsers and devices.
8. Deployment
- Host the application using a platform such as GitHub Pages or a similar service for static sites.
9. Maintenance and Updates
- Schedule routine updates and bug fixes based on user feedback.
Conclusion
By following this technical documentation, developers can build a robust, multi-device usable contact directory application utilizing free and open resources. The outlined features and technologies are designed to create an efficient and user-friendly experience tailored for family and community connections.