Planiwiki

Planiwiki serves as an extension to the Planimation Documentation Page. The original site lacked documentations on some important functions, and also didn't have many sample animations for visitors to truly appreciate the magnificence of Planimation. In an attempt to tackle the aforementioned issues, as well as promoting Planimation among students and researchers in the field of artificial intelligence, Planiwiki is created.

Demo

Live Demo

Key features

• Extensive description on Planimation-specific functions with video demonstrations and code examples.
• More description on existing domains, along with easily accessible and executable source code.
• A reference page linking to other PDDL resources.
• Accepting community recommendations and suggestions.

Documentation

User Stories

Models & Diagrams

• Motivational Model
• Domain Model
• System Sequence Diagram
• Architecture Diagram
• Website Database Schema
• Deployment View

Test Cases

• Test Report
• Acceptance Criteria & Acceptance Testing Plan
• Frontend High Level Testing Plan
  • Frontend Elaborated Test Cases
• Backend High Level Testing Plan
  • Backend Elaborated Test Cases

Technical Details

System requirements

• Node.js (v18.16.0)
• Firebase (12.5.4)
• Git (2.30.1)

Setting up

Get Source

The source code and related artefacts are hosted in Github, repository can be cloned through the following command:

git clone https://github.com/7angel4/planimation-website.git

git clone https://github.com/planimation/frontend.git planimation-frontend All the code is available in https://github.com/planimation/

Node.js Installation

1. Navigate to project root directory

2. Install Node.js and npm (if not already installed):

   • You can download and install Node.js from the official website. npm is included with Node.js.
   • Alternatively, if you have Homebrew installed, you can use it to install Node.js and npm: brew install node

Firebase access

Email Yezihanz@student.unimelb.edu.au for access to firebase.

Firebase Installation

1. Navigate to project root directory

2. Install the Firebase Command line Interface (CLI) Tools: Once you have npm installed, you can install the Firebase CLI using the following command:

   $ npm install -g firebase-tools
   

3. Verify the Installation: After the installation is complete, you can verify it by checking the version of the Firebase CLI:

   $ firebase --version
   

4. Login to Firebase: To interact with your Firebase projects, you'll need to authenticate with your Google account (the one that was given Firebase access):

   $ firebase login
   

   • This command will open a new browser window asking you to authenticate with your Google account. Once authenticated, the CLI will be linked to your Firebase projects.

5. Initialise your local project as Firebase project:

   $ firebase init
   

   Follow the prompts to initialize. Follow the default answer unless otherwise stated below:

   • For the step Which Firebase features do you want to set up for this directory?, select Firestore, Functions, Hosting (the first out of two), Emulators.
   • For the step Would you like to initialize a new codebase, or overwrite an existing one?, select Overwrite.

Deployment

• Deploy using emulator:

  $ firebase emulators:start
  

• Deploy to website:

  $ firebase deploy
  

Changelog

version history

Contributors

Tony He 💻	Angel He 💻	Shutong Luo 💻	Angela Yuan 💻	Yezihan Zhou 💻