Skip to content

Latest commit

 

History

History
123 lines (81 loc) · 5.35 KB

README.md

File metadata and controls

123 lines (81 loc) · 5.35 KB
Raw

Memoirable

Online diary for all

Join the chat at https://gitter.im/coderuse/memoirable Build Status

Site

Contents

Overview

We believe that, everyone should keep their experiences to meet new friends, starting new relations, having a bad day, having the most memorable day in a written format. In one's own language and with own feelings. And this written notes should not be lost. One of the problems in preserving paper diaries.

For this reason, we are building this. For you, for us. We can also pass these journals to future generations.

And of course this should remain free and private.

This app will use known and popular free storage providers like Google Drive, Microsoft OneDrive to store data and will be hosted on Github pages. So, as long as you can remember the password of your Storage provider's account, your journal will be accessible for you. And ofcourse it will remain for your own eye only.

Future Plan

Later we may add some features like:

  • Add user preference for fonts, diary editor theme etc
  • Pass selective journal entries to another user
  • Make a backup of your journal to local disk and restore from there. So that, you can keep your journal more safe and more personal

User Manual

We have a small user manual here

Release Notes

Release notes for version 0.1 (29th November, 2016)

In this first release of this diary, we have tried our best to keep it bug free as far as possible. Features are as follows.

Features
  • This release will be compatible with all the later releases. That means, any entry created with this release will be available and usable in later releases
  • Google Drive is supported as the only storage provider. User need to give the permission for application data folder. More details
  • Multiple entries for a date is possible
  • Entries for future date is possible
  • Buttons for Bold & Italics are available in the editor. As we are using CommonMark compatible renderer, all the tags available for CommonMark will be available for the writing. reference
  • Entries would be automatically saved with a delay of 2 seconds after last change (so, there would be no impact over the limitation of Google drive api calls per second)
Disclaimer
  • We have only manually tested this application. Unit tests and automated end-to-end tests have not been added in this release. Those are planned for future releases
  • Refresh on the editor is not permitted and will show one 404 error generated by GitHub
  • This release is only for Google Chrome Desktop version. Best viewed at a minimum 1024px by 768px view-port. But it should work flawlessly with Firefox and Safari

Release History

Support

Use this in your own site

git clone https://github.com/coderuse/memoirable.git
npm install -g grunt-cli typescript typings
npm install

Follow the steps to create a client id for the app and change the clientId in src/app/constants.ts.

Also installation of Ruby is required.

gem install sass susy normalize-scss
grunt build

Host the content in the build folder.

Contribute

This project is at a very initial stage. So, it's the right time to show your love for Open Source Development and be a part of the core team for this awesome project.

So, fork it, follow the above steps and invoke grunt to spawn a dev server with watch over the dev file changes.

Documentation

An auto generated doc is hosted at https://coderuse.github.io/memoirable

Team

Arnab Das Chandan Kr Jha
Arnab Das Chandan Kr Jha

License

Copyright 2016 Team Memoirable

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.