UWindsor CS Wiki

This repository contains the source code for the University of Windsor Computer Science Wiki, a collection of resources, guides, and information designed for students in the University of Windsor's Computer Science programs.

Requirements

• Node.js (>=14)
• PNPM (Installation Guide)
• Git (Installation Guide)

Installation

Windows

1. Download Node.js
2. Install PNPM:

   npm install --global pnpm

3. Install Git

macOS

1. Download Node.js or use:

   brew install node
   # OR
   sudo port install nodejs17

2. Install PNPM:

   npm install --global pnpm

3. Install Git via Xcode Command Line Tools:

   git --version

Linux (Debian/Ubuntu)

sudo apt update && sudo apt install git npm -y
npm install --global pnpm

Local Development

1. Clone the repository:

   git clone [email protected]:UWindsorCSS/Wiki.git

2. Install dependencies:

   pnpm install

3. Start the server:

   pnpm start

   Open: http://localhost:3000/wiki/

Build

Generate static content:

pnpm build

Serve

Serve static content after building:

pnpm serve

Article Requirements

Refer to the Article Requirements for more information on how to write articles.

Contributors

Thank you to all the contributors who made this wiki possible!