Repository: metrom-xyz/monorepo
Pull request #340: docs(frontend): add contributing file for frontend
Author: login: guerrap
Created: 2025-03-06T13:59:10Z | Merged: 2025-03-06T14:08:04Z



Diff:
diff --git a/packages/frontend/.env.example b/packages/frontend/.env.example
new file mode 100644
index 000000000..adf899a88
--- /dev/null
+++ b/packages/frontend/.env.example
@@ -0,0 +1,2 @@
+NEXT_PUBLIC_ENVIRONMENT=development
+NEXT_PUBLIC_WALLETCONNECT_PROJECT_ID=project_id
\ No newline at end of file
diff --git a/packages/frontend/CONTRIBUTING.md b/packages/frontend/CONTRIBUTING.md
new file mode 100644
index 000000000..913bf6647
--- /dev/null
+++ b/packages/frontend/CONTRIBUTING.md
@@ -0,0 +1,43 @@
+# Contributing
+
+This document provides detailed instructions on contributing to the Metrom
+frontend, which is built with Next.js and uses `pnpm` as the package manager.
+
+## Getting started
+
+To begin, install the package dependencies using `pnpm`. Run the following
+command from the root of the project:
+
+```
+pnpm install
+```
+
+### Building the packages
+
+The frontend depends on internal packages (`sdk`, `ui`), so ensure they are
+built by running:
+
+```
+pnpm build
+```
+
+### Setting up environment variables
+
+After installing dependencies, configure the necessary environment variables to
+run the application locally. To do this, create a new `.env` file and copy the
+contents of `.env.example`.
+
+### Environment variables
+
+| Name                                   | Description                                        | Required | Default |
+| -------------------------------------- | -------------------------------------------------- | -------- | ------- |
+| `NEXT_PUBLIC_ENVIRONMENT`              | Metrom environment (`development` or `production`) | ✅       | `-`     |
+| `NEXT_PUBLIC_WALLETCONNECT_PROJECT_ID` | WalletConnect project ID                           | ✅       | `-`     |
+
+## Running the development server
+
+Once the environment variables are set up, start the development server:
+
+```
+pnpm dev
+```
diff --git a/packages/frontend/README.md b/packages/frontend/README.md
index c4033664f..9d34742bd 100644
--- a/packages/frontend/README.md
+++ b/packages/frontend/README.md
@@ -1,36 +1,26 @@
-This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
+<br />
 
-## Getting Started
+<p align="center">
+    <img src="../../.github/static/logo.svg" alt="Metrom logo" width="60%" />
+</p>
 
-First, run the development server:
+<br />
 
-```bash
-npm run dev
-# or
-yarn dev
-# or
-pnpm dev
-# or
-bun dev
-```
+<p align="center">
+    Design your incentives to AMMplify liquidity.
+</p>
 
-Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
+<br />
 
-You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
+<p align="center">
+    <img src="https://img.shields.io/badge/License-GPLv3-blue.svg" alt="License: GPL v3">
+    <img src="https://github.com/metrom-xyz/monorepo/actions/workflows/ci.yml/badge.svg" alt="CI">
+</p>
 
-This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
+# Metrom frontend
 
-## Learn More
+This repository contains the official Metrom frontend, built with Next.js.
 
-To learn more about Next.js, take a look at the following resources:
+## Development
 
-- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
-- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
-
-You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
-
-## Deploy on Vercel
-
-The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
-
-Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
+For contribution guidelines, see [CONTRIBUTING.md](./CONTRIBUTING.md).


Reviews:
user: login: luzzif
state: COMMENTED
author_association: CONTRIBUTOR
submitted_at: 2025-03-06T14:02:28Z
user: login: luzzif
state: COMMENTED
author_association: CONTRIBUTOR
submitted_at: 2025-03-06T14:02:29Z
user: login: luzzif
state: COMMENTED
author_association: CONTRIBUTOR
submitted_at: 2025-03-06T14:03:06Z
user: login: guerrap
state: COMMENTED
author_association: CONTRIBUTOR
submitted_at: 2025-03-06T14:06:04Z
user: login: guerrap
state: COMMENTED
author_association: CONTRIBUTOR
submitted_at: 2025-03-06T14:06:12Z
user: login: guerrap
state: COMMENTED
author_association: CONTRIBUTOR
submitted_at: 2025-03-06T14:06:15Z
user: login: luzzif
state: APPROVED
author_association: CONTRIBUTOR
submitted_at: 2025-03-06T14:06:48Z

