Skip to content

Latest commit

 

History

History
141 lines (106 loc) · 3.95 KB

README.md

File metadata and controls

141 lines (106 loc) · 3.95 KB
Raw

Content Building Block

The Content Building Block handles the management of application content for the Rokwire platform.

Documentation

The functionality provided by this application is documented in the Wiki.

The API documentation is available here: https://api.rokwire.illinois.edu/content/doc/ui/

Set Up

Prerequisites

MongoDB v4.2.2+

Go v1.21+

Environment variables

The following Environment variables are supported. The service will not start unless those marked as Required are supplied.

Name Format Required Description
CONTENT_PORT < int > yes Port to be used by this application.
CONTENT_HOST < url > yes URL where this application is being hosted.
CONTENT_MONGO_AUTH <mongodb://USER:PASSWORD@HOST:PORT/DATABASE NAME> yes MongoDB authentication string. The user must have read/write privileges.
CONTENT_MONGO_DATABASE < url > yes MongoDB database name.
CONTENT_MONGO_TIMEOUT < int > no MongoDB timeout in milliseconds. Defaults to 500.
CONTENT_CORE_BB_HOST < url > yes Core BB host url
CONTENT_SERVICE_URL < url > yes The service host url
CONTENT_AWS_ACCESS_KEY_ID < string > yes AWS Access key ID
CONTENT_AWS_SECRET_ACCESS_KEY < string > yes AWS Secret access key
CONTENT_S3_BUCKET < string > yes AWS S3 bucket name
CONTENT_S3_REGION < string > yes AWS S3 region name
CONTENT_S3_PROFILE_IMAGES_BUCKET < string > yes Profile images S3 bucket name
CONTENT_TWITTER_FEED_URL < url > yes Twitter Feed base URL
CONTENT_TWITTER_ACCESS_TOKEN < string > yes Twitter Bearer access token
CONTENT_DEFAULT_CACHE_EXPIRATION_SECONDS < int > false Default cache expiration time in seconds. Defaults to 120
CONTENT_MULTI_TENANCY_APP_ID < string > yes Application ID for moving from single to multi tenancy for the already existing data
CONTENT_MULTI_TENANCY_ORG_ID < string > yes Organization ID for moving from single to multi tenancy for the already existing data

Run Application

Run locally without Docker

  1. Clone the repo (outside GOPATH)

  2. Open the terminal and go to the root folder

  3. Make the project

$ make
...
▶ building executable(s)… 1.9.0 2020-08-13T10:00:00+0300
  1. Run the executable
$ ./bin/content

Run locally as Docker container

  1. Clone the repo (outside GOPATH)

  2. Open the terminal and go to the root folder

  3. Create Docker image

docker build -t content .
  1. Run as Docker container
docker-compose up

Tools

Run tests
$ make tests
Run code coverage tests
$ make cover
Run golint
$ make lint
Run gofmt to check formatting on all source files
$ make checkfmt
Run gofmt to fix formatting on all source files
$ make fixfmt
Cleanup everything
$ make clean
Run help
$ make help
Generate Swagger docs
$ make swagger

Test Application APIs

Verify the service is running as calling the get version API.

Call get version API

curl -X GET -i http://localhost/content/version

Response

1.9.0

Contributing

If you would like to contribute to this project, please be sure to read the Contributing Guidelines, Code of Conduct, and Conventions before beginning.

Secret Detection

This repository is configured with a pre-commit hook that runs Yelp's Detect Secrets. If you intend to contribute directly to this repository, you must install pre-commit on your local machine to ensure that no secrets are pushed accidentally.

# Install software 
$ git pull  # Pull in pre-commit configuration & baseline 
$ pip install pre-commit 
$ pre-commit install