Git Product home page Git Product logo

pluto-devfeeds's Introduction

Planet Pluto for Unvanquished development feeds

Welcome to Planet Pluto. (Auto-)build your own (static) planet news site from Unvanquished development feeds.

Step 0: Clone

To get started:

Use git and clone this repo e.g.

git clone https://github.com/Unvanquished/pluto-devfeeds.git

Step 1: Install the Planet Pluto Machinery / Tool

To install the planet pluto tools and libraries use ruby's bundler e.g.

cd pluto-devfeeds
make prepare

Ruby's bundler will use the Gemfile to know what you want to install and will generate a Gemfile.lock that will list all libraries with all dependencies and versions locked down.

Step 2: Build the Planet

Try:

make check

to check up on your pluto installation. It must print the pluto help.

Now build the sample starter planet. Try:

make

This will

  1. fetch all feeds listed in planet.ini and

  2. store all entries in a local single-file SQLite database, that is, planet.db in your working folder and

  3. generate a planet web page, that is, index.html in your build/ folder using the devfeeds template pack in the planet-devfeeds folder using all feed entries from the local database. It also builds custom css using sass.

Open up build/index.html in your web browser to see your planet web page. Voila!

What's Next?

Now change the planet configuration in planet.ini to fit your needs. Change the title and add your web feeds.

Look & feel. Change the starter templates in planet-devfeeds to your liking.

Happy planet!

Questions 'n' Answers

Q: How can I update the web feeds and (re)build the planet page(s)?

A: Rerun the command:

make

That's it ;-) The pluto feed fetcher will use conditional HTTP get requests and content hash checks for web feeds etc.

Q: For testing how can I (re)build the planet pages(s) WITHOUT fetching the web feeds?

A: Use the build target:

make build

Q: How can I update the web feeds WITHOUT (re)building the planet page(s)?

A: Use the update target:

make update

References

License

CC0

The pluto.starter scripts and templates are dedicated to the public domain. To be kind, the pluto-devfeeds deviation is dedicated to public domain too. Use it as you please with no restrictions whatsoever.

Questions? Comments?

For Pluto related questions, send them along to the wwwmake Forum/Mailing List, for Unvanquished related questions, send them along the Unvanquished forum. Thanks!

pluto-devfeeds's People

Contributors

illwieckz avatar geraldb avatar

Stargazers

 avatar

Watchers

James Cloos avatar DolceTriade avatar hurf blurf avatar  avatar

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.