About

Ofnotes is a note taking application that is completely offline with support for live editing markdown and material-design. All notes are stored locally per browser.

Features

• Markdown: notes support github flavored markdown and are rendered using material design
• Tags: notes can be tagged to make categorizing and finding them quick and easy
• Indexeddb: never run out of storage space for notes
• Dark mode: essential

Built with

• TypeScript
• Jest
• ReactJS
• Material-UI
• Dexie
• React Router
• MomentJS

Continuous Integration

GitHub Actions is used for CI/CD and the site is deployed to netlify. CI configuration can be viewed at .github/workflows/ofnotes.yml. Every push to master triggers the following steps:

1. Install nodejs and dependencies (npm ci)
2. Ensure prettier code style (npm format:check)
3. Run tests (npm run test -- --coverage)
4. Upload test coverage to codecov
5. Build production application (npm run build)
6. Deploy application to netlify

development

• Clone repo:
  git clone https://github.com/jhackshaw/ofnotes
• Install dependencies:
  npm install
• Run tests:
  npm run test
• Run tests with code coverage:
  npm run test -- --coverage
• Run development server:
  npm run start
• Format source:
  npm run format.

Pull requests welcome.