Sources for CommaFeed.com.

Google Reader inspired self-hosted RSS reader, based on Dropwizard and AngularJS.

Android apps: News+ extension

Browser extensions: Chrome - Firefox - Opera - Safari

git clone https://github.com/Athou/commafeed.git
cd commafeed
mvn clean package
cp config.yml.example config.yml
vi config.yml
java -Djava.net.preferIPv4Stack=true -jar target/commafeed.jar server config.yml 

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.

For storage, you can either use an embedded H2 database (use it only to test CommaFeed) or an external MySQL, PostgreSQL or SQLServer database. You also need Maven 3.x (and a Java 1.8+ JDK) installed in order to build the application.

To install maven and openjdk on Ubuntu, issue the following commands

sudo apt-get install g++ build-essential openjdk-8-jdk maven
# Make sure java8 is the selected java version
sudo update-alternatives --config java
sudo update-alternatives --config javac

On Windows and other operating systems, just download maven 3.x from the official site, extract it somewhere and add the bin directory to your PATH environment variable.

Clone this repository. If you don't have git you can download the sources as a zip file from here

git clone https://github.com/Athou/commafeed.git
cd commafeed

Now build the application

mvn clean package

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.

java -Djava.net.preferIPv4Stack=true -jar target/commafeed.jar server config.yml

You can use a proxy http server such as nginx or apache.

OpenShift is Red Hat's Platform-as-a-Service (PaaS) that allows developers to quickly develop, host, and scale applications in a cloud environment. CommaFeed runs perfectly on OpenShift and can even be used in the free tier. Follow the Getting Started guide and after you sign up and install the Command Line Tools (RHC), do:

rhc create-app commafeed diy-0.1 mysql-5.5
cd commafeed
git remote add upstream -m master https://github.com/Athou/commafeed.git
git pull -s recursive -X theirs upstream master
git push

# To upgrade an existing openshift installation
git pull upstream master
git push

Files for internationalization are located here.

To add a new language, create a new file in that directory. The name of the file should be the two-letters ISO-639-1 language code. The language has to be referenced in the src/main/app/js/i18n.js file to be picked up.

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 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).

See _test.scss for an example.

Steps to configuring a development environment for CommaFeed may include, but may not be limited to:

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.
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
     • 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
   • 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.
   • 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.
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"
9. Apply and hit "Debug"
10. The debugger is now working. To connect to it, open a terminal (or command prompt) and navigate to the directory where you cloned the CommaFeed files.
11. Issue the command gulp dev on Unix based systems or gulp.cmd dev in Windows.
12. The development server is now running at http://localhost:8082 and is proxying REST requests to dropwizard on port 8083.
13. Connect to the server from your browser; you should have functional breakpoints and watches on assets.
14. When you're done developing, create a fork at the top of https://github.com/Athou/CommaFeed page and commit your changes to it.
15. If you'd like to contribute to CommaFeed, create a pull request from your repository to https://github.com/Athou/CommaFeed when your changes are ready. There's a button to do so at the top of https://github.com/Athou/CommaFeed.

Copyright 2013-2014 CommaFeed.

Licensed under the Apache License, Version 2.0 (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:

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.