vanilla-project / vanilla-project.guide

How do I start a project in a new language?

Vanilla Project

This is the repository for https://vanilla-project.guide.

Getting Started

It is required to have Ruby and Bundler installed.

Installing

To install all dependencies run bundle install.

Run Locally

Run bundle exec jekyll serve and it will serve the content on http://localhost:8080.

Deployment

We use Netlify for this site, so deploys happen automatically after merging PRs or pushing directly to the master branch. Pull requests will automatically create a preview deployment, so that changes can be viewed in advance, too.

Built With

• Ruby
• Bundler
• Jekyll
• ❤️

Contributing

Please read contributing.md for details on our code of conduct, and the process for submitting pull requests to us.

Acknowledgments

• Hat tip to Nick Salloum for his CSS-only hamburger menus.

vanilla-project.guide's Issues

“Other Guides in this language”

Once a language has several guides for different project types it might be beneficial to provide a list of more/other guides of that language on a guide’s page.
Similar to a “more posts of this author” section we sometimes find on blog posts.

This could also be extended to other “similar” guides. For example when viewing a guide for a command-line app this list could show links for command-line apps in other languages.

Provide Example Repository for Ruby Command Line Application

IE9 layout quirks

Visited the site in IE9 on Windows and found some issues:

• the horizontal scrollbar at the bottom is always visible
  • seems fixable with overflow-x: hidden; on body
• similar to that, the horizontal scrollbars are always displayed for code/pre areas in the guides.
  • seems fixable with a vendor specific setting -ms-overflow-style: -ms-autohiding-scrollbar; on figure and pre

404 Error - file not found

You get the error when using the link to the Github project at the very end of the page
https://vanilla-project.guide/node/command-line/

Provide example JS/Node command-line application

Similar to the Ruby Command Line Application guide we should have an example repository for the JS/Node guide.

Add Custom 404 Page

Jekyll upgrade broke URLs

After last night's Jekyll upgrade it seems the handling of collections has changed.
This is visible by visiting vanilla-projects.guide and navigating to any guide.

The URL looks like this now: https://vanilla-project.guide/guides/ruby/sinatra/ but it should be https://vanilla-project.guide/ruby/sinatra/

This breaks any bookmark a user has created previously as well as the links in the "Latest Updates" section on the homepage.

Python Command Line Template

A Python template similar to the Ruby one would be great. Every time I try to look into conventions on how to structure a Python app, it seems a bit like the wild west. Having a template with the why that template is a good starting point would be 👍

Provide Language Specific Styling to Guides

We could start by using the GitHub language colors for some parts of the design.