Skip to content

Latest commit

 

History

History
113 lines (87 loc) · 3.16 KB

README.md

File metadata and controls

113 lines (87 loc) · 3.16 KB
Raw

About Eadrax

Eadrax is a diary for your creations. A instance of Eadrax can be found at http://wipup.org/

You might like Eadrax if you:

  • Love making stuff, and do it often
  • Want a no-nonsense place to track and share your creations
  • Work with different mediums: from images, video, music to code
  • Have a project-oriented workflow
  • Want to visualise your process and progress
  • Prefer open-source software

Features

Those marked in bold have been implemented.

User features

  • User register
  • User login
  • User edit
  • User logout
  • User track
  • User untrack
  • User newsfeed
  • User view

Project features

  • Project view
  • Project add
  • Project prepare
  • Project edit
  • Project delete
  • Project track
  • Project untrack

Hook features

  • Hook add
  • Hook delete
  • Hook sync

Update features

  • Update view
  • Update add
  • Update prepare
  • Update edit
  • Update delete

Kudos features

  • Kudos add
  • Kudos delete

Comment features

  • Comment add
  • Comment edit
  • Comment delete

About Eadrax-develop

This branch aims to rewrite Eadrax with the following major changes:

  • Improved project privacy settings
  • Support for HTML5 video via webm
  • Remove the use of categories
  • Added "highlights" pick for updates
  • Sortable WIPSpaces (to allow for many projects)
  • Revitalise the API and separate delivery mechanism to prepare for native apps
  • Improved discover feature from random to feature
  • Remove the group blog idea
  • Remove collaborative projects (may return later)
  • Remove OpenID signin (may return later)
  • Service Hooks for RSS, Github, forum software
  • Custom views for multiple attachment updates, single-sentence updates, pastebin updates and sound updates.
  • Responsive webdesign
  • Redesign with new logo
  • Switch from BBCode to Markdown
  • Improve code quality (readability and flexibility) and decouple from delivery mechanism
  • Switch to MIT license

Installing Eadrax

There are two versions of Eadrax you can get:

  • develop - recommended for developers but still in development.
  • Alternatively, grab master - latest "live" stable version (used by http://wipup.org). Note that this is no longer supported - to install master, please read their README instructions instead.

Developer Information

After following the installation instructions above, set up the development environment as follows:

  1. Get Composer curl -s http://getcomposer.org/installer | php and then run php composer.phar install --dev. This is needed to set up testing tools (installs into bin/).
  2. Use Phing to run phing all in project root. This will run phpspec, phpcs, pdepend, phpmd, phpcpd, phpdcd and phpdoc2. For more information, see phing -projecthelp
  3. Start developing. Specs are in spec/, documentation is in docs/. Any build logs generated by phing all-log useful for CI can be found in build/. Finally, use phing as a shorthand way to run all tests.

That's it! Leave the codebase cleaner than when you found it.