Project Name

Description

This project is built using the Nest framework, leveraging TypeScript to create a robust and scalable server-side application. This codebase is part of a platform designed to help businesses manage their net-zero strategies by tracking and allocating carbon credits. It allows users to manage carbon credit assets, organize business units, and define strategies for reaching net-zero emissions. The system supports detailed tracking of carbon credits, forecasted emissions, and strategic allocations across various projects and business units, ensuring businesses can effectively meet their net-zero objectives.

Requirements

• Node.js
• Just
• Docker

Installation

just install

Environment Setup

Ensure that the .env file is set up correctly:

just check_env

.env.template

DATABASE_URL="postgresql://test:test@localhost:5432/carbonable_ccpm_test"
# In Clerk dashboard / Organization
ORG_ID='org_id_by_clerk'
# In Clerk dashboard / organizations API keys
NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY='pk_test_by_clerk'
CLERK_SECRET_KEY='sk_test_by_clerk'

Initialization

just init

or

just init_test

Testing

Integration test scripts

just test_integration

Coverage test

just test_coverage

Direct Interaction

Using swagger UI (https://swagger.io/docs/)

http://your.url/api

Database Management

# Initialize Database and seed it
just db_init

# Reset Database and push fixtures ( or testing purpose)
just db_fixture

To start and stop db

# Start the database
just start_db

# Stop the database
just stop_db

or

# Start the database
just start_test_db

# Stop the database
just stop_test_db

Prisma Studio

Ui of database (link: http://localhost:5555)

just studio

Deployment

Deployment to fly.

# Deploy to Debug Environment
just deploy_debug

# Deploy to Staging Environment
just deploy_staging

License

This project is MIT licensed.