Skip to content

margni/note

Repository files navigation

mNote

mNote Logo

mNote is an extremely minimal note taking web app.

© Margni Ltd. 2020

About

This is built as a technical demonstration for a relatively simple React+Firebase PWA.

At this time its intended purpose is exploring these ideas, not to demonstrate a production quality app.

Features

  • PWA
    • Manifest, services worker, etc.
    • Installable with custom handler
    • Works Offline
    • Performant, minimal, native/app-like interface
    • Dark theme support
    • Share via Web Share API
    • Most code in module to reduce initial download size
  • Uses Firestore realtime database to sync changes instantaneously
  • Pin Notes
  • Search Notes
  • Tag Notes

Appearance

Designed to be extremely minimal. Design and layout component architecture inspired by Material Design.

CSS modules for componentized CSS rather than something like BEM. Avoided SASS/CSS-in-JS type solutions just for the sake of simplicity.

Uses iconography to make the application largely language agnostic for sighted users (Better accessibility is on the roadmap).

Technical

Designed for experimenting with PWA concepts and Firebase, some technical aspects may not be appropriate for real-world applications; Some hacky experimental code, poor test coverage, not using 3rd party libraries and generally trying to keep things more simple than one otherwise would.

ToDo

To Do

Available Scripts

In the project directory, you can run:

npm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

npm test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

npm run build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

About

mNote is an extremely minimal note taking web app.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published