Skip to content
This repository has been archived by the owner on Apr 19, 2019. It is now read-only.

Home

Jump to bottom
ZlLow edited this page Feb 12, 2019 · 22 revisions

Welcome to One Journey! Here is the documentation for this project.

Background

OneJourney is an Angular web application which aims to be self-service, one-stop site for all ICT staffs and student. It automates and handles all ICT-related matters, managing events, leaderboard, submission of MC and reward system. It has been integrated the eLocker System at block 27 Level 5 with the reward system.

Why Angular

With Angular, there are many tools available to get started on crafting the application right away. You have directives to give HTML elements dynamic behavior. You can power up the forms using FormControl and introduce various validation rules. You may easily send asynchronous HTTP requests of various types. You can set up routing with little hassle.

  1. Components are decoupled. Angular strived to remove tight coupling between various components of the application.
  2. Injection happens in NodeJS-style and you may replace various components with ease.
  3. All DOM manipulation happens where it should happen. With Angular, you don’t tightly couple presentation and the application’s logic making your markup much cleaner and simpler.
  4. Testing is at the heart for Angular. Angular application can be thoroughly tested and it supports both unit and end-to-end testing with tools like Jasmine and Protractor.
  5. Angular generally has a better UI/UX as it is mobile and desktop-ready. In other words, Angular is well designed to run on multiple platforms.
  6. Angular is actively maintained and has a large and vibrant community and ecosystem. There are lots of materials and useful third-party tool for this framework.

Installation Guide

Requirements

If you're on Mac

You will need to install Node.js. Open up terminal & type in brew install node (For brew look here)

If you're on Windows

You just have to install Node from here

To see whether you've install Node.js & NPM. Type in node -v and npm -v

Running the project

Clone the project.

Navigate to the project directory cd site/your-site and type this command npm install
(This should install all the necessary packages for the project)

Type ng serve to run the application.
(The application will run on localhost:4200)

Supported Browsers

Please run the application on either Firefox or Chrome

Getting Started

Click here for more information.

Documentation

For more documentation, switch branch from master to stable,

type this command:

npm run compodoc

This will auto generate the document for the software application.

Clone this wiki locally