Skip to content
This repository has been archived by the owner on Oct 30, 2020. It is now read-only.

The front-end to The DBK's main website - powered by React and Next.js.

Notifications You must be signed in to change notification settings

The-Diamondback-Lab/dbkredux

Repository files navigation

🐢 DBK Redux Frontend

Built with React.js and Next.js, DBK Redux is the redesign project for The Diamondback's main news website.

A project badge featuring the A11Y logo and the text "Built for Accessibility" Build Status SemVer

Overview

Getting Started Usage Contributing Deployment Built With

Getting Started

DBK Redux is the redesign project for The Diamondback's main news website. Located in College Park, Maryland, The Diamondback (DBK) is the University of Maryland's student run newspaper.

Previously, the site was built using Arc Publishing, but eventually the need for a custom built site was clear. The newly designed site was built using React.js and is server side rendered using Next.js. It can be viewed here.

Usage

After installing the project dependenices, there are two ways to run the site locally:

  1. npm run dev - Queries our production backend servers for content
  2. npm run local - Queries local backend servers for content. This requires having three services running locally on your machine
    1. Our API on port 8080
    2. A WordPress server, running on port 80. This is easiest to setup with XAMPP and Bitnami for XAMPP modules
    3. A MySQL server, typically running on port 3306, though this port can be changed in your WordPress configuration.

Built With

  • Next.js - JavaScript library for building user interfaces
  • React.js - JavaScript library for building user interfaces
  • Babel - JavaScript compiler to convert ECMAScript 2015+ code into a backwards compatible JS
  • Sass - CSS extension
  • Google Analytics - Analytics tracking