Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/maruf-pfc/cli-based-note-taking-app

A Simple CLI based Note Taking App built with Shell Programming.
https://github.com/maruf-pfc/cli-based-note-taking-app

bash-scripting cli-based-note-taking-app note-taking-app shell-scripting

Last synced: 7 days ago
JSON representation

A Simple CLI based Note Taking App built with Shell Programming.

Host: GitHub
URL: https://github.com/maruf-pfc/cli-based-note-taking-app
Owner: maruf-pfc
License: mit
Created: 2024-10-05T09:04:07.000Z (about 1 month ago)
Default Branch: main
Last Pushed: 2024-10-05T09:26:42.000Z (about 1 month ago)
Last Synced: 2024-10-18T11:27:39.722Z (28 days ago)
Topics: bash-scripting, cli-based-note-taking-app, note-taking-app, shell-scripting
Language: Shell
Homepage:
Size: 213 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# CLI Based Note Taking App

Welcome to the CLI Based Note Taking App! This is a simple command-line interface application that allows users to create, view, update, and delete notes. It also supports user registration and login functionality.

## Features

- **User Registration and Login**: Securely register and login using a username and password.
- **Create Notes**: Easily create notes with a title and body.
- **View Notes**: View all notes or a specific note by title.
- **Update Notes**: Update the body of an existing note.
- **Delete Notes**: Delete a note by its title.

## Prerequisites

- **Bash**: Ensure you have a Unix-like environment with Bash installed.
- **jq**: This app uses `jq` for JSON parsing. You can install it using your package manager. For example, on Ubuntu, you can install it using:
```bash
sudo apt-get install jq
```

## Installation

1. Clone the repository:

```bash
git clone https://github.com/maruf-pfc/cli-based-note-taking-app.git
cd cli-based-note-taking-app
```

2. Make the script executable:
```bash
chmod +x main.sh
```

## Usage

1. Run the script:

```bash
./main.sh
```

2. Follow the on-screen instructions to register or login.

3. Use the main menu to create, view, update, or delete notes.

## Screenshots

Here are some screenshots demonstrating how to use the app:

1. Register a new user:

![Register](./screenshots/register.png)

2. Login with the registered user:

![Login](./screenshots/login.png)

3. Create a new note:

![Create Note](./screenshots/create%20note.png)

4. Read a note:

![Read Note](./screenshots/read%20single%20note.png)

5. Read all notes:

![Read All Notes](./screenshots/read%20all%20notes.png)

6. Update a note:

![Update Note](./screenshots/update%20note%20part%201.png)
![Update Note](./screenshots/update%20note%20part%202.png)

7. Delete a note:

![Delete Note](./screenshots/delete%20note%20part%201.png)
![Delete Note](./screenshots/delete%20note%20part%202.png)

## Tools and Libraries

- **jq**: [jq](https://stedolan.github.io/jq/) is used for parsing JSON data.

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

## Contributing

Contributions are welcome! Please feel free to submit a Pull Request.