apinavigator / gui

API Navigator enables developers to traverse large and complex API References smoothly and efficiently through a top-notch PWA.

API Navigator

API Navigator enables developers to traverse large and complex API References smoothly and efficiently through a top-notch PWA.

Live Demo

API Navigator

Getting Started

Requirements

• GIT
• Node.js ^v22.2.0
• NPM ^v10.7.0

Installation

Clone the repository

$ git clone [email protected]:apinavigator/gui.git

Install the dependencies

$ npm install

Usage

Run the Development Vite Server

$ npm run dev

Open http://localhost:5173/ (the port may vary) with your favorite browser.

Build Process

Run the Vite Production Build

$ npm run build

Deployment

When a commit is pushed to the main branch, Github Workflows automatically pushes the new distribution to Firebase Hosting.

Built With

• HTML
• CSS
• TypeScript
• React

Running the Tests

# Unit Tests
$ npm run test:unit

# Integration Tests
$ npm run test:integration

# E2E Tests
$ npm run test:e2e

Branding

Font: Montserrat

Primary Color: #0C0C0C

Secondary Color: #171717

Success Color: #1B5E20

Error Color: #B71C1C

Warn Color: #BF360C

Info Color: #0D47A1

Light Mode

Text Color: #0f172a

Light Text Color: #64748b

Background Color: #f7f1f1

Dark Mode

Text Color: #ffffff

Light Text Color: #94a3b8

Background Color: #1e293b

@TODO

• ...

License

MIT

Acknowledgments

• Montserrat | Google Fonts
• MDN