5 Star 16 Fork 4

greenlaw110 / simple-bbs

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

Simple BBS

Live demo site

http://simple-bbs.actframework.org

Background

The project is created to finish the coding challenge I've raised to @AutoPlus.

I've also use this project to demonstrate on the following features of ActFramework:

  1. Login/SignUp user with Social connection, specifically github in this project. However it's a matter of configuration to get the project working on other social channels including LinkedIn and Facebook.
  2. Authentication/Authorisation/Auditing with Act-AAA
  3. CRUD form with Post/Update/Delete and data validation
  4. The expressiveness of ActFramework. It takes only 281 lines of Java code to implement this project.

Known issues

See https://git.oschina.net/greenlaw110/simple-bbs/issues

Requirement

1 It shall allow user to register/login to the system through Github oauth service 2 It shall be able to display user's github profile 3 It shall allow user to publish a message 4 The message must have the following fields

  • title
  • body
  • author
  • date time

5 It shall be able to display a message detail including title, body, author and time 6 It shall display message list 7 It shall allow author to edit message including title and body 8 It shall allow author to delete message he/she published

non-functional requirements

  • No requirement on styling. Just keep it simple.
  • Session expiration time is 60s. Every request shall update the expiration time.
  • No requirement on database. Choose whatever you want. But data must be persistent
  • No need to CSS just use standard HTML element is enough. List shall use <li> element. The body shall use <textarea> element
  • The home page should be message list. Use ajax to implement pagination. Each page shall display 20 messages
  • Project must provide the build script, deploy script and README file.

Platform and Database

You must have MongoDB, JDK7+ and the corresponding JCE installed in order to play with this project. You must install maven to build the application

Build/Run/Deploy

To build and run the app locally

mvn clean compile exec:exec

This will start the app in actframework default port: 5460

To build package for deployment

mvn clean package

This will generate a distribution package in target/dist dir. You can scp the file to your cloud server.

To run the distribution package, unzip it and type ./run

Note about Github application

This app require user to authenticate through GitHub OAuth service. Thus you must register your Github app.

Callback URL

Any OAuth app requrie the app owner to provide a callback URL. You must make sure your callback URL looks like:

http://<my-domain>/~/social/callback?provider=github

Once you registered the github application, you need to open /src/main/resources/app.properties file and type in your app ID and secret.

More about running locally

Since Github allows only one callback URL, if you registered a callback URL for live demo site (like me) then it needs to do some tricks in order to get the app running on local box:

  1. The local app start on port 5460, so you need to install a frontend http server (e.g. nginx) to direct the traffic from port 80 to 5460. Or you change the app configuration and add http.port=80 to get it start on port 80

  2. You might need to hijack your /etc/hosts file (C:\Windows\System32\drivers\etc\hosts on windows) by adding the mapping from the domain in the callback URL you registered on Github to your local ip. Here is my hosts file:

127.0.0.1	localhost simple-bbs.actframework.org

Extra

This project provides some extra functions in addition to the requirements stated above

Authentication/Authorisation/Auditing

This app demonstrate how to use act-aaa to implement Authentication/Authorization/Auditing.

When user post new message or update existing message, the app will audit the action into audit collection in the mongodb. Thus you should be able to find something like the follows:

> use bbs
switched to db bbs
> db.audit.find().pretty()
{
	"_id" : ObjectId("58c4b2daaa5dcb61026fe597"),
	"className" : "simple_bbs.model.Audit",
	"target" : "simple_bbs.model.Message[]",
	"principal" : "greenlaw110@gmail.com",
	"success" : true,
	"permission" : "update",
	"_created" : NumberLong("1489285850015"),
	"_modified" : NumberLong("1489285850015"),
	"v" : NumberLong(1)
}
{
	"_id" : ObjectId("58c4b2deaa5dcb61026fe598"),
	"className" : "simple_bbs.model.Audit",
	"target" : "simple_bbs.model.Message[]",
	"principal" : "greenlaw110@gmail.com",
	"success" : true,
	"permission" : "update",
	"_created" : NumberLong("1489285854817"),
	"_modified" : NumberLong("1489285854817"),
	"v" : NumberLong(1)
}
{
	"_id" : ObjectId("58c4b2e7aa5dcb61026fe599"),
	"className" : "simple_bbs.model.Audit",

Adding test data

This app provides a console command allow you to add test data. Before you start generating test data. Make sure you have at least one user in the system by open your browser navigating to the app and click on Login with Github.

Run nc localhost 5461 (you can change nc to anything like, e.g. telnet or putty on windows) when the app has been started. You should see something like:

  __  ___         _        _     _    _    __ 
 (_    |   |\/|  |_)  |   |_    |_)  |_)  (_  
 __)  _|_  |  |  |    |_  |_    |_)  |_)  __) 
                                              
           powered by ActFramework v1.1.0-f544

 version: ${project.version}
scan pkg: simple_bbs
base dir: /home/luog/p/greenlaw110/simple-bbs
     pid: 29282
 profile: dev
    mode: DEV

     zen: If the implementation is hard to explain, it's a bad idea.
Simple BBS[2k9b0dZP]>

Type help -a to query application command:

Simple BBS[2k9b0dZP]>help -a
help -a
APPLICATION COMMANDS

data.gen     - Generate test data

Type data.gen -h to check how to use the command:

Simple BBS[2k9b0dZP]>data.gen -h
data.gen -h
Usage: data.gen
Generate test data

Options:
  -n,--n     Number of record to be generated

Shortcuts: .dg, d.g, d.gen, data.g, da.ge

Now suppose you want to generate 30 posts, type

Simple BBS[2k9b0dZP]>data.gen -n 30
data.gen -n 30
Test data generated
Simple BBS[2k9b0dZP]>

You will get the data generated.

LOC statistics

luog@luog-Satellite-P50-A:~/p/greenlaw110/simple-bbs$ loc src
--------------------------------------------------------------------------------
 Language             Files        Lines        Blank      Comment         Code
--------------------------------------------------------------------------------
 Java                     9          395           71           43          281
 HTML                     5          269           24            0          245
 XML                      2          133           21           20           92
 JavaScript               3           85            7            2           76
 Batch                    2           14            0            0           14
 YAML                     1           15            3            0           12
 CSS                      1            3            0            0            3
--------------------------------------------------------------------------------
 Total                   23          914          126           65          723
--------------------------------------------------------------------------------```

Should you have any questions, please comment below or submit an issue.

Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: You must give any other recipients of the Work or Derivative Works a copy of this License; and You must cause any modified files to carry prominent notices stating that You changed the files; and You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "{}" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright 2017 greenlaw110 Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License 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.

简介

一个编码挑战项目 展开 收起
Java
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
Java
1
https://gitee.com/greenlaw110/simple-bbs.git
git@gitee.com:greenlaw110/simple-bbs.git
greenlaw110
simple-bbs
simple-bbs
master

搜索帮助

14c37bed 8189591 565d56ea 8189591