#notebook #sqlx #api #tokio #notes #stores

lnotebook

asynchronous API to creating notebooks that stores notes in a database

10 releases

0.1.9 Jul 31, 2024
0.1.8 Jul 28, 2024

#2141 in Database interfaces

Download history 638/week @ 2024-07-26 30/week @ 2024-08-02

58 downloads per month

MIT/Apache

27KB
411 lines

LNotebook

asynchronous API that will helps you to write simple notebook

This API using:

Preparing

Before start working with notebook you must complete commands below.

  1. Clone our repository:
git clone https://github.com/Nnenty/lnotebook

cd lnotebook/
  1. Go to notebook_example directory:
cd notebook_example/
  1. Export your database (change URL on yours):
export DATABASE_URL=postgres://username:password@localhost/db`
  1. Migrate using command:
just migrate

Note: install SQLx-cli if you don't have it installed to run code above.

You did it! Then you have a database ready to use in notebook.

Start the notebook

Clarification: all code in this section assumes that you have completed all commands from the section Preparing.

  • Let's try execute cargo run only:
cargo run

Note: when you use cargo run without terminal command, program should display all total notes. Read more about terminal commands in our documentation.

Let's add new note:

cargo run -- add-note passwords

The program will ask you to enter the desired note to add to the notebook. Paste text login: krutoy_4el password: 1234#endnote# into.

Then let's print our note:

cargo run -- display-note passwords

The output of this program will be like this:

ID: 1
Name: passwords
Data:
login: krutoy_4el
password: 1234

More about terminal commands

To learn more about commands in terminal similar to add-note from the example above read our documentation.

Licenses

Licensed under either license:

  • Apache-2.0 License
  • MIT License

Dependencies

~20–33MB
~516K SLoC