Skip to content

Locate your RealT properties and get useful informations on them

License

Notifications You must be signed in to change notification settings

mfrederic/realt-properties-map

Repository files navigation

Version Contributors Forks Stargazers Issues MIT License

RealT Properties Map Logo

RealT Properties Map

A community-driven project providing an interactive visualization of RealT portfolio properties.

View Demo · Report Bug · Request Feature

📋 About The Project

RealT Properties Map helps you visualize RealT portfolio properties and track your own investments. The project integrates data from multiple sources including:

  • Realtoken Dashboard
  • realtoken-thegraph GQL resources

Important: This project is not officially affiliated with RealT

🚀 Getting Started

Built With

Using Docker (Recommended)

The easiest way to run the project is using Docker:

docker compose up

Manual Setup

This section describes how to setup the project using individual services. This can be useful for development purposes.

Backend Setup

cd ./backend
npm install
npm run dev

The backend will run on http://localhost:3000

Frontend Setup

cd ./frontend
npm install
npm run start

The frontend will run on http://localhost:3010

Environment Configuration

Both frontend and backend require environment configuration. Copy the provided example.env files and modify as needed:

  • backend/example.envbackend/.env
  • frontend/example.envfrontend/.env

🤝 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.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

📝 License

Distributed under the Apache-2.0 License. See LICENSE for more information.