Crostarter 🎉

Demo: Live

An opensource crowd funding platform

Getting started

Follow along to run app in your local machine

Installation

Prerequisites

rbenv install 3.1.3
brew install postgresql

Setup

bundle install
yarn install

Development

• Create or use keys for credentials

  # Copy or create the secret, below is example of copying existing keys to respective environments
  cp master.key config/master.key
  cp development.key config/credentials/development.key
  cp production.key config/credentials/production.key

• Copy .env.example

  cp .env.example .env

• Use SQLite as development database,

  bin/rails db:create
  bin/rails db:migrate

• Launch redis

  colima start
  docker-compose up

• Seed data

  bin/rails db:seed

• Launch server

  bin/rails server
  yarn dev # This will launch app in non-SSR mode
  
  # Run in SSR mode
  yarn dev:ssr
  # Build for SSR
  yarn build:ssr

  OR

  cp .env.example .env
  gem install foreman
  foreman start -f Procfile.dev

Testing

bin/rails g rspec:request user
rspec
bundle exec rspec

Linting

bundle exec rubocop --safe-auto-correct
bundle exec rubocop -A # force - better not use it

Production key

fly secrets set  -a crostarter  RAILS_PRODUCTION_KEY=

Environment variables

aws:
  access_key_id: '******'
  secret_access_key: '******'
secret_key_base: '******'
REDIS_URL: redis://localhost:6379
ci:
  throttle_key:

---