Skip to content

Latest commit

 

History

History
40 lines (27 loc) · 1.19 KB

README.md

File metadata and controls

40 lines (27 loc) · 1.19 KB

Gatsby Starter for Roam

Twitter Follow

A GatsbyJS starter for your Roam Research database.

A screenshot of Gatsby Roam Starter

This project is in the early stages of development.

Getting Started

  1. Install the starter:

    gatsby new gatsby-roam https://github.com/joshuap/gatsby-starter-roam/
  2. Change directory:

    cd gatsby-roam
  3. Export your database in Roam and import it into your project:

    1. Go to https://roamresearch.com/#/app/yourdb -> Export All
      1. Select JSON as the export format
    2. Save export JSON file to db/roam.json
  4. Run the development server:

    gatsby develop

    Your site should be running at http://localhost:8000

License

This project is MIT licensed. See the LICENSE file in this repository for details.