goffee/cup
1
0
Fork 1
Code Issues Pull requests Projects Releases 7 Packages Wiki Activity Actions

rewrite

Browse source
This commit is contained in:
Zeni Kim 2024-09-15 10:06:38 -05:00
parent 6dc72d3e14
commit dbc6f6af05
1 changed files with 13 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

33
README.md
View file

@ -1,13 +1,8 @@
![gocondor logo](https://gocondor.github.io/img/logo_x168.png)
![gocondor logo](https://git.smarteching.com/avatars/cd7cd5b690adc8e5ec6d6cdb117f1bf5a9e9353dae111bfbb394d2c3d4497537?size=200)
# Cup of Goffee
![Build Status](https://github.com/gocondor/gocondor/actions/workflows/build-main.yml/badge.svg)
![Test Status](https://github.com/gocondor/gocondor/actions/workflows/test-main.yml/badge.svg)
[![GoDoc](https://godoc.org/github.com/gocondor/gocondor?status.svg)](https://godoc.org/github.com/gocondor/gocondor)
[![Go Report Card](https://goreportcard.com/badge/github.com/gocondor/gocondor)](https://goreportcard.com/report/github.com/gocondor/gocondor)
## What is GoCondor?
GoCondor is a [Go](https://go.dev) web framework made for building web APIs, suitable for small, medium size and microservices projects. With it's simple structure, and developer friendly experience it helps with increasing the productivity.
Cup is a skeleton project for the Goffee [Go](https://go.dev) framework made for building web APIs, suitable for small, medium size and microservices projects. With it's simple structure, and developer friendly experience it helps with increasing the productivity.
## Main Features
- Routing
@ -20,32 +15,30 @@ GoCondor is a [Go](https://go.dev) web framework made for building web APIs, sui
- HTTPS (TLS)
## Installation
To create a new `GoCondor` project you need to install the `GoCondor's cli` first
To create a new `cup` project you need to install the `Goffee's cli` first
##### Install Gaffer [GoCondor's cli] tool
To install the `gaffer` globally open up your terminal and run the following command:
##### Install Goffee [cli] tool
To install the `goffee` globally open up your terminal and run the following command:
```bash
go install github.com/gocondor/gaffer@latest
go install git.smarteching.com/goffee/goffee@latest
```
![installing](https://gocondor.github.io/img/installing.gif)
##### Create new project using a Cup of Goffee
Here is how you can create new `goCondor` projects using `gaffer`
Here is how you can create new `Goffee` projects
```bash
gaffer new [project-name] [project-remote-repository]
goffee new [project-name] [project-remote-repository]
```
Example
```bash
gaffer new myapp github.com/gocondor/myapp
goffee new myapp git.smarteching.com/goffee/myapp
```
where:
`project-name` is the name of your project
`remote-repository` is the remote repository that will host the project, usually `github.com` is used.
`remote-repository` is the remote repository that will host the project.
## Getting started
First make sure you have [Gaffer](https://gocondor.github.io/docs/gaffer) installed, then use it to create a new project, [here is how](https://gocondor.github.io/docs/gaffer#create-new-project-using-gaffer)
First make sure you have [Goffee](https://git.smarteching.com/goffee/goffee) installed, then use it to create a new project, [here is how](https://git.smarteching.com/goffee/goffee/docs/gaffer#create-new-project-using-gaffer)
Let's create a route that returns `hello world`
@ -59,11 +52,11 @@ Open up the file `routes.go` in the root directory of your project and add the f
```
Next, in your terminal navigate to the project dir and run the following command to start the `live reloading`:
```go
gocondor run:dev
goffee run:dev
```
Finally, open up your browser and navigate to `http://localhost/greeting`
To learn more check the [routing docs section](https://gocondor.github.io/docs/routing)
To learn more check the [routing docs section](https://git.smarteching.com/goffee/goffee/docs/routing)
## Architecture