https://github.com/arthurkay/lucid

A GO-based web application framework
https://github.com/arthurkay/lucid

go-framework golang-framework

Last synced: 5 months ago
JSON representation

A GO-based web application framework

• Host: GitHub
• URL: https://github.com/arthurkay/lucid
• Owner: arthurkay
• License: mit
• Created: 2021-06-15T07:55:29.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2021-11-23T07:29:18.000Z (over 4 years ago)
• Last Synced: 2024-06-20T10:22:40.698Z (almost 2 years ago)
• Topics: go-framework, golang-framework
• Language: Go
• Homepage:
• Size: 46.9 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Lucid Framework

[![license](http://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/arthurkay/lucid/blob/master/LICENSE)

[![Go Report Card](https://goreportcard.com/badge/github.com/arthurkay/lucid)](https://goreportcard.com/report/github.com/arthurkay/lucid)

# Introduction

LUCID is a golang backend framework. The frameowrk is meant to address the issue of having applications that all have different code structures.

The lucid cli tool is there to make the generation of the boiler plate code super easy.

## App Setup

The application architecture will take the form of:

* db

* handlers

* middleware

* models

* routes

* utils

## DB

The `db` directory is the place where all db related configurations will be kept.

These include access to different supported databases as well as initialising these instances of databases.

## Handlers

The `handlers` directory is meant for keeping the business logic of routes.

Each route in mapped to a handler, and that handler is responsible to managing the applications business logic.

## Middleware

The `middleware` directory is for storing data that is meant to be processed between requests.

## Models

The `models` directory is for storing data access API's. These apis include everything involved in CRUD operations on data and databases.

## Routes

The `routes` directory is for http routes access. These routes can be of any number, but its recommended to have them in separate files if they handle different kinds of backend access.

For example, the backend uses `api.go` for API routes and `web.go` for web based routes.

## Utils

The `utils` directory is meant for storing helper function. These functions can be as simple as a function to handle error responses to more comples logic of data mangling.

# Lucid CLI

The cli tool for generation and managing of Lucid app implementations.

# Project Status

Both the CLI and the actual framework are still in active development.

Contributors are welcome.

* [Lucid CLI](https://github.com/arthurkay/lucid-cli)

* [Lucid Framework](https://github.com/arthurkay/lucid)