Giter Club home page Giter Club logo

botwiki.org's Introduction

Botwiki.org

Installing Botwiki

Botwiki is powered by Pico, which is a very simple CMS running on PHP, the content of the site is created with Markdown. You can install the site with Composer, so one of these should work (provided that you have already installed PHP):

php composer install

Or

php composer.phar install

See the Pico documentation for more details; additionally, if you also want to mess with the look of the site, you will need to install node (which comes with npm).

Then, from the root directory, you can run:

sudo npm install

Updating content

All the website's content is inside the content folder. If you only want to update the content, not the look of the page, go to the main folder and run

php -S localhost:5000

The folder structure is very simple and corresponds to the actual structure of the site. So, for example, if you want to add a new Twitter bot, you can navigate to

content/bots/twitterbots/

Then create a new file my_new_bot.md and the page will be available at

localhost:3000/bots/twitterbots/my_new_bot

Or

botwiki.org/bots/twitterbots/my_new_bot

Updating the styles

First run the site as above:

php -S localhost:5000

And then run the gulp tasks, simply with:

gulp

The site will be available with live-reloading at localhost:3000.

If you for some reason get an error about a node package missing, just install it with

sudo npm install NAME_OF_THE_PACKAGE --save-dev

Contributing without GitHub

The main idea behind Botwiki is to keep maintaining, contributing and distributing simple. It runs on PHP, which is the most common back-end language, available even on free web hosting sites. Markdown is a fairly simple language that uses only text.

If you'd like to contribute outside of GitHub, you can send an email to [email protected]. Simply copy the content of this file and replace it with relevant information -- and if you'd like, you can also include a screenshot (the width should be 900px, height is not limited, but shouldn't be more than around 500px).

botwiki.org's People

Contributors

stefanbohacek avatar

Watchers

 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.