Skip to content

Latest commit

 

History

History
31 lines (20 loc) · 1.39 KB

README.md

File metadata and controls

31 lines (20 loc) · 1.39 KB
Raw

Chinese New Year 2023 - Year of the Rabbit Card & Game

This is a Chinese New Year greeting card and mini video game for the Year of the Rabbit. Gong Xi Fa Cai, everyone!

Play it online at shaunanoordin.github.io/cny2023 or shaunanoordin.com/cny2023

Created by Shaun A. Noordin. Original code was based on AvO mk3.

How to Use

Start the web app by accessing index.html from your web browser. (Compatible with Chrome 108.)

Development Notes

  • Target audience: Casual gamers.
  • Target devices: PCs and mobile devices.
  • This is a web app built on HTML5, JavaScript, and Sass/CSS.
  • Developing the web app requires Node and NPM installed on your machine and a handy command line interface. (Bash, cmd.exe, etc)

Project anatomy:

  • Source JavaScript and Sass files are in the /src folder.
  • Compiled JS and CSS files are in the /app folder.
  • Media assets are meant to be placed in the /assets folder, but this is optional.
  • Entry point is index.html.

Starting the project:

  1. Install the project dependencies by running npm install
  2. Run npm start to start the server, or npm run dev to start the server in dev mode (i.e. source files will be watched and changes compiled dynamically.)
  3. Open http://localhost:3000 on your web browser to view the app.