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 (Linda Null, Julia Lobur) in JavaScript.

Try the simulator

It is used within the unit FIT1047 - Introduction to computer systems, networks and security at Monash University

Setup

Latest Stable: https://github.com/MARIE-js/MARIE.js/releases/latest

Latest Release: 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

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)

Copyright © 2016 - 2019 Jason Nguyen, Saurabh Joshi, Eric Jiang, Erfan Norozi, Josh Nelsson-Smith, Guido Tack Copyright © 2017 - 2024 Monash University

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.