https://github.com/codewithshabbir/cli-todolist
https://github.com/codewithshabbir/cli-todolist
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/codewithshabbir/cli-todolist
- Owner: codewithshabbir
- Created: 2024-04-13T21:05:43.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2024-04-15T17:37:29.000Z (about 1 year ago)
- Last Synced: 2024-04-15T18:48:06.407Z (about 1 year ago)
- Language: JavaScript
- Size: 20.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# CLI TodoList with Login and Registration
A command-line interface (CLI) TodoList application with features like registration, login, adding, updating, deleting, and viewing todos.
## Installation
### From GitHub
1. Clone the repository:
```bash
git clone https://github.com/codewithshabbir/cli-todolist.git
```
2. Navigate to the project directory:
```bash
cd cli-todolist
```
3. Install dependencies:
```bash
npm install
```
4. Run the application:
```bash
npm start
```
### From npm
1. Install the CLI TodoList globally:
```bash
npm install -g cli-todolist-wth-login-and-registeration
```
## Usage
After installation, you can run the CLI TodoList using the following command:
```bash
cli-todolist
```
### Registration
To register, run the application and select the registration option. You'll be prompted to provide your username, fullname, gender, and password.
### Login
Once registered, you can log in using your username and password.
### Todos Selection
After logging in, you'll have several options:
- Select todo: View all your todos.
- Add todo: Add a new todo task.
- Update todo: Update an existing todo task.
- Delete todo: Delete a specific todo task.
- Delete all todo: Delete all your todo tasks.
- Exit: Close the program.
### Viewing Todos
When you select the 'Select todo' option, you'll see all your todo tasks.
### Adding Todos
To add a new todo task, select the 'Add todo' option and follow the prompts.
### Updating Todos
To update a todo task, select the 'Update todo' option and follow the prompts.
### Deleting Todos
To delete a specific todo task, select the 'Delete todo' option and follow the prompts. You can also delete all your todo tasks by selecting the 'Delete all todo' option.
## GitHub Repository
You can find the source code on [GitHub](https://github.com/codewithshabbir/cli-todolist).
## NPM Package
The CLI TodoList is also available as an npm package. [Check it out on npm](https://www.npmjs.com/package/cli-todolist-wth-login-and-registeration).
## NPM Profile
Visit my [NPM profile](https://www.npmjs.com/~muhammadshabbir) for more packages.
## Contributing
Contributions are welcome! Feel free to open an issue or submit a pull request.
## License
This project is licensed under the [MIT License](LICENSE).