Skip to content

Commit

Permalink
docs: add milestone 3 delivery template
Browse files Browse the repository at this point in the history
  • Loading branch information
agustinustheo committed Nov 9, 2024
1 parent e942f48 commit 9c55e8f
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 0 deletions.
Binary file added docs/image-9.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
39 changes: 39 additions & 0 deletions docs/milestone-3-delivery.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Milestone Delivery :mailbox:

**The delivery is according to the official [milestone delivery guidelines](https://github.com/w3f/Grants-Program/blob/master/docs/Support%20Docs/milestone-deliverables-guidelines.md).**

* **Application Document:** https://github.com/w3f/Grants-Program/blob/master/applications/myriad_social.md
* **Milestone Number:** 3

**Context**
In this milestone, we've significantly enhanced Myriad Social by migrating to the Paseo Network, implementing comprehensive B2B features, improving performance, and introducing mobile wallet support. These updates make the platform more accessible, efficient, and business-friendly while maintaining our commitment to decentralization.

## Summary of Deliverables for Myriad Social's Polkadot Grant

### 0a. License
Our project continues to be released under the GPL 3.0 License, maintaining our commitment to open-source development.

### 0b. Documentation
We've provided comprehensive [documentation](https://github.com/myriadsocial/myriad-web/blob/main/docs/milestone-3-documentation.md) detailing all new features and improvements.

### 0c. Testing and Testing Guide
A detailed [Testing Guide](https://github.com/myriadsocial/myriad-web/blob/main/docs/milestone-3-testing-guide.md) is available, covering all new features and self-hosting capabilities.

### 0d. Docker
We provide Docker configurations for both production and development environments, including our new [Marauder test environment](https://github.com/myriadsocial/myriad-infrastructure/blob/main/linux/Dockerfile).

**Deliverables**

| Number | Deliverable | Link | Notes |
| ------------- | ------------- | ------------- |------------- |
| 1. | Paseo Network Migration | https://polkadot.js.org/apps/?rpc=wss%3A%2F%2Fws-rpc.paseo.myriad.social | [![Myriad Paseo Dashboard](https://raw.githubusercontent.com/myriadsocial/myriad-web/refs/heads/main/docs/image-9.png)](https://polkadot.js.org/apps/?rpc=wss%3A%2F%2Fws-rpc.paseo.myriad.social) <br/> Successfully migrated to Paseo Network as a Parachain (ParaID 4005) with complete token migration from Octopus Testnet. |
| 2. | Enhanced Timeline Features | https://github.com/myriadsocial/myriad-web | Implemented improved timeline discovery and exclusive timeline creation with a multi-staged interface. ![Timeline Creation](https://raw.githubusercontent.com/myriadsocial/myriad-web/refs/heads/main/docs/create-exclusive-timeline.png) Video demo of the new filtering system: [Timeline Filtering Demo](https://www.youtube.com/watch?v=D0Km7_Buclo) |
| 3. | B2B Multi-User System | https://github.com/myriadsocial/myriad-web | Developed comprehensive B2B features including Personal Access Tokens and team management capabilities. ![Multi-User System](https://raw.githubusercontent.com/myriadsocial/myriad-web/refs/heads/main/docs/multi-user.png) Watch our tutorial on the multi-user system: [Multi-User System Tutorial](https://www.youtube.com/watch?v=-cf-RXFiCdM) |
| 4. | Mobile Wallet Integration | https://github.com/myriadsocial/myriad-web | Successfully integrated Nova Wallet for mobile users, enabling seamless Polkadot wallet connectivity on mobile devices. [![Nova Wallet Tutorial](https://img.youtube.com/vi/6PtEhR9-K50/0.jpg)](https://www.youtube.com/watch?v=6PtEhR9-K50) <br/> See how to use Nova Wallet with Myriad: [Nova Wallet Integration Tutorial](https://www.youtube.com/watch?v=6PtEhR9-K50) |
| 5. | Self-Hosting Capabilities | https://github.com/myriadsocial/myriad-web | Implemented comprehensive self-hosting solution with automated setup via Marauder script and Docker container management. ![Timeline Discovery](https://raw.githubusercontent.com/myriadsocial/myriad-web/refs/heads/main/docs/timeline-discovery.png) |
| 6. | Performance Optimization | https://github.com/myriadsocial/myriad-web | ![Brotli Compression](https://raw.githubusercontent.com/myriadsocial/myriad-web/refs/heads/main/docs/image-2.png) <br/> Achieved significant performance improvements including: <br/> - 50% reduction in transfer size (from 24.3 MB to 10.4 MB) <br/> - 14% reduction in JavaScript bundle size (down to 325kb) <br/> - Implementation of Brotli compression <br/> - Enhanced Fetch/XHR payload efficiency (reduced to 7%) <br/> - Improved mobile performance and data usage |

**Additional Information**
We are pleased to submit this delivery document confirming the successful completion of Milestone 3 deliverables. The migration to Paseo Network, implementation of B2B features, and significant performance improvements represent major steps forward for the platform. These enhancements make Myriad Social more accessible, efficient, and ready for enterprise use while maintaining our commitment to decentralization and user privacy.

Our team remains available to address any questions or concerns regarding this milestone delivery. We appreciate your continued support as we work to advance the Myriad Social platform.

0 comments on commit 9c55e8f

Please sign in to comment.