hkennyv / bigboizanddiana.com

bigboizanddiana.com

id	title
index	README

Overview

This repository contains the code for the next revision of bigboizanddiana.com. Currently, the old gatsby site is deployed (source code can be viewed on the gatsbysite branch). We're aiming to rewrite the site so that we can show a visualization of the discord activity. It is built upon a serverless API function and a React/D3 frontend.

To get started, view the docs here!

Architecture

A high-level diagram is shown below:

The repository structure is as follows:

.
├── Dockerfile            // Dockerfile for deploying documentation
├── README.md
├── api                   // Serverless function
├── docker-compose.yml
├── docs                  // Documentation site content
├── web                   // Frontend application
└── website               // Static documentation site source

Getting Started

To get started with local development, you'll need to run both the api/ and the web/ modules.

Running the API module

• To run the api, you'll need to change directories into the api/ directory:

cd api/

• If you haven't configured the environment already, please read the api docs. It contains valuable information on setting the proper environment variables and getting the discord environment setup.

• And once you're in the right directory, you can install the dependencies:

yarn install

• Run the start script - this will run the functions-framework for local development

yarn start

• as configured, your API should be available on localhost:8080

Running the Web module

Open up another terminal and head back to the root directory of this project.

• change directories into the web/ directory

cd web/

• install the dependencies

yarn install

• start the NextJS dev server

yarn dev

• your dev server should be up and running at http://localhost:3000

Please view the web docs.

Contributing

The tasks for this project are layed out in a kanban board attached to this repository. Select a task to work and promptly move it from the "To Do" column to the "In Progress" column. Once you've submitted a PR, it can be placed in the "Waiting/Pending Review" column. Once approved, we'll move it to the "Done" column. The "Backlog" column is for items that aren't necessarily on the roadmap right now, but could be important in the future possibly.

View the board here!

To contribute, please follow the git-flow workflow. There are also some CI workflows setup to ensure code hygiene and passing builds.