Skip to content

Latest commit

 

History

History
56 lines (39 loc) · 1.38 KB

README.md

File metadata and controls

56 lines (39 loc) · 1.38 KB

Aurora

Overview

Aurora is an open source note taker with first class support for third part extensions. It's built on react-mutate, a framework for creating "mutations" in React.

It's still a little early in the process, but here's the general idea of what we're building at the moment:

Light mode ui mockup

Dark mode ui mockup

For Devs

The use of the yarn package manager is strongly recommended, as opposed to using npm.

Development Scripts

# run application in development mode
yarn dev
# Also display redux acton logs (warning: it logs a lot)
yarn dev-log-redux

# compile source code and create webpack output
yarn compile

# `yarn compile` & create build with electron-builder
yarn dist

# `yarn compile` & create unpacked build with electron-builder
yarn dist:dir

# Linting
yarn lint

# Testing
yarn test
yarn test --watch

# Interacting with database migrations
yarn db-reset -e test
yarn db-down -e development
yarn db-up -d development
yarn db-create-config
yarn db-migrate-create myNewMigration

# Adding a note
# CURRENTLY DOES NOT WORK!!!
yarn create-note "<Some text for the note here>" <tag1> <tag2> ... <tagn>