# dolphin

**Repository Path**: ghosind/dolphin

## Basic Information

- **Project Name**: dolphin
- **Description**: 🐬 Dolphin is a Golang web framework (Under development).
- **Primary Language**: Go
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-09-10
- **Last Updated**: 2021-11-11

## Categories & Tags

**Categories**: Uncategorized

**Tags**: Go语言, WEB框架, web-framework, Framework, 框架

## README

# Dolphin

![test](https://github.com/ghosind/dolphin/workflows/Test/badge.svg)
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/de7fbdc27cd3411b9a2d57d34eae44d2)](https://www.codacy.com/gh/ghosind/dolphin/dashboard?utm_source=github.com&utm_medium=referral&utm_content=ghosind/dolphin&utm_campaign=Badge_Grade)
![Version Badge](https://img.shields.io/github/v/release/ghosind/dolphin)
![License Badge](https://img.shields.io/github/license/ghosind/dolphin)
[![Go Reference](https://pkg.go.dev/badge/github.com/ghosind/dolphin.svg)](https://pkg.go.dev/github.com/ghosind/dolphin)

Dolphin is a simple web framework for Golang.

## Installation

1. Install dolphin by Go cli tool:

    ```bash
    go get -u github.com/ghosind/dolphin
    ```

2. Import dolphin in your code:

    ```go
    import "github.com/ghosind/dolphin"
    ```

## Getting Started

1. The following example shows how to implement a simple web service, and it'll reads parameter name from request query and return the message as a JSON object.

    ```go
    package main

    import (
      "fmt"

      "github.com/ghosind/dolphin"
    )

    func handler(ctx *dolphin.Context) {
      name := ctx.Query("name")

      ctx.JSON(ctx.O{
        "message": fmt.Sprintf("Hello, %s", name),
      })
    }

    func main() {
      app := dolphin.Default()

      app.Use(handler)

      app.Run()
    }
    ```

2. Save the above code as `app.go` and run it with the following command:

    ```bash
    go run app.go
    # Server running at :8080.
    ```

3. Visit `http://locahost:8080?name=dolphin` by your browser or other tools to see the result.

## License

Distributed under the MIT License. See LICENSE file for more information.