Skip to content

Latest commit

 

History

History
67 lines (40 loc) · 1.6 KB

File metadata and controls

67 lines (40 loc) · 1.6 KB

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.

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.