/betterdocs

📚 Web version of https://github.com/khusnetdinov/ruby.fundamental repo - Fundamental programming with ruby examples and references. It covers threads, SOLID principles, design patterns, data structures, algorithms. Books for reading.

Primary LanguageHTML

image

BetterDocs aka Ruby.Fundamental Web Build Status Open Source Helpers

This repo is web adoptation Ruby.Fundamental. It keeps examples with description modern principles, patterns.

Content

  • Gotchas
  • Meta Programming
  • Functional Programming
  • Threads
  • Solid Pronciples
  • Design Patterns
  • Data Structures
  • Algorithms
  • Become Ruby Meister
  • Interview Questions

Contributing

Before open issue or PR, please check contributing guide for guidelines about how to proceed. Every contributor is expected to follow code of conduct.

Development

For setup development environment it requires:

  • Ruby 2.5.1
  • NodeJS v10

In terminal:

git clone https://github.com/khusnetdinov/betterdocs
cd betterdocs
npm install
bundle install

jekyll serve

Setup with Vagrant

Vagrant unify development for different OS users. Setup environment requires preinstalled:

In terminal:

git clone https://github.com/khusnetdinov/betterdocs/
cd betterdocs
vagrant up

Now vagrant virtual machine is runing enter to it:

vagrant ssh

Betterdocs is locate in /app on guest machine;

cd /app

Run vagrant (It requires host option for proper port binding, and it can depend on OS):

jekyll serve --host 0.0.0.0

About

Betterdocs is created and maintained by GeveMePOC team.

image

We love open source software!.

License

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