Sharingan

📖 Sharingan

This knowledge based system has been created to help code reviewers quickly search for specific code review guidelines and generate a ready to use comment for each requirement that is not followed by the student. The Admin can manage data and have analytics that display what users were searching for.

🛠 Built With

Tech Stack

This project was built using.

Client

• tailwind
• HTML
• CSS
• Stimulus

Server

• Ruby on Rails

Database

• PostgreSQL

Other Technologies

• Sidekiq
• Redis

Key Features

• User can register and login
• Authenticated User can use realtime search box to search guidelines and generate ready to use comment for each uncompleted requirements based on the company standard
• Admin can manage data and view analytics that display what users were searching for

🚀 Live Demo

• Live Demo Link

🚀 Credentials

• Credentials Admin: email: '[email protected]', password: 'admin@test'
• Credentials Normal User: email: '[email protected]', password: 'user@test'

💻 Getting Started

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

Prerequisites

In order to run this project you need:

• Ruby 3.1 installed
• Rails 7.0.4.3 installed
• Redis server 7.0.10 installed and running
• 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 [email protected]: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 and dependencies:

bundle install
npm install

5. Create database and run the necessary migration files & build js bundles :

$ bin/rails db:create
$ rake db:migrate
$ rake db:seed
$ yarn run build

6. Run Sidekiq for background processing :

$  bundle exec sidekiq 

7 Finally you can run the server:

rails s

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

Note: Make sure your server is running in test mode. You can run the following command to enter the test mode

rails s -e test

Finally you can run this command to test the solution

bundle exec rspec spec

👥 Authors

👤 Ushindi Bienvenu

• GitHub: @usbbush
• LinkedIn: @usbbush
• Twitter: @usbbush

🔭 Future Features

• Improve design and Improve navigation
• Add more statistics data to give more insights to the Admin
• Improve Search Algorithm

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

⭐️ Show your support

If you like this project, Kindly give it a ⭐

🙏 Acknowledgments

I would like to thank the Ruby community

📝 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.