The Daily Targum is a student-written and student-managed, non-profit incorporated newspaper published by the Targum Publishing Company, with a circulation of 5,000.
Founded in 1869, The Daily Targum is the second oldest and among the largest college newspapers in the nation. The Daily Targum has been a repeat recipient of the Columbia Scholastic Press Association Gold Crown Award, the highest recognition a college newspaper can be awarded in the United States.
IMPORTANT NOTE: This app is open source, but it requires API keys to run. For now, these keys are only for internal use within the company.
-
Download and setup repo (directions)
-
Start bundler
yarn start
-
Open in the brower
The default port is 3000. You can test the website locally by going to http://localhost:3000
-
(optional but recommended)
Make sure your IDE/text editor supports TypeScript to catch errors as you go. Type check will be run locally using pre-commit hook and again remotely using GitHub Actions.
-
Clone repo
-
Install dependencies
yarn
-
Add environment variables (more info below)
# This file must be called .env NOT .env.local cp .env.example .env # Open .env and set varabiles
Set the correct values for all variables in
.env
.
feat: add hat wobble
^--^ ^------------^
| |
| +-> Summary in present tense.
|
+-------> Type: chore, docs, feat, fix, refactor, style, or test.
-
Lint code (checks if rules of hooks have been broken)
yarn lint
-
Check for TypeScript errors
yarn typescript
-
Jest tests
yarn test
Setup
# This file must be called .env NOT .env.local
cp .env.example .env
# Open .env and set varabiles
The following environment variables are required.
# .env.example
# AWS AppSync Config
AWS_APPSYNC_URL=
AWS_APPSYNC_REGION=
AWS_APPSYNC_API_KEY=
# AWS Elasticsearch
AWS_ELASTICSEARCH_URL=
# Contentful
CONTENTFUL_SPACE=
CONTENTFUL_ACCESS_TOKEN_DRAFTS=
Adding environment variables requires changing the following files:
- This repo
.env.example
.github/workflows/*
- Local
.env
(on your local machine)
Files responsible for configuring environment variables are commented ENVIRONMENT VARIABLES
so you can easily be found.