NPO-Accounting/houdini
6
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Add instructions for AGPL CCS

Browse source
This commit is contained in:
Eric Schultz 2018-05-31 13:14:46 -05:00
parent 5958d8458a
commit 6a1c412fbe
1 changed files with 22 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
README.md
View file

@ -68,11 +68,11 @@ There are a number of steps for configuring your Houdini instance for startup
cp .env.template .env cp .env.template .env
``` ```
##### In console 2, run the following and copy the output to you .env file to set you `DEVISE_SECRET_KEY` environment variable. ##### In console 2, run the following and copy the output to you .env file to set you `DEVISE_SECRET_KEY` environment variable.
`docker-compose run web rake secret # copy this result into your DEVISE_SECRET_KEY` `./run rake secret # copy this result into your DEVISE_SECRET_KEY`
##### In console 2, , run the following and copy the output to you .env file to set you `SECRET_TOKEN` environment variable. ##### In console 2, , run the following and copy the output to you .env file to set you `SECRET_TOKEN` environment variable.
``` ```
docker-compose run web rake secret # copy this result into your SECRET_TOKEN ./run rake secret # copy this result into your SECRET_TOKEN
``` ```
##### Set the following secrets in your .env file with your Stripe account information ##### Set the following secrets in your .env file with your Stripe account information
@ -83,10 +83,10 @@ docker-compose run web rake secret # copy this result into your SECRET_TOKEN
If you don't file uploads WILL NOT WORK but it's not required. If you don't file uploads WILL NOT WORK but it's not required.
##### In console 2, install npm packages ##### In console 2, install npm packages
`docker-compose run web npm install` `./run npm install`
##### In console 2, fill the db ##### In console 2, fill the db
`docker-compose run web rake db:create db:structure:load db:seed test:prepare` `./run rake db:create db:structure:load db:seed test:prepare`
##### Set up mailer info ##### Set up mailer info
You can set this in `config/default_organization.yml` or better yet, make a copy with your own org name and add that to your .env file as `ORG_NAME` You can set this in `config/default_organization.yml` or better yet, make a copy with your own org name and add that to your .env file as `ORG_NAME`
@ -99,7 +99,7 @@ If you need help setting up your mailer, visit `config/environment.rb` where the
`docker-compose up` `docker-compose up`
##### In console 2, run: ##### In console 2, run:
`docker-compose run web npm run watch` `./run npm run watch`
##### You can go to http://localhost:5000 ##### You can go to http://localhost:5000
@ -155,6 +155,23 @@ Each component should have its own file.
### react:lib ### react:lib
This generator creates a basic Typescript module along with a test file. This generator creates a basic Typescript module along with a test file.
### Providing the complete corresponding source code
**Note: This is not legal advice and provides a suggestion which may be compliant. You should talk with your legal counsel if you have
questions or concerns with how to comply with the various licenses of Houdini**
Providing the complete, corresponding source code (CCS) of your project to comply with the license of Houdini. There are two methods for doing so right now:
1. Providing a tarball of the current running code
2. Providing a link to Github where the code is pulled from
The easiest method is to provide a tarball. Houdini automatically provides a link on the Terms & Privacy page.
For this to work though, the following characteristics must be true:
* Your have to have any changes you made to the project in `HEAD` in your git repository
* The `.git` folder for your repository must be a direct subfolder of your `$RAILS_ROOT`
* Your web server must be able to run `git archive`.
### Style ### Style