Airsoft Database for Airsoft Spotter Application

This is a database of airsoft guns used in the AIRSOFT SPOTTER application.

Report Incorrect Data / Request to Add a New Airsoft Gun

Open the following link: https://github.com/Precision-Marks/airsoft_database/issues/new/choose

Environments required

Node.js: v20 (Tested by v20.8.1) npm >= 10.1.0

Run npm ci to install required packages from package-lock.json.

When adding or updating dependencies, use npm install <package> and commit both package.json and package-lock.json.

Dependency update procedure

Use npm ci for normal setup and CI runs.
Use npm install only when you intentionally update dependencies.

1. Create a branch for dependency updates.
2. Update dependencies (prefer scoped updates):
   • npm install <package>@latest
   • or npm update (use with care)
3. Verify both files changed as expected:
   • package.json
   • package-lock.json
4. Run verification commands:
   • npm ci
   • npm audit signatures
   • npm audit --audit-level=high
   • npm run test-database
5. Commit package.json and package-lock.json together and open a PR.
6. Merge only after CI checks pass (validate-csv and dependency-review).

Test/Verify CSV database source files

npm run test-database

Create binary database

sh build-databases.sh

If you would like to copy the DB files to AIRSOFT SPOTTER app:

sh cpdata.sh ../<app_repository>/app/src/main/assets

Output formats and options

• By default, both Realm and SQLite databases are generated.
• You can specify the format with --format:
  • realm: generate only Realm database
  • sqlite: generate only SQLite database
  • all: generate both (default)

Outputs:

• Realm: db/realm/catalog_data.realm and db/realm/catalog_data.realm.commitid
• SQLite: db/sqlite/catalog_data.db and db/sqlite/catalog_data.db.commitid
• Extracted SQLite DDL: db/sqlite/catalog_schema.sql

Examples:

• Generate both:
  • sh build-databases.sh
• Generate only SQLite (direct call):
  • npx ts-node src/index.ts --format sqlite -c <commit>

Contribution

To add/modify the gun database edit ./source_data/GunCatalog.csv

To add/modify manufacturer database, edit ./source_data/ManufacturerCatalog.csv

Please refer to the Data Schema section below for details on the required fields and format for these CSV files.

If you add a manufacturer, you should also add "generic" gun data in GunCatalog.csv. The "generic" data has ID < 10000 and starts from 0,25,50,75. And also set src/models/GunIdRange.ts. Gun ID for a manufacturer starts from n x 1000 to n x 1000 + 999.

Data Schema

Details about the structure and fields of the CSV source files can be found in the following documents:

• Manufacturer Catalog Schema: Describes the format of source_data/ManufacturerCatalog.csv. See docs/ManufacturerCatalog.md.
• Gun Catalog Schema: Describes the format of source_data/GunCatalog.csv. See docs/GunCatalog.md.

VsCode extensions recommended

• Rainbow CSV
• vscode-input-sequence: To set sequential id numbers