Review comments:
diff_hunk: @@ -0,0 +1,43 @@
+# Contributing
+
+This document provides detailed instructions on contributing to the Metrom
+frontend, which is built with Next.js and uses `pnpm` as the package manager.
+
+## Getting started
+
+To begin, install the package dependencies using `pnpm`. Run the following
+command from the root of the project:
+
+```
+pnpm install
+```
+
+### Building the packages
+
+The frontend depends on internal packages (`sdk`, `ui`), so ensure they are
+built by running:
+
+```
+pnpm build
+```
+
+### Setting up unvironment uariables
path: packages/frontend/CONTRIBUTING.md
user: login: luzzif
body: Typo here, should be environment
created_at: 2025-03-06T14:02:28Z
author_association: CONTRIBUTOR
diff_hunk: @@ -0,0 +1,43 @@
+# Contributing
+
+This document provides detailed instructions on contributing to the Metrom
+frontend, which is built with Next.js and uses `pnpm` as the package manager.
+
+## Getting started
+
+To begin, install the package dependencies using `pnpm`. Run the following
+command from the root of the project:
+
+```
+pnpm install
+```
+
+### Building the packages
+
+The frontend depends on internal packages (`sdk`, `ui`), so ensure they are
+built by running:
+
+```
+pnpm build
+```
+
+### Setting up unvironment uariables
path: packages/frontend/CONTRIBUTING.md
user: login: luzzif
body: Typo here, should be environment
created_at: 2025-03-06T14:02:29Z
author_association: CONTRIBUTOR
diff_hunk: @@ -1,36 +1,7 @@
-This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
+# Metrom frontend
path: packages/frontend/README.md
user: login: luzzif
body: Can we also add the header image here?
created_at: 2025-03-06T14:02:59Z
author_association: CONTRIBUTOR
diff_hunk: @@ -0,0 +1,43 @@
+# Contributing
+
+This document provides detailed instructions on contributing to the Metrom
+frontend, which is built with Next.js and uses `pnpm` as the package manager.
+
+## Getting started
+
+To begin, install the package dependencies using `pnpm`. Run the following
+command from the root of the project:
+
+```
+pnpm install
+```
+
+### Building the packages
+
+The frontend depends on internal packages (`sdk`, `ui`), so ensure they are
+built by running:
+
+```
+pnpm build
+```
+
+### Setting up unvironment uariables
path: packages/frontend/CONTRIBUTING.md
user: login: guerrap
body: Fixed in c0dc1e341febba4af6cce425f572e802f8a851c8.
created_at: 2025-03-06T14:06:04Z
author_association: CONTRIBUTOR
diff_hunk: @@ -0,0 +1,43 @@
+# Contributing
+
+This document provides detailed instructions on contributing to the Metrom
+frontend, which is built with Next.js and uses `pnpm` as the package manager.
+
+## Getting started
+
+To begin, install the package dependencies using `pnpm`. Run the following
+command from the root of the project:
+
+```
+pnpm install
+```
+
+### Building the packages
+
+The frontend depends on internal packages (`sdk`, `ui`), so ensure they are
+built by running:
+
+```
+pnpm build
+```
+
+### Setting up unvironment uariables
path: packages/frontend/CONTRIBUTING.md
user: login: guerrap
body: Fixed in c0dc1e341febba4af6cce425f572e802f8a851c8.
created_at: 2025-03-06T14:06:12Z
author_association: CONTRIBUTOR
diff_hunk: @@ -1,36 +1,7 @@
-This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
+# Metrom frontend
path: packages/frontend/README.md
user: login: guerrap
body: Fixed in c0dc1e341febba4af6cce425f572e802f8a851c8.
created_at: 2025-03-06T14:06:15Z
author_association: CONTRIBUTOR

PR comments:
user: login: changeset-bot[bot]
created_at: 2025-03-06T13:59:15Z
body: ###  ⚠️  No Changeset found

Latest commit: c0dc1e341febba4af6cce425f572e802f8a851c8

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. **If these changes should result in a version bump, you need to add a changeset.**

