Transax is a transaction-tracking mobile web application for recording money spent shoping or other transaction needs you have.
- Ruby v2.7.1
- Ruby on Rails v6.0.3
- Tailwind 2.0
- Rspec
- Capybara
- Rubocop
- Stylelint
- Windows WSL(Ubuntu 20.04)
- Github-Actions
- VsCode
While the Live Demo provides a demonstration of how the application functions, If you want to add new features and use the code for learning, it is better to have a local environment.
The prerequisites for local installation include Ruby on Rails, Ruby, PostgreSQL.
PostgreSQL, which handles Transax's database, is listed with all the other prerequisite gems in the Gemfile. These may be installed en masse using Bundler.
-
Open a Terminal and navigate to the location in your system where you would like to download the project. New to Terminal? Learn here.
-
Enter the following line of code to clone this repository:
git clone [email protected]:Morrism1/Transax.git -
Enter the following line of code to move inside the downloaded repo:
cd Transax -
To install all of the project's gems, run the following:
bundle install -
To install Javascript dependencies, you need to run the following:
yarn install --check-files -
To set up the project's databases, run the following:
rails db:setup ; rails db:create ; rails db:migrate
Congratulations! Transax is now ready to roll!
Accessing the application requires a running server. This can easily be achieved from the project's root directory by running rails s. The app will now be accessible at the following URL: http://localhost:3000/.
Transax's tests are managed by the rspec-rails gem. Running tests is as easy as entering rspec or
bundle exec rspec in the project's root directory. For more information on rspec-rails, take a look at their GitHub repo.
These are ways, you can follow to deploy your app to Heroku
-
Create an account and set up heroku local on your machine using HerokuCLI
-
Start by creating your app, by running in your app terminal:
Heroku createthis will set your remote branch for deployment. -
Almost done, to deploy to that remote branch run:
git push heroku master -
To be able to use our app, we need to finally run this command:
heroku run rails db:migratewe need to manually migrate the database.
👤 Maurice MURANGWA
-
Github: @Morrism1
-
Twitter: @MorrisMontana0
-
Linkedin: Maurice Murangwa
Feel free to check the issues page.
Give a ⭐️ if you like this project!
This project is MIT licensed.