orbitdb / field-manual

The Offical User's Guide to OrbitDB

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Write Tutorial

aphelionz opened this issue · comments

Almost there... need to audit these sections for tense and typos

  • Introduction
    • Requirements
    • What will I learn?
    • What will I build?
    • Conventions
  • Chapter 1 - Laying the Foundation
    • Installing the requirements: IPFS and OrbitDB
    • Creating the isomorphic bookends
    • Instantiating IPFS and OrbitDB
    • Creating a Database
    • Choosing a data store
    • Key takeaways
  • Chapter 2 - Managing Data
    • Loading the database
    • Adding data
    • Reading data
    • Updating and deleting data
    • Storing Media Files
    • Key takeaways
  • Chapter 3 - Structuring your data
    • Adding a practice counter to each piece
    • Utilizing the practice counter
    • Adding a higher-level database for user data
    • Dealing with fixture data
    • Key takeaways
  • Chapter 4: Peer-to-Peer, Part 1 (The IPFS Layer)
    • Connecting to the global IPFS network
    • Getting a list of connected peers
    • Manually connecting to peers
    • Peer to peer communication via IPFS pubsub
    • Key Takeaways
  • Chapter 5: Peer-to-Peer Part 2 (OrbitDB)
    • Enabling debug logging
    • Discovering Peer’s Databases
    • Connecting automatically to peers with discovered databases
    • Simple distributed queries
    • Key takeaways
  • Chapter 6: Identity and Permissions
    • On security
    • Encryping and decrypting your data
    • Smart Contract Authentication
    • Creating your own authentication middleware
    • Key takeaways
  • Conclusion