Skip to content

Latest commit

 

History

History
122 lines (79 loc) · 3.26 KB

README.md

File metadata and controls

122 lines (79 loc) · 3.26 KB
Raw

My Recipe App

This is a simple Ruby On Rails project. Spendless allows users to create categories and expenses for each category. It has a flexible functionality, allowing users to create one transaction in multiple categories

Preview

Mobile Preview

Spendless is a Ruby on Rails application that allows users to keep track of their expenses and categories. Manage your own money, manage your own life

Deployment

You can find the app deployed in heroku

Requirements

In order to work on this project, you need to have the following dependencies installed:

Built With

  • Languages: Ruby 3.1.1
  • Frameworks: Ruby On Rails, TailWind CSS
  • Technologies used: Visual Studio Code

Getting Started

Clone this repository

$ git clone git@github.com:JohnFTitor/spendless.git
$ cd spendless

Commands to run

Run

$ bundle install

To get all the gems required for the project

Then, run

$ npm install

To install packages such as style linters

To check linters locally, use

$ rubocop
$ npx stylelint "**/*.{css,scss}"

Once you have the project correctly set up, run

$ bin/rails db:setup

To run all migrations, create the database for testing and for development, and insert some data into the database for you to visualize the changes

Finally, each time you make changes to the project, run

$ bundle exec rspec /spec

In the root folder to check the consistency of the app. Please don't make changes to the tests unless completely necessary, and mention it in your PR description.

Important note: Since this project uses Tailwind CSS for the styling, you need to run:

$ ./bin/dev

For you to see the styling being applied in the browser during development

Deployment

The deployment is handled by the owner of this repo. It is done by running

$ git push heroku dev:main

After the implementations where approved and merged in the development branch. Once is ready for production, it will be publish like so:

$ git push heroku main

Authors

👤 Andrés Felipe Arroyave Naranjo

Platform Badge
GitHub @JohnFTitor
Twitter @johnftitor
LinkedIn Andres

Web Design

All the template colors, font, and layout distribution for the whole project were designed by Gregoire Vella on Behance. A link to the project can be found here. Check Gregoire for more amazing GUI and Graphic designs!

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Show your support

Give a ⭐️ if you like this project!