Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add to Readme. #61

Merged
merged 1 commit into from
Dec 9, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 29 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,40 @@
# README
# Finance Calculator
> This is a calculator to help someone budget their finances, or practice Rails Development

This README would normally document whatever steps are necessary to get the
application up and running.
![](header.png)

Things you may want to cover:
## Installation

* Ruby version
This app requires Rails 7.1 and Ruby 3.2:

* System dependencies
Get up and running with 4 easy steps!

* Configuration
1. Add gems:
```sh
bundle install
```

* Database creation
2. migrate the database:

* Database initialization
```sh
rails db:migrate
```

* How to run the test suite
3. Migrate the seed data:

* Services (job queues, cache servers, search engines, etc.)
```sh
rails data:migrate
```

* Deployment instructions
4. Start your server:
```sh
bin/dev || rails s
```

* ...
## Contributing

1. Fork it (<https://github.com/neb417/finance/fork>)
2. Create your feature branch (`git checkout -b feature/fooBar`)
3. Commit your changes (`git commit -am 'Add some fooBar'`)
4. Push to the branch (`git push origin feature/fooBar`)
5. Create a new Pull Request
Loading