Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/go-ego/re

Re is a tool for helping develop with ego app framework.
https://github.com/go-ego/re

build-tools ego go golang hot-reload tool

Last synced: 27 days ago
JSON representation

Re is a tool for helping develop with ego app framework.

Awesome Lists containing this project

README

        

# Ego re

[![CircleCI Status](https://circleci.com/gh/go-ego/re.svg?style=shield)](https://circleci.com/gh/go-ego/re)
[![Build Status](https://travis-ci.org/go-ego/re.svg)](https://travis-ci.org/go-ego/re)
[![Go Report Card](https://goreportcard.com/badge/github.com/go-ego/re)](https://goreportcard.com/report/github.com/go-ego/re)
[![GoDoc](https://godoc.org/github.com/go-ego/re?status.svg)](https://godoc.org/github.com/go-ego/re)
[![Release](https://github-release-version.herokuapp.com/github/go-ego/re/release.svg?style=flat)](https://github.com/go-ego/re/releases/latest)
[![Join the chat at https://gitter.im/go-ego/ego](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/go-ego/ego?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)


>Re is a tool for helping develop with ego app framework, base on [bee](https://github.com/beego/bee).

This is a work in progress.

[简体中文](https://github.com/go-ego/re/blob/master/README_zh.md)

## Contents
- [Requirements](#requirements)
- [Installation](#installation)
- [Usage](#usage)
- [Plans](#plans)
- [Donate](#donate)
- [Contributing](#contributing)
- [License](#license)

## Requirements:

- Go version >= 1.3

## Installation:
```
go get -u github.com/go-ego/re
```
Then you can add re binary to PATH environment variable in your ~/.bashrc or ~/.bash_profile file:

```
export PATH=$PATH:/bin
````
## Usage

```sh

USAGE
re command [arguments]

AVAILABLE COMMANDS

new auto-generate code for the ego app, Creates a ego application
api Creates a ego API application
riot Creates a riot application
gse Creates a gse application
run Run the application by starting a local development server
pack Compresses a Ego application into a single file
bale Transforms non-Go files to Go source files
version Prints the current Re version
migrate Runs database migrations
fix fix the ego application to make it compatible with ego 1.0

Use re help [command] for more information about a command.

```

### re new

To create a new Ego web application

### re run

To run the application we just created, you can navigate to the application folder and execute:
```
$ cd my-webapp && re run
```
Or from anywhere in your machine:
```
$ re run github.com/user/my-webapp
```
For more information on the usage, run re help run.

## Plans
- generate code and docs
- generating a dockerfile
- help with debugging your application

## Donate
- Supporting ego, [buy me a coffee](https://github.com/go-vgo/buy-me-a-coffee).
## Contributing

- To contribute to re, please see [Contribution Guidelines](https://github.com/go-ego/re/blob/master/CONTRIBUTING.md).

- See [contributors page](https://github.com/go-ego/re/graphs/contributors) for full list of contributors.

## License

Re is primarily distributed under the terms of both the MIT license and the Apache License (Version 2.0).

See [LICENSE-APACHE](http://www.apache.org/licenses/LICENSE-2.0), [LICENSE-MIT](https://github.com/go-ego/ego/blob/master/LICENSE), and COPYRIGHT for details.