forked from Archives/Athou_commafeed
mv_store=false is not required anymore (fixes #1007)
This commit is contained in:
29
README.md
29
README.md
@@ -7,7 +7,6 @@ CommaFeed is now considered feature-complete and is in maintenance mode.
|
|||||||
|
|
||||||
## Related open-source projects
|
## Related open-source projects
|
||||||
|
|
||||||
|
|
||||||
Android apps: [News+ extension](https://github.com/Athou/commafeed-newsplus)
|
Android apps: [News+ extension](https://github.com/Athou/commafeed-newsplus)
|
||||||
|
|
||||||
Browser extensions: [Chrome](https://github.com/Athou/commafeed-chrome) - [Firefox](https://github.com/Athou/commafeed-firefox) - [Opera](https://github.com/Athou/commafeed-opera) - [Safari](https://github.com/Athou/commafeed-safari)
|
Browser extensions: [Chrome](https://github.com/Athou/commafeed-chrome) - [Firefox](https://github.com/Athou/commafeed-firefox) - [Opera](https://github.com/Athou/commafeed-opera) - [Safari](https://github.com/Athou/commafeed-safari)
|
||||||
@@ -35,14 +34,14 @@ Browser extensions: [Chrome](https://github.com/Athou/commafeed-chrome) - [Firef
|
|||||||
|
|
||||||
CommaFeed 2.0 has been rewritten to use Dropwizard and gulp instead of using tomee and wro4j. The latest version of the 1.x branch is available [here](https://github.com/Athou/commafeed/tree/1.x).
|
CommaFeed 2.0 has been rewritten to use Dropwizard and gulp instead of using tomee and wro4j. The latest version of the 1.x branch is available [here](https://github.com/Athou/commafeed/tree/1.x).
|
||||||
|
|
||||||
For storage, you can either use an embedded H2 database (use it only to test CommaFeed) or an external MySQL, PostgreSQL or SQLServer database.
|
For storage, you can either use an embedded file-based H2 database or an external MySQL, PostgreSQL or SQLServer database.
|
||||||
You also need the Java 1.8+ JDK in order to build the application.
|
You also need the Java 1.8+ JDK in order to build the application.
|
||||||
|
|
||||||
To install the required packages to build CommaFeed on Ubuntu, issue the following commands
|
To install the required packages to build CommaFeed on Ubuntu, issue the following commands
|
||||||
|
|
||||||
# if openjdk-8-jdk is not available on your ubuntu version (14.04 LTS), add the following repo first
|
# if openjdk-8-jdk is not available on your ubuntu version (14.04 LTS), add the following repo first
|
||||||
sudo add-apt-repository ppa:openjdk-r/ppa
|
sudo add-apt-repository ppa:openjdk-r/ppa
|
||||||
sudo apt-get update
|
sudo apt-get update
|
||||||
|
|
||||||
sudo apt-get install g++ build-essential openjdk-8-jdk
|
sudo apt-get install g++ build-essential openjdk-8-jdk
|
||||||
|
|
||||||
@@ -50,7 +49,6 @@ To install the required packages to build CommaFeed on Ubuntu, issue the followi
|
|||||||
sudo update-alternatives --config java
|
sudo update-alternatives --config java
|
||||||
sudo update-alternatives --config javac
|
sudo update-alternatives --config javac
|
||||||
|
|
||||||
|
|
||||||
Clone this repository. If you don't have git you can download the sources as a zip file from [here](https://github.com/Athou/commafeed/archive/master.zip)
|
Clone this repository. If you don't have git you can download the sources as a zip file from [here](https://github.com/Athou/commafeed/archive/master.zip)
|
||||||
|
|
||||||
git clone https://github.com/Athou/commafeed.git
|
git clone https://github.com/Athou/commafeed.git
|
||||||
@@ -63,7 +61,7 @@ Now build the application
|
|||||||
Copy `config.yml.example` to `config.yml` then edit the file to your liking.
|
Copy `config.yml.example` to `config.yml` then edit the file to your liking.
|
||||||
Issue the following command to run the app, the server will listen by default on `http://localhost:8082`. The default user is `admin` and the default password is `admin`.
|
Issue the following command to run the app, the server will listen by default on `http://localhost:8082`. The default user is `admin` and the default password is `admin`.
|
||||||
|
|
||||||
java -Djava.net.preferIPv4Stack=true -jar target/commafeed.jar server config.yml
|
java -Djava.net.preferIPv4Stack=true -jar target/commafeed.jar server config.yml
|
||||||
|
|
||||||
You can use a proxy http server such as nginx or apache.
|
You can use a proxy http server such as nginx or apache.
|
||||||
|
|
||||||
@@ -77,12 +75,11 @@ The language has to be referenced in the `src/main/app/js/i18n.js` file to be pi
|
|||||||
|
|
||||||
## Themes
|
## Themes
|
||||||
|
|
||||||
To create a theme, create a new file `src/main/app/sass/themes/_<theme>.scss`. Your styles should be wrapped in a `#theme-<theme>` element and use the [SCSS format](http://sass-lang.com/) which is a superset of CSS.
|
To create a theme, create a new file `src/main/app/sass/themes/_<theme>.scss`. Your styles should be wrapped in a `#theme-<theme>` element and use the [SCSS format](http://sass-lang.com/) which is a superset of CSS.
|
||||||
|
|
||||||
Don't forget to reference your theme in `src/main/app/sass/app.scss` and in `src/main/app/js/controllers.js` (look for `$scope.themes`).
|
Don't forget to reference your theme in `src/main/app/sass/app.scss` and in `src/main/app/js/controllers.js` (look for `$scope.themes`).
|
||||||
|
|
||||||
See [_test.scss](https://github.com/Athou/commafeed/blob/master/src/main/app/sass/themes/_test.scss) for an example.
|
See [\_test.scss](https://github.com/Athou/commafeed/blob/master/src/main/app/sass/themes/_test.scss) for an example.
|
||||||
|
|
||||||
|
|
||||||
## Local development
|
## Local development
|
||||||
|
|
||||||
@@ -91,12 +88,12 @@ Steps to configuring a development environment for CommaFeed may include, but ma
|
|||||||
1. `git clone https://github.com/Athou/CommaFeed` into some folder to get the project files.
|
1. `git clone https://github.com/Athou/CommaFeed` into some folder to get the project files.
|
||||||
2. Install Eclipse Luna (or latest) from http://www.eclipse.org/downloads/packages/eclipse-ide-java-developers/lunasr1 or your repo if available.
|
2. Install Eclipse Luna (or latest) from http://www.eclipse.org/downloads/packages/eclipse-ide-java-developers/lunasr1 or your repo if available.
|
||||||
3. In Eclipse, Window → Preferences → Maven → Annotation Processing. Check "Automatically configure JDT APT"
|
3. In Eclipse, Window → Preferences → Maven → Annotation Processing. Check "Automatically configure JDT APT"
|
||||||
* You may have to install the m2e-apt connector to have "Annotation Processing" as an option. Do so from Window → Preferences → Maven → Discovery → Open Catalog → type "m2e-apt" in the search box
|
- You may have to install the m2e-apt connector to have "Annotation Processing" as an option. Do so from Window → Preferences → Maven → Discovery → Open Catalog → type "m2e-apt" in the search box
|
||||||
* If you have installed Eclipse EE instead of Luna, you may have trouble installing m2e-apt
|
- If you have installed Eclipse EE instead of Luna, you may have trouble installing m2e-apt
|
||||||
4. Install Lombok into Eclipse from http://projectlombok.org/download.html
|
4. Install Lombok into Eclipse from http://projectlombok.org/download.html
|
||||||
* You may have to run `java -jar lombok.jar` as an administrator if your eclipse installation is not in your home folder
|
- You may have to run `java -jar lombok.jar` as an administrator if your eclipse installation is not in your home folder
|
||||||
5. In Eclipse, File → Import → Maven → Existing Maven Projects. Navigate to where you cloned the CommaFeed files into, and select that as the root directory. Click Finish.
|
5. In Eclipse, File → Import → Maven → Existing Maven Projects. Navigate to where you cloned the CommaFeed files into, and select that as the root directory. Click Finish.
|
||||||
* You may notice some errors along the lines of "Plugin execution not covered by lifecycle configuration". These are inconsequential.
|
- You may notice some errors along the lines of "Plugin execution not covered by lifecycle configuration". These are inconsequential.
|
||||||
6. Find the file "CommaFeedApplication.java" under the navigation pane.
|
6. Find the file "CommaFeedApplication.java" under the navigation pane.
|
||||||
7. Right click it to bring up the context menu → Debug as... → Debug Configurations
|
7. Right click it to bring up the context menu → Debug as... → Debug Configurations
|
||||||
8. Type `server config.dev.yml` under "Program arguments" in the "Arguments" tab for the Java Application setting "CommaFeedApplication"
|
8. Type `server config.dev.yml` under "Program arguments" in the "Arguments" tab for the Java Application setting "CommaFeedApplication"
|
||||||
@@ -116,7 +113,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
|
|||||||
you may not use this work except in compliance with the License.
|
you may not use this work except in compliance with the License.
|
||||||
You may obtain a copy of the License in the LICENSE file, or at:
|
You may obtain a copy of the License in the LICENSE file, or at:
|
||||||
|
|
||||||
http://www.apache.org/licenses/LICENSE-2.0
|
http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
|
||||||
Unless required by applicable law or agreed to in writing, software
|
Unless required by applicable law or agreed to in writing, software
|
||||||
distributed under the License is distributed on an "AS IS" BASIS,
|
distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
|||||||
@@ -87,7 +87,7 @@ app:
|
|||||||
|
|
||||||
database:
|
database:
|
||||||
driverClass: org.h2.Driver
|
driverClass: org.h2.Driver
|
||||||
url: jdbc:h2:/home/commafeed/db;mv_store=false
|
url: jdbc:h2:/home/commafeed/db
|
||||||
user: sa
|
user: sa
|
||||||
password: sa
|
password: sa
|
||||||
properties:
|
properties:
|
||||||
|
|||||||
Reference in New Issue
Block a user