Skip to content

Commit 93d98aa

Browse files
committed
Merge branch 'master' into Fox-Working
Conflicts: .project Doc/Build.md OpenNote/Config.php README.md
2 parents 640a6d2 + 5e20a3f commit 93d98aa

File tree

6 files changed

+78
-30
lines changed

6 files changed

+78
-30
lines changed

.project

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,4 +15,4 @@
1515
<nature>org.eclipse.angularjs.core.angularnature</nature>
1616
<nature>tern.eclipse.ide.core.ternnature</nature>
1717
</natures>
18-
</projectDescription>
18+
</projectDescription>

Doc/Build.md

Lines changed: 18 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,18 @@
1-
# How To Build
2-
3-
Installing Build Enviorment
4-
---------------------------
5-
6-
git clone this repositiory
7-
8-
thern run
9-
```
10-
npm install
11-
```
12-
13-
this will install everything fron bower to grunt.
14-
15-
Then run
16-
```
17-
grunt build
18-
```
19-
20-
This is pull all the bower components and build things like css
1+
# How to build
2+
3+
## Clone
4+
You will need to clone the front end and the backend
5+
https://github.com/FoxUSA/OpenNote
6+
https://github.com/FoxUSA/OpenNoteService-PHP
7+
8+
Most of the buid tasks require the OpenNote and OpenNoteService-PHP to be in the same folder
9+
10+
## Build Requirments
11+
- Bower
12+
- Grunt
13+
- Composer
14+
15+
## Build
16+
Run from OpenNote project
17+
`grunt build`
18+

Doc/Install.md

Lines changed: 20 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,35 @@
11
# How To Install
2+
# Automatic(Wizard Based Install)
3+
To run the installer open
4+
`<install path>/Service/install.php`
25

6+
Make sure you delete `install.php` and `Config.template`.
7+
8+
### Security Note
9+
Be default we put the sqlite databse in the web folder. This is not a good idea. We solved this by putting in a htaccess file to not allow the database to be downloaded.
10+
11+
Still, you should move this file out of the webserver directory and change the location in `Config.php`
12+
13+
## Manual
314
###MYSql
415
- Create a MYSQL database named "OpenNote"
516
- Download and extract OpenNote into a folder on your php web-server called "OpenNote"
6-
- Open up the `model/sql` folder and run `notebook.sql` in your OpenNote database
7-
- Change the database connection settings inside of `web-server path/OpenNote/Config.php` to match your db settings.
17+
- Open up the `Service/model/sql` folder and run `notebook.sql` in your OpenNote database
18+
- Change the database connection settings inside of `Service/Config.php` to match your db settings.
819
These are stored in the following lines of code in `/OpenNote/Config.php`:
920
```php
10-
public static $dbUserName = "notebook";
11-
public static $dbPassword = "password";
12-
public static $dbServer = "localhost";
13-
public static $dbName = "notebook";
21+
$dbUserName = "notebook";
22+
$dbPassword = "password";
23+
$dbServer = "127.0.0.1";
24+
$dbName = "notebook";
1425
```
1526
1627
- Now the site install is complete. You can now open the site by going to your webserver url +/OpenNote
1728

1829
###SQLite
1930
- Download and extract OpenNote into a folder on your php web-server called "OpenNote"
20-
- Move the SQLite database file from `model/sql` folder to a folder not in the web server www directory.
21-
- Change the database connection settings inside of `web-server path/OpenNote/Config.php` to match your db settings.
31+
- Create a SQLite database file and execute the SQL DDL from `Service/model/sql` and run `notebook.sqlite.sql`.
32+
- Change the database connection settings inside of `Service/Config.php` to match your db settings.
2233
- These are stored in the following lines of code in `/OpenNote/Config.php`:
2334

2435
Uncomment the following lines in the dbConfig function:
@@ -33,4 +44,4 @@ Comment the following lines in the dbConfig function:
3344
$dbName = "../<relative path>/OpenNote.sqlite";
3445
```
3546
36-
- Now the site install is complete. You can now open the site by going to your webserver url +/OpenNote
47+
- Now the site install is complete. You can now open the site by going to your webserver url +/OpenNote

Doc/Upgrade.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# How To Upgrade
2+
###MYSql
3+
- Make sure you make a copy of you database and the OpenNote directory
4+
- Run `Service/model/sql/updateScript/` scripts to roll the database up to current specs.
5+
- You will copy need to copy the upload directory contents into the new upload direcory in `Service/upload`.
6+
7+
###SQLite
8+
Same as the MYSql. You may need to slightly modify the sql upload script to be compatible with sqlite.

License

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
The MIT License (MIT)
2+
3+
Copyright (c) 2014 Jacob Liscom
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,20 @@ Features
3131

3232
Upcoming Features
3333
-----------------
34+
- REST service and Angular JS Based front end. Working on in working branch.
35+
- Tags (You win)
3436
- Email to note
3537
- Implement history viewer
3638
- Install script
3739
- Move Notes (Feature lost when migrating to Angular based list)
40+
- Native Apps?????
41+
42+
User Wish List
43+
--------------
44+
List of things users are wishing for that have not made it into the pipeline.
45+
Please do not re-submit issues for these features. Instead, how about a donation with the feature in the comment?
46+
47+
- Out of box PostgreSQL support. PDO connector support PostgreSQL.
3848

3949
Demo
4050
-------

0 commit comments

Comments
 (0)