claireso / bookmarks

A self hostable application for storing bookmarks

Bookmarks

Bookmarks is a self hostable application for storing bookmarks. It is built with Express 4 and Mongoose. PhantomJs is used to take screen capture of your bookmarks. You need to install it on your server. This application is still in beta.

Install it

Clone the project:

git clone https://github.com/claireso/bookmarks.git

Install the dependencies

cd bookmarks
npm install

Build scripts

Gulp is used in the project to build scripts

cd gulp
npm install
gulp build

Configure it

Add the config.js file in the root directory

touch config.js

Past this code in the config.js file and complete it

var config = {

    session: {
        secret: ''
    },

    db: {
        development: {
            uri: ''
        },
        production: {
            uri: ''
        }
    },

    mail: {
    
    }

}

// Export config
module.exports = config;

• secret : a string to protect your session
• db.development.uri : the uri of your database in development environment (ie : 'mongodb://localhost/bookmarks')
• db.development.uri : the uri of your database in production environment
• mail : nodemailer is used to send mail if you forgot your password account. You need to add a SMTP configuration. Check the documentation here.

Create your account

After the configuration of your application and starting your Mongodb server, you need to create your account. For this enter this command line:

node install.js development

Replace 'development' by 'production' if you are in the production environment. You must enter an email and a password.

Then, you can start your application :

npm start

Roadmap

• Adding mobile compatibility
• Adding a pagination for the lists (done)

Built with

• Express
• Mongoose
• PhamtomJs
• Nodemailer