Files
leanote/README.md

85 lines
2.4 KiB
Markdown
Raw Normal View History

2014-05-06 23:02:18 +08:00
We will upload leanote as soon as possible. Thanks for watching leanote.
2014-05-06 22:40:29 +08:00
## Introduction
2014-05-05 01:07:19 -07:00
2014-05-06 22:40:29 +08:00
leanote, it's a cloud note. You can create your own cloud note in leanote.
## Features
* Knowledge: manage your knowledge in leanote. Leanote contains tinymce editor and markdown editor, just enjoy yourself and leanote.
* Share: share your knowledge to your friends in leanote. Well, you are not alone, you can invite your friends to join your cloud note and share your knowledge each other.
* Cooperation: collaborate with friends to improve your knowledge.
* Blog: public your knowledge and leanote be your blog.
## Why we create leanote
Well, to be honest, our inspiration comes from evernote, and we use evenote to manage our knowledge everyday. But we find that:
* Evernote's editor can't meet our needs, it hasn't document navigation, can't put our codes(as a programmer, put codes is the basic needs), can't resize images...)
* We like markdown, but evernote don't support it.
* We want to public our knowledge, so we have our blog(such as wordpress) and evernote, but why can't be one!
* ......
2014-05-06 22:54:05 +08:00
## How to use it
leanote build with golang(revel) and mongodb. so you must install mongodb at first.
2014-05-06 22:56:38 +08:00
### Install mongodb
go http://www.mongodb.org to download and install it.
2014-05-06 22:54:05 +08:00
2014-05-06 22:59:52 +08:00
### Export initial mongodb data
the mongodb data in leante/mongodb_backup/leanote_install_data
```
mongorestore -h localhost -d leanote --directoryperdb path_to_leanote_install_data
```
2014-05-07 08:56:19 +08:00
the initial data contains two users
```
user1 username: leanote, password: abc123
user2 username: admin, password: abc123
```
2014-05-06 22:59:52 +08:00
2014-05-06 22:56:38 +08:00
### Configure conf/app.conf
2014-05-06 22:54:05 +08:00
``mongodb`` **required**
the mongodb info
2014-05-06 22:56:38 +08:00
```Shell
2014-05-06 22:54:05 +08:00
db.host=localhost
db.port=27017
db.dbname=leanote # required
db.username=root
db.password=root123
# or you can set the mongodb url for more complex needs
# mongodb://myuser:mypass@localhost:40001,otherhost:40001/mydb
db.url=mongodb://root:root123@localhost:27017/leanote
```
``email``
for find password
``http.port``
default is 80
``adminUsername``
default is admin. The index site is the adminUsername's blog
for more infomation please see app/app.conf and revel manuals http://revel.github.io/
2014-05-06 22:56:38 +08:00
### Run leanote
2014-05-07 11:53:27 +08:00
consume the leanote' path is LP
2014-05-07 11:55:08 +08:00
* cd LP/bin
* set GOPATH
2014-05-06 22:56:38 +08:00
```
2014-05-07 11:53:27 +08:00
export GOPATH=$GOPATH:`pwd`
```
2014-05-07 11:55:08 +08:00
* run leanote
```
./leanote -importPath=github.com/leanote/leanote
2014-05-06 22:56:38 +08:00
```
## How to develop leanote
2014-05-06 22:54:05 +08:00
## License
2014-05-06 22:59:52 +08:00
leanote is released as open-source software under the GNU General Public License (GPL), version 2 or later.