Skip to content
This repository has been archived by the owner on Jun 12, 2023. It is now read-only.
/ logan-center Public archive

Source code for the Logan Center for Urban Investigative Reporting website

Notifications You must be signed in to change notification settings

kleinweb/logan-center

Repository files navigation

Logan Center for Urban Investigative Reporting

This web project is produced by the Digital Initiatives team at Temple University's Klein College of Media and Communication.

In its initial stages, the project consists of a static Next.js site hosted on GitHub Pages from this repo.

In the near future, the Next.js fronted will ingest content from WordPress.

Netlify Status

Getting Started

Work in progress.

Prerequisites

  • Nix
  • Docker Desktop
  • Direnv (recommended)

Initial Setup

direnv allow
yarn install
yarn build

Development

yarn dev

Open http://localhost:3000 with your browser to see the result.

Updating

yarn upgrade-interactive
yarn install && yarn build

The codebase is structured following the monorepo pattern, specifically following the kitchen-sink and with-tailwind examples laid out in Turbo's own monorepo.

Turbo's earlier examples (from which this project grew) left much to the imagination. Consider referring to any updated examples when a Turbo release adds new features and if the changes seem to offer a significant improvement, update the project accordingly.

Configurating

Nixago Files

Some tool configuration files are generated with Nixago for the sake of flexibility, annotation (JSON, for example, doesn't allow comments), and reducing clutter. These files will be defined in a corresponding *.nix file within the ./nix/ directory.

For example, Prettier's prettierrc file is configured within prettierrc.json.nix. Once you've made your edits, go to your terminal and run direnv reload. You should see a message this appear towards the end of the command output:

nixago: '.prettierrc.json' link updated

Learning

To learn more about Next.js, take a look at the following resources:

You can check out the Next.js GitHub repository - your feedback and contributions are welcome!

Licenses

This project is primarily licensed under the GNU General Public License version 3.0 or later, though some code is derived from other sources with other licenses.

See ./.reuse/dep5 and ./LICENSES for detailed information.