https://github.com/namiwang/fiber-note

A networked note-taking app, open and self-hosted, inspired by roam-research, obsidian and others.
https://github.com/namiwang/fiber-note

note-taking obsidian prosemirror rails roamresearch

Last synced: 6 days ago
JSON representation

A networked note-taking app, open and self-hosted, inspired by roam-research, obsidian and others.

• Host: GitHub
• URL: https://github.com/namiwang/fiber-note
• Owner: namiwang
• Created: 2020-06-12T13:00:20.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-01-19T19:25:28.000Z (almost 2 years ago)
• Last Synced: 2024-11-19T18:48:35.981Z (24 days ago)
• Topics: note-taking, obsidian, prosemirror, rails, roamresearch
• Language: Ruby
• Homepage: https://fiber-note-demo.herokuapp.com
• Size: 14.7 MB
• Stars: 168
• Watchers: 3
• Forks: 15
• Open Issues: 44
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• Open-Source-Ruby-and-Rails-Apps - fiber-note - A networked note-taking app, open and self-hosted, inspired by roam-research, obsidian and others. 🔥 ✅ 🚀 (Happy Exploring 🤘)
• jimsghstars - namiwang/fiber-note - A networked note-taking app, open and self-hosted, inspired by roam-research, obsidian and others. (Ruby)

README

        
![building](https://github.com/namiwang/fiber-note/workflows/test/badge.svg)

[![codecov](https://codecov.io/gh/namiwang/fiber-note/branch/master/graph/badge.svg)](https://codecov.io/gh/namiwang/fiber-note)



# fiber note

A networked note-taking app which is open and self-hosting, inspired by roam-research and others.

# screenshots

![screenshot](shed/screenshots/v0.optimized.gif?raw=true "screenshot")

# demo

A public demo

# deployment

## dependencies

- typical rails environment, plus `postgresql` and `redis`.

## heroku

[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy)

## environment variables

The app loads environment variables and behaves accordingly. It uses [dotenv](https://github.com/bkeepers/dotenv) to loads values from files (e.g. `.env`, `.env.development.local`, `.env.production`). Platforms like heroku also allow you to set env variables in the configuration panel.

### authentication

The app loads password from `ENV['PASSWORD']`, which is `password` by default, as defined in `.env`.

### available services

To enable performance analytics by skylight, set environment vars `SKYLIGHT_ENABLED=true` and `SKYLIGHT_AUTHENTICATION=YOUR_TOKEN`.

To enable sentry for error tracking, set an environment var `SENTRY_DSN=YOUR_SENTRY_DSN`.

## cookies

For security reasons (i.e. deploy this repo directly), `secret_key_base` will be randomized every time the server restarts, that includes upgrading to a new version. User may have to do a refresh in browser.