Project: Word-Game

This project is a word game, that will be fully featured, word game. Where a player can play against either the computer as an opponent or play against a friend online(This will be the strecth task). This game will be built by several developers working as a team, from one repo. As such care needs to be taken so as not to undermine the work of another. Based on this, certain guidelines follow.

How to run this app locally

• Clone the repo.
• npm install
• Navigate to the /server/backend and run npm start.(this starts the server).
• Navigate back to the root folder and run npm start.

Guidelines

Read these guidelines carefully. Feel free to reach out, if you have any questions.

A few things to note

• Tasks will be broken down and apportioned shortly amonst all participating developers based on skill and interest.
• You will need to branch out of the master and create a separate branch, this is where you will be pushing your code to.
• After completing a module you will submit a PR, which will be reviewed,and then merged if it meets the standards and requirements fo the project.
• Use meaningful comments and commits to help yourself and others working on this project, its important that your code is readable and easy-on-the-eye.
• Do not merge your own code, atleast one member of the team should merge your code, in the case of subteams and the PM should merge code directly to the master branch.
• You will not need to fork this project, as a contributor/owner you can push directly to the repo, but never to the master. Pls resist the urge as much as possible :D

Description

• A player can Initiate a game between him/her and the computer or human opponent(stretch task). Once a game is instantiated, Then game begins a count down (The initiator of the game has the chance to set a time alloted for a player to finish a complete word before he lose's his turn)

• The game will generate say m rows of n-boxes where (n can be anything from 4 - 10). The Players are provided with an intelligent random set of tiles(I say intelligent because the random tiles must include enough letters to actually have several options of different word combinations possible), each tile carrying a letter(Think of it like the tiles in scrabble).

• The player is required to fill up one empty box making a correct word in the process, after which the computer or an opponent is required to play next. On completing a succesful word, the player is awarded a score, and then it becomes the opponent's turn to play. Failure to make up a correct word, a player can either choose to skip a turn this will mean the player loose's a turn. When a player cant seem to form a word after the countdown timer reaches zero, the other opponent is declared the winner.

• For the multiplayer version - once a game, a user can either play as anonymous or as a registered user, an only registered users can gain access to their play history, leaderboard and dashboard.

-When a multiplayer game is instantiated, the instantiator of the game will forward a unique link to his opponent,throw this link both can play together

• More information will come shortly! feel free to reach out if theres something you don't understand.

Project Dependencies

This list will be modified before project kicks-off fully

Frontend

• Redux (This will be a good way to practice next week's stuffs)
• A UI-framework either semantic-ui or material-ui (The UI team will pick this) excellent utility UI elements
• Animate.css aid with animations
• React-animations also help with animations
• react-icons Excellent for icons
• Style-components
• Formik Excellent for forms
• Chakra-UI- Excellent UI-Library
• Axios good ajax calls
• React-Icons, an exhasutive collection of Icons
• React-Notifications, for notifications
• Oxford dictionary api for validating words / We might still go the loal dictionary way...depends on our discussions.

Backend (This is no longer a stretch, it is now included in the core of the project)

• Nodejs
• Express
• SocketIO
• Redis or nedb for in-memory database

Minimum Viable Product

• A working game with the play against computer and atleast an opponent online.

Project Duration

This Project is designed to be intense, engaging and rewarding as well. It will stretch us, and also help us become comfortable with designing and building out a relatively complex application bit by bit. As such this project should be delivered in under 5 weeks.