<details><summary>This PR includes no changesets</summary>

  When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

</details>

[Click here to learn what changesets are, and how to add one](https://github.com/changesets/changesets/blob/main/docs/adding-a-changeset.md).

[Click here if you're a maintainer who wants to add a changeset to this PR](https://github.com/metrom-xyz/monorepo/new/docs/contributing-file?filename=.changeset/mean-worms-kick.md&value=---%0A%22frontend%22%3A%20patch%0A---%0A%0Adocs(frontend)%3A%20add%20contributing%20file%20for%20frontend%0A)


author_association: NONE
user: login: vercel[bot]
created_at: 2025-03-06T13:59:15Z
body: [vc]: #qv9tM5I/8ZKXGEUQnoqDBYHXi2Nwcz4+FnZFcjhKztw=:eyJpc01vbm9yZXBvIjp0cnVlLCJ0eXBlIjoiZ2l0aHViIiwicHJvamVjdHMiOlt7Im5hbWUiOiJhcHAiLCJyb290RGlyZWN0b3J5IjoicGFja2FnZXMvZnJvbnRlbmQiLCJpbnNwZWN0b3JVcmwiOiJodHRwczovL3ZlcmNlbC5jb20vbWV0cm9tL2FwcC84UzdRdXFIRlFjV01Uc1JncTV2VWE1c2ZUNktkIiwicHJldmlld1VybCI6ImFwcC1naXQtZG9jcy1jb250cmlidXRpbmctZmlsZS1tZXRyb20udmVyY2VsLmFwcCIsIm5leHRDb21taXRTdGF0dXMiOiJERVBMT1lFRCJ9LHsibmFtZSI6InNhZmUtYXBwIiwicm9vdERpcmVjdG9yeSI6InBhY2thZ2VzL2Zyb250ZW5kIiwiaW5zcGVjdG9yVXJsIjoiaHR0cHM6Ly92ZXJjZWwuY29tL21ldHJvbS9zYWZlLWFwcC9DeGQyUEVERlJqUnF6cWhocjUxYzRjU1NpQXdVIiwicHJldmlld1VybCI6InNhZmUtYXBwLWdpdC1kb2NzLWNvbnRyaWJ1dGluZy1maWxlLW1ldHJvbS52ZXJjZWwuYXBwIiwibmV4dENvbW1pdFN0YXR1cyI6IkRFUExPWUVEIn0seyJuYW1lIjoidWkiLCJyb290RGlyZWN0b3J5IjoicGFja2FnZXMvdWkiLCJpbnNwZWN0b3JVcmwiOiJodHRwczovL3ZlcmNlbC5jb20vbWV0cm9tL3VpL3Q2RGtoNjJ4ckhqZzc3VFdMMW16VnNSbjhKYnoiLCJwcmV2aWV3VXJsIjoidWktZ2l0LWRvY3MtY29udHJpYnV0aW5nLWZpbGUtbWV0cm9tLnZlcmNlbC5hcHAiLCJuZXh0Q29tbWl0U3RhdHVzIjoiREVQTE9ZRUQifV19
**The latest updates on your projects**. Learn more about [Vercel for Git ↗︎](https://vercel.link/github-learn-more)

| Name | Status | Preview | Updated (UTC) |
| :--- | :----- | :------ | :------ |
| **app** | ✅ Ready ([Inspect](https://vercel.com/metrom/app/8S7QuqHFQcWMTsRgq5vUa5sfT6Kd)) | [Visit Preview](https://app-git-docs-contributing-file-metrom.vercel.app) | Mar 6, 2025 2:11pm |
| **safe-app** | ✅ Ready ([Inspect](https://vercel.com/metrom/safe-app/Cxd2PEDFRjRqzqhhr51c4cSSiAwU)) | [Visit Preview](https://safe-app-git-docs-contributing-file-metrom.vercel.app) | Mar 6, 2025 2:11pm |
| **ui** | ✅ Ready ([Inspect](https://vercel.com/metrom/ui/t6Dkh62xrHjg77TWL1mzVsRn8Jbz)) | [Visit Preview](https://ui-git-docs-contributing-file-metrom.vercel.app) | Mar 6, 2025 2:11pm |




author_association: NONE