Node.js Coding and Documentation Enhancement
Budget: ₹100 – ₹400 INR
Technical Documentation and Code Quality Improvement Task
Tools:
• Node.js
• Google Colab
• Google Drive
• Windsurf code editor
Part 1: Code Analysis and Documentation
1. Review the provided code and data:
o Install and use Windsurf code editor on your machine
o Create and open new project folder in Windsurf
o Download codes to the folder and analyze the existing codebase
o Identify potential improvements and issues
o Document any bugs or inefficiencies found
2. Create a professional README.md file that includes:
o Clear one-line project description
o Step-by-step installation instructions for beginners
o Dependencies and system requirements
o Flow diagram showing the process
o Known issues and limitations
3. Generate a comprehensive package.json file:
o List all Node.js dependencies with version numbers
o Include only necessary packages
o Test the requirements file
Part 2: Code Testing and Improvement
1. Set up coding machine:
o Test code execution in either google colab or local machine
2. Implement improvements:
o Optimize code performance
o Improve user input validation
3. Document all changes made:
o Explain rationale for each improvement
o Provide before/after comparisons
Part 3: Practical Demonstration
1. Walking through the README.md file
2. Demonstrating the improvements made
3. Running tests and showing results
Submission Requirements:
Submit a ZIP file containing:
project_submission/
├── src/
│ ├── improved_code.js
│ └── tests/
├── docs/
│ ├── README.md
│ └── CHANGES.md
├── package.json
├── test_results.txt
├── logs/
└── config/
Sample Flow Diagram Format:
[Input Files] → [File Detection] → [Backup Creation]
↓
[Duplicate Detection] → [Processing] → [Statistics]
↓
[Output Generation] → [Backup Management]
Additional Notes:
• Must use Windsurf code editor with Claude 3.5 sonnet model selected for development
• Codes need to be generated inside Windsurf with AI.
• All documentation must be in Markdown format
• The code will be run by instructions given in README.md by beginner in coding on a new machine
Code location: https://drive.google.com/drive/folders/1MY15NDdZZ_xSZYwJlwFeNK4TJDWTjRfl?usp=sharing
Tools:
• Node.js
• Google Colab
• Google Drive
• Windsurf code editor
Part 1: Code Analysis and Documentation
1. Review the provided code and data:
o Install and use Windsurf code editor on your machine
o Create and open new project folder in Windsurf
o Download codes to the folder and analyze the existing codebase
o Identify potential improvements and issues
o Document any bugs or inefficiencies found
2. Create a professional README.md file that includes:
o Clear one-line project description
o Step-by-step installation instructions for beginners
o Dependencies and system requirements
o Flow diagram showing the process
o Known issues and limitations
3. Generate a comprehensive package.json file:
o List all Node.js dependencies with version numbers
o Include only necessary packages
o Test the requirements file
Part 2: Code Testing and Improvement
1. Set up coding machine:
o Test code execution in either google colab or local machine
2. Implement improvements:
o Optimize code performance
o Improve user input validation
3. Document all changes made:
o Explain rationale for each improvement
o Provide before/after comparisons
Part 3: Practical Demonstration
1. Walking through the README.md file
2. Demonstrating the improvements made
3. Running tests and showing results
Submission Requirements:
Submit a ZIP file containing:
project_submission/
├── src/
│ ├── improved_code.js
│ └── tests/
├── docs/
│ ├── README.md
│ └── CHANGES.md
├── package.json
├── test_results.txt
├── logs/
└── config/
Sample Flow Diagram Format:
[Input Files] → [File Detection] → [Backup Creation]
↓
[Duplicate Detection] → [Processing] → [Statistics]
↓
[Output Generation] → [Backup Management]
Additional Notes:
• Must use Windsurf code editor with Claude 3.5 sonnet model selected for development
• Codes need to be generated inside Windsurf with AI.
• All documentation must be in Markdown format
• The code will be run by instructions given in README.md by beginner in coding on a new machine
Code location: https://drive.google.com/drive/folders/1MY15NDdZZ_xSZYwJlwFeNK4TJDWTjRfl?usp=sharing