# ardan

**Repository Path**: teamlint/ardan

## Basic Information

- **Project Name**: ardan
- **Description**: web development framework 
- **Primary Language**: Go
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-20
- **Last Updated**: 2024-05-31

## Categories & Tags

**Categories**: webframework

**Tags**: None

## README

# ardan
web rapid development framework 

## Deps
- [Gin](https://gin-gonic.com/) HTTP web framework
- [XORM](https://xorm.io/) ORM Framework 
- [Container](https://github.com/teamlint/container) Dependency injection container

## CLI
ardan cli tools

### Install

#### Go get

```shell
go get github.com/teamlint/ardan
```

#### OR Git

```shell
git clone git@github.com:teamlint/ardan.git
cd ardan
go install # OR: task install
```

### Usages

#### Init Project

initial application project layout & infrastructure codes

`ardan [global options] init [all|query|repository|service|controller]`

```go
mkdir myproject
cd myproject
go mod init <name>
ardan -s -dc <db-conn> init all
```
#### Project layout

![](https://github.com/teamlint/ardan/blob/master/screenshots/layout.png?raw=true)

#### Run 

```shell
task run
```
OR
```shell
cd cmd/server
go run main.go
```

### Model Sync

#### Create model file.

Write model file in `app/model/tom.go`

```go
package model

import (
	"time"
)

//ardan:sync
//ardan:gen 
// Tom test model
type Tom struct{
	ID         string     `xorm:"not null pk unique CHAR(20) 'id'" json:"id"`
	Username   string     `xorm:"not null index VARCHAR(100)" json:"username"`
	CreatedAt  time.Time  `xorm:"not null created TIMESTAMPZ" json:"created_at"`
}
```
```shell
ardan -dc <db-conn> sync 
```

#### view database

have fun!.

![](https://github.com/teamlint/ardan/blob/master/screenshots/sync_db.png?raw=true)

### Generate Tools

genrate model query/repository/service/controller codes.

`ardan gen [all|query|repository|service|controller]`

```shell
ardan gen all
```

## TODO
-