Start developing SGI modules

Version Date Notes By
0.2 2017-12-22 Updated section 1.2 FPA
0.1 2017-10-25 Initial release FPA

1. Backend

1.1 Grab base SGI project

The first step to start developing in SGI is to get the base (core) sgi project from WeMake GitLab. The following commands can be done with a Git graphical user interface, like SourceTree

  1. git clone https://gitlab.wemake.pt/wemake/sgi/backend/core.git wemake-sgi-backend. Clone the repository from gitlab
  2. cd wemake-sgi-backend
  3. git config user.name "Flávio Alves". Define repository user name (replace with your own name)
  4. git config user.email "flavio.alves@roboyo.pt". Define repository user email (replace with your own email)
  5. git fetch. Fetch branches and/or tags, along with the objects necessary to complete their history
  6. git checkout develop. Checkout develop branch

1.2 Developing a SGI module

1.2.1 New module

  1. php artisan module:generate
  2. Indicate the module name, like it is named in gitlab (eg. documents, technical-audits, etc).
  3. Indicate the module repository url (eg. https://gitlab.wemake.pt/wemake/sgi/backend/documents.git)
  4. Start developing your awesome module!

1.2.2 Existing module

  1. cd modules
  2. git clone https://gitlab.wemake.pt/wemake/sgi/backend/documents.git Documents. This is an example to clone documents module repository. Please note that the folder name must be in StudlyCase.
  3. git fetch. Fetch branches and/or tags, along with the objects necessary to complete their history
  4. git checkout develop. Checkout develop branch
  5. Start developing!