Giter VIP home page Giter VIP logo

spc-web's Introduction

Scrabble Points Calculator React Frontend Application

This is an application which helps to calculate how many points a word (up to 10 chars) in scrabble would score. I am using the TDD (Test Driven Development) approach to build this application as much as possible within the allotted time, simply put writing tests before writing the implementation code and refactoring the code in the process. Read more here.

I will also be using TBD (Trunk Based Development) where I keep commits small and push directly to the main branch. Read more here.

Features

  • Enter any English word from 1-10 characters
  • Get scrabble score based on word entered
  • Save your score
  • Reset tiles
  • View top 10 scores
  • Validate if your word is an English word and if it is not, score is not calculated
  • If your word scores in the top ten, you will see a banner that informs you that your word has scored in the top ten and advises you to save

Getting Started

Please adhere to the package versions below (Prerequisites) to avoid any issues with installation.

Prerequisites

  • Node.js v19.0.0
  • npm v8.19.2
  • yarn 4.1.1 (with Corepack enabled, shipped default with Nodejs)

Installation

  1. Clone the repository:
git clone https://github.com/eLn86/spc-backend.git
  1. Navigate to the project directory:
cd spc-web
  1. Ensure corepack is enabled:
corepack enable
  1. Set yarn version:
yarn set version 4.1.1
  1. Install dependencies:
yarn install
  1. Start the development server:
yarn start

The application should now be running on http://localhost:3000. As API calls are made the moment you type a letter, please ensure that the backend is running first. You can get it up by following the instructions here: https://github.com/eLn86/spc-backend

Running Tests

I am using Jest for unit tests. You can run the tests via the following command:

yarn test

For test coverage, you can run:

yarn test --coverage

Built With

  • React JS
  • Axios for API calls
  • Create React App for bootstrapping
  • Ant Design for UI
  • Free dictionary API (https://dictionaryapi.dev/)

spc-web's People

Watchers

Elnathan Erh avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.