https://github.com/deltegui/phoenix-cli
Phoenix Client
https://github.com/deltegui/phoenix-cli
Last synced: 9 days ago
JSON representation
Phoenix Client
- Host: GitHub
- URL: https://github.com/deltegui/phoenix-cli
- Owner: deltegui
- Created: 2019-12-08T00:37:44.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2020-09-20T17:09:43.000Z (almost 6 years ago)
- Last Synced: 2026-01-14T20:05:39.462Z (6 months ago)
- Language: Go
- Homepage:
- Size: 3.74 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Phoenix CLI
Creating a new phoenix project from scratch, can be a repeating task. You can automate it with phoenix cli
## Install
just run
```
go install github.com/deltegui/phoenix-cli
```
## Usage
To create a new API project run:
```
phoenix-cli -new <> -type api
```
or omit -type:
```
phoenix-cli -new <>
```
To create a new MPA project do:
```
phoenix-cli -new <> -type mpa
```
## Project structure
| Folder/File | Explaination |
|--------------------|---------------------------------------------------------------------------------------------------------------------------------------------------|
| /src | Your code lives here
| /src/configuration | Normally you will have only config.go file. Here you can change configuration options that can be passed by command line arguments or config.json |
| /src/controllers | Here you store controllers and injectors |
| /src/domain | Here you store application services and domain entities |
| /static | Here you can serve your static files. Only appears if you create a MPA project. You need to call EnableStaticServer |
| /templates | Here you can store templates to render. Only appears if you create a MPA project. |
| /config.json | This file stores values that will be loaded to configuration struct defined in /src/configuration/config.json. |
| /logo | An ASCII logo that appears when you run the project. You can disable it deleting EnableLogoFile in main.go |
| /main.go | Application starting point. Here you can configure phoenix. |
| /Makefile | Simple makefile to automate tasks |