README.md

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgements

About The Project

An online version of the Codenames board game, where two opposing teams each have a spymaster who provides a one-word hint and number of corresponding words, and the guesser(s) have to choose their team's words while avoiding other colours.

Includes authentication, and a public/private lobby feature, and stripe integration for upgrading player accounts to support private games.

Built With

• React
• Socket.io
• NodeJS
• Express

Getting Started

Prerequisites

NodeJS is the only required dependency of the application.

Installation

To Launch your own local version of CodeWords:

1. Clone the repo

   git clone https://github.com/hatchways/team-fruit-loops.git

2. Install NPM packages

   npm install

3. Create a .env file with your API keys

   cp .env.example .env

Usage

CodeWords is available to play here

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.

Contributors

Team Leader:

• Sina Jamshidi

Members:

• Peixing Ma
• Travis Matthews
• Alan Vuong

Contact

Peixing Ma - github

Travis Matthews - github

Alan Vuong - github

Project Link: https://github.com/hatchways/team-fruit-loops

Acknowledgements

• Img Shields
• Choose an Open Source License