localorbit

KO | EN

gitlite — search

#ai #golang #machine-learning #rust #deep-learning #linux #macos #java #windows #awesome #awesome-list #vue #security #openai

(★ 16)

Local Orbit is an open source web application and service that empowers food hubs to efficiently sell and distribute local food.

localorbit Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Local Orbit

[![CircleCI](https://circleci.com/gh/LocalOrbit/localorbit/tree/master.svg?style=svg)](https://circleci.com/gh/LocalOrbit/localorbit/tree/master)

* **[Staging Deploy (Preview)](https://github.com/LocalOrbit/localorbit/compare/staging...master)**
* **[Production Deploy (Preview)](https://github.com/LocalOrbit/localorbit/compare/production...staging)**

See the `docs/` directory for more documentation.

## Developer Setup

1. Install `ruby 2.3.8` (use a ruby version manage like [rbenv](https://github.com/rbenv/rbenv) or [rvm](https://rvm.io/))
1. Clone this repo `git clone git@github.com:LocalOrbit/localorbit.git`, `cd localorbit` into it
1. Install dependencies (for MacOs) via [Homebrew](https://brew.sh/) with `brew bundle`. Other platforms see requirements in [`Brewfile`](./Brewfile).
1. `bundle`
1. `cp config/application.yml{.example,}` and modify if needed, see [Environment variables](#environment_variables) below
1. `cp config/database.yml{.example,}` and modify if needed (Some modification is probably necessary. Try adding `template: template0`)
1. `yarn`
1. `rake db:setup` - runs `db:create`, `db:schema:load` and `db:seed`
1. `rake db:seed:development` - See [Test Accounts](#test-accounts) section for usernames and passwords
1. `rails server`
1.  Add `127.0.0.1 localtest.me` to `/etc/hosts`
1.  Go to http://localtest.me:3000 in a browser (we use localtest.me to always point to 127.0.0.1 so we can use subdomains, which localhost doesn't allow.)
1.  Run delayed job in foreground with `./bin/delayed_job run` (caveat: delete jobs from that table first if loading in production data)

#### Other required services to setup

* See [stripe howto](docs/stripe_in_development.md) for configuring stripe for development.
* Setup a [mailtrap](https://mailtrap.io/) account and put the username and password into your application.yml
* AWS is used by the app to store images as well as transferring db backups between environments.
  1. Get an invitation to the AWS account
  2. Configure an API key and secret
  3. [Configure the AWS cli tools](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html) (which should already be installed via `brew bundle`.)

### Environment variables

`ENV` is generally accessed via [figaro](https://github.com/laserlemon/figaro) in application code. Figaro enforces presence of required `ENV` vars via [`config/initializers/figaro.rb`](./config/figaro.rb). In `development` and local `test` environments we populate/customize `ENV` via figaro with `config/application.yml` (see an [example application.yml](./config/application.yml.example)). For Heroku `staging` and `production` environments the `ENV` vars are populated with [Heroku cli](https://devcenter.heroku.com/articles/config-vars). For [CircleCI](https://circleci.com/gh/LocalOrbit), sensitive `ENV` vars like API keys and other secrets are managed via the [Circle CI web application](https://circleci.com/gh/LocalOrbit/localorbit/edit#env-vars), and non-sensitive `ENV` vars are managed via the [`.circleci/config.yml`](./.circleci/config.yml).

### Production Setup

* At least one Market must be created before creating Organizations

### Test Accounts
Running `rake db:seed:development` makes the following test accounts available

*Selling Organization*
Email: seller@example.com
Password: password1

*Buying Organization*
Email: buyer@example.com
Password: password1

*Market Manager*
Email: mm@example.com
Password: password1

*Admin*
Email: admin@example.com
Password: password1

### Javascript Specs

Specs live in spec/javascripts/\*.js.coffee

Run suite on command line:  bundle exec rake konacha:run
Run suite via browser:  bundle exec rake konacha:serve (then visit http://localhost:3500)
Run suite automatically on changes to javascript sources or specs:  bundle exec guard

### Cloning staging for local development

Run `rake db:dump:staging`

**WARNING: This will replace EVERYTHING in your development db with what is currently on staging**

### Load production data into development or staging

Below is a quick overview, for more granular tasks see [production-copy.rake](lib/tasks/production-copy.rake).

#### Into development

If no existing cleansed production dump, all-in-one go:

rake production_copy:stomp_dev_db DOWNLOAD_NEW=YES REALLY=YES

If an existing dump:

rake production_copy:stomp_dev_db REALLY=YES

Or two step

rake production_copy:bring_down
    rake production_copy:stomp_dev_db REALLY=YES

#### Into staging

Load production data into staging via development, will also sync s3 from production to staging:

rake production_copy:to[staging]

Or if you already have a recent copy of production in development do:

rake production_copy:push_out[staging]

### Heroku Notes

There are _binstub_ helpers in `$RAILS_ROOT/bin` that allow for shortcuts when dealing with Heroku environments. See [binstubs plugin](https://github.com/tpope/heroku-binstubs) for usage & more info.
## Contributing

See [development process](docs/development_process.md).

localorbit

localorbit Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

localorbit

localorbit Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README