Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.

/app/package-lock.json
/site/package-lock.json

# dependencies
/.pnp
Expand Down
24 changes: 5 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
# Summary

This repo contains 6 packages.
This repo contains 5 packages.

`@klimadao/app` -> app.klimadao.finance, a standalone single-page-app for protocol interactions.

`@klimadao/base` -> base.klimadao.finance, a standalone single-page-app specifically for the base network.

`@klimadao/carbon-projects` -> A Sanity CMS that contains curated data for Verra projects, deployed to [carbon-projects.sanity.studio](https://carbon-projects.sanity.studio/), and referenced by the Carbonmark frontend and backend. NOTE: Unlike the other packages, this one is **not** included as an NPM workspace from the root package.json. To work with the CMS you need to run `sanity install` from inside the `carbon-projects` folder.

`@klimadao/carbon` -> data.klimadao.finance site (formerly carbon.klimadao.finance)

`@klimadao/lib` -> Components and utilities that are shared between packages.

`@klimadao/site` -> klimadao.finance homepage, content and cms-powered pages.

## Requirements

Take note, this repo utilizes newer features from Node, NPM and TypeScript 4.5.
Expand All @@ -33,9 +33,8 @@ A set of NPM Workspace commands are provided, and can be run from the root folde

- `npm run dev-all`: run all workspaces with hot reloading enabled.
- `npm run dev-app`: [http://localhost:3001](http://localhost:3001)
- `npm run dev-carbonmark`: [http://localhost:3002](http://localhost:3002)
- `npm run dev-carbonmark-api`: [http://localhost:3003](http://localhost:3003)
- `npm run dev-site`: [http://localhost:3000](http://localhost:3000)
- `npm run dev-base`: [http://localhost:3002](http://localhost:3002)
- `npm run dev-carbon`: [http://localhost:3003](http://localhost:3003)
- `npm run dev-lib`: enable hot-reload for changes to components or utils.

Other scripts you should know about:
Expand All @@ -44,15 +43,6 @@ Other scripts you should know about:
- `npm run format-all`: Format all files with `prettier`.
- `npm run extract-strings:dev`: Extract translation files for the source language "en".

## Type Generation
Typescript types for Carbonmark and Carbonmark API are generated via the `generate:types` script in each respective project.

Regenerate types in any of the following changes:

1. Models in the API (.model files)
2. Change to any of the dependant subgraphs (see `codegen.constants.ts`)
3. API Version targeted by Carbonmark

## Translations

### For Developers
Expand Down Expand Up @@ -82,10 +72,6 @@ We follow these rules:
- On the bottom right you will notice the source text (in English) and the place to translate the text beneath.
- You can prefill this by selecting an entry in the Suggestion area above.

## Pledge Dashboard

Klima Infinity pledge dashboard is backed by a firebase database. Follow the following to set up your dev environment if you'd like to contribute to the project.

# Diagrams

See [this page in the wiki of this repo](https://github.com/KlimaDAO/klimadao/wiki/Diagrams) for architecture and other diagrams.
Expand Down
2 changes: 1 addition & 1 deletion base/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "@klimadao/base",
"private": true,
"scripts": {
"dev": "next dev -p 3004",
"dev": "next dev -p 3002",
"build": "prettier --check . && next build",
"start": "next start",
"lint": "next lint"
Expand Down
Loading