This guide provides instructions for setting up and running the Next.js instance locally, as well as an overview of the development workflow.
Before you begin, ensure the following are installed on your system:
If you're using nvm
, you can activate the required Node.js version by running:
nvm install
-
Clone the repository Clone the repository to your local machine:
git clone https://github.com/your-org/your-repo.git cd your-repo
-
Register the VEDA-UI package The VEDA-UI package is hosted on a Verdaccio instance during its experimental phase. To install it, configure Yarn to use the Verdaccio instance:
yarn config set @developmentseed:veda-ui http://verdaccio.ds.io:4873/
-
Install dependencies
Install the project dependencies by running:
yarn install
-
Configure environment variables
Create a
.env.local
file in the root directory and add the necessary environment variables. Refer to the Configuration guide for details on required variables.
To start the development server, run:
yarn dev
The website will then be accessible at http://localhost:3000.
To build the project for production:
yarn build
The output will be generated in the .next
directory.
The app can be deployed to any platform supporting Node.js. Refer to your deployment platform's documentation for further instructions.