Add comprehensive Getting Started guide to frontend README #196
+109
−0
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR addresses issue #XXX by adding a comprehensive Getting Started section to the frontend README, making it easier for new contributors to set up and start developing with the Disfactory frontend.
What's Added
The new Getting Started section includes:
Prerequisites - Clear requirements for Node.js 16+, npm, and Git with helpful download links and version manager recommendations
Quick Start Guide - A streamlined 4-step process to get developers from zero to running:
npm install.env.examplenpm run serveAvailable Scripts Table - Documentation of all npm commands with clear descriptions:
npm run serve- Development server with hot-reloadnpm run build- Production buildnpm run test- Unit testsnpm run test:watch- Tests in watch modenpm run lint- Code lintingnpm run typecheck- TypeScript type checkingProject Structure - Visual overview of key directories (
src/,docs/,public/) and their purposesDevelopment Environment - Summary of the tech stack including Vue.js 2.7, Vuetify 2.x, OpenLayers, TypeScript, and Jest
Troubleshooting Section - Practical solutions for common setup issues:
Contributing Guidelines - Step-by-step workflow for new contributors including branching, testing, and PR submission
Testing
All commands and instructions have been thoroughly tested to ensure they work correctly:
http://localhost:8080The documentation maintains consistency with the existing structure while providing everything a new developer needs to quickly get started with the Disfactory frontend project.
Fixes #70
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.