Skip to content

Latest commit

 

History

History
43 lines (28 loc) · 1.3 KB

CONTRIBUTING.md

File metadata and controls

43 lines (28 loc) · 1.3 KB
Raw

Contributing

Feel free to submit issues, pull requests, and fork the repository.

Development

To develop the package, clone the project and install the cloned repository as a dependency in your own project, or install the package directly to your project from a GitHub branch or fork.

Remember to rebuild the package after making changes by using npm run build in the package directory, as projects will only utilize compiled .js and .d.ts files.

Clone and develop locally

git clone https://github.com/NTNUI/ntnui-tools
cd ntnui-tools && npm install
cd my-project
npm i local/path/to/ntnui-tools

Development from GitHub

You can npm install directly from GitHub if you have your own branch, commit and/or fork of the package.

cd my-project

## Branch
npm i https://github.com/NTNUI/ntnui-tools#branch

## Fork or commit hash
npm i https://github.com/{username}/ntnui-tools#commit

Set custom API URL

The default API URL is https://api.ntnui.no. It can be useful to change it by setting NTNUI_TOOLS_API_URL as an environment variable during development.

ntnui-tools uses dotenv to support loading environment variables from a .env file.

# .env in your project root
NTNUI_TOOLS_API_URL = 'https://dev.api.ntnui.no'