Athens

Open-Source Roam. For more background, please read the Athens FAQ on my public Roam.

Contributing

Please refer to CONTRIBUTING.md and CODE_OF_CONDUCT.md.

Getting Started

You will need:

• a java sdk: I'm using openjdk 11.0.2
• lein: Clojure's main package manager (lein installs the correct version of Clojure for you)
• yarn or npm: I'm using yarn

Because yarn and lein are straightforward, and the only system dependency needed is java, I don't think docker is critical for local development.

Once your OS recognizes your java sdk, you have lein and yarn, simply clone the repo, run lein dev, yarn, and go to localhost:3000.

Built With

See Athens vs Roam Tech Stack for more background.

Roadmap / Objectives

• to provide a self-hosted option, easily deployable on your machine
• to provide a hosted option using Datomic and their open-source license
  • if hosted, maintaining best practices (such as end-to-end encryption) and complying with standards like GDPR
• to provide a React Native mobile client
• to begin development of an open protocol for bi-directional links between Roam and other open-source alternatives

Questions

Send a message in the #athens channel of the Roam Slack or ping me on Twitter at @tangjeff0.

---