{"id":18706572,"url":"https://github.com/maruf-pfc/cli-based-note-taking-app","last_synced_at":"2025-08-15T22:42:51.271Z","repository":{"id":258304924,"uuid":"868019324","full_name":"maruf-pfc/cli-based-note-taking-app","owner":"maruf-pfc","description":"A Simple CLI based Note Taking App built with Shell Programming.","archived":false,"fork":false,"pushed_at":"2024-10-05T09:26:42.000Z","size":218,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-05-19T06:38:43.936Z","etag":null,"topics":["bash-scripting","cli-based-note-taking-app","note-taking-app","shell-scripting"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/maruf-pfc.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-10-05T09:04:07.000Z","updated_at":"2024-11-06T13:30:58.000Z","dependencies_parsed_at":"2024-10-18T11:27:45.020Z","dependency_job_id":null,"html_url":"https://github.com/maruf-pfc/cli-based-note-taking-app","commit_stats":null,"previous_names":["maruf-pfc/cli-based-note-taking-app"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/maruf-pfc/cli-based-note-taking-app","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maruf-pfc%2Fcli-based-note-taking-app","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maruf-pfc%2Fcli-based-note-taking-app/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maruf-pfc%2Fcli-based-note-taking-app/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maruf-pfc%2Fcli-based-note-taking-app/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/maruf-pfc","download_url":"https://codeload.github.com/maruf-pfc/cli-based-note-taking-app/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maruf-pfc%2Fcli-based-note-taking-app/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":270640491,"owners_count":24620957,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-15T02:00:12.559Z","response_time":110,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bash-scripting","cli-based-note-taking-app","note-taking-app","shell-scripting"],"created_at":"2024-11-07T12:14:41.080Z","updated_at":"2025-08-15T22:42:51.203Z","avatar_url":"https://github.com/maruf-pfc.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# CLI Based Note Taking App\n\nWelcome 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.\n\n## Features\n\n- **User Registration and Login**: Securely register and login using a username and password.\n- **Create Notes**: Easily create notes with a title and body.\n- **View Notes**: View all notes or a specific note by title.\n- **Update Notes**: Update the body of an existing note.\n- **Delete Notes**: Delete a note by its title.\n\n## Prerequisites\n\n- **Bash**: Ensure you have a Unix-like environment with Bash installed.\n- **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:\n  ```bash\n  sudo apt-get install jq\n  ```\n\n## Installation\n\n1. Clone the repository:\n\n   ```bash\n   git clone https://github.com/maruf-pfc/cli-based-note-taking-app.git\n   cd cli-based-note-taking-app\n   ```\n\n2. Make the script executable:\n   ```bash\n   chmod +x main.sh\n   ```\n\n## Usage\n\n1. Run the script:\n\n   ```bash\n   ./main.sh\n   ```\n\n2. Follow the on-screen instructions to register or login.\n\n3. Use the main menu to create, view, update, or delete notes.\n\n## Screenshots\n\nHere are some screenshots demonstrating how to use the app:\n\n1. Register a new user:\n\n   ![Register](./screenshots/register.png)\n\n2. Login with the registered user:\n\n   ![Login](./screenshots/login.png)\n\n3. Create a new note:\n\n   ![Create Note](./screenshots/create%20note.png)\n\n4. Read a note:\n\n   ![Read Note](./screenshots/read%20single%20note.png)\n\n5. Read all notes:\n\n   ![Read All Notes](./screenshots/read%20all%20notes.png)\n\n6. Update a note:\n\n   ![Update Note](./screenshots/update%20note%20part%201.png)\n   ![Update Note](./screenshots/update%20note%20part%202.png)\n\n7. Delete a note:\n\n   ![Delete Note](./screenshots/delete%20note%20part%201.png)\n   ![Delete Note](./screenshots/delete%20note%20part%202.png)\n\n## Tools and Libraries\n\n- **jq**: [jq](https://stedolan.github.io/jq/) is used for parsing JSON data.\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n## Contributing\n\nContributions are welcome! Please feel free to submit a Pull Request.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmaruf-pfc%2Fcli-based-note-taking-app","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmaruf-pfc%2Fcli-based-note-taking-app","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmaruf-pfc%2Fcli-based-note-taking-app/lists"}