/sharingan

Primary LanguageRubyMIT LicenseMIT

Sharingan

📖 My Budget App

A mobile web application where you can manage your budget: you have a list of transactions associated with a category, so that you can see how much money you spent and on what.

🛠 Built With

Tech Stack

This project was built using.

Client
Server
Database

Key Features

  • User can register and login
  • **Authenticated User can use realtime search box to search articles
  • Admin can view analytics that display what users were searching for

(back to top)

🚀 Live Demo

(back to top)

💻 Getting Started

To get a local copy up and running, follow these steps.

Prerequisites

In order to run this project you need:

  • Ruby installed
  • Postgresql installed
  • Git installed [ In case you want to clone this repo using your terminal]
  • Any IDE or text editor that supports Ruby

Setup

Clone this repository to your desired folder:

1. Clone this repository or download the Zip folder:"

$ git clone git@github.com:bienvenuushindi/sharingan.git

2. Navigate to the location of the folder in your machine:

you@your-Pc-name:~$ cd <folder>

3. Press Enter to navigate to your local clone.

4. Install the gems:

bundle install

5. Create database and run the necessary migration files :

$ bin/rails db:create
$ rake db:migrate
$ rake db:seed

6 Finally you can run the server:

rails s

Additionally, run this if you want to test the app:

rspec spec

(back to top)

👥 Authors

👤 Ushindi Bienvenu

(back to top)

🔭 Future Features

  • Add test for remaining features
  • Use caching and a job queue to process requests in the background. This is important to handle a large number of requests
  • Make use of Redis server and Sidekiq gems to fulfill this previous feature
  • Improve design and Improve navigation
  • Add more statistics data to give more insights to the Admin
  • Improve Search Algorithm

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project, Kindly give it a ⭐

(back to top)

🙏 Acknowledgments

I would like to thank the Ruby community and Helpjuice team

(back to top)

📝 License

This project is MIT licensed.

NOTE: we recommend using the MIT license - you can set it up quickly by using templates available on GitHub. You can also use any other license if you wish.

(back to top)