/HyperNote

A note-taking application which can also be used as a personal wiki and productivity tracker!

Primary LanguageJavaScriptMIT LicenseMIT

Contributors Forks Stargazers Issues MIT License


HyperNote

A productivity application and a personal wiki!
HyperNotert Bug · Request Feature

Table of Contents

About The Project

The main aim behind this project was to build a general productivity applicaiton and a personal wiki which can also be used as a general purpose note taking application or a diary. We still have plans to implement several other features as addons to the current applications, so stay tuned!

Built With

Getting Started

To get a local copy up and running follow these simple steps. The current build setup is run and tested on windows 10. So other platforms are not yet fully supported.

Prerequisites

npm is reqired to be installed on your PC to build the project from source

Installation

  1. Clone the repo
git clone https://github.com/RikilG/HyperNote.git
cd HyperNote
  1. Install NPM packages
npm install
  1. Run the application
npm start

Usage

The current application by default uses a working directory in your %APPDATA% folder. this can be changed in settings.
As of now, the application supports:

  • listing files
  • creating files/folders
  • rendering markdown (with realtime preview)
  • editing files (not saving yet :)
  • multiple splits for editing (horizontal only for now)
  • pomodoro timers

Roadmap

  • Give option to toggle b/w renderer and editor (or) split renderer
  • Provide a default page with info when no files are open (similar to vscode blank tab when no files are open)
  • Add file save functionality
  • Add pomodoro framework
  • Add trello framework
  • Add calendar
  • Integrate with desktop notifications

Contributing

Have a feature you would like to add? know a solution to the issue you are having? Follow the steps to contribute to this project!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b AmazingFeature)
  3. Commit your Changes (git commit -m 'Add AmazingFeature')
  4. Push to the Branch (git push origin AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contributors