dzoech / Nudelsieb

Nudelsieb is a service that enables one to quickly write down thoughts and ideas before having forgotten them already.

Home Page:https://nudelsieb.zoechbauer.dev/swagger

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Build Status

Nudelsieb is a service that enables one to quickly write down thoughts and ideas before having forgotten them already. It focuses on supporting developers managing their tasks by providing a simple command line interface to add new records called Neurons. Neurons can be organized into groups, and allow to schedule reminders. Reminders are pushed as notifications to the mobile app. The main goal of the mobile app to facilitate easy rescheduling of reminders. Currently, only Android is supported.

Nudelsieb is work in progress.

Installation

Chocolatey Version Chocolatey

You can install the CLI via the Windows package manager Chocolatey:

choco install nudelsieb-cli

Usage

After the installation with Chocolatey you can use the CLI with the these aliases: nudelsieb or the short version nds.

Usage: nudelsieb [command] [options]

Options:
  -v|--version  Show version information.
  -?|-h|--help  Show help information.

Commands:
  add
  config
  list
  login
  reminder

Run 'nudelsieb [command] -?|-h|--help' for more information about a command.

Getting started

A random thought that occurred to you is called a neuron. To add a new neuron, simply run

nudelsieb add "My random thought I want to remember"

If you want to order your thought into groups, run

nudelsieb add "My random thoughts I want to remember" --group "work" --group "support"

To retrieve or remember your thoughts, run

nudelsieb get --group "work"

Architecture

The following architecture sketch illustrates the big picture: Architecture sketch from first brainstorming session

See the Swagger specification of our REST API at https://nudelsieb.zoechbauer.dev/swagger.

Setup instructions for Azure environments

Azure Service Bus requires a connection string with Listen and Send permissions, and a queue named reminder-push-notifications.

Recommended extensions for Visual Studio

CodeMaid for consistent code formatting (press CTRL + M, CTRL + SPACE) Editor Guidelines for visual guidance on the maximum line length

About

Nudelsieb is a service that enables one to quickly write down thoughts and ideas before having forgotten them already.

https://nudelsieb.zoechbauer.dev/swagger


Languages

Language:C# 98.9%Language:PowerShell 0.6%Language:Dockerfile 0.5%