CMB New Payroll System
- Ruby 2.7.4 (use rbenv)
- Postgres (9.5)
- Bundler
Note: This application was developed on Linux or Mac. It has not been tested for development on Windows, although you will probably be able to make it work.
- Install dependencies locally.
- Clone repo
- bundle update
- Create/seed database
- Run tests
- Start server (if desired)
Use normal rails commands to create the database. Keep in mind that the database must be seeded with rails db:seed after creation and migration. The wages table requires a wages.sql file which is stored on the server. It is not committed to this repo.
Run rails test. This uses minitest.
Generally the reports output a PDF. Finance's desire was to have the reports be printable. Creation of the PDF reports uses Thinreports to help organize and create the reports.
You should use the Thinreports Editor to edit these reports. The reports can be edited in a text editor as well, but it's helpful to use the GUI editor. There are versions for all platforms.
Features should be built on a feature branch from the develop branch. When complete and tested, merge into the develop branch.
Production deployment requires merging the develop branch into the master branch and pushing to Github. After this, run cap production deploy to deploy to the production server. This requires passwordless SSH to the production server to complete.
This software project is licensed under the MIT License. See LICENSE.md
This software project is Copyright (C) 2018 SIL International. http://www.sil.org/