Skip to content

Latest commit

 

History

History
70 lines (44 loc) · 2.43 KB

README.md

File metadata and controls

70 lines (44 loc) · 2.43 KB

This is the front-end for Who Owns What (WOW). For more details on WOW, see ../README.md.

This project was bootstrapped with Create React App.

Configuration

This project comes pre-configured with sensible defaults, but you can customize them with the following command:

cp .env.local.sample .env.local

Now edit .env.local as needed.

Available Scripts

In the project directory, you can run:

yarn start

Runs the app in the development mode. Note that you also need to be running the API server for everything to work properly, so you might want to run yarn start in the parent directory instead.

Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.

You will also see any lint errors in the console.

yarn test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

yarn build

Note: Before running this, you will want to make sure to set REACT_APP_API_BASE_URL appropriately, so that the front-end knows where its back-end API is. See .env.local.sample for more documentation on this variable.

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

yarn lingui

Runs the lingui CLI with the given parameters. For instance, if you want to extract messages to localize, you can run yarn lingui extract.

yarn contentful

Some pages contain long-form rich text content that is localized via Contentful. The latest versions of the content can be pulled by running this command. You'll want to make sure you have the proper environment variables defined so this script can access your Contentful space; see .env.local.sample for more details.

Learn More

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.