Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #31

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
79 changes: 45 additions & 34 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,46 +1,57 @@
## Bit By Bit Developers core library
## BitByBit Core Library

<img src="https://app.bitbybit.dev/assets/git-cover.png" alt="Picture showing bitbybit.dev platform">

This project contains core 3D algorithms of Bit By Bit Developers platform which are open-sourced under MIT license. This library was previously UI dependant and is now separated to ensure protection of our corporate identity and cloud services.
This project contains core 3D algorithms of BitByBit's platform, which are open-sourced under the MIT license. This library is now separated from the UI to ensure protection of our corporate identity and cloud services.

Visit https://bitbybit.dev to use our full cloud platform.
To use our full cloud platform, visit https://bitbybit.dev.

## Github
https://github.com/bitbybit-dev/bitbybit
## NPM
https://www.npmjs.com/package/bitbybit-core
### Resources

## Example Applications
Laptop Holder
https://app-store.bitbybit.dev/laptop-holder
Github Source Code Angular - https://github.com/bitbybit-dev/app-examples/tree/main/angular/laptop-holder
Github Source Code React - https://github.com/bitbybit-dev/app-examples/tree/main/react/laptop-holder

Cup Configurator
https://app-store.bitbybit.dev/cup
Github Source Code - https://github.com/bitbybit-dev/app-examples/tree/main/react/cup
- **GitHub**: https://github.com/bitbybit-dev/bitbybit
- **NPM**: https://www.npmjs.com/package/bitbybit-core

## Closed Source Example Applications
https://app-store.bitbybit.dev/terrace-furniture
### Example Applications

## Build package
tsc -p tsconfig.bitbybit.json
- **Laptop Holder**
- [Live Demo](https://app-store.bitbybit.dev/laptop-holder)
- [Angular Source Code](https://github.com/bitbybit-dev/app-examples/tree/main/angular/laptop-holder)
- [React Source Code](https://github.com/bitbybit-dev/app-examples/tree/main/react/laptop-holder)

- **Cup Configurator**
- [Live Demo](https://app-store.bitbybit.dev/cup)
- [React Source Code](https://github.com/bitbybit-dev/app-examples/tree/main/react/cup)

## Media Channels
Discord: https://discord.gg/GSe3VMe
Youtube: https://www.youtube.com/channel/UCWM0VODRsLYOjB2IAaFHBSQ
Instagram: https://www.instagram.com/bitbybit.dev
Twitter: https://twitter.com/bitbybit_dev
LinkedIn: https://lnkd.in/gQjEQA2
Facebook: https://www.facebook.com/bitbybitdev
Medium: https://bitbybit-dev.medium.com/
### Closed Source Example Applications

## Principles
Bit By Bit Developers company will keep these core algorithms that you can find in this repository free and opensource for its users. These algorithms are based on other open-source projects, run and are deployed on the browser, thus there is no point of closing them down from public.
- **Terrace Furniture**: https://app-store.bitbybit.dev/terrace-furniture

## About Bit By Bit Developers platform
Bit By Bit Developers web platform allows creators to program geometry through simple visual programming language or choose monaco typescript editor with full intellisense of bitbybit API. This cloud platform can fulfil many practical, educational and artistic needs of its users. Through familiar programming interface used in tools such as Scratch and Blockly.Games we expose powerful 3D algorithms that make it easier to implement various parametric tasks. Our goal is to make it very simple for users to share their ideas and designs. We want to encourage everyone to engage in the future of this tool.
### Build package

## Major Dependencies
BabylonJS, Blockly, OpenCascade, JSCAD, Verbnurbs
To build the package, run: `tsc -p tsconfig.bitbybit.json`.

### Media Channels

- **Discord**: https://discord.gg/GSe3VMe
- **Youtube**: https://www.youtube.com/channel/UCWM0VODRsLYOjB2IAaFHBSQ
- **Instagram**: https://www.instagram.com/bitbybit.dev
- **Twitter**: https://twitter.com/bitbybit_dev
- **LinkedIn**: https://lnkd.in/gQjEQA2
- **Facebook**: https://www.facebook.com/bitbybitdev
- **Medium**: https://bitbybit-dev.medium.com/

### Principles

BitByBit Developers will keep these core algorithms free and open-source for its users. These algorithms are based on other open-source projects, run and are deployed on the browser, thus there is no point of closing them down from the public.

### About BitByBit Developers platform

BitByBit Developers' web platform allows creators to program geometry through a simple visual programming language or choose a Monaco TypeScript editor with full intellisense of BitByBit API. This cloud platform can fulfill practical, educational, and artistic needs of its users. Through a familiar programming interface used in tools such as Scratch and Blockly.Games, we expose powerful 3D algorithms that make it easier to implement various parametric tasks. Our goal is to make it very simple for users to share their ideas and designs. We want to encourage everyone to engage in the future of this tool.

### Major Dependencies

- BabylonJS
- Blockly
- OpenCascade
- JSCAD
- Verbnurbs