Skip to content
This repository has been archived by the owner on Sep 19, 2023. It is now read-only.

Latest commit

 

History

History
35 lines (25 loc) · 1.15 KB

README.md

File metadata and controls

35 lines (25 loc) · 1.15 KB

Site

This Next.js app constitutes the frontend of the OpenSanctions.org website.

Please, note that it runs the latest released version Next.js 13.

Getting Started

Installation

The requirement for running a Next.js 13 app is having Node.js 16.8.0 (or newer) installed.

Notes:

  • You might need to upgrade your local version of npm as well.
  • If you're looking for a Node.js version manager, try n for macOS, Linux, or Windows Subsystem for Linux (does not work on native shells on Microsoft Windows).

1- Clone this repository

git clone git@github.com:opensanctions/site.git

2- Install the dependencies by running:

npm install

Running the app locally

1- Set up environment variables (they're listed in /lib/constants.ts). To make a search on your local website, you need to set an API_TOKEN var and assign it your API key. This is the only env var to set up if you plan to use the Opensanctions production API (https://api.opensanctions.org).

2- Run the development server:

npm run dev

3- Open http://localhost:3000 in your browser to see the website.