bulletin-board

Leapfrog Bulletin Board is a web application created with Node.js(express) as backend and React.js as frontend.

The Bulletin Board acts as a platform for sharing useful information regarding ongoing activities at Company/Organization to its employees through different informative segments. Information can be in form of Google slides, videos, images, website and YouTube.

Setup

Clone the repository

# Clone with SSH
$ git clone git@github.com:leapfrogtechnology/bulletin-board.git

# Or with HTTPS
$ git clone https://github.com/leapfrogtechnology/bulletin-board.git

Install dependencies (Root folder also requires package installation for proper functionality)

# Using npm
$ npm install

# Or using yarn
$ yarn

For API

Read our installation guide for API for the development guide.

For APP

Read our installation guide for APP for the development guide.

Google API Credentials

Goto Google oAuth Console and create new oAuth Credential with Application type as Web application and authorized domain as following:

http://localhost
http://localhost:3000
http://0.0.0.0:8848

Note: Need to Update the domain when in production.

Update Credential in API

# Google CLIENT ID
GOOGLE_CLIENT_ID=
GOOGLE_SECRET=

Update in APP

# Google Client ID KEY
REACT_APP_GOOGLE_CLIENT_ID=

Generate Changelog

Generate Changelog Only with following command:

$ NEXT=APP_NEXT_VERSION TOKEN=YOUR_GITHUB_TOKEN yarn changelog

E.g:
$ NEXT=v4.0.1 TOKEN=4545c0557b37331454343434 yarn changelog

Release

Generate changelog and publish a new tag using the following command:

$ NEXT=APP_NEXT_VERSION TOKEN=YOUR_GITHUB_TOKEN yarn release

E.g:
$ NEXT=v4.0.1 TOKEN=4545c0557b37331454343434 yarn release

Note: This requires github_changelog_generator to be installed.

Don't have github token, generate one here: generate_github_token

USAGE

Read our usage guide how to properly add information on Bulletin Board.

Contributing

Read our contributing guide to learn about our development process, how to propose bugs and improvements.

Changelog

Check the CHANGELOG for full release history.

License

Licensed under The MIT License.