From 285d1a040dbe739692588dbd9f493a508577ad3d Mon Sep 17 00:00:00 2001 From: inimaz <93inigo93@gmail.com> Date: Mon, 15 Jun 2026 18:32:19 +0200 Subject: [PATCH 1/2] docs: remove mentions to Nextjs in docs --- docs/how-to/agent-instructions.md | 12 ++++++------ webapp/README.md | 13 +++---------- 2 files changed, 9 insertions(+), 16 deletions(-) diff --git a/docs/how-to/agent-instructions.md b/docs/how-to/agent-instructions.md index 58aa9ee6a..8b3ebfd0e 100644 --- a/docs/how-to/agent-instructions.md +++ b/docs/how-to/agent-instructions.md @@ -30,8 +30,8 @@ Here's what you need to know to navigate and contribute effectively. - Visualizes emission data from CSV files - Run with: `uv run task carbonboard` -4. **🌐 webapp/** - Next.js Web Dashboard - - Modern React/Next.js web application +4. **🌐 webapp/** - Web Dashboard + - Modern React web application - Connects to the API backend - Run with: `cd webapp && pnpm dev` @@ -83,7 +83,7 @@ Here's what you need to know to navigate and contribute effectively. # Python dashboard uv run task carbonboard - # Next.js webapp + # Js webapp cd webapp pnpm install pnpm dev @@ -122,7 +122,7 @@ Here's what you need to know to navigate and contribute effectively. ### Dashboard Development 1. **Python Dashboard**: Uses Dash + Plotly, see `codecarbon/viz` -2. **Next.js Dashboard**: Modern React components in `webapp/src/` +2. **React Dashboard**: Modern React components in `webapp/src/` 3. **Connect to API**: Set `CODECARBON_API_URL=http://localhost:8008` for local development ## Environment Management @@ -155,7 +155,7 @@ uv run task -l - **[CONTRIBUTING.md](https://docs.codecarbon.io/latest/how-to/contributing/)**: Detailed contribution guidelines and setup - **[README.md](https://github.com/mlco2/codecarbon/blob/master/README.md)**: Project overview and quickstart - **[carbonserver/README.md](https://github.com/mlco2/codecarbon/blob/master/carbonserver/README.md)**: API architecture and database schema -- **[webapp/README.md](https://github.com/mlco2/codecarbon/blob/master/webapp/README.md)**: Next.js dashboard setup +- **[webapp/README.md](https://github.com/mlco2/codecarbon/blob/master/webapp/README.md)**: React dashboard setup - **[carbonserver/tests/TESTING.md](https://github.com/mlco2/codecarbon/blob/master/carbonserver/tests/TESTING.md)**: Comprehensive testing guide ### VS Code Debugging @@ -177,7 +177,7 @@ The repository includes VS Code launch configurations in `docs/how-to/contributi β”‚ (package) │───▢│ (API) │◀───│ (2 versions) β”‚ β”‚ β”‚ β”‚ β”‚ β”‚ β”‚ β”‚ β€’ CLI tools β”‚ β”‚ β€’ FastAPI β”‚ β”‚ β€’ Dash (Python) β”‚ -β”‚ β€’ Tracking core β”‚ β”‚ β€’ PostgreSQL β”‚ β”‚ β€’ Next.js (Web) β”‚ +β”‚ β€’ Tracking core β”‚ β”‚ β€’ PostgreSQL β”‚ β”‚ β€’ React (Web) β”‚ β”‚ β€’ Data output β”‚ β”‚ β€’ Authenticationβ”‚ β”‚ β€’ Visualization β”‚ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ ``` diff --git a/webapp/README.md b/webapp/README.md index 93aa20370..aa1aeefad 100644 --- a/webapp/README.md +++ b/webapp/README.md @@ -1,6 +1,6 @@ -# Next.js Code Carbon Web Application Project +# Code Carbon Web Application Project -Welcome to the Code Carbon Next.js Project! This README will guide you through the process of setting up and running the project on your local machine. +Welcome to the Code Carbon Project! This README will guide you through the process of setting up and running the project on your local machine. ## Prerequisites @@ -53,11 +53,4 @@ In the project directory, you can run: - `pnpm dev`: Runs the app in development mode - `pnpm build`: Builds the app for production - `pnpm start`: Runs the built app in production mode -- `pnpm lint`: Runs the linter to check for code style issues - -## Learn More - -To learn more about Next.js, check out the following resources: - -- [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. +- `pnpm lint`: Runs the linter to check for code style issues \ No newline at end of file From 79bb5180c341e57fa83fc70b949c1dc1ae0d5cb4 Mon Sep 17 00:00:00 2001 From: inimaz <93inigo93@gmail.com> Date: Mon, 15 Jun 2026 18:37:22 +0200 Subject: [PATCH 2/2] prettier --- webapp/README.md | 46 +++++++++++++++++++++++----------------------- 1 file changed, 23 insertions(+), 23 deletions(-) diff --git a/webapp/README.md b/webapp/README.md index aa1aeefad..74fd6b81d 100644 --- a/webapp/README.md +++ b/webapp/README.md @@ -6,9 +6,9 @@ Welcome to the Code Carbon Project! This README will guide you through the proce Before you begin, ensure you have the following installed on your system: -- Node.js (version 14 or later) -- pnpm (better alternative to npm) -- Git +- Node.js (version 14 or later) +- pnpm (better alternative to npm) +- Git ## Getting Started @@ -16,41 +16,41 @@ Follow these steps to get the project up and running on your local machine: 1. **Open a terminal and go to the /webapp folder** - ```bash - cd webapp - ``` + ```bash + cd webapp + ``` 2. **Install dependencies** - ```bash - pnpm install - ``` + ```bash + pnpm install + ``` 3. **Set up environment variables** - This project uses environment variables for configuration. You need to create a `.env` file in the root directory of the project. + This project uses environment variables for configuration. You need to create a `.env` file in the root directory of the project. - - Copy the `.env.example` file and rename it to `.env`: + - Copy the `.env.example` file and rename it to `.env`: - ```bash - cp .env.example .env - ``` + ```bash + cp .env.example .env + ``` - - Open the `.env` file and fill in the necessary values for your local environment. + - Open the `.env` file and fill in the necessary values for your local environment. 4. **Run the development server** - ```bash - pnpm dev - ``` + ```bash + pnpm dev + ``` - The application should now be running on [http://localhost:3000](http://localhost:3000). + The application should now be running on [http://localhost:3000](http://localhost:3000). ## Available Scripts In the project directory, you can run: -- `pnpm dev`: Runs the app in development mode -- `pnpm build`: Builds the app for production -- `pnpm start`: Runs the built app in production mode -- `pnpm lint`: Runs the linter to check for code style issues \ No newline at end of file +- `pnpm dev`: Runs the app in development mode +- `pnpm build`: Builds the app for production +- `pnpm start`: Runs the built app in production mode +- `pnpm lint`: Runs the linter to check for code style issues