Skip to content
This repository has been archived by the owner on Mar 28, 2021. It is now read-only.

Latest commit

 

History

History
108 lines (77 loc) · 3.41 KB

README.md

File metadata and controls

108 lines (77 loc) · 3.41 KB

Project Archieved

goals

goals is a Golang/GraphQL Framework. goals is still in beta release.

installation

go get github.com/dennys-bd/goals

usage

goals has 3 main commands today:

  • init: Used to generate a basic Goals project
  • scaffold: Used to create GraphQL Models, Schemas and Resolvers
  • runserver: Used to start the goals application

commands

goals init

goals init PROJECTNAME should start your project under your $GOPATH/src

goals scaffold

scaffold graphql

Usage

You can generate a entire model in a syntax rails like, is recommended to use simple quote on the fields of model coz ]! characters is reserved for bash terminals.
ALSO, DONT USE WHITE SPACES, it's used to separate the fields ;) goals s g <modelname> 'fieldName(param:ParamType,param2:ParamType2):fieldType! relationName:type:[ModelName]!'

Verbose

You can create your model inserting it's fields in line by line using the verbose flag (-v) goals s g <modelname> -v

Console will ask you to insert the first field you can write something like this: (there is no problem using whitespaces where) fieldName(param: ParamType, param2: ParamType2): FieldType!

then console will print informations about the field and you can confirm or erase this field if confirmed it will asks to create another field until you send a blank line.

should create a suitable model, schema and resolver structures for your new type
For now you should use simple quote in your attributes, -Use Spaces to separate the attributes-.

Flags
  • --json It creates a model genarating json value for each attribute of model.
  • --no-model Don't create the model. (Use it if you alread have a model)
  • --no-schema Don't create the schema. (Use it if you alread have a schema)
  • --no-resolver Don't create the resolver. (Use it if you alread have a resolver)
  • --resolver or -r Change the resolver name for your model.
  • --verbose or -v Is a way of creating your params for the attribute, and create each attribute separately.(You can use spaces now) NO QUITE READY YET.

scaffold auth

Usage

goals s auth should create a private resolver, with it's auth structures.

covering commun graphql types: String, Int, Boolean, ID, Float, and Time from github.com/graph-gophers/graphql-go.
Every other type will be treated as Scalar if you don't specifically declare type before modelName

goals runserver

Usage

goals r Start your server with some goals pattern configurations.

Flags
  • --port or -p Change the port to serv your goals application
  • --env-port Infer the port from the environment variable PORT (The --port flag is stronger ifused together, please don't.)
  • --env or -e Starts your goals application with the configurations for specified environment - goalsr -e production
  • --verbose or -v Verbose, right? for now it only prints the schemas

todo

  • command init
  • command scaffold
  • command scaffold graphql
  • command scaffold auth
  • goals core to facilitate serving pages
  • command runserver
  • environment separation ready (dotEnv)
  • versoning
  • scalar file
  • database integration
  • flag to separate application in database directive ou gateway in init
  • flag to separate model in databased ou delivered from external api in scaffold
  • write tests for check writing files
  • goals core
  • goals admin