https://github.com/harvestprofit/just-an-entries-example

🧾 Example accounting setup
https://github.com/harvestprofit/just-an-entries-example

Last synced: about 1 month ago
JSON representation

🧾 Example accounting setup

• Host: GitHub
• URL: https://github.com/harvestprofit/just-an-entries-example
• Owner: HarvestProfit
• License: mit
• Created: 2020-06-21T23:01:34.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-03-08T20:56:58.000Z (almost 2 years ago)
• Last Synced: 2023-03-08T22:12:26.133Z (almost 2 years ago)
• Language: Ruby
• Homepage:
• Size: 1.46 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 35
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        


  



[![Tests](https://github.com/HarvestProfit/just-an-entries-example/workflows/Tests/badge.svg)](https://github.com/HarvestProfit/just-an-entries-example/actions)

## Getting Started

### Prerequisites

Please install the following:

- [Ruby](https://www.ruby-lang.org/en/downloads/)

  - Feel free to use [RVM](https://rvm.io/) or [Rbenv (recommended)](https://github.com/rbenv/rbenv) for version management

- [NodeJS](https://nodejs.org/en/)

  - Feel free to use [NVM](https://github.com/creationix/nvm) or [Nodenv (recommended)](https://github.com/nodenv/nodenv) for version management

- [Postgres.app](https://postgresapp.com/)

In order to run the project in development, you'll need to install the

required RubyGems, NPM modules, and set up your Postgres database:

```bash

bundle install

yarn install

rails db:setup

```

Problems getting everything setup? Check for the following gem problems

- [pg](https://stackoverflow.com/a/20226895)

- [puma](https://stackoverflow.com/a/53404317/10750268)

- [eventmachine](https://github.com/eventmachine/eventmachine/issues/661#issuecomment-182531919)

### Linting

We use linters for [static code analysis](https://en.wikipedia.org/wiki/Static_program_analysis). I would highly encourage you to consider using them for all coding projects, not just this one.

You can use the following command to install our linters for [Atom, our preferred code editor](https://atom.io/):

```bash

apm install linter linter-eslint linter-rubocop language-babel

```

#### Rubocop

We use [RuboCop](http://rubocop.readthedocs.io/en/latest/) as our ruby linter.

Run the following to install RubyCop globally:

```shell

gem install rubocop

```

### Running in Development

A rails command is included to start up Postgres.app

if it isn't running already and then start the Rails

app with Puma at .

```bash

rails s

```

### Testing

Our Application runs tests via [Minitest](https://github.com/seattlerb/minitest), and runs those tests on every commit via [Github Actions](https://github.com/HarvestProfit/just-an-entries-example/actions).

#### Minitest

Minitest tests can be found in the [test](./test) directory.

## Initial Deployment

[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/HarvestProfit/just-an-entries-example)