Skip to content

Latest commit

 

History

History
100 lines (64 loc) · 2.35 KB

README.md

File metadata and controls

100 lines (64 loc) · 2.35 KB
Raw

McNamara

McNamara is an expense tracker web application built with Rails, PostgreSQL and Docker that tracks expenses and expense categories.



Features

  • Creation of custom categories
  • Global time zone selection
  • Custom icon upload for categories powered by Active Storage
  • FOREX currency stats for USD, CAD, CHF, DKK, JPY and GBP
  • Downloadable expenses pie chart

Built With

  • Ruby v2.7.0
  • Ruby on Rails v6.1.2
  • PostgreSQL:latest
  • Tailwind CSS
  • Rates API

Live Demo

https://bit.ly/3bWNsof

Getting Started

To get a local copy up and running follow the next steps:

  • Get the repository by either cloning or Zip download
  • Install gems with bundle install
  • Setup database with bin/rails db:migrate. Keep in mind that you need to setup Postgres by installing it or by running it inside a Docker instance.
  • Make sure all node packages are available by running npm install

Usage

Start server with:

bin/rails server

Open http://localhost:3000/ in your browser.

Run tests

rspec

Deployment

The live version was deployed to a server running Ubuntu 20.04 with the following architecture where the PostgreSQL DB and the Rails Application run inside a Docker container.



The PostgreSQL DB has the following schema:

Author

👤 Josias Alvarado

Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

Show your support

Give a ⭐️ if you like this project!

Acknowledgments

License

This project is MIT licensed.