Code Monkey home page Code Monkey logo

memories's Introduction

Memories

A terminal note-taking application.

What is it?

This a note application designed mainly for GNU/Linux. This application can do the following things:

  • You can quickly view all the note that you have taken.
  • You can take note and store it on a local MySQL database without having to create a file.
  • You can copy a note on MySQL database to file, edit it and update the content.
  • You can run bash command on the application just like interacting with a terminal.

How to use

How to run

Before running the program, please excute the ./scripts/MySQLDB.sql file to generate the table. You can run the start.sh in "./out/start/sh"

bash out/start.sh

If you have different configuration for MySQL connection, then adjust the file.

How to create a file

To create a file, please run

edit -n newfile.md new

Pleas note! When editing a file, you'll have to following its format or otherwise the app cannot parse the content.

# Meta information
## ID
300525489
## Theme
Hackathon
## Create On
2023-09-13

# Content
## Note
Prepare for the Semi-Finals
## Description
Congratulations! You've Advanced to the Semi-Finals of the Hackathon.
Each time has 15 minutes: {5 for presentation, 10 for debate and QAs with the judges}
## Links
- AI
- Recycling
- LLM

How to copy a note to a file

First, you'll have to view the notes

view -a

After that, you can select a note using its index number (start from 0) and copy it to a file.

edit -n select_2.md -s 2 copy

How to persist a file to a record on MySQL DB

Assume that you have edit mynote.md file, you can do just that by:

edit -n mynote.md save

Use case diagram

Here is an overview of the app Use Case diagram

memories's People

Contributors

h4438 avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.