xbing1221 / sited-project

A developer friendly Java CMS based on JAX-RS, Guice style DI, Bean Validation, JPA and React.

Sited CMS

A developer friendly Java CMS based on JAX-RS, Guice style DI, Bean Validation, JPA and React.

• Built for startup, provides well designed quick prototyping code base.
• More modules are coming...

Edit Template	Edit Page
Index Page	Post Page

Features

Frameworks	Content	Notes
OS	Windows Linux Mac OS
Database	MySQL HSQL	For other databases, need to manually install the JDBC driver
Backend Console	React 16 Element UI	Support IE11+
Frontend	jQuery 1.1.12 Bootstrap 3.3.7	Support IE8+
API	Jersey Hibernate Hibernate Validator Jackson Guava DBCP
Messaging	RabbitMQ	Kafaka support is under development
Caching	Redis
Template Engine	Provides Thymeleaf like syntax JEXL
Modules
User	Login Page Register Page reset password support role permission management	Oauth support is under development
Page	Index Page Category Page Post Page Tag Page Archive Page Search result page	Support drag&drop widgets to edit template
Page Index	Index Pages with Lucene
File	File browser image scale file upload file download	Folder permissions similar to Linux file system is under development
Email	SMTP client SES client Email Template Email Tracking
Pincode	Email pincode
Captcha	Simple captcha image

Getting Started

These instructions will get you a copy of the Sited CMS up and running on your local machine.

Prerequisites

1. Download and install Open JDK 10 or Oracle JDK 10
2. If you want to use MySQL as database. (Optional, Sited default embeds HSQL)
   1. Download and install MySQL.
   2. Create a database.
      CREATE DATABASE main CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
   3. Create a database user with schema update permission.
      CREATE USER 'user'@'localhost' IDENTIFIED BY 'password'; GRANT ALL PRIVILEGES ON * . * TO 'user'@'localhost'; FLUSH PRIVILEGES;

Installing

1. Download the package file sited-v0.9.0-beta.zip (For all platform)
2. Unzip the package
3. Run ./bin/sited
4. Use a browser(IE11+) to open http://localhost:8080
5. Fill in the require information to setup sited.
   1. Choose language.
   2. Input app name, the name will be displayed in page title.
   3. Select database.
      1. If you want to use MySQL, input the info of database and user you created.
   4. Input SMTP settings.

      Optional, if you skip the SMTP settings, user register will be disabled.

   5. Click install button. Sited will restart.
6. Open http://localhost:8080/admin/

Run Source Code

1. Clone the repo
2. Import as a Gradle project to Intellij IDEA or Eclipse.
3. Run sited-main/src/java/Main.java

Known issues

• There will be errors in module-info.java for duplicate module java.xml.bind
• There will be errors in DAO related source codes for missing @Transactional.

It is because of Java 10 JEE split package issues. A temp fix for Intellij IDEA is:

1. Open settings. Build, Execution, Deployment>Compiler>Java Compiler.
2. Input the following parameters to Additional command line parameters. And replace the path of javax.transaction-api-1.3.jar.

   --add-modules=java.xml.bind --patch-module java.transaction=~\.gradle\caches\modules-2\files-2.1\javax.transaction\javax.transaction-api\1.3\e006adf5cf3cca2181d16bd640ecb80148ec0fce\javax.transaction-api-1.3.jar
   

3. The error messages are still there, but it compiles.

Code Examples

To start an App:

public class Main {
    public static void main(String[] args) throws InterruptedException {
        Path dir = Paths.get(System.getProperty("user.home")).resolve(".sited");
        App app = new UndertowApp(dir);
        ServiceLoader.load(AbstractModule.class).forEach(app::install);
        app.start();
    }
}

To create a Module:

public class TodoServiceModuleImpl extends TodoServiceModule {
    @Override
    protected void configure() {
        //import DatabaseModule to register entity and create repository
        module(DatabaseModule.class)
            .entity(Task.class);
        
        bind(TaskService.class);
        
        //register service implementation
        api().service(TaskWebService.class, TaskWebServiceImpl.class);
    }
}

Release Notes

• What's next

  • Facebook integration
  • Add this sharing
  • GA tracking

• 0.9.0 · Beta release

  • User management, supports login/register/forget password/pincode/captcha code.
  • Page management, supports category/page/template/variable/components.
  • File management, supports upload files, download files, scale images, react file browser.
  • Basic email template support

Authors

• Chi (Xiamen, China)
  If you need support for customization or commerce license, please feel free to contact me.
  • email chiron.chi#gmail.com
  • skype chiron.chi#gmail.com
  • wechat sited-io

See also the list of contributors who participated in this project.

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

License

This project is licensed under the AGPL License - see the LICENSE.md file for details