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.
Before you begin, ensure you have the following installed on your system:
- Node.js (version 14 or later)
- pnpm (better alternative to npm)
- Git
Follow these steps to get the project up and running on your local machine:
-
Open a terminal and go to the /webapp folder
cd webapp
-
Install dependencies
pnpm install
-
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.-
Copy the
.env.example
file and rename it to.env
:cp .env.example .env
-
Open the
.env
file and fill in the necessary values for your local environment.
-
-
Run the development server
pnpm dev
The application should now be running on http://localhost:3000.
In the project directory, you can run:
pnpm dev
: Runs the app in development modepnpm build
: Builds the app for productionpnpm start
: Runs the built app in production modepnpm lint
: Runs the linter to check for code style issues
To learn more about Next.js, check out the following resources:
- Next.js Documentation - learn about Next.js features and API.
- Learn Next.js - an interactive Next.js tutorial.