student-management-app v1.0.1
Student Management App
Description: A Simple CLI Student Management System
Installation
To use the Student Management App, you can simply run it using npx. There's no need to install it globally or locally.
npx student-management-appFeatures
- Add new student information, including name, roll number, age, grade, class, and section.
- Edit existing student information.
- Remove student records.
- List all the students currently stored.
Usage
Upon running the app using npx student-management-app, you will be presented with a menu to perform various actions:
- Add Student: Add a new student to the system.
- Edit Student: Modify an existing student's information.
- Remove Student: Delete a student from the system.
- List Students: View a list of all the students currently stored.
- Exit: Quit the application.
Follow the prompts and instructions provided by the app to manage your student data.
Student Data Storage
Student information is stored in a JSON file (students.json) in the same directory as the app. This file will be created automatically if it does not exist.
Contribution
Contributions to the Student Management App are welcome! If you'd like to add new features, fix bugs, or improve the code, please fork the repository at https://github.com/typescriptkamran/student-management-system.git, make your changes, and create a pull request.
License
This project is licensed under the ISC License.
Author
Name: Muhammad Kamran
Dependencies
Development Dependencies
- @types/chalk: ^2.2.0
- @types/inquirer: ^9.0.3
You can create a `README.md` file in your project directory and paste this content into it, replacing the placeholders with the actual information about your app. This updated README reflects the package.json information you provided.