# student-management-app

> Simple Student Management System

Latest version **1.0.1** (published 2023-10-01) · ISC license · 0 weekly downloads

## Install

```sh
npm install student-management-app
pnpm add student-management-app
yarn add student-management-app
bun add student-management-app
```

Provides the command `student-management-app`.

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2023-10-01 |
| First published | 2023-10-01 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 30.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Muhammad Kamran |
| Maintainers | typescriptkamran |

## Links

- npm: https://www.npmjs.com/package/student-management-app
- Repository: https://github.com/typescriptkamran/student-management-system
- Homepage: https://github.com/typescriptkamran/student-management-system#readme
- Issues: https://github.com/typescriptkamran/student-management-system/issues
- npm.io page: https://npm.io/package/student-management-app

## Dependencies (2)

- [chalk](https://npm.io/package/chalk.md) ^5.3.0
- [inquirer](https://npm.io/package/inquirer.md) ^9.2.11

## Recent versions

- 1.0.1 (latest) — 2023-10-01
- 1.0.0 — 2023-10-01

## README

# 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-app
```

## Features

- 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:

1. **Add Student**: Add a new student to the system.
2. **Edit Student**: Modify an existing student's information.
3. **Remove Student**: Delete a student from the system.
4. **List Students**: View a list of all the students currently stored.
5. **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](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

- [chalk](https://www.npmjs.com/package/chalk): ^5.3.0
- [inquirer](https://www.npmjs.com/package/inquirer): ^9.2.11

## Development Dependencies

- [@types/chalk](https://www.npmjs.com/package/@types/chalk): ^2.2.0
- [@types/inquirer](https://www.npmjs.com/package/@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.

---
_Source: https://npm.io/package/student-management-app · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._