This is a simple Histogram application that allows users to generate grahp bars based on the count of words of either a text file or a text area
In order to work on this project, you need to have the following dependencies installed:
- Languages: Ruby
- Frameworks: Ruby On Rails
- Technologies used: Visual Studio Code
$ git clone git@github.com:JohnFTitor/histogram.git
$ cd histogram
Run
$ bundle install
To get all the gems required for the project
Then, run
$ npm install
To install packages such esbuild and chartkirt
To check linters locally, use
$ rubocop .
Once you have the project correctly set up, run
$ bin/rails db:create
To generate the database for this project and work without any issue. Please review the requirements listed above
Important note: Since this project uses SCSS for the styling, you need to run:
$ ./bin/dev
For you to see the styling being applied in the browser during development
It's really important to check the console where you run bin/dev, since it is there where the values of the cycles will be printed
If you have any issue setting up this project, don't hesitate to contact me with any link below
- Optimizing the counting algorithm. There must be a better way to count the words and sort them on the go, without demanding too much time complexity
- Add exception handling with direct user feedback. The app can be easily broken if you submit a file that is not of type .txt or no file at all, which is not suitable. Providing error handling and flash messages can do so the users have a better experience
- Create a better chart. Due to the nature of the external gem, there are some issues when the input file has many unique words, since its size is not responsive at all. Creating a chart by hand could provide more flexibility on this end
👤 Andrés Felipe Arroyave Naranjo
Platform | Badge |
---|---|
PortFolio | JohnFTitor |
GitHub | @JohnFTitor |
@johnftitor | |
Andres |
Contributions, issues, and feature requests are welcome!
Give a ⭐️ if you like this project!