👩🏫 Don't worry: if you want to participate, we will give top priority to your onboarding so that you can start using the library right away and help us with whatever you want.
The first thing to do is to clone the repository to your local machine.
Start by forking the project (click on fork button on the top right) and choosing yourself as the owner of the fork (if asked).
Now go to the forked repository, click on code button (generally green in color) and copy the https URL.
📦 Now open terminal on your machine and change the current working directory to the location where you want to clone the directory. Enter these commands:
See examples for more details on how to use web-ifc.
🐣 The WASM library is built through emscripten, please see the emscripten installation guide for information on how to set up emscripten. Afterwards
emsdk_env needs to be in your path(environment variable).
🌏 Open the terminal again and run these commands:
npm install to install all dependencies.
npm run setup-env whenever you open a new terminal, this will set up the required emscripten environment variables for you to compile code.
npm run build-release-all to build a release version of the wasm binary and the accompanying web-ifc api. It will be placed in
npm run dev to launch a development server with a basic ifc file viewer.
📝 VS Code - You can install VS Code from here.
☝ Although the primary focus of the library is to be used through WebAssembly in the browser/nodejs, the project can be used stand-alone as a c++ library or executable. See here for a simple entry point to get started.
🔢 Open you terminal and enter these commands:
git status to review your changes.
git checkout master to checkout to master branch.
git pull to sync your cloned repository with the origin repository.
git checkout <branch-name> to go back to your working branch.
git pull to sync with the the main branch.
git add . to stage your changes.
git commit -m "type a message to display for changes" to commit the changes made.
git push to push the changes to the main repository.
Now go to your github, inside the forked version of the repository. You will see a notification on the right (if not click on pull requests) 'compare & pull request' (generally green color button), click on it. Now describe the changes you made in short and click on 'create pull request'.
😊 Talk to us! Tell us about your situation and your ideas and we will help you get started as soon as possible.