Skip to content

Latest commit

 

History

History
72 lines (45 loc) · 2.33 KB

README.md

File metadata and controls

72 lines (45 loc) · 2.33 KB

Nebula API

A database for some really useful UTD data collected by our tools.

Project maintained by Nebula Labs.

Documentation

Documentation for the current production API can be found here.

How to use

  • Visit our Discord and ask to be provisioned an API key (please provide details on your use case)
  • Read the documentation listed above (and authenticate with your key for interactive demos)
  • Make requests to https://api.utdnebula.com with your provisioned api key set as the x-api-key request header
  • Build cool stuff!

Contributing

Contributions are welcome!

This project uses the MIT License.

Please visit our Discord and talk to us if you'd like to contribute!

How to Contribute

Create your own fork by forking this repository

Clone your forked repository. (Don't forget to install Git if you haven't already)

Submit proposed changes via a Pull Request

Building

Requirements

Building for Windows

cd into nebula-api\api

Setup Go Dependencies with .\build.bat setup

Build with .\build.bat build

Run with .\go-api.exe

Note: some have experienced issues with Windows Defender or other antivirus blocking go-api.exe from reading files, editing files, or causing slowed performance. Consider adding a exception to your nebula-api folder.

Building for macOs, Linux, and WSL

cd into nebula-api/api

Setup Go dependencies with make setup

Build with make build

Run with ./go-api

Running to API locally

Copy .env.template to .env with cp .env.template .env

Enter Nebula MongoDB URI in .env

Run go-api

Check command output to see the route serving traffic. It's likely port 8080

Visit http://localhost:8080 to access nebula-api locally