📒NEARCatalog App standalone version

Ecosystem directory for NEAR Protocol

Table of Contents

• Getting Started
  • Installing dependencies
  • Running the app
  • Building for production
  • Running tests
• Project Structure
  • Routes
  • Global State
• Contributing

Getting Started

Installing dependencies

npm install

Config .env file

here is sample env file:

NEAR_CATALOG_API=https://api.nearcatalog.xyz
NEXT_PUBLIC_NEAR_CATALOG_API=https://api.nearcatalog.xyz
BASE_URL=http://nearcatalog.xyz

Running the app

First, run the development server:

npm run dev

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

Building for production

npm run build

Running tests

npm run test

See the full testing guide.

Project Structure

This is a Next.js project bootstrapped with create-next-app.

It uses next/font to automatically optimize and load Manrope, a custom Google Font.

Routes

This project uses the Next.js App Router, and so the routes are defined in the app folder. There are three main pages:

• /: Home page of the application. It displays a list of projects that are available on the NEAR platform.
• /project/:projectId: Displays the details of a specific project. It includes information about the project, such as the name, description, and the list of tags associated with the project.
• /category/:categoryId: Displays a list of projects that are associated with a specific category.

Global State

zustand is used to manage global state. It is a state management library that provides a simple and scalable solution for managing application state in a React or Preact application.

The state is stored in the store folder. There are two stores that are used in this project:

• search-store.ts: Manages the search state, including the search query and the tags that are selected.
• tags-modal-store.ts: Manages the state of the tags modal for mobile devices.
• search-modal-store.ts: Manages the state of search modal.

Public APIs

You can see the public APIs of NEARCatalog Indexer here: https://docs.nearcatalog.xyz/

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you're interested in contributing to this project, please read the contribution guide.