{"id":27150926,"url":"https://github.com/micqo/galvanico","last_synced_at":"2025-04-08T14:22:09.106Z","repository":{"id":283715885,"uuid":"952684958","full_name":"MIcQo/galvanico","owner":"MIcQo","description":"Galvanico is an open-source, browser-based strategy game inspired by Ikariam, but set in the Industrial Age. Players develop their own industrial cities, research new technologies, manage resources, and engage in trade and diplomacy in a world powered by electricity and innovation.","archived":false,"fork":false,"pushed_at":"2025-04-05T03:55:07.000Z","size":210,"stargazers_count":4,"open_issues_count":17,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-05T04:24:52.658Z","etag":null,"topics":["browser-game","cockroachdb","game","game-development","golang","nats","open-source","vue","vue3"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/MIcQo.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2025-03-21T17:41:37.000Z","updated_at":"2025-04-05T03:55:07.000Z","dependencies_parsed_at":null,"dependency_job_id":"b6e6dfc4-c6a9-4e7f-82dc-fb054d2e38f3","html_url":"https://github.com/MIcQo/galvanico","commit_stats":null,"previous_names":["micqo/galvanico"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MIcQo%2Fgalvanico","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MIcQo%2Fgalvanico/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MIcQo%2Fgalvanico/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MIcQo%2Fgalvanico/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MIcQo","download_url":"https://codeload.github.com/MIcQo/galvanico/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247856893,"owners_count":21007673,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["browser-game","cockroachdb","game","game-development","golang","nats","open-source","vue","vue3"],"created_at":"2025-04-08T14:22:08.235Z","updated_at":"2025-04-08T14:22:09.058Z","avatar_url":"https://github.com/MIcQo.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Galvanico\n\n[![Contributions Welcome](https://img.shields.io/badge/Contributions-Welcome-brightgreen.svg)](CONTRIBUTING.md)\n\nGalvanico is an open-source, browser-based strategy game inspired by Ikariam, but set in the Industrial Age. Players develop their own industrial cities, research new technologies, manage resources, and engage in trade and diplomacy in a world powered by electricity and innovation.\n\n## Features\n\n* **Industrial Age Setting:** Immerse yourself in a world of steam engines, early electricity, and burgeoning industries.\n* **City Building:** Construct and manage various industrial buildings, including factories, power plants, and research labs.\n* **Research \u0026 Technology:** Unlock new technologies to improve your city's efficiency, military strength, and economic power.\n* **Resource Management:** Gather and manage resources like coal, iron, and electricity to fuel your industrial empire.\n* **Trade \u0026 Diplomacy:** Interact with other players through trade agreements, alliances, and diplomacy.\n* **Military Expansion:** Build and command industrial-era military units to defend your city and conquer new territories.\n* **Electricity System:** A core mechanic, managing and generating electricity to power your industrial buildings.\n* **Open Source:** Contribute to the development and shape the future of Galvanico.\n\n## Getting Started\n\n### Prerequisites\n\n* Go (latest stable version)\n* Node.js (latest LTS recommended)\n* npm (or yarn)\n* A modern web browser\n\n### Installation\n\n1.  Clone the repository:\n\n    ```bash\n    git clone https://github.com/MIcQo/galvanico.git\n    cd galvanico\n    ```\n\n2.  Install backend dependencies (Go):\n\n    ```bash\n    go mod tidy\n    ```\n3. Stand up required services:\n\n    ```bash\n    docker compose up -d\n    ```\n\n4. Configure environment variables:\n\n    ```bash\n    cp config.example.yaml config.yaml\n    ```\n\n    Edit `config.yaml` with your desired settings.\n\n\n5. Initialize the database:\n\n    First, you need to create the inital bun migration schema:\n\n    ```bash\n    go run main.go db init\n    ```\n\n5.  Start the backend server:\n\n    ```bash\n    go run main.go serve\n    ```\n\n4.  Install frontend dependencies (Vue 3):\n\n    ```bash\n    cd client\n    npm install # or yarn install\n    cd ..\n    ```\n\n5.  Start the frontend development server:\n\n    ```bash\n    cd client\n    npm run dev # or yarn dev\n    ```\n\n6.  Open your browser and navigate to `http://localhost:5173`. (or the port that Vue dev server outputs)\n\n## Development\n\nWe welcome contributions from the community! Please read our [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on how to contribute.\n\n### Project Structure\n\n```\ngalvanico/\n├── cmd/                # Go commands\n├── client/             # Frontend code (Vue 3, etc.)\n├── internal/           # Internal code between server parts (if any)\n├── migrations/         # Migration files\n├── docs/               # Documentation\n├── docker-compose.yaml # Docker compose file\n├── CONTRIBUTING.md     # Contribution guidelines\n├── LICENSE             # License information\n└── README.md           # This file\n```\n\n### Technologies Used\n\n* **Frontend:** [Vue 3](https://vuejs.org/) , [TypeScript](https://www.typescriptlang.org/)\n* **Backend:** [Go](https://golang.org/)\n* **Database:** [PostgreSQL](https://www.postgresql.org/) (actually, we\n  use [CockroachDB](https://github.com/cockroachdb/cockroach))\n* **Broker:** [NATS](https://github.com/nats-io/nats-server)\n\n## Contributing\n\nWe encourage you to contribute to Galvanico! Here's how you can get involved:\n\n* **Report Bugs:** If you find a bug, please open an issue on GitHub.\n* **Suggest Features:** Share your ideas for new features and improvements.\n* **Submit Pull Requests:** Contribute code, documentation, or other improvements.\n* **Help with Design:** Contribute to the game's visual design and user interface.\n* **Translate the Game:** Help us make Galvanico accessible to a wider audience.\n\nPlease read our [CONTRIBUTING.md](CONTRIBUTING.md) for detailed guidelines.\n\n## License\n\nGalvanico is released under the [Apache 2.0 License](LICENSE).\n\n## Acknowledgments\n\n* Inspired by [Ikariam](https://www.ikariam.com/).\n* Thanks to all contributors and the open-source community.\n\n## Contact\n\nFor any questions or inquiries, please open an issue on GitHub.\n\n---\n\n**Let's build the industrial age together!**","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmicqo%2Fgalvanico","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmicqo%2Fgalvanico","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmicqo%2Fgalvanico/lists"}