Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ilesinge/memor

Bookmark manager
https://github.com/ilesinge/memor

Last synced: 3 months ago
JSON representation

Bookmark manager

Awesome Lists containing this project

README

        

Memor
=====

Memor is a bookmark manager.

Features
--------

* Multi-user
* Responsive design (usable on mobile)
* Grouping of bookmarks based on tags
* Import/Export browser-format bookmarks file
* Quick posting with bookmarklet
* Filter with multiple criteria (tags, user, search)
* I18n (available locales : English, French)
* REST API (partial implementation of delicious.com / Semantic Scuttle API)
* Compatible with [Scuttloid](https://github.com/ilesinge/scuttloid) Android App (although the privacy status of a bookmark is meaningless in Memor)

Planned features
----------------

* Tag management (rename, merge, delete)
* Commenting system
* More REST API features

Screenshots
-----------

###Main Memor view:

![Main Memor view](http://www.ndre.gr/memor/memor1.png "Main Memor view")

###Bookmark detail:

![Bookmark detail](http://www.ndre.gr/memor/memor2.png "Bookmark detail")

###On a small screen:

![On a small screen](http://www.ndre.gr/memor/memor3.png "On a small screen")

Technology
----------

* Ruby 2.0
* Rails 4
* Database: tested with MySQL and SQLite (should work with PostgreSQL)
* Twitter Bootstrap
* Bootswatch Metro theme for Bootstrap
* And some Ruby gems : https://github.com/ilesinge/memor/blob/master/Gemfile

Installation
------------

- Ensure you have Ruby 2.0 installed (with https://rvm.io/, just saying)
- Set up the database if using MySQL or PostgreSQL
- Copy `config/database.yml.mysql` (and adapt database auth parameters) or `config/database.yml.sqlite` to `config/database.yml`
- Comment the line `gem 'mysql2'` or `gem 'sqlite3'` in the file `Gemfile` based on which database you're using
- Install gem dependencies:

```sh
gem install bundler
cd memor
bundle install
```

- Generate database structure:

```sh
rake db:migrate
```

OR if you're doing a production install:

```sh
RAILS_ENV=production rake db:migrate
```

- Create an admin account:

```sh
# Prepend with 'RAILS_ENV=production' if needed
rake db:seed
```

- Precompile assets if you're doing a production install:

```sh
RAILS_ENV=production rake assets:precompile
```

- Start the server:

```sh
# Prepend with 'RAILS_ENV=production' if needed
rails s
```

- Launch http://localhost:3000/ in your browser
- Connect with user `administrator`, password `memorFTW!`
- Access http://localhost:3030/users/administrator/edit to change admin password (and username if you want)

Et voilà !

For production servers, I suggest to use [Unicorn](http://unicorn.bogomips.org/) with Nginx or [Phusion Passenger](https://www.phusionpassenger.com/) with Apache.

Bugs, ideas, questions?
----------------------

Use Github [issue tracker](https://github.com/ilesinge/memor/issues) !