Skip to content

Commit

Permalink
Begin rewrite
Browse files Browse the repository at this point in the history
  • Loading branch information
cyderize committed Apr 7, 2024
1 parent b12ae9a commit 2685645
Show file tree
Hide file tree
Showing 116 changed files with 10,306 additions and 49,997 deletions.
13 changes: 9 additions & 4 deletions .github/workflows/build-and-deploy.yml
Original file line number Diff line number Diff line change
@@ -1,30 +1,35 @@
name: Build and Deploy to Prod
on:
push:
branches:
- master
pull_request:

jobs:
build:
name: Build
runs-on: ubuntu-latest
steps:
- name: Checkout Repo
uses: actions/checkout@master
uses: actions/checkout@v4
- name: Setup Node
uses: actions/setup-node@v4
with:
node-version: '20'
cache: npm
- name: Setup Pages
id: setup_pages
uses: actions/configure-pages@v5
- name: Install Dependencies
run: npm ci
- name: Build
run: npm run build
env:
BASE_PATH: ${{ steps.setup_pages.outputs.base_path }}
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: ./build
path: ./dist
deploy:
if: ${{ github.ref == 'refs/heads/main' }}
permissions:
pages: write
id-token: write
Expand Down
79 changes: 22 additions & 57 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,59 +1,24 @@
# Windows image file caches
Thumbs.db
ehthumbs.db
# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
pnpm-debug.log*
lerna-debug.log*

# Folder config file
Desktop.ini

# Recycle Bin used on file shares
$RECYCLE.BIN/

# Windows Installer files
*.cab
*.msi
*.msm
*.msp

# Windows shortcuts
*.lnk

# =========================
# Operating System Files
# =========================

# OSX
# =========================

.DS_Store
.AppleDouble
.LSOverride

# Thumbnails
._*

# Files that might appear in the root of a volume
.DocumentRevisions-V100
.fseventsd
.Spotlight-V100
.TemporaryItems
.Trashes
.VolumeIcon.icns

# Directories potentially created on remote AFP share
.AppleDB
.AppleDesktop
Network Trash Folder
Temporary Items
.apdisk

# Log files
**/*.log

# Node modules and build folder
node_modules
build
working
doc

# Vim
*.swp
dist
dist-ssr
*.local

# Editor directories and files
.vscode/*
!.vscode/extensions.json
.idea
.DS_Store
*.suo
*.ntvs*
*.njsproj
*.sln
*.sw?
4 changes: 4 additions & 0 deletions .prettierrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"singleQuote": true,
"useTabs": true
}
28 changes: 0 additions & 28 deletions .travis.yml

This file was deleted.

1 change: 0 additions & 1 deletion CNAME

This file was deleted.

123 changes: 0 additions & 123 deletions Gruntfile.js

This file was deleted.

60 changes: 4 additions & 56 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,78 +1,26 @@
# MARIE.js
==============
MARIE.js
========

MARIE.js is an implementation of a simulator for a 'Machine Architecture that is Really Intuitive and Easy'
from [The Essentials of Computer Organization and Architecture](https://books.google.com.au/books/about/The_Essentials_of_Computer_Organization.html?id=3kQoAwAAQBAJ&redir_esc=y) (Linda Null, Julia Lobur) in JavaScript.

**[Try the simulator](https://marie-js.github.io/MARIE.js/)**

It is used within the unit [FIT1047 - Introduction to computer systems, networks and security](http://www.monash.edu/pubs/handbooks/units/FIT1047.html) at [Monash University](https://monash.edu)
It is used within the unit [FIT1047 - Introduction to computer systems, networks and security](http://www.monash.edu/pubs/handbooks/units/FIT1047.html) at [Monash University](https://monash.edu).

![Monash Uni logo](https://www.monash.edu/__data/assets/git_bridge/0006/509343/deploy/mysource_files/monash-logo-mono.svg)

## Setup
Latest Stable: [https://github.com/MARIE-js/MARIE.js/releases/latest](https://github.com/MARIE-js/MARIE.js/releases/latest])

Latest Release: [https://github.com/MARIE-js/MARIE.js/archive/master.zip](https://github.com/MARIE-js/MARIE.js/archive/master.zip)

This is for web developers who would like to develop, build or deploy the
MARIE.js project. If this is you, then continue reading below.

MARIE.js is essentially a front-end only site with no servers or databases.
The tools we use are `npm` and `grunt`, which makes developing this project
a little easier.

It is recommended that you use a Unix-like operating system to build, test and
run the code. You'll need to install `npm`, then run the following commands to
install dependencies, build the release version, and run a localhost server as
well as opening the default browser directing to the localhost site.

npm run start

## Development
To test and build the development version of MARIE.js, run the following
commands.

npm ci
npm run start
npm run dev

## Building
To build just run

npm run build

## Documentation
We use jsdoc for documenting the code. This can be found within the `doc`
folder.

If you want to build the documentation website again (if you have, say, made
some changes to the documentation of the JavaScript code), then run this
command.

grunt jsdoc

## Contribute
If you would like to contribute to this project, simply fork this repository
then make the changes to the forked repository. Once changes are made, perform a
pull request to this repository. We'll review the pull request, and if it is
accepted, we'll add your name to our license.

## Recommended Commit/Pull Request Tags
[HF] HotFix
[P] Patch
[PROV] Provisioning Update
[CU] Cumulative Update
[MU] Migration Updates

[D] Dependency Update
[DOC] Documentation Updates

[UI] User Input/Ouput Update
[UX] User Experience Update
[GAPI] Google API Updates

[O] Other

## License

### The MIT License (MIT)
Expand Down
15 changes: 0 additions & 15 deletions deploy.sh

This file was deleted.

13 changes: 13 additions & 0 deletions index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!doctype html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<link rel="icon" type="image/png" href="/logo.png" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>MARIE.js</title>
</head>
<body>
<div id="app"></div>
<script type="module" src="/src/main.ts"></script>
</body>
</html>
Loading

0 comments on commit 2685645

Please sign in to comment.