README.md

Gatsby Starter for Roam

A GatsbyJS starter for your Roam Research database.

This project is in the early stages of development.

• Here are my notes.
• PRs welcome.

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.