This project consists of two separate repositories:
- Nirmaan-show: Main showcase repository
- NIRMAN-SUBMission-of-NST-ADYPU: Submission repository
- Frontend:
- HTML5
- CSS3
- JavaScript (ES6+)
- Bootstrap for responsive design
- Version Control: Git
- Hosting: GitHub Pages
- Git installed on your system
- Modern web browser (Chrome, Firefox, Safari)
- Text editor (VS Code recommended)
git clone https://github.com/nst-sdc/Nirmaan-show.git
git clone https://github.com/nst-sdc/NIRMAN-SUBMission-of-NST-ADYPU.git{
"teamName": "Example Team",
"members": [
{
"name": "Member 1",
"role": "Developer"
}
],
"projectDetails": {
"title": "Project Name",
"description": "Project Description"
}
}- Always validate JSON syntax using tools like JSONLint
- Keep backup before making changes
- Use proper indentation (2 or 4 spaces)
- Maintain consistent naming conventions
- Add comments in separate documentation
- Incorrect file paths in HTML/CSS/JS files
- Case sensitivity issues in filenames
- Missing files or resources
- Incorrect repository configuration
-
Check File Paths:
- Use relative paths correctly
- Verify file existence
- Maintain consistent casing
-
GitHub Pages Configuration:
# In .github/workflows/pages.yml name: Deploy to GitHub Pages on: push: branches: [ main ]
-
Custom 404 Page: Create a
404.htmlin root directory:<!DOCTYPE html> <html> <head> <title>Page Not Found</title> </head> <body> <h1>404 - Page Not Found</h1> <a href="/">Return to Home</a> </body> </html>
# Create new branch
git checkout -b fix/team-name-404
# Make your changes
# Stage changes
git add .
# Commit with descriptive message
git commit -m "Fix: Team folder 404 error and path corrections"
# Push to your fork
git push origin fix/team-name-404
# Create PR on GitHub
# Go to repository → Pull requests → New pull request- Provide clear description of changes
- Reference related issues
- Include testing steps
- Add screenshots if UI changes
- Request review from maintainers
- Enable GitHub Pages in repository settings
- Wait for deployment (check Actions tab)
- Test all navigation links
- Verify team folder access
- Check media loading
- Test on multiple browsers
- Verify file exists in correct location
- Check case sensitivity
- Ensure proper GitHub Pages configuration
- Validate all internal links
- Use JSON validator
- Check for missing commas
- Verify UTF-8 encoding
- Backup before editing
- Validate all links monthly
- Update documentation as needed
- Review and merge PRs promptly
- Monitor GitHub Actions status
- Keep consistent coding style
- Document all major changes
- Regular backups
- Version control all changes
For issues or questions:
- Open GitHub issue
- Tag relevant maintainers
- Provide detailed problem description
- Include error messages/screenshots