Omega Docs

Website for missing Omega 365 (NT) Documentation
Explore the docs »

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
   • Recommended IDE Setup
3. Usage
4. Roadmap

About The Project

More info comming soon

Built With

Frontend was written with Vue Composition API, with Bootstrap.

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

To run this project you'll need to have nodejs installed on your computer. You can download it here

Get latest npm version

• npm

  npm install npm@latest -g

Installation

1. Clone the repo

   git clone https://github.com/ArvidWedtstein/Omega-Docs.git

2. Install NPM packages

   npm install

3. Compile and Hot-Reload for Development

   npm run dev

4. Type-Check, Compile and Minify for Production

   npm run build

Recommended IDE Setup

VSCode + Volar (and disable Vetur) + TypeScript Vue Plugin (Volar).

Type Support for .vue Imports in TS

TypeScript cannot handle type information for .vue imports by default, so we replace the tsc CLI with vue-tsc for type checking. In editors, we need TypeScript Vue Plugin (Volar) to make the TypeScript language service aware of .vue types.

If the standalone TypeScript plugin doesn't feel fast enough to you, Volar has also implemented a Take Over Mode that is more performant. You can enable it by the following steps:

1. Disable the built-in TypeScript Extension
   1. Run Extensions: Show Built-in Extensions from VSCode's command palette
   2. Find TypeScript and JavaScript Language Features, right click and select Disable (Workspace)
2. Reload the VSCode window by running Developer: Reload Window from the command palette.

Customize configuration

See Vite Configuration Reference.

Deploying new feature

When starting work on a new feature, branch off from the dev branch:

git checkout -b myfeature Development
# Switched to a new branch "myfeature"

Finished features may be merged into the dev branch to definitely add them to the upcoming release:

git checkout dev
# Switched to branch 'dev'

git merge --no-ff myfeature
#Updating ea1b82a..05e9557
# (Summary of changes)

git branch -d myfeature
# Deleted branch myfeature (was 05e9557).

git push origin dev

Deploying

Hosted on netlify

Push to prod branch, and it will deploy automatically

Usage

Usage is comming soon

Roadmap

Roadmap comming soon (or never)

See the open issues for a full list of proposed features (and known issues).

(back to top)