Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/disintegration/bebop
Bebop is a simple discussion board / forum web application
https://github.com/disintegration/bebop
discussion-board forum golang rest-api vuejs web-app
Last synced: 7 days ago
JSON representation
Bebop is a simple discussion board / forum web application
- Host: GitHub
- URL: https://github.com/disintegration/bebop
- Owner: disintegration
- License: mit
- Created: 2017-05-03T19:21:10.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-03-21T22:36:11.000Z (almost 7 years ago)
- Last Synced: 2024-12-07T11:41:35.670Z (15 days ago)
- Topics: discussion-board, forum, golang, rest-api, vuejs, web-app
- Language: Go
- Homepage:
- Size: 27.3 MB
- Stars: 552
- Watchers: 31
- Forks: 73
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Bebop
Bebop is a simple discussion board / forum web application.
## Features
- REST API backend written in Go
- Vue.js-based frontend
- Two databases are supported:
- PostgreSQL
- MySQL
- Three file-storage backends are supported to store user-uploaded files (e.g. avatars):
- Local filesystem
- Google Cloud Storage
- Amazon S3
- Social login (OAuth 2.0) via three providers:
- Google
- Facebook
- Github
- JSON Web Tokens (JWT) are used for user authentication in the API
- Single binary deploy. All the static assets (frontend JavaScript & CSS files) are embedded into the binary
- Markdown comments
- Avatar upload, including animated GIFs. Auto-generated letter-avatars on user creation
## Getting Started
* Create a new empty database (MySQL оr PostgreSQL) that will be used as a data store and a database user with all privileges granted on this database.
* Obtain OAuth 2.0 credentials (client_id and secret) from at least one of the providers (Google, Facebook, Github) so users can log into the web application. The OAuth callback url will be `/oauth/end/`. The `` is where the bebop web app will be mounted on your site and the `` is the lowercase provider name. For example, if base_url is `https://my.website.com/forum/`, then the oauth callback url for google will be `https://my.website.com/forum/oauth/end/google`.
* Download and compile the bebop binary:
```
$ go get -u github.com/disintegration/bebop/cmd/bebop
```
* Inside an empty directory run:
```
$ bebop init
```
This will generate an initial configuration file "bebop.conf" inside the current dir.
Edit the configuration file to set the server listen address, the base url, the database and file storage parameters, OAuth credentials, etc.
* Run the following command to start the bebop web server.
```
$ bebop start
```
* Sign in into your web application using one of the social login providers.
Then run the following command to grant admin privileges to your user.
```
$ bebop add-admin
```
## Screenshots
### Topics
### Comments
