SiteSurveyor Documentation

Getting Started

Installation

git clone https://github.com/consolationmangena/sitesurveyor.git
cd sitesurveyor
npm install

Running the Project

npm run dev

This will start the development server at http://localhost:3000

API Reference

Survey Endpoints

GET /api/surveys - List all surveys

POST /api/surveys - Create new survey

Contributing

Development Workflow

  1. Fork the repository
  2. Create a new branch (git checkout -b feature/your-feature)
  3. Commit your changes
  4. Push to the branch
  5. Open a Pull Request

Code Style

Please follow the existing code style and run npm run lint before committing.

Support

For additional help, please:

  • Check the GitHub Issues
  • Open a new issue if your problem isn't documented
  • Join our community forum (coming soon)