Skip to content

Latest commit

 

History

History
154 lines (103 loc) · 6.27 KB

README-SITE.md

File metadata and controls

154 lines (103 loc) · 6.27 KB
Raw

TODO: Add your site's name

TODO: Briefly describe your site

Development environment setup

This section explains how to set up your development environment, so that you can build, test, and preview the site locally.

  1. Install Node.js dependencies

    yarn install

  2. Install Git hooks

    yarn prepare

Getting Started

First, run the development server:

npm run dev
# or
yarn dev

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

You can start editing the page by modifying pages/index.tsx. The page auto-updates as you edit the file.

API routes can be accessed on http://localhost:3000/api/hello. This endpoint can be edited in pages/api/hello.ts.

The pages/api directory is mapped to /api/*. Files in this directory are treated as API routes instead of React pages.

Note: To test Locale select page and Cookie banner, you need to test site in the Incognito mode or clear cookies for 'localhost' in browser settings, because selected language and cookie preferences are set in Cookies. Follow instructions for Chrome on how to clear cookies.

Environment variables

The site depends on the following environment variables that you need to provide:

  • SITE_URL (VERCEL_URL is used as fallback in Vercel environments). This variable should represent the site's canonical URL in the environment, e.g., https://www.beporsed.org. You most likely want to use http://localhost:3000 for your variables in .env.local.
  • ZENDESK_URL. The canonical Zendesk URL, e.g., https://signpost-afghanistan.zendesk.com.
  • ZENDESK_MAPPED_URL. The mapped URL configured in Zendesk that Zendesk prepends to links, e.g., https://www.unitedforukraine.org.
  • ZENDESK_OAUTH_TOKEN. The OAuth token from Zendesk that allows querying their API. Note To generate it, see Generate OAUTH token section.
  • NEXT_PUBLIC_MAPBOX_ACCESS_TOKEN. The mapbox access token for the service map tiles.
  • PREVIEW_TOKEN. Access token for previewing content on a live Next.js website. Use any string generator to create the preview access token for your instance, e.g. use random.org. Tip Share the token and the ZD preview mode instructions with content editors of the instace for them to use the preview mode manually when needed.

Running locally

Get the environment variables:

Some functionality, such as getting dynamic content via authenticated requests, requires secret tokens and IDs. In order to run the server locally, we will need to pull these environment variables into our setup. There are two ways of doing this.

A. Sign-in to vercel to manage environment variables and copy and paste each key-value pair into your .env.local file.

or

B. Install the Vercel CLI and pull the environment variables:

# Install the CLI
yarn global add vercel
# Setup and link your repo to the existing unitedforukraine/nextjs project
vercel link
# Pull the environment variables into your local environment
vercel env pull .env.local

Run the development server:

yarn dev

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

Linting & formatting

We use ESLint and [Prettier][prettier] to lint and format the directory respectively.

To check for lint and formatting errors, run

yarn lint
yarn prettier --check .

To automatically fix issues, run

yarn lint --fix
yarn prettier --write .

Testing

This section describes practices used for testing.

E2E testing

To run e2e tests, run

yarn e2e:headless

Site's design

This section documents some of the site's design decisions.

Sitemap & robots.txt

To improve SEO of the website, we publish robots.txt and a sitemap.

We use next-sitemap to simplify the process of creating those files.

Search

We use Algolia search engine to generate indexes for Zendesk Articles and Search queries. See full list of Signpost indexes on Algolia Signpost Dashbaord: https://www.algolia.com/apps/BWATZIXLX6/dashboard

How to add Search to new Signpost websites:

  1. Add Search index for your Signpost instance: https://www.algolia.com/getstarted/#/zendesk
  2. Configure new search index ('Configuration' tab for your index):
    • In 'Language', populate 'Index languages' and 'Query languages' with your site's locales, e.g. see example for U4U index.
    • In 'Facets', add 'category.id' to 'Attributes for faceting'. It's needed to filter internal/helper articles. E.g. see example of U4U index.
  3. Add Queries index from your article index: https://www.algolia.com/apps/BWATZIXLX6/query-suggestions
    • Ask your Product manager (Liam) if you don't have permissions.

Custom content elements

Zendesk articles rendered on this web site can contain custom content elements. The custom elements are processed in ArticleContent base component.