Init

shaunanoordin · Dec 29, 2020 · 71e1732 · 71e1732
commit 71e1732
Show file tree

Hide file tree

Showing 19 changed files with 5,920 additions and 0 deletions.
diff --git a/.babelrc b/.babelrc
@@ -0,0 +1,4 @@
+{
+  "plugins": ["@babel/plugin-proposal-optional-chaining"],
+  "presets": ["@babel/preset-env"]
+}
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,2 @@
+node_modules
+.DS_Store
diff --git a/README.md b/README.md
@@ -0,0 +1,29 @@
+# Chinese New Year 2021 - Year of the Ox Card & Game
+
+This is a Chinese New Year greeting card and mini video game for the Year of the Ox. Gong Xi Fa Cai, everyone!
+
+Created by [Shaun A. Noordin](https://shaunanoordin.com).
+
+## How to Use
+
+Start the web app by accessing `index.html` from your web browser. (Compatible with Chrome 87.)
+
+## Development Notes
+
+- Target audience: Casual gamers who celebrate Chinese New Year.
+- Target devices: PCs and mobile devices.
+- This is a web app built on HTML5, JavaScript, and [Sass](https://sass-lang.com/)/CSS.
+- Developing the web app requires [Node](https://nodejs.org/) 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.
diff --git a/app/main.css b/app/main.css
diff --git a/app/main.css.map b/app/main.css.map
diff --git a/app/main.js b/app/main.js
diff --git a/assets/simple-bg.png b/assets/simple-bg.png
diff --git a/index.html b/index.html
@@ -0,0 +1,24 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+<meta charset="UTF-8">
+<title>Chinese New Year 2021 - Year of the Ox</title>
+<meta name="viewport" content="width=device-width, initial-scale=1">
+<meta name="theme-color" content="#cc4444">
+<link href="https://fonts.googleapis.com/css?family=Source+Code+Pro:300" rel="stylesheet">
+<link href="./app/main.css" rel="stylesheet">
+<script src="./app/main.js"></script>
+</head>
+<body>
+<div id="app">
+<header>
+  <h1>Chinese New Year 2021 - Year of the Ox</h1>
+</header>
+<main>
+  <canvas id="canvas" />
+  <output id="console"></output>
+</main>
+<footer><a href="https://shaunanoordin.com">shaunanoordin.com</a> / 2021</footer>
+</div><!--/#app-->
+</body>
+</html>