GoCondor

[Under Development]

What is GoCondor?

GoCondor is a golang web framework with an MVC like architecture, it's based on Gin framework, it provides you with an easy-to-use directory structure with a development experience similar to Laravel, made for developing modern APIs and microservices. Full docmentation is available at GoCondor Docs.

Features

Router
Middlewares
JWT tokens
ORM (GORM)
Cache (Redis)
TLS
Context Package Integrator
Live-Reloading for development
Features Control

Create a new project

To create a new GoCondor project you need to install the GoCondor cli first

Install Condor cli

To install the GoCondor cli run the following command

go get github.com/gocondor/installer/gocondor

Create a project using GoCondor cli:

To create a new project run the following command:

gocondor new my-project github.com/my-organization/my-project

Getting started

First create a project by following the steps above. Now Let's create a route to handle our first request let's start by defining the handler function for the request, create a file with the name example.go in http/handlers folder with the following content:

package handlers

import (
"github.com/gin-gonic/gin"
)

func ExampleShow(c *gin.Context) {
    message := "Hello from example handler!"
    c.JSON(200, gin.H{
        "message": message,
    })
}

Next lets define the route, to do that open up the file http/routes.go, then inside the function RegisterRoutes() add to this line router.Get("/", handlers.ExampleShow) and make sure it looks like below:

func RegisterRoutes() {
    router := routing.Resolve()
    // Define your routes here
    router.Get("/", handlers.ExampleShow)
}

Next start the app by running the following code from inside the project:

gocondor run:dev

Finally, open up your browser and navigate to localhost:8000

Architecture

the architecture is similar to MVC architecture, there is a routes.go file where you can define all your routes and their handlers, the handler is simply a method that gets executed when the request is received, you can think of it like a controllers action in MVC

The request journey looks like below:

request -> routing -> middleware -> handler -> middleware -> json response

Folder structure

├── gocondor
│   ├── config/ ---------------> control what features to turn on
│   ├── http/------------------> http related code
│   │   ├── handlers/ --------------> contains your http requests handlers
│   │   ├── middlewares/ -----------> middlewares are defined here
│   ├── routes.go -------------> your routes are defined here
│   ├── integrations/ ---------> contains the integrations of third party packages into gin context
│   ├── logs/ -----------------> log files
│   ├── models/ ---------------> database models
│   ├── ssl/ ------------------> ssl certificates
│   ├── .env ------------------> environment variables 
│   ├── .gitignore ------------> gitignore file
│   ├── go.mod ----------------> go modules the project depends on
│   ├── LICENSE ---------------> license
│   ├── main.go ---------------> ssl certificates
│   ├── README.md -------------> readme file

Contribute

The framework consists of two main parts, each lives in a separate repository, the first part is the core which contains the framework core packages. the second part is gocondor which has the project folder structure and responsible of gluing everything together.

To contribute you simply need to clone these two repositories locally and create new branches from the develop branch, add your changes, then open up a PR to the develop branch.

Here is how you can clone and set up the development workflow in your local machine:

Create the organization gocondor directory in your workspace, make sure the full path to it looks like below:

$GOPATH/src/ginthub.com/gocondor

clone the repository core inside the organization gocondor directory:

git clone git@github.com:gocondor/core.git

clone the repository gocondor:

git clone git@github.com:gocondor/gocondor.git

cd into the project gocondor and open up go.mod in your editor and add the line github.com/gocondor/gocondor/core => [full-local-path-to-core] to the replacestatement, make sure it looks something like this:

module github.com/gocondor/gocondor

replace (
 github.com/gocondor/core => C:/Users/myname/go/src/github.com/gocondor/core

 github.com/gocondor/gocondor/config => ./config
 github.com/gocondor/gocondor/http => ./http
 github.com/gocondor/gocondor/http/middlewares => ./http/middlewares
 github.com/gocondor/gocondor/integrations => ./integrations
 github.com/gocondor/gocondor/models => ./models
)

Note: this is needed to tell go that instead of using the remote core package use the local copy where we will be making the changes, once you are done, open a PR to develop branch.

TechplexEngineer/gocondor