theredorm/lecter

:boom: Show executable code by request

Table of contents

• 🚨 Problems
• 🚀 Solution
• ‼️ Requirements
• 🛠️ Installing
• 🕹️ Using
• 👨‍💻 Example of using
• ❤️ Contributing & Contributors
• 🗃️ License

🚨 Problems

1. Developers don't know how their app works.
2. Reading code is a long process.
3. Memorize many lines of code is difficult.

🚀 Solution

1. The main purpose of that gem is to help developers to understand which code executes by request.
   

2. Gem's work could be compared with visiting a doctor: You give symptoms of your disease and receive a diagnosis.
   You give parameters of a request and receive executable code.

3. You don't have to work with debuggers, read and remember many lines of code.
   Just give&receive!

‼️ Requirements

Please use a multithreading server such as a puma with more than 1 workers.
More information about how to tune puma server please follow the link.

🛠️ Installing

Installing is a very simple process.

1. Add the gem to your Gemfile:

   group :development do
     git 'https://github.com/neodelf/lecter.git', branch: 'master' do
       gem 'lecter'
     end
   end

2. Execute in a terminal in app's directory:

   bundle install

3. Add routes to your config/routes.rb:

   mount Lecter::Engine => '/lecter'

🕹️ Using

You should do two simple steps:

1. Go to /lecter/diagnosis/new

2. Fill in form fields with request parameters:

   HTTP method - request's method
   Endpoint - use absolute route like localhost:3000/blogs
Body(raw) - request's parameters

👨‍💻 Example of using

There is an example with POST method:

1. Go to localhost:3000/lecter/diagnosis/new

2. Fill form with:

   HTTP method - POST
Endpoint - localhost:3000/posts
Body(raw) - "post"=>{"title"=>"New title", "description"=>"Desciption"}

   

3. Submit form

4. Receive result

   

❤️ Contributing & Contributors

1. Bug reports and pull requests are welcome.
2. There are many issues as a proposal to improve this library. If you have any ideas please feel free to write your thoughts in a new issue.
3. Choose what you like to fix or improve on the issues list. You can ask any questions in the comments.
4. ‼️ Mention of each contributor will be on the README file.

Thanks goes to these wonderful people:

Aleksey Glukhov 💻 📖

🗃️ License

The gem is available as open source under the terms of the MIT License.