Code Monkey home page Code Monkey logo

puffin_facts's Introduction

PUFFIN FACTS README

Welcome to Puffin Facts! An amazing site for learning things about puffins.

Please see our Contribution Guide to learn how to contribute to Puffin Facts.

How to get started

  • Install Ruby and check that your version is > 2.4.4
$ ruby -v
ruby 2.5.0
  • Install SQLite3 and check your version:
$ sqlite3 --version
  • Install Rails:
$ sudo gem install rails
$ rails --version
  • Update dependencies:
$ bundle install
$ bundle update --bundler
  • Clone the repository:
$ git clone https://github.com/stuartlynn/puffin_facts.git
$ cd puffin_facts
  • Start your server:
$ rails server

If you get an error with You must use Bundler 2 or greater with this lockfile. (Bundler::LockfileError), you need to manually replace the last line in Gemfile.lock with 1.13.6.

  • Open a browser tab at http://localhost:3000/. And there you go: Puffin facts!

If you get a SQLite3 error instead, replace the sqlite line in your Gemfile.lock with sqlite3 (1.3.12).

puffin_facts's People

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

puffin_facts's Issues

Show new fact without reloading page

Refreshing the page for new facts is bad user experience. There should be a "Next Fact" button that shows a new fact without reloading the page.

The puffin fact should be a partial

MVP works as is, but the changing puffin fact should be pulled out into a partial. This will keep code modular and simple as complexity grows

Sometimes facts repeat

When you get the same fact twice in a row, the site seems broken. Prevent site from displaying the same fact it displayed last time.

Request for website link.

Hi, everyone :
I want to visit the website but can't find any link provided in the reopsitory page.
I tried to google it and check whether it is published by GitHub Pages.

UI redesign

The site's simple design needs an update! New design needs to be responsive, modern, and include 100% more puffins.

Not enough emojis

We need more emojis in the title so people know how great PuffinFacts is ๐Ÿ˜ปโœจ๐Ÿ’ฅ๐Ÿท๐ŸŒป

Facts live in the controller :(

This is a tightly coupled design and will make the app difficult to test as it becomes more complex. Data should be separated out into it's own file!

Improve documentation

The README isn't very informative. How do we set up a project? What version of ruby/rails are we on? How are tests run?

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.