api

command module
v0.0.0-...-5f2badd Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 11, 2020 License: MIT Imports: 6 Imported by: 0

README

Quicky.dev API

License GoDoc API Go Report Card

Description

This API is used to serve the quicky.dev web app. For more information about the client, please refer to this repository.

Getting started

For documentation on enpoints used, please refer to this markdown file for how to use & run the quicky.dev API.

Goals and vision

  1. Full support for both Macos & Debian based operating systems.
  2. Building an open source community around the project.
  3. Additional package support for all operating systems (Currentlys support roughly 25 packages).
  4. Updating client UI that reflects new features with API support.
  5. (Stretch challenge) A fully functional regression testing system to ensure that future releases don't break in production.
  6. (Stretch challenge) Collecting analytics about our most commonly downloaded packages and tools.

Resources

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
Package controllers will hold all of the logic for our routes that will be called in our main function in main.go Package controllers will hold all of the logic for our routes that will be called in our main function in main.go
Package controllers will hold all of the logic for our routes that will be called in our main function in main.go Package controllers will hold all of the logic for our routes that will be called in our main function in main.go
Package filestore will be used to store bash commands as txt
Package filestore will be used to store bash commands as txt

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL