git ssb

0+

Zach! / dat-zine-library



Branch:
Zach committed Make README more approachableLatest: ca62693 on 7/24/2018, 6:14:53 AM
📄.gitignore
📄CHANGELOG.md
📄README.md
📁branch
📁building
📄dat.json
📄favicon.ico
📄index.html
📄index.js
📄package-lock.json
📄package.json
📁volunteers
📁zines
README.md

Dat Zine Library

It's a zine library for the Chorus!

You can see an example library here:
dat://dat-zine-library.hashbase.io

**To get a personal history, and changelog, for this library code check out: https://coolguy.website/projects/dat-zine-library

Directory Structure

The code is organized around the metaphor of a real-life zine library. So you have all of the zines, the building the zines go in, and the volunteers that perform all the actions that make the whole operation run. You also have the identity of this library branch, and what distinguishes it from other zine libraryies.

This repo is laid out the same:

TODO: Each folder has its own README with more details.

Customizing the library

If you are the librarian, you can edit any of these files to make your branch your own. The level of customization depends on how much coding you wanna do.

Here's what I recommend:

The library is built using choo. This is a cute framework for building interactive web apps. Their homepage has an awesome tutorial on getting started. To really customize this, though, you'll need to install all required modules and such to your local computer. (see below)

Installing

The simplest way to install this is to visit the library link in beaker, then fork it and add it to your local directory.

Alternately, you can clone this from gitlab. git clone https://gitlab.com/zachmandeville/dat-zine-library.git

Then:

cd dat-zine-library
npm install
npm run build

If you cloned it from gitlab, you'll need to add this folder to yr BeakerBrowser:

- Open Beaker
- Click the Hamburger Icon in the top Right
- choose Create New > From Folder
- select dat-zine-library
- Click the link in the top right to view it!

Usage

To add a new dat zine: You can do it through the add-zine button on the front end, or through the backend like so:

title: name of zine
----
url: dat:/ads;lkfajdsgklajglkah3j2kljakhdh32j.sha256

Click save and you should be good. If not, lemme know!

Built with git-ssb-web