Settlers of Catan

Report Bug · Request Feature

Overview

Welcome to my Settlers of Catan application, inspired by the 2-player version of Catan, Rivals for Catan. This was my first project using TypeScript and itegrating frontend and backend technologies in a single application.

While still in development, the application currently supports key features such as playing and building cards, collecting resources, and initial multiplayer functionality using web sockets with Socket.io.

Future plans for the application include enhancing the multiplayer features, improving the user interface, and adding additional game mechanics. Feel free to explore the project, report issues, or contribute to its ongoing development.

Built With

Getting Started

This section provides instructions on how to get a local copy up and running.

Prerequisites

Before installing, make sure you have the following tools installed:

• Node.js: The runtime environment for executing JavaScript code server-side. You can download it from Node.js official website.

• npm (Node Package Manager): Comes with Node.js, but you can check if it's installed by running npm -v in your terminal. If you need to update npm, run:

  npm install npm@latest -g

Installation

To get a local copy up and running follow these simple steps.

1. Clone the repository Begin by cloning the repository to your local machine:

   git clone https://github.com/austin-cavanagh/settlers-of-catan.git

2. Navigate to the project directory Enter directory after cloning:

   cd settlers-of-catan

3. Install dependencies Install the necessary packages using npm:

   npm install

4. Start the development server To start the Vite development server run:

   npm run dev

5. Happy coding!

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Contact

Austin Cavanagh - GitHub - LinkedIn - austin.cavanagh.cs@gmail.com

License

Distributed under the MIT License. See LICENSE.txt for more information.