Giter Club home page Giter Club logo

tildeslash's Introduction

tildeslash

tildeslash is a web-based codelog software, i.e. blogware for developers.
Make use of the powerful Ace as Markdown editor.

tildeslash is named from the pathname of home folder, a.k.a ~/ on Unix/Linux.
The goal of tildeslash is to give developers a comforting home on the web,
where they can easily share and teach coding skills for the public.

tildeslash is based on Mozilla's Playdoh,
which is a web application template based on Django.

Patches are welcome!
Feel free to fork and contribute to this project on github.

Installation

Prerequisites:

Steps:

Firstly checkout source code from Github (make sure you use --recursive):

$ git clone --recursive git://github.com/mozilla/bedrock.git
$ cd bedrock

Then create a virtualenv using virtualenv wrapper,
so that you can install dependencies in a safe and clean environment
without worrying about version conflict among different projects.

$ mkvirtualenv tildeslash                    # create a virtualenv for tildeslash
$ workon tildeslash                          # change current virtualenv to tildeslash
$ pip install -r requirements/compiled.txt   # installs compiled dependencies for playdoh
$ pip install -r requirements/dev.txt        # installs test dependencies for playdoh
$ pip install -r requirements/custom.txt     # installs dependencies for tildeslash

If you are on OSX and some of the compiled dependencies fails to compile,
try explicitly setting the arch flags and try again:

$ export ARCHFLAGS="-arch i386 -arch x86_64"
$ pip install -r requirements/compiled.txt

Create your database, for non-ascii codeloggers, be aware of encoding settings.

CREATE DATABASE tildeslash CHARACTER SET utf8 COLLATE utf8_general_ci;

Copy sample local setting file:

$ cp tildeslash/settings/local.py-dist tildeslash/settings/local.py

change db credentials and HMAC_KEYS/SECRET_KEY,
give your codelog a cool title using CODELOG_TITLE setting.

Load database schema and initial data with following commands:

./manage.py syncdb
./manage.py migrate

If your less won't compile automatically,
add the path to the LESS compiler (found by using which lessc)
to tildeslash/settings/local.py with the following line:

LESS_BIN = '/path/to/lessc'

Make it run:

To make the server run, make sure you are inside a virtualenv,
and then run the server:

$ ./manage.py runserver

Let's it! Now check this URL in your browser:
http://localhost:8000/

Features

Todos

  • Wordcount with asian character support
  • Responsive Design
  • RSS feed
  • L10n (Start from chinese)
  • Author profile
  • Tag cloud
  • Customized admin interface (Currently using default django admin)
  • Mobile-accessible admin interface
  • Inline image upload

Author

I'm Eddie, a Web Developer located in Taipei, Taiwan
Currently working at Mozilla

License

This software is licensed under the New BSD License.
For more information, read the file LICENSE.

tildeslash's People

Contributors

kumar303 avatar ozten avatar peterbe avatar davedash avatar yshlin avatar willkg avatar tofumatt avatar rlr avatar stasm avatar fwenzel avatar glogiotatidis avatar rfreebern avatar erikrose avatar jgmize avatar lonnen avatar mathjazz avatar ppapadeas avatar akatsoulas 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.