GVO Mirror Content

Contributing to the Project

GVO welcomes contributors to our open source DAA app. Join GVO's discord server to get more help from other contributors on our Engineering Workstream channels. Please refer to the project's style and contribution guidelines for submitting patches and additions. In general, we follow the "fork-and-pull" Git workflow. For creating branches, we prefer to format it this way: [ISSUE-TAG]/[ISSUE-NUMBER]-[A-MEANINGFUL-TITLE]. So for example, we have an issue called "Update README" with a tag of "enhancement" and issue number of 1, the ideal branch name could be: enhancement/1-update-readme

Steps for Contributing with the "fork-and-pull" workflow:

Fork the repo on GitHub Clone the project to your own machine Commit changes to your own branch Push your work back up to your fork Submit a Pull request so that we can review your changes NOTE: Be sure to merge the latest from "upstream" before making a pull request!

Credits:

A Next.js-powered frontend for your Mirror blog

This project mimics the Mirror publication design and pulls data from their APIs, allowing you to self-host your Mirror blog on a custom domain.

You can view a demo of this project by visiting m1guelpf.blog, which hosts the my Mirror publication.

Features

• Article list
• Article page
• Code highlighting (using VSCode's rendering engine, allows for custom themes. Currently using github-light and github-dark, depending on the publication's theme)
• Dark mode (when enabled on Mirror)
• Patience page (when no articles exist)
• Static generation (all pages should load instantly once deployed)
• Static re-generation (new articles should appear without re-deploying)
• Embeds
  • Tweet embeds
  • YouTube embeds
  • Additional embeds (CodePen, JSBin, Gists, etc., not sure if supported by Mirror already)
  • NFT embeds
  • Bookmark cards (Open Graph)
  • NFT crowdfunding
  • NFT auctions
• Email list support (when enabled on Mirror)
• Pull content from Arweave
• Write Mirror entry about this project

Development

• Clone this repo in a local directory
• Install dependencies (yarn install or npm install)
• Copy the .env.example file to .env.local, and fill in your mirror subdomain and your Infura Project ID
• Start the server! (yarn dev or npm run dev)

Deploying to Vercel

You can deploy this project to Vercel (and load your own publication!) by clicking the button below:

Once it's ready, you should be able to attach your custom domain from the Vercel settings page.

FAQ

Is this decentralized?

Kind of. While I'm pulling the entry listing and contents from the Arweave chain directly, the publication details come from Mirror's APIs.

Why did you make this?

I like playing with stuff :). I really like Mirror's design, so I decided to create a Ghost theme "inspired" by their design. Once that was finished, I decided to turn that theme into something slightly more useful.

Who are you?

👋 Hi! I'm Miguel Piedrafita, an 20-year-old indie maker, getting his toes deep into crypto. You can follow my journey and all the little things I make on the way on Twitter.

I have another question

Read Building apps with Mirror, an entry I wrote in my own Mirror publication explaining how this project works, and how you can build your own Mirror apps. If you still have questions after that, drop me a line on Twitter.

License

This project is open-sourced software licensed under the MIT license. See the License file for more information.