README.md

Devcision

Table of Contents

• Devcision
  • Table of Contents
  • Setup
    • Prerequisites
    • Installation
  • Database Structure
    • Main Models
  • Seeds
    • Loading Seeds
  • Usage
    • Accessing Algorithms
  • Demo
  • Contributing
  • License

Setup

Prerequisites

• Ruby 3.3.3
• Rails 7.1.3 or higher
• PostgreSQL

Installation

1. Clone the repository

git clone git@github.com:hoasung01/devcision.git
cd devcision

2. Install dependencies

bundle install

3. Setup database

rails db:create
rails db:migrate

Database Structure

The database is organized hierarchically:

AlgorithmCategory
├── AlgorithmType
│   └── Algorithm
│       ├── AlgorithmImplementation
│       ├── AlgorithmComplexity
│       ├── AlgorithmExample
│       └── AlgorithmBenchmark

Main Models

• AlgorithmCategory: High-level categories (Sorting, Searching, etc.)
• AlgorithmType: Specific types within categories (Comparison-based sorting, etc.)
• Algorithm: Individual algorithms with their characteristics
• AlgorithmImplementation: Code implementations in various languages
• AlgorithmComplexity: Time and space complexity analysis
• AlgorithmExample: Usage examples and test cases
• AlgorithmBenchmark: Performance benchmarks

Seeds

The seed data is organized in categories:

db/
└── seeds/
    ├── shared/
    │   └── constants.rb
    └── algorithms/
        ├── 01_sorting.seeds.rb
        ├── 02_searching.seeds.rb
        ├── 03_graph.seeds.rb
        ├── 04_dynamic_programming.seeds.rb
        ├── 05_string.seeds.rb
        ├── 06_tree.seeds.rb
        ├── 07_greedy.seeds.rb
        ├── 08_divide_conquer.seeds.rb
        ├── 09_backtracking.seeds.rb
        ├── 10_computational_geometry.seeds.rb
        └── 11_numerical.seeds.rb

Loading Seeds

Load all seeds:

rails db:seed

Load specific category:

rails db:seed:algorithms:sorting

Reset and reload:

rails db:reset  # Drops, creates, migrates, and seeds

Usage

Accessing Algorithms

# Get all sorting algorithms
sorting = AlgorithmCategory.find_by(name: 'Sorting Algorithms')
sorting_algorithms = sorting.algorithms

# Find specific algorithm
quick_sort = Algorithm.find_by(name: 'Quick Sort')

# Get complexity analysis
quick_sort.complexity_analysis

# Get implementations
quick_sort.implementations.by_language('ruby')

# Get examples
quick_sort.examples.by_difficulty(:beginner)

Demo

Explore some of the features of Devcision:

1. Major algorithm

2. AI advisor

Input a problem description to get AI-powered algorithm analysis and recommendations.

Contributing

1. Fork the repository
2. Create your feature branch (git checkout -b feature/your-feature)
3. Add your algorithms to the appropriate seed file
4. Commit your changes (git commit -am 'Add some feature')
5. Push to the branch (git push origin feature/your-feature)
6. Create a Pull Request

License

This project is licensed under the MIT License