zandemax/KingsCastle

KingsCastle.io

The reincarnation of the classic pen and paper game Kingscastle. (Simplified Go)
View Game · Report Bug · Request Feature

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Roadmap
• Contributing
• License
• Contact
• Acknowledgements

Built With

• Vue.js
• Node.js
• Webpack

Getting Started

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

Installation

1. Clone the repo

git clone https://github.com/TheNewCivilian/KingsCastle

2. Start the components in dev mode

cd backend
npm install
node src/main.js
cd ..

cd frontend
npm install
npm run serve 
cd ..

3. Run Frontend build

cd frontend
npm run build 

4. Serve Build via Webserver You will find the backend in /backend. This represents the server. It can be run with node src/main.js and served via a reverse proxy. In frontend you will find static web content which represents the client. This needs to be served by a standard webserver.

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

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

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

License

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

Contact & Contributors

TheNewCivilian - https://neuz8t.de - private Webpage

Project Link: https://github.com/TheNewCivilian/KingsCastle