# gui

**Repository Path**: mirrors_freenas/gui

## Basic Information

- **Project Name**: gui
- **Description**: FreeNAS Corral GUI project
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-09-24
- **Last Updated**: 2026-02-14

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<img src="https://avatars0.githubusercontent.com/u/3792476?v=3&s=200">

# FreeNAS Corral GUI Development

FreeNAS Corral is the next version of FreeNAS, a FreeBSD-based open source NAS / application hosting software appliance. This repo is where development of the GUI happens.

The FreeNAS Corral GUI is based on various HTML5 Javascript development frameworks and technologies.

Please read the [CONTRIBUTING.md](https://github.com/freenas/gui/blob/master/CONTRIBUTING.md) document for the full documentation on contributing to the GUI project.  The quick TL;DR version of how to get started is:

1. Check out this repo somewhere and cd to it.
2. Install FreeNAS Corral on a VM / machine (let's call it freenas.local)
3. npm install (to install the various tools locally).
4. npm run-script serve & (run the stand-alone web server)
5. Go to http://localhost:3000/#?host=freenas.local

Edit sources as desired and the web server should pick up the changes, for
incremental style development.