https://github.com/aaqyaar/node-simple-assignment
Semester 7 - First Simple Assignment
https://github.com/aaqyaar/node-simple-assignment
nodejs typescript
Last synced: about 1 month ago
JSON representation
Semester 7 - First Simple Assignment
- Host: GitHub
- URL: https://github.com/aaqyaar/node-simple-assignment
- Owner: aaqyaar
- Created: 2023-10-12T17:23:49.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-11-01T07:07:04.000Z (about 2 years ago)
- Last Synced: 2023-11-01T08:23:50.308Z (about 2 years ago)
- Topics: nodejs, typescript
- Language: TypeScript
- Homepage:
- Size: 1.18 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Node.js Simple Assignment
Semester 7 - The project is a simple todo list application that allows users to add, delete, update and list todo items. The application uses the File System and Events Module in Node.js to store and manage todo items.
## Getting Started
The project is written in TypeScript and uses the File System and Events Module in Node.js to store and manage todo items.
> :warning: Before running the project, make sure you can meet the prerequisites.
### Prerequisites
The following software is required to be installed on your system:
- Node.js
- NPM
- YARN (optional)
### Installation
Follow the steps below to install and run the project:
1. Clone the repository:
```bash
git clone https://github.com/aaqyaar/node-simple-assignment.git
```
2. Install dependencies:
```bash
npm install
```
3. Run the server:
```bash
npm start
```
4. Interact with in the command line cli
```bash
Choose one of these commands (add/delete,update,list,exit)
add/delete: add/delete a note
update: update a note
list: list all notes
exit: exit the program
```
## File Structure
Contains the following files:
- `index.ts`: The main entry point of the application.
- `todo.ts`: Contains functions for managing todo items.
- `todos.json`: Stores the todo items in JSON format.