GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — GitHub - xlc-dev/novaexample: Example project written with Nova.

BranchesTags
Open more actions menu

Latest commit

 

History

16 Commits
16 Commits

Folders and files

NameName
Last commit message
Last commit date
static
static
 
 
.gitignore
.gitignore
 
 
LICENSE
LICENSE
 
 
README.md
README.md
 
 
go.mod
go.mod
 
 
go.sum
go.sum
 
 
main.go
main.go
 
 

Repository files navigation

Nova Example Project

This is an example project built with Nova. It demonstrates how to quickly set up an API with Nova, including integrated OpenAPI documentation.

Prerequisites

Before you get started, ensure you have:

  • Go 1.24 or higher

Installation

Getting started with the Nova Example Project is straightforward:

  1. Clone the repository:

    git clone https://github.com/xlc-dev/novaexample.git
    cd novaexample
  2. Build the binary:

    go build -o novaexample

    This will create an executable binary named novaexample in your project directory.

Running the API

Once built, you can run the API with customizable host and port settings:

  • Default (host: localhost, port: 8080):

    ./novaexample
  • Custom host and port:

    ./novaexample --host=0.0.0.0 --port=3000

    Replace 0.0.0.0 with your desired host and 3000 with your preferred port.

OpenAPI Documentation

Nova comes with excellent OpenAPI integration.

  • View the OpenAPI JSON:

    Access the raw OpenAPI specification at: http://localhost:8080/openapi.json

  • Explore with Swagger UI:

    For a beautiful and interactive API documentation experience, visit the Swagger UI at: http://localhost:8080/docs

Enjoy exploring the Nova Example Project! If you have any questions or feedback, feel free to open an issue.

License

This project is licensed under the MIT License. See the LICENSE file for more details.

About

Example project written with Nova.

xlc-dev.github.io/nova/

Topics

apiexamplegolanggolang-libraryrest

Resources

Readme
MIT license
Activity

Stars

3 stars

Watchers

0 watching

Forks

0 forks
Report repository

Used by

Contributors

Languages

You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.