Package Exports
- project-indexer
- project-indexer/src/projectIndexer.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (project-indexer) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
Project Indexer
A local project indexer with browser trigger support.
Installation
You can install this package globally:
npm install -g project-indexerOr use it directly with npx:
npx project-indexerUsage
Running in the Terminal
Once installed, you can start the indexer server in the terminal:
project-indexerThis will start a server on port 5666 that provides endpoints for indexing projects.
Running as a Background Service
To run the indexer as a background service that starts automatically when your system boots:
Install the package globally:
npm install -g project-indexer
Install as a service:
# Navigate to where the package is installed cd $(npm root -g)/project-indexer # Install the service npm run service:install
Service Management Commands
Check service status:
npm run service:statusStop the service:
npm run service:stopUninstall the service:
npm run service:uninstall
API Endpoints
POST /index: Index a project- Request body:
{ "dir": "/path/to/project", "projectId": "your-project-id", "serverUrl": "https://your-server-url", "projectName": "Your Project Name", "token": "your-auth-token", "deviceId": "your-device-id" }
- Request body:
GET /status: Check indexing status- Response:
{ "indexing": true|false }
- Response:
Development
To run the project locally:
# Clone the repository
git clone <repository-url>
cd project-indexer
# Install dependencies
npm install
# Start the server
npm startLicense
ISC