README
¶
Getting started
Are you interested in the next generation of TsuboneSystem? Why not try on your computer?
Building requirements
All of the following softwares:
- GNU Bash
- GNU Make
- Go 1.8
- OpenJDK 8
- MariaDB 10.1
- Node.js
- npm
- procps (ps command)
- SELinux Reference Policy
Platforms other than Arch Linux and CentOS 7 are not tested. Fixes for other Linux distributions, Microsoft-supported Windows and macOS are highly appreciated.
Client requirements
Either of the following browsers:
- Google Chrome 53 or any later version
- Microsoft Edge
- Microsoft Internet Explorer 11
- Mozilla Firefox 45 or any later version
If you use older Internet Explorer, throw it away and go Firefox.
Testing
1. Set an appropriate GOPATH.
export GOPATH=/somewhere/nice
2. Download TsuboneSystem3 with go get.
go get -d github.com/kagucho/tsubonesystem3/...
cd $GOPATH/src/github.com/kagucho/tsubonesystem3
3. Create a configuration file as configuration/configuration.go.
Configure for tsubonesystem3 command. See configuration/example for an
example and detailed explanations for the configuration.
4. Create a new database.
$ mysql
> CREATE DATABASE tsubonesystem;
> exit
$
5. Deploy the testing tables.
$ mysql < test.sql
5. Prepare.
$ make prepare
6. Make!
make
make provides other helpful targets; see Makefile.
Testing Database
The testing database is named test.sql and it includes records useful for
testing.
The passwords in members table is encrypted with DBPasswordKey in
configuration/example/configuration.go. The raw passwords are NthPassword,
where N is the member number. For example, the username and the password for
member 1 is 1stDisplayID and 1stPassword.
Web Application Dependencies
See webapp/package.json. webapp/jquery.min.js and webapp/jquery.min.map
are prebuilt code of the modified jQuery hosted at
https://github.com/akihikodaki/jquery.
License
This software is licensed under AGPL-3.0. See COPYING.TXT.
Standards
This application implicitly conforms to the following standards.
- Accessible Rich Internet Applications (WAI-ARIA) 1.0
- CSS Snapshot 2017
- DOM Standard
- ECMAScript® 2016 Language Specification
- Encoding Standard
- HTML Standard
- The Go Programming Language Specification
- URL Standard
- Web Audio API W3C Working Draft 08 December 2015
- XMLHttpRequest Standard
The usage of the Web Audio API is limited to complement; the lack of the API should not affect to the core experience.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package authority implements HMAC-SHA256 authority.
|
Package authority implements HMAC-SHA256 authority. |
|
db
Package db implements an abstraction for the database.
|
Package db implements an abstraction for the database. |
|
encoding
Package encoding provides encoding features.
|
Package encoding provides encoding features. |
|
handler/apiv0
Package apiv0 implements API v0.
|
Package apiv0 implements API v0. |
|
handler/apiv0/token
Package token implements a some utility related to token.
|
Package token implements a some utility related to token. |
|
handler/apiv0/token/backend
Package backend implements the backend of the token server of API v0.
|
Package backend implements the backend of the token server of API v0. |
|
handler/file
Package file implements a file server.
|
Package file implements a file server. |
|
handler/private
Package private implements the private page hosting.
|
Package private implements the private page hosting. |
|
mail
Package mail implements a feature to email.
|
Package mail implements a feature to email. |
|
scope
Package scope implements the common expression of scope.
|
Package scope implements the common expression of scope. |
|
configuration
|
|
|
frontend
|
|
|
Package jwt implements JWT (JSON Web Token).
|
Package jwt implements JWT (JSON Web Token). |
|
Package limiter implements a simple rate limiter.
|
Package limiter implements a simple rate limiter. |
|
Package unchunked implements an unchunked response writer wrapper.
|
Package unchunked implements an unchunked response writer wrapper. |