Files
navi/README.md
ztimson 4735968612
All checks were successful
Build and publish / Build Container (push) Successful in 1m29s
Nav init
2026-02-28 23:27:35 -05:00

83 lines
2.5 KiB
Markdown

<!-- Header -->
<div id="top" align="center">
<br />
<!-- Logo -->
<img src="navi/logo.png" alt="Logo" width="200" height="200">
<!-- Title -->
### Net Navi
<!-- Description -->
Your personal AI assistant
<!-- Repo badges -->
[![Version](https://img.shields.io/badge/dynamic/json.svg?label=Version&style=for-the-badge&url=https://git.zakscode.com/api/v1/repos/ztimson/navi/tags&query=$[0].name)](https://git.zakscode.com/ztimson/navi/tags)
[![Pull Requests](https://img.shields.io/badge/dynamic/json.svg?label=Pull%20Requests&style=for-the-badge&url=https://git.zakscode.com/api/v1/repos/ztimson/navi&query=open_pr_counter)](https://git.zakscode.com/ztimson/navi/pulls)
[![Issues](https://img.shields.io/badge/dynamic/json.svg?label=Issues&style=for-the-badge&url=https://git.zakscode.com/api/v1/repos/ztimson/navi&query=open_issues_count)](https://git.zakscode.com/ztimson/navi/issues)
<!-- Links -->
---
<div>
<a href="https://git.zakscode.com/ztimson/navi/wiki" target="_blank">Documentation</a>
• <a href="https://git.zakscode.com/ztimson/navi/releases" target="_blank">Release Notes</a>
• <a href="https://git.zakscode.com/ztimson/navi/issues/new?template=.github%2fissue_template%2fbug.md" target="_blank">Report a Bug</a>
• <a href="https://git.zakscode.com/ztimson/navi/issues/new?template=.github%2fissue_template%2fenhancement.md" target="_blank">Request a Feature</a>
</div>
---
</div>
## Table of Contents
- [Net Navi](#top)
- [About](#about)
- [Built With](#built-with)
- [Setup](#setup)
- [Production](#production)
- [Development](#development)
- [License](#license)
## About
Your personal AI network navigator
## Setup
<details>
<summary>
<h3 id="production" style="display: inline">
Production
</h3>
</summary>
#### Prerequisites
- [Docker](https://docs.docker.com/install/)
#### Instructions
1. Run the docker image: `docker run -p 80:80 git.zakscode.com/ztimson/navi:latest`
2. Open [http://localhost](http://localhost)
</details>
<details>
<summary>
<h3 id="development" style="display: inline">
Development
</h3>
</summary>
#### Prerequisites
- [Node.js](https://nodejs.org/en/download)
#### Instructions
1. Install the dependencies: `npm install`
2. Start the Angular server: `npm run start`
3. Open [http://localhost:4200](http://localhost:4200)
</details>
## License
Copyright © 2023 Zakary Timson | All Rights Reserved | Available under MIT Licensing
See the [license](./LICENSE) for more information.