Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/chrisvilches/kakeibo-api
Backend for a money management app
https://github.com/chrisvilches/kakeibo-api
graphql rails rails-api ridgepole ruby ruby-on-rails
Last synced: about 2 months ago
JSON representation
Backend for a money management app
- Host: GitHub
- URL: https://github.com/chrisvilches/kakeibo-api
- Owner: ChrisVilches
- Created: 2022-01-13T18:08:47.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-02-04T09:03:19.000Z (almost 2 years ago)
- Last Synced: 2023-03-01T09:56:41.475Z (almost 2 years ago)
- Topics: graphql, rails, rails-api, ridgepole, ruby, ruby-on-rails
- Language: Ruby
- Homepage:
- Size: 194 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Kakeibo (API)
Description of this project can be found here (frontend repository): https://github.com/ChrisVilches/Kakeibo-UI
## Ruby version
Check the `.ruby-version` file.
## System dependencies
1. If using sqlite, some system dependencies are required. For details: https://guides.rubyonrails.org/development_dependencies_install.html
2. Redis running on `localhost:6379` (for `sidekiq-scheduler`). It can be changed in `config/initializers/sidekiq.rb` (follow the Gem instructions: https://github.com/moove-it/sidekiq-scheduler).
## Database creation/initialization
```
bundle exec ridgepole -c config/database.yml --apply --env development
bundle exec ridgepole -c config/database.yml --apply --env test
bundle exec ridgepole -c config/database.yml --apply --env production
```
## Run the test suite
```
bundle exec rspec
```
## Services (job queues, etc.)
Scheduler being used for executing periodic jobs is `sidekiq-scheduler`. By default it needs Redis running on the default port on localhost.
Along with the main app, it's necessary to start one `sidekiq` process by executing:
```
bundle exec sidekiq
```
Environment variables needed:
```
# Backup file (texts like {year} will be replaced by the appropriate value):
BACKUP_OUTPUT_FILE=/home/my_username/backup-{year}-{month}-{day}.json
SUMMARY_EMAIL_CRON_STRING="* * * * *"
BACKUP_EMAIL_CRON_STRING="* * * * *"
BACKUP_TO_DISK_CRON_STRING="* * * * *"
```
Manage the process yourself. According to `sidekiq` (when trying to use deprecated options):
```
ERROR: Daemonization mode was removed in Sidekiq 6.0, please use a proper process supervisor to start and manage your services
ERROR: Logfile redirection was removed in Sidekiq 6.0, Sidekiq will only log to STDOUT
```
Some ideas on how to manage the process:
* https://github.com/mperham/sidekiq/wiki/Deployment
* https://github.com/seuros/capistrano-sidekiq/issues/212
## Configuration and deployment instructions
For now, deployment has to be done manually (capistrano setup is low priority for now).
1. Install using:
```
bundle install
```
2. Create a file called `.env`, copy the content of `.env.template` and edit accordingly.
3. Edit the `config/database.yml` file.
4. Execute database changes:
```
bundle exec ridgepole -c config/database.yml --apply --env production
```
5. Deploy the server:
```
RAILS_ENV=production bundle exec rails s -b 0.0.0.0 -p APP_PORT
```
Optionally, create a user manually in the Rails console:
```ruby
User.create!(email: '[email protected]', password: 'qwerty123')
```
## Tools used
1. GraphQL
2. Devise (JWT)
3. Ridgepole
4. Rspec
5. RuboCop & RubyCritic
6. Sidekiq & Redis
And others.
## Development
Run all tests and linting:
```
bundle exec rake
```