Athena

Chinese Version / 中文版

Library Management System based on Spring Framework and RESTful API

Currently, the Athena Project contains following components:

• A RESTful API /src/main/java
• A WeChat Application /src/main/javascript
• A frontend based on Angular /src/main/typescript

More components like the Android application will be included in future

This is project is inspired by the question from here

Feature

• Manage different kinds of publication from book, journal to audio and more
• Configurable from config file
• Test Driven Development
• RESTful API
• Angular as front-end framework
• JWT

Install & Preparation

Setup database

Use .sql file /src/resource/database.sql to setup the database.

Add config file

To install the application, first need to create some config file in resources

Or you can copy the key in /src/main/java/resource/application.properties.example and src/main/java/resource/config.properties.example , then create corresponding new config file

• application.properties

  Config MySQL

  key	value
  spring.datasource.url	The url of datasource
  spring.datasource.username	Username
  spring.datasource.password	Password
  spring.datasource.driverClassName	Drive class

  Config Redis

  Spring Boot has configure most of the configuration for us. Table below lists the configuration that I changed. See this document to find all the auto-configuration that Spring Boot defined

  key	value
  spring.redis.database	Index of the redis, default 0
  spring.redis.host	Host of the redis, default localhost
  spring.redis.port	Port of the redis, default 6379
  spring.redis.password	Password of the redis

  Config MongoDB

  key	value
  spring.data.mongodb.host	Mongo server host
  spring.data.mongodb.authentication-database	Authentication database name
  spring.data.mongodb.username	Login user of the mongo server
  spring.data.mongodb.password	Login password of the mongo server
  spring.data.mongodb.database	Database name

• config.properties

  Config JWT

  key	value
  security.token.key	The key of JWT Authentication
  security.token.header	The key of JWT in HTTP header
  security.token.prefix	The prefix of JWT
  security.token.expirationtime	The expiration time of JWT

  Config search param

  key	value
  search.default.count	The default value on how much result to return per page
  search.limit.expiredtime	How long before reset the time that unauthenticated user
  search.limit.prefix	The prefix added to the remote address of the request when stored and queried in Redis
  search.limit.get.times	How much get request can perform for unauthenticated user within expired time

  Config url

  key	value
  web.url	the whole url prefix of project. e.g http://localhost:8080/api/v1
  web.url.prefix	the url without protocol host and port e.g /api/v1

  Config Privilege

  key	value
  privilege.sequence	The sequence that denote the importance of privilege.

Install required library

Run following command in command line to install library by maven mvn

The following dependencies are required by Athena, you can also find them in the pom.xml

• Spring Boot Starter
  • spring-boot-starter-data-redis
  • spring-boot-starter-data-jpa
  • spring-boot-starter-web
  • spring-boot-starter-security
  • spring-boot-starter-data-mongodb
• Mysql Connector
• Apache Common
• Jpinyin
• Jjwt
• Springfox Swagger2

The dependencies below are required for test

• DBUnit
• Spring Security Test

  Note that the spring security does not contain some of useful component such as @WithMockUser

• Kotlin Stdlib Jre8
• Kotlin Test

  Athena will use Kotlin for test

• Fongo
• NoSqlUnit

Start

First, start the test databases by docker:

docker-compose up -d

To run the application, use

mvn spring-boot:run

API

To access the api documentation, first run the application and then access the

http://localhost:8080/swagger-ui.html#/

Exception Check List

Among the Athena, we may encounter different kind of exceptions. The Http standard status code(like 401,400) may not be enough. Thus, we introduce some custom status code which will be include in the response body when exception happens.