Contributing

Development Setup

1. Clone the repository

   git clone https://github.com/Turbotailz/athena-api.git
   cd athena-api
   

2. Install dependencies

   npm install
   

3. Build Data Run the build script to process the raw JSON files in data/ and generate the TypeScript database.

   npm run build-data
   

4. Run Locally Start the development server.

   npm run dev
   

Data Structure

The source of truth for all data lives in the data/ directory.

• data/heroes.json: Hero definitions and metadata.
• data/items-by-locale.json: Item definitions.
• data/heroes-items.json: Links between heroes and their specific items.

To add a new hero or item, edit these JSON files and run npm run build-data to verify the changes.

License

This project is licensed under the MIT License.

For Maintainers

If you are a project maintainer looking for details on deployment, versioning, and automated workflows, please see the Maintenance Guide.