https://github.com/juliencrn/rusty-journal

Learning project: A command line to-do app written in Rust.
https://github.com/juliencrn/rusty-journal

command-line diesel rust sqlite

Last synced: 15 days ago
JSON representation

Learning project: A command line to-do app written in Rust.

• Host: GitHub
• URL: https://github.com/juliencrn/rusty-journal
• Owner: juliencrn
• License: mit
• Created: 2021-07-19T14:40:26.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2021-09-23T16:40:13.000Z (over 3 years ago)
• Last Synced: 2024-10-05T01:41:24.058Z (5 months ago)
• Topics: command-line, diesel, rust, sqlite
• Language: Rust
• Homepage:
• Size: 260 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


Rusty Journal


A command line to-do app written in Rust.

**README Sections:** [Options](#options) — [Installation](#installation) - [License](#license)



![Screenshots of Rusty Journal](screenshot.png)

---

## Options

```

Rusty Journal 0.1.0

A command line to-do app written in Rust and SQLite

USAGE:

    rusty_journal 

FLAGS:

    -h, --help       Prints help information

    -V, --version    Prints version information

SUBCOMMANDS:

    add         Write a task to the journal file

    delete      Delete an given task by id

    done        Set a task completed by id

    help        Prints this message or the help of the given subcommand(s)

    list        List resting tasks from the journal file

    list-all    List all tasks from the journal file

    reset       Delete all tasks

    update      Update task description by id

```

---

## Installation

_Rusty journal_ is written in [Rust](https://www.rust-lang.org/), so you'll need to grab a Rust installation in order to compile it. The recommended way to install Rust for development is from the [official download page](https://www.rust-lang.org/tools/install), using rustup.

Once Rust is installed, you can compile _Rusty journal_ with Cargo:

```bash

# Download the repo

$ git clone https://github.com/juliencrn/rusty-journal

$ cd rusty-journal

# Create an .env file with the database path

$ echo "DATABASE_URL=testing_db.db" > .env

# Initiate ORM

$ diesel setup

$ diesel migration run

# Build, use...

$ cargo build --release

$ ./target/release/rusty_journal --version

> Rusty Journal 0.1.0

$ cargo run -- --help

```

## License

Distributed under the MIT License. See [`LICENSE`](./LICENSE) for more information.