Repository files navigation

Official documentation for theNovorender Web API and associated technologies.

Access the documentation site here:https://docs.novorender.com

To set up the project locally, follow these steps:

1. Clone the repository:

   git clone https://github.com/novorender/docscd docs

2. Install dependencies:

   npm install

3. Start the development server:

   npm start

   This will launch the project in your default browser athttps://localhost:3001.

Deployment is automated usingGitHub Actions. The relevant workflows are located in the.github/workflows directory.

• Deploying to a Test/Development Environment:
  Simply open a pull request (PR), and a test deployment will be triggered automatically. Once the deployment is complete, a comment with the test instance URL will be added to the PR.

• Deploying to Production:
  This requires merging changes into themain branch.Following workflow.github/workflows/azure-static-web-apps-happy-pebble-0a13f1503.yml handles the deployment.

We use the following tools to maintain code quality and style:

• ESLint: Identifies and fixes potential issues in the code.

AHusky pre-commit hook ensures that code adheres to the established linting rules before being committed.

We follow theSemantic Commit Messages convention for commit messages to maintain a clear and meaningful commit history. Adhering to this convention helps us maintain consistency across the project and simplifies automated changelog generation.

We welcome contributions! If you’d like to contribute, please follow these steps:

1. Fork the repository and create a new branch for your changes.
2. Make sure your changes follow the project’s coding and documentation standards.
3. Submit a pull request (PR) to the main repository with a clear description of your changes.

We’ll review your PR and merge it once it’s been approved.