gina 0.0.9-p91c → 0.1.1-alpha.100

package/AUTHORS

@@ -2,5 +2,6 @@
 # project in one way or another.
 #
 
-Martin Luther ETOUMAN <m.etouman@rhinostone.com>
+Martin Luther ETOUMAN <martin-luther.etouman@gina.io>
+Fabrice Delaneau <fabrice.delaneau@gina.io>
 Stephane HEAV <stephane.heav@gmail.com>

package/INSTALL.md

@@ -0,0 +1,46 @@
+# INSTALL
+
+## Manual installation
+Link globally gina to your user local env
+```tty
+cd /usr/local/bin
+```
+```tty
+ln -s ../lib/node_modules/gina/bin/cli ./gina
+```
+
+Copy the `.gina` sample folder to you home directory
+
+## Setup permissions
+
+In order to run Gina properly with no re
+
+Skip this step if you are running gina from `root` or through `sudo`
+Create `/var/run/gina` (pid folder) and allow access to your user :
+
+
+> **Attention:** this step must be repeated everytime the machine is restarted because `/var/run` folder will be cleanned up
+
+e.g.: 
+```tty
+sudo mkdir /var/run/gina
+```
+```tty
+sudo chown -R myuser:mygroup /var/run/gina
+```
+
+Then run the following command line to start the framework service
+
+```tty
+gina framework:start
+```
+
+hit `ctrl+c` to end the process
+```tty
+sudo chown <youruser>:<yourgroup> /var/run/gina
+```
+
+Now you can start the service with your usual user
+```tty
+gina framework:start
+```

package/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2015 Rhinostone <gina@rhinostone.com>
+Copyright (c) 2009-2022 Rhinostone <contact@gina.io>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README-4Contributors.md

@@ -0,0 +1,96 @@
+# The contributor's guide
+> This is a document is a work in progress.
+> If you would like to contribute, you can contact us at `contact@gina.io` 
+
+### Installing Gina
+---
+
+You __cannot__ just install the framework with the `NPM` CLI. You will need to fetch/fork sources from the [github page](https://github.com/Rhinostone/gina) since all files are not published to `NPM`.
+
+
+
+| Requirements | Description
+|--------|--------|
+| OS | Mac OS X or Linux |
+| Node js       |   Node js v16.x or later     |
+| NPM      |   v8.x or later     |
+
+ 
+
+__NB.:__ Gina is meant to be install globaly
+> [A Note on Permissions](http://npm.github.io/installation-setup-docs/installing/a-note-on-permissions.html)
+> [Alternatives to installing npm packages globally](https://2ality.com/2022/06/global-npm-install-alternatives.html)
+
+
+#### Check your prefix
+
+
+
+```tty
+npm config get prefix
+```
+
+> Default `prefix` should be: 
+> For libraries `/usr/local`
+
+Targeted folder should be: `{prefix}/lib/node_modules/gina`
+Make sure you have the appropriate permissions to write.
+
+#### Clone gina
+
+Then go to `{prefix}/lib/node_modules` in order to clone the project
+```tty
+cd {prefix}/lib/node_modules
+```
+
+```tty
+git clone https://github.com/Rhinostone/gina.git gina
+```
+
+```tty
+cd gina && git checkout develop
+```
+
+#### Complete installation
+
+Run the `pre installation script` in order to setup permissions
+```tty
+node ./script/pre_install.js
+```
+
+Then run the `post installation script`
+```tty
+node ./script/post_install.js
+```
+
+Check if everything is working fine
+```tty
+gina version
+```
+
+```tty
+gina start
+```
+
+#### Setting the framework default environment
+
+> By default, Gina comes with 2 environments : `dev` and `prod`. The default is `prod`. But if you are contributing to the framework we advise you you to use the `dev` environment: you will get a lot of debug messages, but it is easier to track what is being done in background.
+
+__Changing default env__
+By default, Gina is installed with `dev` environment which allow you to display the toolbar.
+If you need to change this:
+```tty
+gina framework:set --env=prod
+```
+
+This only means that if you omit the env in the command line while trying to start the framework, it will automatically add `--env=prod` for you.
+
+> __NB:__ Unlike for the projects `envs`, the framework env list cannot be changed; it is `dev` or `prod`.
+
+
+### Publishing
+---
+
+
+### Troubleshooting
+---