Skip to content

Development

Getting Started

1. Clone Repository

git clone https://github.com/credinvest/cred-web-commercial.git
cd cred-web-commercial

2. Install Dependencies

npm install

3. Environment Setup

cp .env.example .env
# Configure environment variables

4. Start Development Server

npm run dev

API Integration

The Commercial platform provides comprehensive APIs for:

API Description
Authentication JWT-based user authentication
Data Access CRUD operations for business data
Analytics Real-time metrics and reporting
User Management Role and permission management

Testing

Unit Tests

npm run test

Jest is used for component testing.

Integration Tests

npm run test:integration

API endpoint testing with supertest.

E2E Tests

npm run test:e2e

Cypress is used for user flow testing.

Code Standards

  • Follow the Coding Standards guide
  • Use ESLint and Prettier for formatting
  • Write tests for new features
  • Create PR with descriptive title and description