/Realtime-search-box

This is a real-time search box, where users search articles, and then to have analytics that display what users were searching for.

Primary LanguageRubyMIT LicenseMIT

 

Real-Time-Search-Box

This app is a realtime search box, where users search articles, and then have analytics that display what they were searching for.

Built with

Install & Setup

To setup and install this project, follow the below steps:

  • Clone this project by the command:

    git clone https://github.com/Terbeche/Realtime-search-box.git
    
  • Then switch to the project folder by the bellow query:

    cd Realtime-search-box
    
  • Install the required dependecies with:

    bundle install
    
  • Install npm dependencies with:

    npm install
    
  • Before running below commands update config/database.yml with your local DB credentials. Then run:

    rake db:create
    
    rake db:migrate
    
    rake db:seed
    
  • To make the tailwindcss works run the below commands:

    ./bin/bundle add tailwindcss-rails
    ./bin/rails tailwindcss:install
    
    
  • To run the website, With Ruby on Rails and PostgreSQL installed in your environment, you can run

    ./bin/dev
    

Tests

  • Run bundle install
  • Run bundle exec rspec spec

Prerequisites

  • IDE to edit and run the code (We use Visual Studio Code 🔥).
  • Git to versionning your work.
  • Postgresql
  • Rails

Author

👤 Mustapha

🤝 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!

📝 License

This project is MIT licensed.