README.md

PostApoc - A Survival Simulation Game

Welcome to PostApoc, a real-time survival simulation game. As a player, you're thrown into a post-apocalyptic world where you need to master survival skills, through crafting, base building, and combat.

Table of Contents

• Installation
• Running the Game
• Contributing
• Testing
• Dependencies
• Changelog
• Project Structure
• License

Installation

1. Clone the repository:

   git clone https://github.com/Unnamed-GameDev-Studio/postapoc

2. Navigate to the project directory:

   cd postapoc

3. Install the dependencies:

   yarn install

Running the Game

1. Start the development server:

   yarn dev

2. Build for production:

   yarn build

3. Serve the built files:

   yarn serve

Contributing

We encourage you to contribute to PostApoc! Please check out the Contributing guide for guidelines about how to proceed.

Testing

Run all unit and end-to-end tests:

yarn test

You can also run unit tests and end-to-end tests separately:

yarn test:unit
yarn test:e2e

For test coverage report:

yarn coverage

Dependencies

PostApoc is built using various technologies including but not limited to Phaser, bitECS, RBush, Mitt, and LogLevel. The complete list of dependencies can be found in the package.json file.

Changelog

The changelog is available here. A detailed commit history is also available here.

Project Structure

Please refer to the FILETREE.md for a detailed project structure.

License

PostApoc is released under the MIT License.

For any additional information, please refer to the files included in this repository or open a new issue.