Open-Earth-Monitor Cyber-infrastructure

Overview

description

Table of Contents

1. Installation & development
2. Deployment
3. Contributing

Installation & development

Requirements:

• NodeJs v18
• Yarn

Main libraries used in the project

• React as a UI library
• Next.js as a React framework
• Tailwind CSS as a styles framework
• Typescript as a programming language
• OpenLayers as a map library
• Playwright as e2e testing framework
• Radix UI as a UI components library
• VisX as a data visualization library

Quick start for development

In order to start modifying the app, please make sure to correctly configure your workstation:

1. Make sure you have Node.js installed or install NVM to manage your different Node.js versions
2. (Optional) Use Visual Studio Code as a text editor to benefit from automatic type checking
3. (Optional) Configure your text editor with the Prettier, ESLint, EditorConfig, Tailwind CSS recommended plugins
4. Use the correct Node.js version for this app by running nvm use; if you didn't install NVM (step 2), then manually install the Node.js version described in .nvmrc.
5. Install Yarn by running npm install -g yarn.

Create environment file following the .env.example file, creating a file called .env.local. For more info about environment variables, check the Environment variables section.

Example:

NEXT_PUBLIC_API_URL=http://api-domain.org

Install the dependencies:

yarn install

Run the server for development:

yarn dev

You can access a hot-reloaded version of the app on http://localhost:3000.

Production

To build the app for production, run:

yarn build

This will create an optimized production build in the .next folder.

Run de application in production mode:

yarn start

Check out the Next.js deployment documentation for more details.

Environment variables

Set the environment variables needed creating a file .env.local in the root of the project with the following content:

Variable name	Description	Default value
NEXT_PUBLIC_API_URL	URL of the API for datasets Data.	http://localhost:3000

Contributing

Please, create a PR for any improvement or feature you want to add. Try not to commit anything directly on the main branch.