Code Monkey home page Code Monkey logo

click-the-fox's Introduction

Assignment

Getting Started

  • This project was bootstrapped with Create React App + Typescript
  • The following version has been used for this application
  • The node version used : v10.16.3
  • The npm version used : 6.9.0

Running the project in your local

  1. Ensure you have nodeJS (the version specified above installed)
  2. Clone the project,
  3. Run into the root of the folder and execute npm install
  4. Run npm start in the root directory of the project
  5. The project should be up and running. Open http://localhost:3000/
  6. The page will reload if you make edits.

Testing

  • For unit testing jest framework has been used along with enzyme.
  • To execute the unit test cases, please run npm run test. This will run all the test in watch mode.

Approach for problem the code solution is trying to solve.

  1. The images are not shown till the time they are loaded to create a seamless experience
  2. The images are preloaded from before
  3. The painting process/time of images has also been taken into account

Production Build

  1. The production build folder can be generted using npm run build
  2. It will create a build folder. You may serve it with a static server, which can be served therogh any process manager ex: PM2, forever
  3. Currently it is being served using express server, the configs are written in server.js file
  4. For using it install PM2 process manager globally in the machine using npm install pm2 -g
  5. A PM2 configuration file is provided as pm2-config.json
  6. The app can be served using pm2 start pm2-config.json
  7. It will run on http://localhost:3000/

Optimizations

  1. Typescript has been used for the type checkings so that most of the errors can be caught on development phase itself
  2. Linting and pre-commit hooks have been used to follow the code quality and a same pattern
  3. Unit testing setup has been done so that a TDD approach can be taken up
  4. Lazy loading to improve performance
  5. Chunking and hashing the build files generated

Screens

  1. Welcome Screen

Screenshot 2021-09-01 at 4 31 05 AM

  1. Welcome screen with name

Screenshot 2021-09-01 at 4 31 15 AM

  1. Hello Screen

Screenshot 2021-09-01 at 4 31 21 AM

  1. Loading Screen

Screenshot 2021-09-01 at 4 40 08 AM

  1. Play Screen

Screenshot 2021-09-01 at 4 31 30 AM

  1. Scoreboard

Screenshot 2021-09-01 at 4 39 08 AM

click-the-fox's People

Contributors

koshtaayush avatar

Stargazers

 avatar

Watchers

 avatar  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.