repo stringlengths 8 123 | branch stringclasses 178 values | readme stringlengths 1 441k ⌀ | description stringlengths 1 350 ⌀ | topics stringlengths 10 237 | createdAt stringlengths 20 20 | lastCommitDate stringlengths 20 20 | lastReleaseDate stringlengths 20 20 ⌀ | contributors int64 0 10k | pulls int64 0 3.84k | commits int64 1 58.7k | issues int64 0 826 | forks int64 0 13.1k | stars int64 2 49.2k | diskUsage float64 | license stringclasses 24 values | language stringclasses 80 values |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
RocketCraftingServer/kickstart | main | null | Ultimate vanilla performance powered project. Based on Safir project demos. Safir use rocketCraftingServer for account session staff. | web-client,virtual-dom,lightweight-javascript-library,performance,standalone,vanilla-javascript,rocketcraftingserver,javascript,nodejs | 2023-04-29T15:04:55Z | 2024-02-18T20:15:01Z | null | 1 | 0 | 42 | 0 | 0 | 2 | null | MIT | JavaScript |
thuongtruong1009/notix | main | <div align="center">
<img src="https://raw.githubusercontent.com/thuongtruong1009/notix/main/public/favicon.ico" width="28" height="28" /> $\huge\textcolor{purple}{\text{Notix}}$
$\small\textcolor{purple}{\textit{Saving temporary notes extension}}$
<img src="https://img.shields.io/badge/w3c-validated-brightgreen" alt="w3c_badge" />
<img src="https://img.shields.io/github/languages/code-size/thuongtruong1009/notix" alt="code_size_badge" />
<img alt="GitHub release" src="https://img.shields.io/github/v/release/thuongtruong1009/notix?color=yellow">
<img src="https://img.shields.io/badge/manifest-v3-pink" alt="manifest_version_badge" />
<a href="LICENSE"><img src="https://img.shields.io/github/license/thuongtruong1009/notix" alt="license_badge" /></a>
<a href="https://hits.dwyl.com/thuongtruong1009/notix" rel="nofollow"><img src="https://hits.dwyl.com/thuongtruong1009/notix.svg" alt="HitCount" data-canonical-src="https://hits.dwyl.com/thuongtruong1009/notix.svg" style="max-width: 100%;"></a>
</div>
| | |
| :----------------------------------------------------------: | :----------------------------------------------------------: |
| <img src="public/preview1.png" alt="preview1" width="400" /> | <img src="public/preview2.png" alt="preview2" width="400" /> |
| <img src="public/preview3.png" alt="preview3" width="400" /> | <img src="public/preview4.png" alt="preview4" width="400" /> |
| <img src="public/preview5.png" alt="preview5" width="400" /> | <img src="public/preview6.png" alt="preview6" width="400" /> |
| | |
## 📢 About
- Notix is a simple extension that helps in saving temporary notes. It is built with HTML, CSS and JavaScript based on Chrome manifest verion 3. It is cross-browser compatible extension that means it can be used on any browser.
<!-- ## 📚 Documentation
## 📦 Download
## 📝 Usage -->
## 🎉 What's new
##### _(Not support in <ins>http://localhost</ins> static living for popup)_
- Create new notes, edit note data, delete selected notes, clear text, and dispatch notes data with unlimited storage time
- Copy note as text, image to the clipboard
- Export/download notes data as .txt files, .png images
- Share note via image link
- Voice to text (only English)
- Audio reading text
- Auto save typed note text
- Not reset data when closing the browser
- Display notes information (total notes, name - size - total words - total lines - created - last update time of current note, etc.)
- Cross-browsers compatibility (Chrome, Firefox, Edge, Opera, Brave, etc.)
- UI/UX friendly (transition, shadow effect, gradient color etc.)
- Setting options (dark mode, fonts, auto-save, auto-sync, audio-options etc.)
- Search notes by name
## 🎯 Todo
- [ ] Scroll to top button
- [ ] Filter notes by created time, last updated time, etc.
- [ ] Password protection for secret notes
- [ ] Detect language translation of note text
- [ ] Export/import notes backup data
- [ ] Real-time sync notes data between tabs
- [ ] Insert image to text
- [ ] Text editor tool panel
- [ ] Localization
## 🧩 Built With
- [HTML](https://www.w3schools.com/html/)
- [CSS](https://www.w3schools.com/css/)
- [JavaScript](https://www.w3schools.com/js/)
- [Chrome extension](https://developer.chrome.com)
## 🔨 Development
- Star this repository
- Clone the repository
```bash
git clone https://github.com/thuongtruong1009/notix.git
```
- **On browser** -> **Settings** -> **Extensions** -> **Developer mode (open $\textcolor{blue}{\text{chrome://extensions/}}$ for chrome)** -> **Load unpacked** -> **Select the cloned folder**
## 📄 Changelog
- Track experience at [Changelog](https://thuongtruong1009.github.io/notix/changelog.html)
## 🛡️ Credits
This project is licensed under the [GNU General Public v3.0](LICENSE)
Copyright of [@thuongtruong1009](https://github.com/thuongtruong1009), 2023
## ❤️ Support me
> <a href="https://nhantien.momo.vn/0917085937"><img height="28" src="https://raw.githubusercontent.com/thuongtruong1009/notix/main/public/momo.svg"></a> <a href="https://www.paypal.me/thuongtruong1009"><img height="30" src="https://raw.githubusercontent.com/thuongtruong1009/notix/main/public/paypal.svg"></a> <a href='https://ko-fi.com/thuongtruong1009'><img height='26' style='border:0px;height:28px;color:blue' src='https://raw.githubusercontent.com/thuongtruong1009/notix/main/public/kofi.svg' border='0' alt='Buy Me a Coffee at ko-fi.com' /></a> <a href="public/mb_qr.jpg"><img height="32" src="https://raw.githubusercontent.com/thuongtruong1009/notix/main/public/mbbank.svg"></a>
## 📧 Contact
- Email: [thuongtruongofficial](mailto:thuongtruongofficial)
| 📌 A simple extension that helps in saving temporary notes | add-on,browser,chrome-extension,css,css3,extension,extensions,html,html-css-javascript,html5 | 2023-05-07T09:37:01Z | 2023-11-18T14:59:16Z | 2023-11-18T14:59:16Z | 1 | 5 | 40 | 0 | 0 | 2 | null | GPL-3.0 | JavaScript |
shawonk007/online-grocery-shop | master | # Groceria - Multi-Page Grocery Shop UI
Explore this Multi-Page Grocery Shop UI GitHub repository—an extensive web interface for a virtual grocery store with multiple interconnected pages. This project showcases the synergy of HTML, CSS, Bootstrap, JavaScript, jQuery, and SASS to deliver a comprehensive and engaging shopping experience.
## Live Preview
To preview this project please visit https://demo.shawon-khan.com/grocery-shop/
## User Interface
## Technologies Used
The following technologies have been used in the creation of this UI:
- **[Bootstrap](https://getbootstrap.com/)** : A CSS framework for creating responsive and attractive UI components.
- **[FontAwesome](https://fontawesome.com/)**: A popular icon library that provides a wide range of icons for web projects.
## Key Features
- **Responsive Design**: The Grocery Shop UI offers a seamless user experience across devices, with each page designed to adapt effortlessly to various screen sizes.
- **Bootstrap-Powered Layout**: Built on Bootstrap, the user interface boasts a consistent, user-friendly layout with responsive elements, ensuring easy navigation and a cohesive design.
- **Interactive Shopping Experience**: JavaScript and jQuery enhance the user interface with interactive features, including product filtering, real-time cart updates, and a user-friendly checkout process.
- **Customizable Styling with SASS**: Harness the power of SASS for organized and easily customizable styles, empowering you to personalize colors, typography, and design elements to align with your brand.
- **Multi-Page Structure**: This repository includes multiple pages such as Home, About Us, Shop, Product Display, Cart, Checkout, Login, Register, Privacy Policy, Terms and Conditions, Blog, and more, creating a comprehensive web presence for your grocery shop.
- **Product Catalog**: Showcase products with detailed descriptions, pricing, and images, providing an immersive shopping experience for customers.
- **Shopping Cart**: Enable customers to add, manage, and review items in their cart before proceeding to checkout.
- **User-Friendly Navigation**: Smooth page transitions, clear categorization, and an intuitive menu make navigating the grocery shop effortless.
Whether you're establishing an online grocery store or expanding an existing e-commerce venture, our Multi-Page Grocery Shop UI GitHub repository is a valuable resource. Fork it, tailor it to your unique requirements, and create a compelling online shopping platform with a variety of pages to serve your customers' needs effectively.
## License
`Groceria - Multi-Page Grocery Shop UI` is licensed under the `GNU General Public License version 3.0 (GPL-3.0)`. You can find the full text of the license in the `LICENSE` file.
## Author
`Groceria - Multi-Page Grocery Shop UI` is designed and maintained by **[Muhammad Nasir Uddin Khan Shawon](https://www.shawon-khan.com/)**. You can find more about me on my [GitHub profile](https://github.com/shawonk007). Feel free to reach out via email at `shawonk007@gmail.com` or connect with me on **[LinkedIn](https://www.linkedin.com/in/shawonkhan007)**. | "Online Grocery Shop - Groceria" is a Github repository showcasing "Groceria," a sleek and user-friendly UI design for an online grocery shop. Developed using HTML5, CSS5, JavaScript, SCSS, and Bootstrap5, this project aims to offer a seamless shopping experience for customers. | bootstrap5,css3,html5,javascript,sass,scss | 2023-05-04T06:14:10Z | 2023-09-10T11:12:05Z | null | 1 | 0 | 10 | 0 | 0 | 2 | null | GPL-3.0 | HTML |
CorvusCodex/Multithread-Polkadot-Brute-Force | main | # Multithread Polkadot Brute-force by CorvusCodex
Nodejs script that generates random private keys for the Polkadot blockchain and checks if the corresponding public generic Substrate (format starts with "5") address is in a list of addresses stored in a file named ‘data.txt’. If a match is found, the script logs the public address and saves the wallet and its private key (seed) to a file named ‘match.txt’. The script uses the cluster module to create worker processes for each CPU and runs the generate function repeatedly with no delay.
## Installation
1. Clone this repository
2. Run npm install to install dependencies
## Usage
1. Add the addresses you want to check against to a file named ‘data.txt’, with one address per line.
2. Run node index.js to start the script.
## Support
Support my work:
1. BTC: bc1q7wth254atug2p4v9j3krk9kauc0ehys2u8tgg3
2. ETH & BNB: 0x68B6D33Ad1A3e0aFaDA60d6ADf8594601BE492F0
3. Buy me a coffee: https://www.buymeacoffee.com/CorvusCodex
## Disclaimer
The code within this repository comes with no guarantee, the use of this code is your responsibility. I take NO responsibility and/or liability for how you choose to use any of the source code available here. By using any of the files available in this repository, you understand that you are AGREEING TO USE AT YOUR OWN RISK. Once again, ALL files available here are for EDUCATION and/or RESEARCH purposes ONLY. The chances of finding a match are extremely low and it is not recommended to use this script for any illegal or unethical activities.
MIT License
Copyright (c) 2023 CorvusCodex
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
| Nodejs script that generates random private keys for the Polkadot blockchain and checks if the corresponding public address is in a list of addresses stored in a file named ‘data.txt’. If a match is found, the script logs the public address and saves the wallet and its private key (seed) to a file named ‘match.txt’. | bruteforce,crack,crypto,cryptocurrency,cryptography,javascript,nodejs,polkadot,seed,seed-cracking | 2023-05-12T22:27:56Z | 2023-05-19T19:16:57Z | null | 1 | 0 | 13 | 0 | 2 | 2 | null | MIT | JavaScript |
MEGAMMS/MEGA-AI | master | # MEGA-AI
MEGA-AI is a Web Application for generating images from text using [stability-ai](https://replicate.com/stability-ai/stable-diffusion) using only vanilla javascript.
The project is based on Fireship course for javascript.
## Dependencies
* [NodeJS](https://nodejs.org/en/download/) v12
* NPM v6.9.0
* [NVM](https://github.com/nvm-sh/nvm)
## Installation
1. Run `nvm use` to use the correct Node.JS version.
2. Run `npm install` to install dependencies.
## Getting Started
1. Run `npm run dev` to start the application
2. Go to http://localhost:5173 to view the website.
## The Environment
To set up the enviroment you have to signup for [replicate](https://replicate.com/signin)
to get your [API](https://replicate.com/account) key and paste it in `.env` file.
```
replicate_KEY="Your replicate API key"
```
## Run
Run this command to start up the server:
```bash
node server.js
```
And now you are good to go.
Test the app and i am waiting for your feedback😊.
## License
[MIT](https://choosealicense.com/licenses/mit/)
| MEGA-AI is a Web Application for generating images from text using stability ai using only vanilla javascript. | ai,api-rest,backend,fireship,frontend,javascript,nodejs,website | 2023-04-29T00:29:11Z | 2023-05-02T21:11:23Z | null | 1 | 0 | 9 | 0 | 0 | 2 | null | null | JavaScript |
swetamishra123/razorpayClone | master | # Razorpay Clone
A clone of the Razorpay payment gateway integration for online transactions. This project aims to replicate the functionality of Razorpay for educational and learning purposes.
## Table of Contents
- [Overview](#overview)
- [Features](#features)
- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#license)
## Overview
This Razorpay Clone project is a simplified version of the popular Razorpay payment gateway. It demonstrates how online payment processing works by simulating key features and functionalities.
## Features
- **Payment Processing**: Simulate payment processing with essential steps.
- **User Interface**: User-friendly interface for payment initiation.
- **Payment Status**: View the payment status after the transaction.
- **Sandbox Mode**: Test transactions without actual money transfer.
## Installation
To run this project locally, follow these steps:
1. Clone this repository:
```bash
git clone https://github.com/your-username/razorpay-clone.git
2. Navigate to the project directory:
```bash
cd razorpay-clone
4. Install dependencies:
```bash
npm install
5. Start the development server:
```bash
npm start
6. Open your web browser and access the project at [http://localhost:3000](http://localhost:3000).
## Usage
1. Open the project in your web browser.
2. Simulate payment by filling in the necessary details.
3. Follow the prompts to complete the payment process.
4. Check the payment status to see the result.
## Contributing
Contributions are welcome! If you'd like to contribute to this project, please follow these guidelines:
1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Make your changes and commit them with descriptive messages.
4. Push your branch to your fork.
5. Create a pull request to merge your changes into the main project.
6. Please ensure your code follows best practices and includes appropriate documentation.
## License
This project is licensed under the MIT License.
| This project aims to replicate the functionality of Razorpay for educational and learning purposes. | css,html5,javascript,node-module,nodejs,npm,tailwindcss | 2023-04-24T17:59:53Z | 2024-03-30T13:50:07Z | null | 1 | 9 | 35 | 0 | 1 | 2 | null | MIT | HTML |
Ashish0o7/code-editor | main | # Structure
It got 3 servers all hosted differently, one for adding questions( using Django, I've removed it now and merged with others), server for Collaboration and server of featured codes.
## Backend
### 1. Featured Codes and Adding,deleting new codes server
Repo: https://github.com/Ashish0o7/chat-code-server/tree/master
### 2. Collaboration and chatting
Repo: https://github.com/Ashish0o7/chat-code-server/tree/main
### 3. Adding questions
Repo: https://github.com/Ashish0o7/add_codes_server
( I've discontinued it, and for more robust process, merged these operations with Featured codes)
# Home Page
[](https://postimg.cc/fJKBzb9X)
# Featured Page, with rating
[](https://postimg.cc/jDCxvL64)
# Collab in realtime
[](https://postimg.cc/JyvGjj9X)
# Add Code
[](https://postimg.cc/mcjGs4Sg)
# Byte Builder
The Code Editor is a cutting-edge platform tailored for programmers and developers. It enables you to write, edit, save, and compile code both individually and collaboratively. This application stands out by merging real-time collaboration with the ability to share and evaluate high-quality code snippets. Furthermore, it offers a unique feature where users can share coding questions, fostering a collaborative and supportive environment for learning and problem-solving. Designed with a user-friendly interface, this editor ensures a seamless and enriching coding experience for all users.
## Features
### 1. Real-Time Collaboration
Collaborate seamlessly with others on coding projects in real-time, boosting productivity and teamwork.
### 2. Code Compilation and Execution
Write and execute code within the browser, with instant feedback on output, time, and memory usage.
### 3. Community-Driven Code Sharing
Discover and rate high-quality code snippets shared by the user community, fostering a culture of peer learning.
### 4. Secure Authentication
A robust login and registration system ensures the security and management of user data.
### 5. Enhanced Performance with Redis
Integrates Redis for efficient data handling, significantly improving system performance.
## Technologies Used
- Frontend: React.js
- Backend: NodeJS, Django, Express.js
- Database: MongoDB, Redis
- Authentication: Firebase
- APIs & Libraries: Axios, Socket.IO, Mongoose
- Architecture: Microservices
## Getting Started
1. Clone the repository:
```
git clone https://github.com/Ashish0o7/code-editor.git
```
3. Install the dependencies:
```
cd code-editor
npm install
```
3. Start the server:
```
npm run start
```
4. Open your browser and go to `http://localhost:3000` to use the code editor.
## Backend
1. Clone these repositories seperately
### Featured Codes and Adding,deleting new codes server
Repo: https://github.com/Ashish0o7/chat-code-server/tree/master
### Collaboration and chatting
Repo: https://github.com/Ashish0o7/chat-code-server/tree/main
2. Install dependencies for both
```
npm install
```
3. To Start collaboration server
```
node server.js
```
4.
To start Featured codes and questions server
```
node server2.js
```
5. By this time, your frontend and both the server would be running
6. Now go ahead and setup .env file for both frontend and backend server
#### For frontend
```
REACT_APP_FIREBASE_API_KEY=
REACT_APP_FIREBASE_AUTH_DOMAIN=
REACT_APP_FIREBASE_PROJECT_ID=
REACT_APP_FIREBASE_STORAGE_BUCKET=
REACT_APP_FIREBASE_MESSAGING_SENDER_ID=
REACT_APP_FIREBASE_APP_ID=
REACT_APP_FIREBASE_MEASUREMENT_ID=
```
### For backend server
```
REACT_APP_RAPID_API_URL = ''
REACT_APP_RAPID_API_HOST = ''
REACT_APP_RAPID_API_KEY = ''
```
## Contributing
Contributions are welcome! Please submit a pull request if you'd like to make any changes or improvements to the code editor.
##
| Code Editor with compiling, saving code and meta data functionalities | reactjs,javascript,socket-io,code-editor,express,judge0-api,monaco-editor,mongodb | 2023-04-30T21:11:06Z | 2024-04-10T11:59:41Z | null | 1 | 0 | 97 | 0 | 0 | 2 | null | null | JavaScript |
Friskes/Frishub | master | <h1 align="center">-> <a href="https://frishub.ru" target="_BLANK">frishub</a> <-</h1>
## Запуск проекта локально без докера
#### 1) Необходим установленный и запущенный <a href="https://github.com/tporadowski/redis" target="_BLANK">REDIS</a> сервер на пк.
#### 2) Загрузите репозиторий с помощью команды:
git clone https://github.com/Friskes/Frishub.git
#### 3) Создайте виртуальное окружение (необходим Python==3.8 на пк):
py -3.8 -m venv venv
#### 4) Обновите установщик pip:
python.exe -m pip install --upgrade pip
#### 5) Установите зависимости необходимые для работы проекта:
pip install -r requirements.txt
#### 6) Сгенерируйте статические файлы:
python manage.py collectstatic
#### 7) Создайте миграции:
python manage.py makemigrations
#### 8) Выполните миграцию:
python manage.py migrate
#### 9) Создайте супер пользователя:
python manage.py createsuperuser
#### 10) Для запуска проекта, в первой консоли, выполните команду:
python manage.py runserver
#### 11) Для запуска CELERY необходимого для полноценной работы проекта, во второй консоли, выполните команду:
python manage.py runcelery
#### 12) Откройте в браузере проект по адресу:
http://127.0.0.1:8000/
#### Для остановки программы нажмите сочетание клавиш CTRL+C в обеих консолях.
## Запуск проекта локально с докером
#### 1) Загрузите репозиторий с помощью команды:
git clone https://github.com/Friskes/Frishub.git
#### 2) Необходимо создать файл `.env` в корне проекта с содержимым:
```
# IF DEPLOY OR DEV WITH DOCKER MUST BE TRUE ELSE FALSE
RUN_DEV_SERVER_WITH_DOCKER=1
PROJECT_NAME=FriskesSite
POSTGRES_DB=db
POSTGRES_USER=db
POSTGRES_PASSWORD=db
POSTGRES_HOST=postgres
POSTGRES_PORT=5432
REDIS_HOST=redis
REDIS_PORT=6379
CELERY_APP=FriskesSite
CELERY_FLOWER_URL_PREFIX=flower
CELERY_FLOWER_ADDRESS=celery-flower
CELERY_FLOWER_PORT=5555
SERVER_HOST=0
SERVER_IP=0
```
#### 3) Запустите Docker Desktop на пк.
#### 4) Создайте образ и запустите контейнер:
docker compose up --build
#### 5) Создайте супер пользователя (для этого остановите контейнер):
docker compose run wsgiserver python manage.py createsuperuser
#### 6) Снова запустите контейнер:
docker compose up
#### 7) Откройте в браузере проект по адресу:
http://127.0.0.1:8000/
#### Для остановки программы нажмите сочетание клавиш CTRL+C
<br>
> # Развёртывание проекта на удаленном сервере:
1. [О чём говорится в этом документе](#О-чём-говорится-в-этом-документе)
1. [Создание SSH ключа](#Создание-SSH-ключа)
1. [Установка серверных зависимостей](#Установка-серверных-зависимостей)
1. [Публикация проекта на Github](#Публикация-проекта-на-Github)
1. [Развёртывание github репозитория на сервере](#Развёртывание-github-репозитория-на-сервере)
1. [Создание systemd socket и service файлов для Gunicorn](#Создание-systemd-socket-и-service-файлов-для-Gunicorn)
1. [Дебаг (DEBUGGING)](#Дебаг-(DEBUGGING))
1. [Установка и настройка Redis](#Установка-и-настройка-Redis)
1. [ASGI для размещения Django Channels в качестве отдельного приложения](#ASGI-для-размещения-Django-Channels-в-качестве-отдельного-приложения)
1. [Развертывание Django Channels с помощью Daphne & Systemd](#Развертывание-Django-Channels-с-помощью-Daphne-&-Systemd)
1. [Запуск daphne.service при загрузке сервера](#Запуск-daphne.service-при-загрузке-сервера)
1. [Настройка домена](#Настройка-домена)
1. [Установка Celery](#Установка-Celery)
1. [Установка Celery Beat](#Установка-Celery-Beat)
1. [Установка Celery Flower](#Установка-Celery-Flower)
1. [Создание суперпользователя](#Создание-суперпользователя)
1. [FAQ](#FAQ)
1. [References](#References)
# О чём говорится в этом документе
Обо всём, что связано с публикацией веб-сайта django, оснащенного WebSockets, с использованием Django Channels,
а так же о celery, celery beat, celery flower.
# Создание SSH ключа
#### SSH key
Обязательно выберите SSH-ключ для аутентификации вместо пароля. В противном случае хакеры могут взломать пароли для входа на ваш сервер. Использование SSH-ключа намного безопаснее.
Чтобы сгенерировать SSH-ключ откройте командную строку в windows и выполните команду `ssh-keygen`, вам будет предложено ввести путь по которому будет сохранён сгенерированный ключ, после нажмите enter один раз. **Обязательно сохраните резервную копию приватного и публичного ключа**.
#### IP адрес вашего сервера
Запишите где-нибудь IP-адрес вашего сервера. Берётся он на хостинге где вы арендуете сервер. Он понадобится вам в дальнейшем для входа на ваш сервер.
# Войдите на сервер с помощью SSH и FTP
Лично мне нравится использовать программу [MobaXterm](https://mobaxterm.mobatek.net/) для входа на серверы (она бесплатная). Это здорово, потому что вы можете использовать SSH и FTP из одного окна. Это очень удобно.
#### SSH Настройки
1. Установите IP-адрес сервера
1. Установите `root` в качестве имени пользователя
1. Под "Advanced SSH settings":
1. кликните "use private key" и выберите место, где вы сохранили свой приватный SSH ключ.
# Установка серверных зависимостей
Запустите эти команды в SSH-терминале.
`passwd` Установка пароля для root пользователя.
`sudo apt update`
`sudo apt install python3-pip python3-dev libpq-dev postgresql postgresql-contrib nginx curl`
`sudo -u postgres psql` Войти в командную строку БД
`CREATE DATABASE frishub_db;`
`CREATE USER friskes WITH PASSWORD 'пароль';`
`ALTER ROLE friskes SET client_encoding TO 'utf8';`
`ALTER ROLE friskes SET default_transaction_isolation TO 'read committed';`
`ALTER ROLE friskes SET timezone TO 'UTC';`
`GRANT ALL PRIVILEGES ON DATABASE frishub_db TO friskes;`
`\q` Выйти из командной строки БД
`sudo -H pip3 install --upgrade pip`
`sudo -H pip3 install virtualenv`
`sudo apt install git-all`
`sudo apt install libgl1-mesa-glx` Устранить проблему с "cv2"
`adduser django`
Установка другой версии Python
(
`sudo apt-get install -y make build-essential libssl-dev zlib1g-dev`
`sudo apt-get install -y libbz2-dev libreadline-dev libsqlite3-dev wget curl llvm`
`sudo apt-get install -y libncurses5-dev libncursesw5-dev xz-utils tk-dev`
`su root`
`cd /opt`
`wget https://www.python.org/ftp/python/3.8.9/Python-3.8.9.tgz`
`tar xzvf Python-3.8.9.tgz`
`cd Python-3.8.9`
`./configure --enable-optimizations`
`make`
`sudo make install`
)
(проверить какой текущий пользователь можно с помощью команды): `id`
переходим с root пользователя на friskes
`su friskes`
`cd /home/friskes/`
`mkdir project`
`cd project`
Проверить версию Python в OS
`python3 -V`
(
Установить Python самой последней версии которая установлена на сервере в виртуальное окружение
`virtualenv venv`
Либо
Установить Python конкретной версии которая установлена на сервере в виртуальное окружение
`python3.8 -m venv venv`
)
`source venv/bin/activate`
В случае необходимости деактивация виртуального окружения происходит с помощью команды: `deactivate`
# Публикация проекта на Github
1. Войдите в Github.com
1. Создайте новый репозиторий [https://github.com/new](https://github.com/new)
1. Откройте терминал в вашем локальном каталоге проекта
Выполните эти команды:
`git init`
`git add .`
`git commit -m "init repo"`
`git remote add origin https://github.com/Friskes/Frishub.git`
`git push -u origin master`
#### Создайте файл .env в корневом каталоге проекта
```
WINDOWS_REDIS_INSTALLED=0
# IF DEPLOY OR DEV WITH DOCKER MUST BE TRUE ELSE FALSE
RUN_DEV_SERVER_WITH_DOCKER=1
SECRET_KEY=<секретный_ключ>
# IF LOCAL IP EXISTS THEN START LOCAL SERVER ONLY WITH IT
MY_LOCAL_IPV4_ADDRESS=<ваш_локальный_ip_(не_обязательная_настройка)>
PROJECT_NAME=FriskesSite
POSTGRES_DB=<название бд>
POSTGRES_USER=<никнейм в бд>
POSTGRES_PASSWORD=<пароль в бд>
POSTGRES_HOST=postgres
POSTGRES_PORT=5432
REDIS_HOST=redis
REDIS_PORT=6379
CELERY_APP=FriskesSite
CELERY_FLOWER_URL_PREFIX=flower
CELERY_FLOWER_ADDRESS=celery-flower
CELERY_FLOWER_PORT=5555
SERVER_HOST=<хост сервера>
SERVER_IP=<айпи сервера>
```
#### Обновите код в Github после добавления нового файла
`git add .`
`git commit -m "add .env"`
`git push origin master`
# Развёртывание github репозитория на сервере
Откройте MobaXterm и войдите на свой сервер через SSH.
Инициализируйте git в директории в которой будет находится проект
`git init`
Загрузите проект в текущую директорию
`git pull https://github.com/Friskes/Frishub.git prod`
попросит ввести github никнейм владельца репозитория (Friskes) и токен в качестве пароля
(при создании токена необходимо указать права для Repository permissions -> Contents -> Read-only) иначе будет выдавать ошибку
Токен создаётся здесь: https://github.com/settings/tokens?type=beta
Токен надо сохранить куда нибудь локально т.к. он будет требоватся часто
Потребуется залогинится в гите с помощью данных команд
`git config --global user.name "your_github_username"`
`git config --global user.email "your_github_email"`
Можно сохранить логин + пароль(токен) в store чтобы не вводить их каждый раз заного. [источник](https://stackoverflow.com/questions/68775869/message-support-for-password-authentication-was-removed-please-use-a-personal`)
Необходимо единоразово ввести команду перед исполнением git pull
`git config --global credential.helper store`
В будущем этот store можно удалить командами
`git config --local --unset credential.helper`
`git config --global --unset credential.helper`
`git config --system --unset credential.helper`
Принтануть store: `git config credential.helper`
Проверить версию пакетного менеджера pip
`pip -V`
Обновляем пакетный менеджер pip
`pip install --upgrade pip`
Необходимо обязательно удалить файл local_settings.py
На сервере должен оставатся только prod_settings.py
На локальной машине могут оставатся оба файла.
Не забываем добавить в requirements.txt пару библиотек перед установкой если их нету
`psycopg2-binary`
`gunicorn`
Переходим в директорию с проектом
`cd FriskesSite`
посмотреть список библиотек из файла requirements.txt
`cat requirements.txt`
перед установкой необходимо проверить, если присутствует библиотека
`twisted-iocpsupport`
её необходимо убрать перед установкой на линуксе.
https://stackoverflow.com/questions/66428469/twisted-iocpsupport-error-when-using-pip-on-ubuntu-debian-io-h-missing
Устанавливаем библиотеки
`pip install -r requirements.txt`
Для работы вебсокета дополнительно необходимо установить библиотеки
`pip install -U 'Twisted[tls,http2]'`
Создаём пустую папку для медиа файлов если она ещё не создана
`mkdir media`
## Проверьте, можете ли вы запустить свой проект (Тестовый запуск)
`su root`
`sudo ufw allow 8000`
`su friskes`
`source venv/bin/activate`
`cd FriskesSite`
`python manage.py makemigrations`
`python manage.py migrate`
`python manage.py runserver 0.0.0.0:8000`
посетите [http://<ваш_серверный_ip>:8000/](http://<ваш_серверный_ip>:8000/)
Остановить сервер
`CTRL+C`
Может быть такая проблема что не будет нормально грузить static либо media
для этого надо выполнить эти команды для диреторий static и media соответственно
`sudo chown -R www-data:www-data /home/friskes/project/FriskesSite/static`
`sudo chown -R www-data:www-data /home/friskes/project/FriskesSite/media`
`sudo chmod -R 777 /home/friskes/project/FriskesSite/static`
`sudo chmod -R 777 /home/friskes/project/FriskesSite/media`
`sudo usermod -a -G www-data $(whoami)`
# Создание systemd socket и service файлов для Gunicorn
Мы провели тест, чтобы узнать, запустится ли приложение, если мы запустим его вручную, но мы хотим, чтобы приложение автоматически запускалось / перезапускалось, когда это необходимо. Например, когда мы перезапускаем сервер или он по какой-то причине выходит из строя.
Один из способов сделать это - с помощью gunicorn. Запустив эту команду, вы увидите, что gunicorn может запускать приложение:
`gunicorn --bind 0.0.0.0:8000 FriskesSite.wsgi`
либо
`gunicorn FriskesSite.wsgi:application --bind 0.0.0.0:8000`
посетите [http://<ваш_серверный_ip>:8000/](http://<ваш_серверный_ip>:8000/)
Итак, нам просто нужна служба для запуска этой команды при запуске сервера. Один из способов сделать это - использовать [systemd](https://en.wikipedia.org/wiki/Systemd)
`CTRL+C`
#### Настройте systemd для запуска gunicorn с помощью `gunicorn.socket` файла
`su root`
Перейдите в директорию: `/etc/systemd/system/`
Создайте файл с именем: `gunicorn.socket`
Добавьте в файл следующее и сохраните:
```
[Unit]
Description=gunicorn socket
[Socket]
ListenStream=/run/gunicorn.sock
[Install]
WantedBy=sockets.target
```
#### Создайте gunicorn service для запуска приложения WSGI (приложение django)
Создайте новый файл: `gunicorn.service`
Добавьте следующее в `gunicorn.service` и сохраните. **Очень важно скопировать это в точности так, как у меня. Также ваша структура каталогов внутри /home/friskes/ должна быть точно такой же, как у меня. В противном случае этот служебный файл не будет знать, о вашем проекте.**
```
[Unit]
Description=gunicorn daemon
Requires=gunicorn.socket
After=network.target
[Service]
User=friskes
Group=www-data
WorkingDirectory=/home/friskes/project/FriskesSite
ExecStart=/home/friskes/project/venv/bin/gunicorn \
--access-logfile - \
--workers 3 \
--bind unix:/run/gunicorn.sock \
FriskesSite.wsgi:application
[Install]
WantedBy=multi-user.target
```
`sudo systemctl start gunicorn.socket`
`sudo systemctl enable gunicorn.socket`
#### Полезные команды
1. `sudo systemctl daemon-reload`
- Должно быть выполнено, если вы измените `gunicorn.service` файл.
1. `sudo systemctl restart gunicorn`
- Если вы меняете код в своём проекте, вы должны выполнить это, чтобы увидеть изменения.
1. `sudo systemctl status gunicorn`
- Проверка статуса gunicorn
1. `sudo shutdown -r now`
- полная перезагрузка сервера
- Важное замечание, команды начинающиеся на sudo может использовать только root пользователь, соответственно сначало надо перейти в root пользователя с помощью команды `su root`
проверить версию операционной системы сервера
`ldd --version`
возвращаемся в родительскую директорию
`cd ..`
либо
`cd ~`
Очистить консоль
`clear`
#### Настройте Nginx для передачи прокси-сервера(proxy pass) к Gunicorn
> Мы будем использовать Nginx в качестве HTTP-прокси. Это помогает защитить наш веб-сайт от злоумышленников. Вы можете прочитать больше об этом здесь[https://docs.gunicorn.org/en/stable/deploy.html](https://docs.gunicorn.org/en/stable/deploy.html). Нам нужно настроить Nginx и gunicorn для совместной работы.
Перейдите в директорию: `/etc/nginx/sites-available`
Создайте файл `FriskesSite` с таким содержимым:
```
server {
listen 80;
server_name <ваш_серверный_ip>;
location /static/ {
root /home/friskes/project/FriskesSite;
}
location /media/ {
root /home/friskes/project/FriskesSite;
}
location / {
include proxy_params;
proxy_pass http://unix:/run/gunicorn.sock;
}
}
```
Измените пользователя `user` в самом начале файла `/etc/nginx/nginx.conf` на созданного нами пользователя friskes
это поможет в обнаружении static/media файлов
#### Настройте брандмауэр (Firewall)
`sudo ln -s /etc/nginx/sites-available/FriskesSite /etc/nginx/sites-enabled`
`sudo nginx -t`
`sudo systemctl restart nginx`
`sudo ufw delete allow 8000`
`sudo ufw allow 'Nginx Full'`
`sudo systemctl restart gunicorn`
(`service gunicorn restart` Нет никакой разницы между этими двумя командами `sudo systemctl restart gunicorn`)
Перезапустите сервер: `sudo shutdown -r now`
посетите: [http://<ваш_серверный_ip>/](http://<ваш_серверный_ip>/)
# Дебаг (DEBUGGING)
Вот несколько команд, которые вы можете использовать для просмотра журналов сервера. **Эти команды абсолютно необходимо знать.** Если ваш сервер случайно не работает в один прекрасный день, это то, что вы используете для начала отладки.
1. `sudo journalctl` это место, куда объединяются все журналы. Обычно я проверяю именно там.
1. `sudo tail -F /var/log/nginx/error.log` Просмотр последних записей в журнале ошибок
1. `sudo journalctl -u nginx` Журналы процессов Nginx
1. `sudo less /var/log/nginx/access.log` Журналы доступа Nginx
1. `sudo less /var/log/nginx/error.log` Журналы ошибок Nginx
1. `sudo journalctl -u gunicorn` журналы приложений gunicorn
1. `sudo journalctl -u gunicorn.socket` проверьте журналы сокетов gunicorn
Логи можно промотать в конец с помощью комбинации клавиш Shift+G
Листать логи можно с помощью стрелок на клавиатуре
Просмотр лога в режиме реального времени с флагом `-f`:
`tail -f file_name.log`
# Установка и настройка Redis
Redis используется как своего рода "очередь обмена сообщениями" для Django Channels. Подробнее об этом читайте здесь [https://channels.readthedocs.io/en/stable/topics/channel_layers.html?highlight=redis#redis-channel-layer](https://channels.readthedocs.io/en/stable/topics/channel_layers.html?highlight=redis#redis-channel-layer)
Для исправления ошибки: "redis.exceptions.ConnectionError: Error 111 connecting to 127.0.0.1:6379. 111." введите команду:
`sudo ufw allow 6379`
`sudo apt install redis-server`
Перейдите в директорию: `/etc/redis/`
Откройте файл: `redis.conf`
Нажмите `CTRL+F` для поиска `supervised no` в редакторе
Измените `supervised no` на `supervised systemd` и сохраните
`sudo systemctl restart redis.service`
Подтвердите, что Redis запущен по адресу 127.0.0.1. По умолчанию порт должен быть 6379.
`sudo systemctl status redis`
`CTRL+C` Для выхода из журнала.
`sudo apt install net-tools`
`sudo netstat -lnp | grep redis`
`sudo systemctl restart redis.service`
# ASGI для размещения Django Channels в качестве отдельного приложения
Из документации Django channels:
> ASGI (Asynchronous Server Gateway Interface) - это спецификация, на основе которой построены каналы, она предназначенна для отсоединения приложений каналов от конкретного сервера приложений и предоставления общего способа написания кода приложений и промежуточного программного обеспечения.
`su friskes`
Установите владельца файла
`cat > asgi.py`
friskes должен быть владельцем этого файла.
Проверить какие файлы находятся в текущей директории
`ls`
введите `ls -l` чтобы проверить владельца. friskes должен быть владельцем.
# Развертывание Django Channels с помощью Daphne & Systemd
> Gunicorn - это то, что мы используем для запуска приложения WSGI, которое является нашим приложением Django. Для запуска приложения ASGI нам нужно что-то еще, дополнительный инструмент. **[Daphne](https://github.com/django/daphne)** был создан для каналов Django и является самым простым. Мы можем запустить daphne с помощью службы systemd при загрузке сервера, точно так же, как мы запускаем gunicorn, а затем gunicorn запускает приложение django.
Вот несколько ссылок, которые я нашел полезными. Информация по этому поводу скудна:
1. [https://channels.readthedocs.io/en/latest/deploying.html](https://channels.readthedocs.io/en/latest/deploying.html)
1. [https://stackoverflow.com/questions/50192967/deploying-django-channels-how-to-keep-daphne-running-after-exiting-shell-on-web](https://stackoverflow.com/questions/50192967/deploying-django-channels-how-to-keep-daphne-running-after-exiting-shell-on-web)
`su root`
`apt install daphne`
Перейдите в `/etc/systemd/system/`
Создайте `daphne.service`. Обратите внимание, что порт равен `8001`. Это тот же порт как и у нашего `WebSocket` класса в шаблоне.
```
[Unit]
Description=WebSocket Daphne Service
After=network.target
[Service]
Type=simple
User=root
WorkingDirectory=/home/friskes/project/FriskesSite
ExecStart=/home/friskes/project/venv/bin/python /home/friskes/project/venv/bin/daphne -b 0.0.0.0 -p 8001 FriskesSite.asgi:application
Restart=on-failure
[Install]
WantedBy=multi-user.target
```
`systemctl daemon-reload`
`systemctl start daphne.service`
`systemctl status daphne.service`
`CTRL+C`
# Запуск daphne.service при загрузке сервера
> С помощью gunicorn и приложения WSGI мы создали файл `gunicorn.socket`, который сообщает gunicorn о запуске при загрузке сервера (по крайней мере, я так понимаю). Я не мог понять, как заставить это работать для daphne, поэтому вместо этого я написал сценарий bash, который будет запускаться при загрузке сервера.
#### Создайте скрипт для запуска daphne
Перейдите в `/root`
создайте файл `boot.sh` и сохраните содержимое
```
#!/bin/sh
sudo systemctl start daphne.service
```
Возможно, придется включить его запуск как скрипт (не уверен, нужно ли это)
`chmod u+x /root/boot.sh`
Если вы хотите узнать больше о сценариях bash, я нашел это полезным:
[https://ostechnix.com/fix-exec-format-error-when-running-scripts-with-run-parts-command/](https://ostechnix.com/fix-exec-format-error-when-running-scripts-with-run-parts-command/).
#### Сообщите systemd, чтобы он запустил скрипт bash при загрузке сервера
Перейдите в `/etc/systemd/system`
создайте файл `on_boot.service` с содержимым:
```
[Service]
ExecStart=/bin/bash /root/boot.sh
[Install]
WantedBy=default.target
```
`systemctl daemon-reload`
##### запустите
`sudo systemctl start on_boot`
##### Включите его для запуска при загрузке
`sudo systemctl enable on_boot`
##### Разрешить обслуживание daphne через брандмауэр (firewall)
`ufw allow 8001`
##### перезагрузите сервер
`sudo shutdown -r now`
##### Проверьте, запустилась ли служба on_boot при запуске сервера:
`systemctl status on_boot.service`
можно посмотреть логи
`sudo journalctl -u on_boot.service`
##### Проверьте, запустилась ли служба daphne при запуске сервера:
`systemctl status daphne.service`
можно посмотреть логи
`sudo journalctl -u daphne.service`
##### Проверьте, запустилась ли служба gunicorn при запуске сервера:
`systemctl status gunicorn.service`
# Настройка домена
Если вам нужно пользовательское доменное имя (что, вероятно, делают все), в этом разделе вы узнаете, как это сделать.
#### Купите домен на любом понравившемся сайте.
#### Подключите DNS в вашем хостинге
A-запись должна быть равна серверному ip
#### Добавьте домен в хостинг
#### Обновить конфигурацию Nginx
Ранее мы настроили Nginx на передачу прокси-сервера(proxy pass) в gunicorn. Нам нужно добавить новый домен в эту конфигурацию.
перейдите в директорию `/etc/nginx/sites-available`
обновите файл `FriskesSite`
```
server {
listen 80;
server_name <ваш_домен> www.<ваш_домен> <ваш_серверный_ip>;
location /static/ {
root /home/friskes/project/FriskesSite;
}
location /media/ {
root /home/friskes/project/FriskesSite;
}
location / {
include proxy_params;
proxy_pass http://unix:/run/gunicorn.sock;
}
}
```
`sudo systemctl reload nginx`
Убедитесь, что конфигурация nginx по-прежнему в порядке.
`sudo nginx -t`
### добавьте новые домены в `ALLOWED_HOSTS` проекта если не сделали этого ранее
Примените изменения
`service gunicorn restart`
## ТЕПЕРЬ ПРИШЛО ВРЕМЯ ПОДОЖДАТЬ...
> Может потребоваться некоторое время, чтобы ваш веб-сайт стал доступен в пользовательском домене. Я действительно не знаю, сколько времени это на самом деле займет. Я ждал несколько часов, пока у меня не заработало.
#### Откуда ты знаешь, что это работает?
Посетив свой домен, вы должны увидеть сообщение `Welcome to nginx!` **ИЛИ вы должны увидеть свой проект вживую и работающим**
Вообще обычно процесс занимает не более 24-48 часов, время обновления зависит от интернет-провайдера.
Чтобы начать работу над сайтом уже сейчас, пропишите для своего компьютера соответствие адреса и домена в файл hosts по этой [инструкции](https://beget.com/ru/kb/how-to/sites/kak-dobavit-sootvetstvie-ip-adresa-i-domena-sajta-v-fajl-etc-hosts?_ga=2.217897046.1912125031.1673476626-1439285939.1671724688).
# HTTPS (Если у вас зарегистрирован домен и он работает)
**Не выполняйте этот шаг, если только вы не сможете посетить свой веб-сайт, используя пользовательский домен.** Посмотрите: [Откуда ты знаешь, что это работает?](#Откуда-ты-знаешь,-что-это-работает?)
#### Установка certbot
HTTPS немного сложнее настроить при использовании Django Channels. Nginx и Daphne требуют некоторой дополнительной настройки.
`sudo apt install certbot python3-certbot-nginx`
`certbot --version`
`sudo systemctl reload nginx`
Убедитесь, что конфигурация nginx по-прежнему в порядке.
`sudo nginx -t`
#### Разрешить HTTPS через брандмауэр(firewall)
Если вы не выполняли эту команду ранее - выполните
`sudo ufw allow 'Nginx Full'`
`sudo ufw delete allow 'Nginx HTTP'` Блокировать стандартный HTTP
#### Получить SSL-сертификат
`sudo certbot --nginx -d <ваш_домен> -d www.<ваш_домен>`
#### Состояние службы отвечающей за авто обновление Certbot для проверки сертификата
`sudo systemctl status certbot.timer`
#### протестировать процесс обновления
`sudo certbot renew --dry-run`
## Обновить конфигурацию nginx
Нам нужно сообщить nginx, чтобы он разрешил передачу данных websocket через порт 8001. Я действительно не уверен, как это объяснить. Я не понимаю этого сам до конца. Это работает аналогично тому, как мы разрешаем gunicorn передавать прокси-сервер(proxy pass) nginx.
Перейдите в директорию `/etc/nginx/sites-available`
обновите `FriskesSite`
```
# REDIRECT (www or non-www domain) HTTP TRAFFIC to (www or non-www domain) HTTPS protocol
server {
listen 80;
server_name www.<ваш_домен> <ваш_домен>;
return 301 https://$host$request_uri;
}
# REDIRECT (www domain) HTTPS TRAFFIC to (non-www domain) HTTPS protocol
server {
listen 443 ssl;
ssl_certificate /etc/letsencrypt/live/<ваш_домен>/fullchain.pem;
ssl_certificate_key /etc/letsencrypt/live/<ваш_домен>/privkey.pem;
server_name www.<ваш_домен>;
return 301 $scheme://<ваш_домен>$request_uri;
}
# MAIN (non-www domain) HTTPS protocol HANDLER
server {
listen 443 ssl;
ssl_certificate /etc/letsencrypt/live/<ваш_домен>/fullchain.pem;
ssl_certificate_key /etc/letsencrypt/live/<ваш_домен>/privkey.pem;
include /etc/letsencrypt/options-ssl-nginx.conf;
ssl_dhparam /etc/letsencrypt/ssl-dhparams.pem;
server_name <ваш_домен>;
client_max_body_size 10M;
location /static/ {
root /home/friskes/project/FriskesSite;
}
location /media/ {
root /home/friskes/project/FriskesSite;
}
location / {
# https://stackoverflow.com/a/22027177/19276507
proxy_set_header Host $host;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Forwarded-Proto $scheme;
proxy_pass http://unix:/run/gunicorn.sock;
}
location /ws/ {
proxy_http_version 1.1;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection "upgrade";
proxy_redirect off;
proxy_pass http://127.0.0.1:8001;
}
}
```
## Обновить `daphne.service`
Расскажите daphne, как получить доступ к нашему сертификату https.
Перейдите в директорию `/etc/systemd/system`
обновите файл `daphne.service`
```
[Unit]
Description=WebSocket Daphne Service
After=network.target
[Service]
Type=simple
User=root
WorkingDirectory=/home/friskes/project/FriskesSite
ExecStart=/home/friskes/project/venv/bin/python /home/friskes/project/venv/bin/daphne -e ssl:8001:privateKey=/etc/letsencrypt/live/<ваш_домен>/privkey.pem:certKey=/etc/letsencrypt/live/<ваш_домен>/fullchain.pem FriskesSite.asgi:application
Restart=on-failure
[Install]
WantedBy=multi-user.target
```
# Установка Celery
[официальная документация](https://docs.celeryq.dev/en/latest/userguide/daemonizing.html#usage-systemd)
Обновить установщик apt
`sudo apt update`
Установить celery
`sudo apt -y install celery`
Создать файл celery.service
`/etc/systemd/system/celery.service`
С содержимым:
```
[Unit]
Description=Celery Service
After=network.target
[Service]
Type=forking
User=friskes
Group=www-data
EnvironmentFile=/etc/conf.d/celery
WorkingDirectory=/home/friskes/project/FriskesSite
ExecStart=/bin/sh -c '${CELERY_BIN} multi start ${CELERYD_NODES} \
-A ${CELERY_APP} --pidfile=${CELERYD_PID_FILE} \
--logfile=${CELERYD_LOG_FILE} --loglevel=${CELERYD_LOG_LEVEL} ${CELERYD_OPTS}'
ExecStop=/bin/sh -c '${CELERY_BIN} multi stopwait ${CELERYD_NODES} \
--pidfile=${CELERYD_PID_FILE}'
ExecReload=/bin/sh -c '${CELERY_BIN} multi restart ${CELERYD_NODES} \
-A ${CELERY_APP} --pidfile=${CELERYD_PID_FILE} \
--logfile=${CELERYD_LOG_FILE} --loglevel=${CELERYD_LOG_LEVEL} ${CELERYD_OPTS}'
Restart=always
[Install]
WantedBy=multi-user.target
```
Создать директорию conf.d и файл celery внутри
`/etc/conf.d/celery`
С содержимым:
```
CELERY_APP="FriskesSite"
CELERY_BIN="/home/friskes/project/venv/bin/celery"
CELERYD_NODES="w1"
CELERYD_MULTI="multi"
CELERYD_OPTS="--time-limit=300 --concurrency=8"
CELERYD_PID_FILE="/var/run/celery/%n.pid"
CELERYD_LOG_FILE="/var/log/celery/%n%I.log"
CELERYD_LOG_LEVEL="INFO"
CELERYBEAT_SCHEDULE_FILE="/var/run/celery/celerybeat-schedule"
CELERYBEAT_PID_FILE="/var/run/celery/beat.pid"
CELERYBEAT_LOG_FILE="/var/log/celery/beat.log"
CELERY_FLOWER_URL_PREFIX="flower"
CELERY_FLOWER_LOG_FILE="/var/log/celery/flower.log"
CELERY_FLOWER_ADDRESS="127.0.0.1"
CELERY_FLOWER_PORT="5555"
```
Создать файл celery.conf
`/etc/tmpfiles.d/celery.conf`
С содержимым:
```
d /var/run/celery 0755 friskes www-data -
d /var/log/celery 0755 friskes www-data -
```
Общие команды для Celery, Beat, Flower служб:
После изменения файла необходимо перезапустить демона
`sudo systemctl daemon-reload`
Установить авто запуск после каждой перезагрузки сервера
`systemctl enable <название_службы>.service`
Отключить авто запуск после каждой перезагрузки сервера
`sudo systemctl disable <название_службы>.service`
Посмотреть лог
`sudo journalctl -u <название_службы>.service`
Проверить состояние
`sudo systemctl status <название_службы>`
Остальные команды:
`sudo systemctl start <название_службы>`
`sudo systemctl stop <название_службы>`
`sudo systemctl restart <название_службы>`
# Установка Celery Beat
Создать файл celerybeat.service
`/etc/systemd/system/celerybeat.service`
С содержимым:
```
[Unit]
Description=Celery Beat Service
After=network.target
[Service]
Type=simple
User=friskes
Group=www-data
EnvironmentFile=/etc/conf.d/celery
WorkingDirectory=/home/friskes/project/FriskesSite
ExecStart=/bin/sh -c '${CELERY_BIN} -A ${CELERY_APP} beat \
-s ${CELERYBEAT_SCHEDULE_FILE} \
--pidfile=${CELERYBEAT_PID_FILE} \
--logfile=${CELERYBEAT_LOG_FILE} \
--loglevel=${CELERYD_LOG_LEVEL}'
Restart=always
[Install]
WantedBy=multi-user.target
```
# Установка Celery Flower
Создать файл celeryflower.service
`/etc/systemd/system/celeryflower.service`
С содержимым:
```
[Unit]
Description=Flower Celery Service
After=network.target
[Service]
User=friskes
Group=www-data
EnvironmentFile=/etc/conf.d/celery
WorkingDirectory=/home/friskes/project/FriskesSite
ExecStart=/bin/sh -c '${CELERY_BIN} -A ${CELERY_APP} flower \
--url_prefix=${CELERY_FLOWER_URL_PREFIX} --port=${CELERY_FLOWER_PORT} \
--address=${CELERY_FLOWER_ADDRESS} \
--log-file-prefix=${CELERY_FLOWER_LOG_FILE} --loglevel=${CELERYD_LOG_LEVEL}'
Restart=on-failure
Type=simple
[Install]
WantedBy=multi-user.target
```
# Создание суперпользователя
Перед тестированием сервера необходимо создать суперпользователя.
`su friskes`
`cd /home/friskes/project/`
`source venv/bin/activate`
`cd FriskesSite`
`python manage.py createsuperuser`
Перезагрузите сервер и зайдите на свой веб-сайт, чтобы опробовать его. Теперь все должно работать.
Спасибо за чтение и не стесняйтесь вносить свой вклад в этот документ, если у вас есть лучший способ объяснить происходящее. Я ни в коем случае не являюсь веб-экспертом.
# FAQ
Вот некоторые вещи, которые я хотел бы знать, когда делал это в первый раз.
### Если вы изменяете файл или обновляете код в проекте, нужно ли вам что-либо делать?
Да.
Если вы изменяете только код, который *не связан с django channels*, то вам нужно запустить только:
`service gunicorn restart`
Но если вы измените какой-либо код, связанный с django channels, **тогда вы также должны перезапустить службу daphne**:
`service daphne restart`
На всякий случай я всегда просто запускаю и то, и другое. Это не может повредить.
### Команды для проверки статусов сервисов
На протяжении всего этого документа мы периодически проверяем статус настроенных нами сервисов. Такие вещи, как:
1. `sudo systemctl status gunicorn`
1. `sudo systemctl status redis`
1. `systemctl status daphne.service`
1. `systemctl status on_boot.service`
1. `sudo systemctl status certbot.timer`
### Команды NGINX
Посмотреть статус nginx
1. `sudo systemctl status nginx`
Остановить nginx (до первой перезагрузки сервера)
1. `sudo systemctl stop nginx`
Запустить nginx
1. `sudo systemctl start nginx`
Автоматическая остановка а затем запуск nginx
1. `sudo systemctl reload nginx`
Отключить автоматический запуск nginx после перезагрузки сервера
1. `sudo systemctl disable nginx`
Включить автоматический запуск nginx после перезагрузки сервера
1. `sudo systemctl enable nginx`
Если что-либо из этого не сработает, значит, вы сделали что-то не так. Наиболее распространенная проблема заключается в том, что структура каталогов не совпадает. Например, вы могли бы использовать `/home/friskes/project/неправильное_название_проекта/` вместо `/home/friskes/project/FriskesSite/`. Вам нужно очень внимательно изучить структуру ваших каталогов и убедиться, что все названия указаны правильно и соотносятся с `.service` файлами, которые вы создали.
> Когда вы вносите изменения в `.service` файл, **Всегда выполняйте команду `sudo systemctl daemon-reload`**. Или на всякий случай просто перезапустите этот чертов сервер `sudo shutdown -r now`. Перезапуск сервера - это безопасный способ, но и самый медленный.
### Получить информацию об оперативной памяти
Команда: `free -h`
Вызвать программу диспетчер задач [инструкция](https://zalinux.ru/?p=1811)
Команда открытия диспетчере: `top` Выйти кнопкой `q`
Команды `Shift + <` и ` Shift + >` меняют столбец по которому сортируются строки в диспетчере
Покажет использование памяти процессами:
`ps aux | awk '{print $6/1024 " MB\t\t" $11}' | sort -n`
# References
1. [https://www.digitalocean.com/community/tutorials/how-to-set-up-django-with-postgres-nginx-and-gunicorn-on-ubuntu-18-04](https://www.digitalocean.com/community/tutorials/how-to-set-up-django-with-postgres-nginx-and-gunicorn-on-ubuntu-18-04)
1. [https://channels.readthedocs.io/en/latest/](https://channels.readthedocs.io/en/latest/)
1. [https://www.digitalocean.com/community/tutorials/how-to-install-and-secure-redis-on-ubuntu-20-04](https://www.digitalocean.com/community/tutorials/how-to-install-and-secure-redis-on-ubuntu-20-04)
1. [https://www.digitalocean.com/community/tutorials/how-to-set-up-object-storage-with-django](https://www.digitalocean.com/community/tutorials/how-to-set-up-object-storage-with-django)
1. [https://stackoverflow.com/questions/61101278/how-to-run-daphne-and-gunicorn-at-the-same-time](https://stackoverflow.com/questions/61101278/how-to-run-daphne-and-gunicorn-at-the-same-time)
1. [https://github.com/conda-forge/pygridgen-feedstock/issues/10](https://github.com/conda-forge/pygridgen-feedstock/issues/10)
1. [https://www.digitalocean.com/community/tutorials/how-to-secure-nginx-with-let-s-encrypt-on-ubuntu-20-04](https://www.digitalocean.com/community/tutorials/how-to-secure-nginx-with-let-s-encrypt-on-ubuntu-20-04)
| Тренировочный Python-Django проект использующий: WebSocket, Celery, Redis, PostgreSQL на бэке и много JavaScript на фронте. | celery,django,javascript,postgresql,python,redis,websocket | 2023-05-09T21:41:58Z | 2024-04-06T10:06:05Z | null | 1 | 0 | 199 | 0 | 0 | 2 | null | null | Python |
Astrogeek77/30_Day_of_LC_Javascript | main | null | the 30 Days LeetCode Challenge is just for you! Every day starting May 5, LeetCode will pick one JavaScript problem to solve. Solve the daily problem to win rewards and master basic JavaScript skills. JavaScript beginners are welcome to join the event. | codebase,javascript,leetcode-challenge-solution | 2023-05-10T04:26:04Z | 2023-06-03T16:29:08Z | null | 1 | 0 | 23 | 0 | 0 | 2 | null | null | JavaScript |
Muzna-J/budget-tracker-client | main | # Budget Tracking App
This is a budget tracking app built with the MERN stack (MongoDB, Express.js, React.js, Node.js). It allows users to track their expenses and incomes, manage their profiles, and view graphical representations of their financial data using Chart.js.
## Repositories
- Backend Repository: [budget-tracker-server](https://github.com/Muzna-J/budget-tracker-server)
- Frontend Repository: [budget-tracker-client](https://github.com/Muzna-J/budget-tracker-client)
## Features
- User authentication using JSON Web Tokens (JWT)
- User registration and login with password hashing using bcrypt
- CRUD operations for user profiles, expenses, and incomes
- Dashboard displaying charts and statistics using Chart.js
- Responsive design and styling using Bootstrap
## Technologies Used
- MongoDB: Database for storing user profiles, expenses, and incomes
- Express.js: Backend web application framework
- React.js: Frontend JavaScript library for building user interfaces
- Node.js: JavaScript runtime environment
- Mongoose: Object Data Modeling (ODM) library for MongoDB and Node.js
- bcrypt: Password hashing and verification
- JWT: Authentication and authorization with JSON Web Tokens
- Chart.js: JavaScript charting library for creating interactive charts
- Bootstrap: CSS framework for responsive design and styling
| The Budget Tracking App is a MERN stack (MongoDB, Express.js, React.js, Node.js) web application that helps users effectively manage their expenses and incomes. With features like user authentication, CRUD operations, and data visualization using Chart.js, it provides an intuitive interface for tracking financial activities. | mernstack,budget-tracker,chartjs,expense-tracker,expressjs,javascript,nodejs,reactjs,bootstrap | 2023-05-10T08:13:06Z | 2024-04-25T14:37:02Z | null | 1 | 0 | 46 | 0 | 1 | 2 | null | null | JavaScript |
pingidentity-developers-experience/ping-oidc-client-sdk | main | # OAuth/OIDC Client-side SDK
## From Ping Identity
### Authors: Technical Enablement Demo Team
---
## NOTE:
### For native integration with your Javascript or browser-based apps, please use the NPM package hosted [here](https://www.npmjs.com/package/@pingidentity-developers-experience/ping-oidc-client-sdk?activeTab=readme).
### You only need to clone or fork this repo if your intent is to contribute to, or extend, this SDK project.
---
### Shortcuts
- [tl;dr - I'm a pro, I just wanna play!](#tldr)
- [Project details](#project-details)
- [Security](#security)
- [What's Included](#whats-included)
- [Step by Step - Package/Module](#step-by-step-npm)
- [Step by Step - Plain-old Javascript](#step-by-step-pojs)
- [ClientOptions Parameter Details](#options-details)
- [Misc. Details](#misc-details)
- [Requesting enhancements or reporting issues](#requests-issues)
- [Known Gotchas](#gotchas)
- [Disclaimer](#disclaimer)
### tl;dr - I Just Wanna Play<a id="tldr"></a>
``` JavaScript
// Install the SDK package in your project with either npm or yarn.
// Import or require an instance of the SDK. This example calls it `OidcClient`.
// Set your OAuth configs
const clientOptions = {
client_id: '<authn-server-client-id>',
// redirect_uri: 'https://example.com/page',
// response_type: 'token',
// usePkce: false,
// scope: 'openid profile revokescope',
// state: 'xyz',
// logLevel: 'debug',
// storageType: 'worker', // defaults to 'local'. Also falls back to 'local' for backwards compatibility when choosing 'worker' and the Worker object is not present.
// customParams: { param1: 'value1', param2: 'value2' } // will append custom parameters to the authorization url. Expects an object with string key/values.
};
// Initialize the SDK using an authorization server's well-known endpoint. Note this takes in the base url of the auth server, not the well-known endpoint itself. '/.well-known/openid-configuration' will be appended to the url by the SDK.
const oidcClient = await OidcClient.initializeFromOpenIdConfig('https://auth.pingone.com/<env-id>/as', clientOptions);
// Authorize a user. Note this will use window.location.assign, thus redirecting the user after the url is generated.
oidcClient.authorize(/* optional login_hint */);
// Get the token from storage
if (await oidcClient.hasToken()) {
const token = await oidcClient.getToken();
}
// That's it.
```
### Project Details<a id="project-details"></a>
This project is an OAuth/OIDC SDK hosted at [npmjs.com](https://www.npmjs.com/package/@pingidentity-developers-experience/ping-oidc-client-sdk?activeTab=readme), for bootstrapping the [OAuth](https://www.rfc-editor.org/rfc/rfc6749) and [OpenID Connect (OIDC)](https://openid.net/developers/specs/) protocol in your own custom applications, with the intent to automate or simplify steps in the protocol flow and integration of it. This allows you, the developer, to do what you do best, focusing on your company's business apps, while Ping Identity handles what we do best, identity security.
With a developer-first focus and simplicity in design, native Javascript APIs were chosen as much as possible over 3rd-party packages and libraries which incur supply chain risks, and may conflict with your company's security standards. Additionally, native Javascript APIs simplify maintenance for Ping Identity and its customers, and reduces the potential attack vectors of this package in your applications.
This project was built to the OAuth/OIDC specs, and is not Ping proprietary. Therefore this SDK will work with any OAuth-compliant authorization server.
### Security<a id="security"></a>
#### Best practices
For guidelines on security best practices please see [OAUTH 2.0 for Browser-Based Apps](https://datatracker.ietf.org/doc/html/draft-ietf-oauth-browser-based-apps-07) and [OAUTH 2.0 Security Best Current Practice](https://datatracker.ietf.org/doc/html/draft-ietf-oauth-security-topics-16).
#### Software Bill of Materials
NPM transient dependencies can run deep. For this reason, we include a software bill of materials (SBOM) with each release that you or your security teams can audit. These SBOMs are generated using [CycloneDX by OWASP](https://owasp.org/www-project-cyclonedx/). Packages we import are primarily for development of the SDK and can be excluded in builds. These packages may change at our discretion.
#### Responsible Disclosure
**Please read the [Contributor Guidelines](https://github.com/pingidentity-developers-experience/ping-oidc-client-sdk/blob/main/.github/CONTRIBUTING.md) for reporting security issues.**
Before each release, we run the following commands against our project to ensure a clean project. We make every reasonable effort to resolve category critical and high vulnerabilities.
`npm doctor`
`npx unimported`
`npm outdated`
`npx depcheck`
`npm audit`
Because of the as-is offering and license of this project, it is highly recommended that users of this SDK run `npm audit`, or the Javascript SAST tool of your choice, and evaluate the results and make changes to meet your internal application security requirements.
### What's Included:
- Authorization code grant
- Implicit grant
- PKCE
- State
- Get / Revoke / Refresh Token
- End session / Logout
- User Info
- Storage Options; *local, session, Worker (in-memory)*
- Custom params support on the /authorize call.
### Step-by-step - Package/Module<a id="step-by-step-npm"></a>
If you want to see an example app and integration running before digging your feet in below, check out our [OIDC SDK example integration package](https://github.com/pingidentity-developers-experience/ping-integration-example-packages) in our growing library of integration examples.
**1) Install the SDK in your project from NPM**
```Bash
# With npm
npm install @pingidentity-developers-experience/ping-oidc-client-sdk
# With yarn
yarn add @pingidentity-developers-experience/ping-oidc-client-sdk
```
**2) In your app code**
`import { OidcClient } from '@pingidentity-developers-experience/ping-oidc-client-sdk';`
#### Usage:
Note these examples show usage against PingOne, but the OidcClient will work against any OAuth/OIDC compliant authorization server. Also, this SDK is written using TypeScript so you will get typings in your app if needed.
**Errors from the SDK** are passed up to your application so that you can handle them gracefully and manage your UX requirements. You can catch them in a try/catch block if you are using async/await or you can use the catch() method on the promise returned from the function call.
**3) We recommend you initialize the SDK using the static initializeFromOpenIdConfig method shown above, as this will hit the authorization server's well-known endpoint and use the meta data in the response to configure the SDK endpoints for you.**
``` JavaScript
// Initialize the SDK using an authorization server's well-known endpoint. Note this takes in the base url of the auth server, not the well-known endpoint itself. '/.well-known/openid-configuration' will be appended to the url by the SDK.
const oidcClient = await OidcClient.initializeFromOpenIdConfig('https://auth.pingone.com/<env-id>/as', clientOptions);
```
Alternatively, if you have limitations with using your .well-known endpoint, you can initialize an OidcClient manually.
``` JavaScript
const clientOptions = {
client_id: '<authn-server-client-id>',
};
const openIdConfig = {
authorization_endpoint: "https://auth.pingone.com/<env-id>/as/authorize", // Required
token_endpoint: "https://auth.pingone.com/<env-id>/as/token", // Required
revocation_endpoint: "https://auth.pingone.com/<env-id>/as/revoke", // Required if using revokeToken() function
userinfo_endpoint: "https://auth.pingone.com/<env-id>/as/userinfo", // Required if using fetchUserInfo() function
end_session_endpoint: "https://auth.pingone.com/<env-id>/as/signoff" // Required if using endSession() function
};
const client = await OidcClient.initializeClient(clientOptions, openIdConfig);
```
**4) Getting a token from storage** - plus revoke, refresh, and ending a session
``` JavaScript
if (await oidcClient.hasToken()) {
const token = await oidcClient.getToken();
// If you need the state that was passed to the server, you can get it from the TokenResponse managed by the SDK
const state = token.state;
// Revoke the token on the server and remove it from storage
await oidcClient.revokeToken();
// Refresh the access token and store the new token in storage
await oidcClient.refreshToken();
// End the user's session using the end_session_endpoint on the auth server
await oidcClient.endSession(/* optional post logout redirect uri */);
}
```
**5) Other optional calls**
If you wish to override the authorize() behavior and apply it to an anchor tag, for example, you can capture the URL like this.
```JavaScript
const authnUrl = await oidcClient.authorizeUrl(/* optional login_hint */);
```
This is used to get the user info from the userinfo endpoint on the authZ server. This must be used after the user has gone through authorize flow and an ID token is available in storage.
```JavaScript
const userInfo = await oidcClient.fetchUserInfo();
```
### Usage without node/npm<a id="step-by-step-pojs"></a>
If you wish to use the SDK in a web application that does not use node or npm you can import it from unpkg or a similar CDN and use it as follows.
``` HTML
<!-- NOTE: In most cases you should specify a version in case we release major/breaking changes, see https://www.unpkg.com/ for more information -->
<script type="module" src="https://unpkg.com/@pingidentity-developers-experience/ping-oidc-client-sdk/lib/ping-oidc.js"></script>
<script type="text/javascript">
const client = await pingOidc.OidcClient.initializeFromOpenIdConfig({...});
// The above step-by-step examples will be the same after this.
</script>
```
### ClientOptions Parameter<a id="options-details"></a>
| Parameter | Type (TS enum where applicable) | Description | Options | Default value if not specified |
| ----------- | ---- |------------- | ------- | ------------- |
| client_id (required)| string | Client id issued by the auth server for your application | - | - |
| redirect_uri | string | Redirect URI for server to send user back to | - | Current URL from browser when SDK was initialized |
| response_type | string | Token response type |`'code'`, `'token'`|`'code'`|
| usePkce | boolean | Whether the SDK will add a code challenge to the url | `true`, `false` | `true` |
| scope | string | Requested scopes for token | - | `'openid profile'` |
| state | string \| object | State passed to server | - | Random string to act as a nonce token |
| logLevel | string (LogLevel) | Logging level for statements printed to console | `'debug'`, `'info'`, `'warn'`, `'error'`, `'none'` | `'warn'`
| storageType | string (StorageType) | Where tokens are stored; localStorage, sessionStorage, Web Worker. Worker is recommended for better security. | `'local'`, `'session'`, `'worker'` | `'local'` (for backwards compatibility) |
| customParams | object | Custom URI parameters to append to the authorization URL | - | - |
### Misc. Details<a id="misc-details"></a>
#### Multiple Clients on a Page
The OidcClient supports multiple instances out of the box, allowing you to manage multiple tokens on the same page. Please note that the OidcClient class uses state to ensure that the correct client instance is processing the token or authorization code when the user is redirected back to the app from the authorization server. If you do not provide state through the ClientOptions a random string is created for you.
#### Implementation Details:
Some authorization servers, such as Ping Identity's, support and take advantage of custom params in the querystring of an /authorize endpoint call. When initiating this SDK, you can optionally pass in an object of name:value pairs that will be parsed, encoded and appended to the querystring. See the [ClientOptions Parameter Details](#options-details) above.
When using `authorize()` you can optionally pass in a login_hint parameter as a string if you have already collected a username or email from the user. The authorize function will build the url and navigate the current browser tab to it for you. Alternatively if you would like to get the authorization url ahead of time and trigger the navigation to the server yourself via an anchor href or click event, you can do so using the `authorizeUrl()` function instead. When using PKCE (which is enabled by default) the SDK will generate a code verifier and challenge for you and use the verifier when getting a token from the token_endpoint on the authorization server.
After a user has authorized on the server they will be redirected back to your app with a token in the url fragment (implicit grants) or with a `code` in the query string (`grant_type: 'authorization_code'`). The SDK will check for both cases when it is initialized and handle getting the token for you. It will also remove the token or code from the url and browser history. If you need the token from the SDK, use the `getToken()` function, the token response from that call also includes the state you passed through the clientOptions. The SDK will attempt to `JSON.parse` the state when it received from the authorization server, but if that fails it will be stored as a string.
**TokenResponse is as follows (this is a TypeScript interface, `?` indicates an optional property)**
``` TypeScript
export interface TokenResponse {
access_token: string;
expires_in: number;
id_token?: string;
scope: string;
token_type: string;
state: string | any;
}
```
### Requesting Enhancements, community support, or Reporting Issues<a id="requests-issues"></a>
Use the standard [github Issues list](https://github.com/pingidentity-developers-experience/ping-oidc-client-sdk/issues/new) to make these types of requests or reports, and please apply the proper label.
### Known Gotchas<a id="gotchas"></a>
- **`Error: Missing class properties transform`**
We've seen this error in React projects where dependencies had been "ejected". (*Could apply to other JS frameworks*). If you get this error, the fix is to apply this package, [babel plugin transform class properties](https://www.npmjs.com/package/babel-plugin-transform-class-properties).
*If you've ejected your dependencies, you will need to manually configure webpack config file in the babel-loader section.*
- **Salesforce Lightning Development**
-- Lightning and static resources with async functions cause known cross-browser compatibility issues. Lightning addresses this in the docs with a solution from babeljs.
[Transform async to generator](https://developer.salesforce.com/docs/platform/lwc/guide/security-lwsec-async.html).
-- Lightning does not typically allow custom code to access/install external packages or modules, and therefore have to be downloaded and put on their CDN. For this, we recommend you use the `unpkg.com` URL we provide above in the [Usage without node/npm](#usage-without-nodenpm).
-- One other consideration, we've seen how the development framework for Salesforce Lightning wraps the operations of the `promise` object. This hasn't been the root cause of any experiences thus far, but is something to consider if you see anomalous behavior.
### Disclaimer<a id="disclaimer"></a>
THIS ENTIRE PROJECT AND ALL ITS ASSETS IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL PING IDENTITY OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) SUSTAINED BY YOU OR A THIRD PARTY, HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT ARISING IN ANY WAY OUT OF THE USE OF THIS PROJECT CODE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | This is available as an npmjs package so you do not need to clone/fork this project unless you want to contribute. | javascript,oauth,oidc,pingidentity,sdk | 2023-04-28T00:19:23Z | 2024-05-02T20:02:22Z | 2024-05-02T20:02:22Z | 10 | 90 | 321 | 0 | 4 | 2 | null | Apache-2.0 | TypeScript |
n2duc/typescript-base | main | compile to js file: tsc xxx.ts
install npm package ts-node to run typescript file directly
Run in terminal: ts-node example.ts
Hello World | TypeScript is a strongly typed programming language that builds on JavaScript, giving you better tooling at any scale | javascript,typescript | 2023-05-11T18:31:36Z | 2023-09-17T15:59:39Z | null | 1 | 0 | 10 | 0 | 0 | 2 | null | null | TypeScript |
Luiscarlosvd/Awesome-Books-ES6 | main | <h1>Awesome Books Refactored Project</h1>
<a name="readme-top"></a>
<!-- TABLE OF CONTENTS -->
# 📗 Table of Contents
- [📗 Table of Contents](#-table-of-contents)
- [📖 Monsters of Code 2023](#-monsters-of-code-2023)
- [🛠 Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Key Features ](#key-features-)
- [🚀 Live Demo ](#-live-demo-)
- [💻 Getting Started ](#-getting-started-)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#deployment)
- [👥 Authors ](#-authors-)
- [🔭 Future Features ](#-future-features-)
- [Walkthrough ](#walkthrough-)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [📝 License ](#-license-)
<!-- PROJECT DESCRIPTION -->
# 📖 Awesome Books<a name="about-project"></a>
In Awesome Books Project we work only in plain JavaScript and Html.
## 🛠 Built With <a name="built-with"></a>
### Tech Stack <a name="tech-stack"></a>
- HTML
- JS
- CSS
<details>
<summary>Client</summary>
- HTML<br>
- JS<br>
- CSS
</details>
<details>
<summary>Server</summary>
- Null
</details>
<details>
<summary>Database</summary>
- Null
</details>
### Key Features <a name="key-features"></a>
- **Responsive Design**
- **List Section**
- **Add and Remove books**
<!-- LIVE DEMO -->
## 🚀 Live Demo <a name="live-demo"></a>
> Comming Soon...
<!-- - No live demo available yet -->
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- GETTING STARTED -->
## 💻 Getting Started <a name="getting-started"></a>
To get a local copy up and running, follow these steps.
### Prerequisites
- A web browser
- A code editor
- A terminal
### Setup
Clone this repository to your desired folder:
```sh
git clone https://github.com/Luiscarlosvd/Awesome-Books-ES6.git
```
### Install
Install this project with:
```sh
cd Awesome-Books-ES6
npm install
```
### Usage
To run the project, execute the following command:
```sh
npm run dev
```
### Run tests
To run tests, run the following command:
- no tests available
<!--
Example command:
```sh
bin/rails test test/models/article_test.rb
```
--->
### Deployment
> Comming Soon...
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- AUTHORS -->
## 👥 Author <a name="authors"></a>
👤 Luis Valera
- GitHub: [@Luiscarlosvd](https://github.com/Luiscarlosvd)
- Twitter: [@Luiscarlosvd29](https://twitter.com/Luiscarlosvd29)
- LinkedIn: [Luis Valera](https://www.linkedin.com/in/luis-valera-6a5749267/)
## 🔭 Future Features <a name="future-features"></a>
- **More styling 😁**
- **Add Images 👌**
- **More sections 😎**
## Walkthrough <a name="walkthrough"></a>
> Comming Soon...
<!-- CONTRIBUTING -->
## 🤝 Contributing <a name="contributing"></a>
Contributions, issues, and feature requests are welcome!
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- SUPPORT -->
## ⭐️ Show your support <a name="support"></a>
If you like this project, give it a ⭐️!
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 🙏 Acknowledgments <a name="acknowledgements"></a>
I would like to thank Microverse for giving me the opportunity to learn and grow as a developer.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- LICENSE -->
## 📝 License <a name="license"></a>
This project is [MIT](./LICENSE) licensed.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
| Project a list to save books with authors entered by the user. Users can add and remove books and the changes will be saved in local storage. built with JavaScript, HTML and CSS | html,javascript | 2023-05-01T13:34:35Z | 2023-05-01T21:06:56Z | null | 1 | 1 | 10 | 1 | 0 | 2 | null | MIT | JavaScript |
LeadFisherSolutions/leadutils | main | <h1 align="center">Leadfisher common library</h1>
<h2 align="center">Installation</h2>
```npm
npm i leadutils --save
```
<h2 align="center">Usage</h2>
- **The module** divided into submodules, for example here you can see work with submodule <code>time</code>.
```javascript
const utils = require('leadutils');
// const { time, obj, string, time, net, crypto, utils, oop, fp, pp, async } = utils;
console.log(utils.time.prettify('h:m:s / D.M|Y', new Date())); // 18:50:54 / 07.05|2023
```
<h2 align="center">Modules</h2>
<details open>
<summary width="100%">Time module | <b>.time</b></summary><br/>
- **(prettify)** Return date in any string format
```ts
prettify(format: string, date?: Date | string | number) => string;
// format is any combination of letters [YMDhmsi] with any optional separators
// Y - Year; M - Month; D - Day; h - Hours; m - Minute; s - Second; i - Millisecond
```
```javascript
const utils = require('leadutils');
utils.time.prettify('h:m:s / D.M|Y', new Date()); // 18:50:54 / 07.05|2023
utils.time.prettify('h-m-s.i', new Date()); // 18-50-54.045
```
- **(duration)** Return duration in ms from string
```ts
function duration(time: string): number;
// time is any combination of letters [dhms] with values
// d - Day; h - Hours; m - Minute; s - Second;
// Example: 1d 1h 1m 1s 90061000
```
```javascript
const utils = require('leadutils');
utils.time.duration('5s'); // 5000
utils.time.duration('24h'); // 86400000
utils.time.duration('1d'); // 86400000
utils.time.duration('1d 1h 1m 5s'); // 90065000
```
- **(compare)** Create any dates compare functions
```javascript
const utils = require('leadutils');
utils.time.compare((a, b) => a > b)('2023-05-07', '2023-05-08'); // false
utils.time.compare((a, b) => a > b)('2023-01-01', '2021-05-08'); // true
```
- **(formatDuration)** Make seconds in more readable format
```javascript
const utils = require('leadutils');
utils.time.formatDuration(1000); // 1 second
utils.time.formatDuration(60000); // 1 minute
utils.time.formatDuration(60001); // 1 minute 1 second
utils.time.formatDuration(90000); // 1 minute 30 seconds
```
- **(divideDuration)** Get a divided ms by all day time measurements object
```javascript
const utils = require('leadutils');
utils.time.divideDuration(new Date()); // { day: 19484, hour: 16, minute: 6, second: 34, millisecond: 818 }
utils.time.divideDuration(90020); // { day: 0, hour: 0, minute: 1, second: 30, millisecond: 20 }
```
- **(datesDiff)** Return difference between two dates in any time measurement
```javascript
const utils = require('leadutils');
let tomorrow = new Date(new Date().setDate(new Date().getDate() + 1));
utils.time.datesDiff(new Date(), tomorrow); // 1
utils.time.datesDiff(new Date(), tomorrow, 'hour'); // 24
```
</details>
<details>
<summary width="100%">Parallel programming module | <b>.pp</b></summary><br/>
**(Semaphore)** for limit concurrency accessing limited resource
```ts
class Semaphore(concurrency: number, size?: number, timeout?: number){
empty: boolean;
enter: Promise<boolean>;
leave: void;
}
```
</details>
<details>
<summary width="100%">Different utils module | <b>.utils</b></summary><br/>
- **(shuffle)** Shuffle array
```javascript
const utils = require('leadutils');
utils.array.shuffle([1, 2, 3]); // ~[2,3,1]
```
- **(sample)** Get sample from array
```javascript
const utils = require('leadutils');
utils.array.sample([1, 2, 3]); // ~2
utils.array.sample([1, 2, 3]); // ~3
utils.array.sample([1, 2, 3]); // ~2
```
- **(range)** Creates array from range
```javascript
const utils = require('leadutils');
utils.array.range(4, 7); // [4,5,6,7]
```
- **(random)** Generate a random number
```javascript
const utils = require('leadutils');
utils.utils.random(0, 5); // 2
utils.utils.random(0, 5); // 4
```
- **(equals)** Deep equals for any type of values
```javascript
const utils = require('leadutils');
utils.utils.equals(0, 0); // true
utils.utils.equals('test', 'test'); // true
utils.utils.equals([1, 2], [1, 2]); // true
utils.utils.equals([1, 2], [1, 2, 3]); // false
utils.utils.equals({ a: true, b: { foo: true } }, { a: true, b: { foo: true } }); // true
utils.utils.equals({ a: true, b: { foo: true } }, { a: true, b: { foo: true, bar: true } }); // false
```
- **(prettyBytes)** Return more readable bytes format
```javascript
const utils = require('leadutils');
utils.utils.prettyBytes(10000000); // 10 MB
utils.utils.prettyBytes(1); // 1 B
```
- **(mostPerformant)** Select fastest method
```javascript
const utils = require('leadutils');
utils.utils.mostPerformant([() => 1 + 2, () => 1 * 2, () => 1 / 2, () => 1 - 2]); // ~0
```
- **(timeTaken)** Log execution time
```javascript
const utils = require('leadutils');
utils.utils.timeTaken((a, b) => a + b)(2 + 3); // return 5; log => timeTaken: 0.297ms
```
</details>
<details>
<summary width="100%">Async programming module | <b>.async</b></summary><br/>
```ts
function delay(msec: number, signal?: EventEmitter): Promise<void>;
function timeout(msec: number, signal?: EventEmitter): Promise<void>;
```
- **(delay)** Promise resolve after provided msec, with abort controller
```javascript
const utils = require('leadutils');
utils.async.delay('10s').then(() => console.log('after delay'));
```
- **(timeout)** Promise resolve if signal was passed in provided ms, else reject
```ts
function delay(msec: number, signal?: EventEmitter): Promise<void>;
```
```javascript
const utils = require('leadutils');
utils.async.delay('10s').then(() => console.log('after delay'));
```
</details>
<details>
<summary width="100%">Network utils module | <b>.net</b></summary><br/>
- **(receiveBody)** Stream body receiver
```ts
function receiveBody(stream: IncomingMessage): Promise<Buffer | null>;
```
- **(createXML)** Create XML response
```javascript
const utils = require('leadutils');
const xmlBody = utils.net
.createXML()
.add({ loc: 'https://leadfisher.ru/', priority: 1, time: '2022-04-12' })
.add({ loc: 'https://leadfisher.ru/test', priority: 0.4, time: '2022-04-10' }).get;
// <?xml version="1.0" encoding="UTF-8"..
```
- **(intIP)** Get ip integer interpretation
```javascript
const utils = require('leadutils');
utils.net.intIP('127.0.0.1'); // 2130706433
```
- **(parseCookie)** Parse cookie from string
```javascript
const utils = require('leadutils');
let cookie = 'test=123;';
utils.net.parseCookie(cookie); // {test: 123}
```
- **(removePort)** Parse cookie from string
```javascript
const utils = require('leadutils');
utils.net.removePort('https://leadfisher.ru/api/test'); // https://leadfisher.ru
```
</details>
<details>
<summary width="100%">String manipulations utils | <b>.string</b></summary><br/>
- **(escape, escapeHTML, unescapeHTML)** Escape unfriendly characters
```javascript
const utils = require('leadutils');
utils.string.escape('https://leadfisher.ru'); // 'https:\\/\\/leadfisher\\.ru'
utils.string.escapeHTML('<script>alert("leadfisher !");</script>'); // <script>alert("leadfisher !");<script>
utils.string.unescapeHTML('<script>alert("leadfisher !");<script>'); // <script>alert("leadfisher !");</script>
```
- **(template)** String templates
```javascript
const utils = require('leadutils');
const template = utils.string.template`Hello ${'put_here'} !`;
template({ put_here: 'Alex' }); // Hello Alex !
template({ put_here: 'Admin' }); // Hello Admin !
```
- **(yesNo)** Parse user answers
```javascript
const utils = require('leadutils');
utils.string.yesNo('yes'); // true
utils.string.yesNo('y'); // true
utils.string.yesNo('n'); // false
utils.string.yesNo(''); // false
```
- **(words)** Parse all words from string
```javascript
const utils = require('leadutils');
utils.string.words('Hello word!'); // ['Hello', 'word']
```
- **(reverse)** String or Array reverse
```javascript
const utils = require('leadutils');
utils.string.reverse('Hello word!'); // !word olleH
utils.string.reverse([1, 2, 3]); // 321
```
- **(phonePrettify, phonePurify, normalizeEmail)** Phone manipulations utils
```javascript
const utils = require('leadutils');
utils.string.phonePrettify('79999999999'); // +7 (999) 999-99-99
utils.string.phonePurify('+7 (999) 999-99-99'); // 79999999999
utils.string.normalizeEmail('Test@MAIL.domain', 'Test@mail.domain'); // 321
```
- **(fileExt, fileName)** System path manipulation utils
```javascript
const utils = require('leadutils');
utils.string.fileExt('/home/user/index.js'); // js
utils.string.fileName('/home/user/index.js'); // index
```
- **(toString, fromString, isValidJSON, jsonParse)** String parsers
> jsonParse and fromString are both safe parsers
```javascript
const utils = require('leadutils');
utils.string.toString(1); // '1'
utils.string.toString(true); // 'true'
utils.string.toString(undefined); // 'undefined'
utils.string.fromString('test'); // 'test'
utils.string.toString({ foo: { boo: true } }); // '{"foo": { "boo": true }}'
utils.string.fromString('1'); // 1
utils.string.fromString('true'); // true
utils.string.fromString('undefined'); // undefined
utils.string.fromString('test'); // 'test'
utils.string.fromString('{"foo": { "boo": true }}'); // { foo: { boo: true } }
utils.string.isValidJSON('{}'); // true
utils.string.jsonParse('{}'); // {}
utils.string.jsonParse(''); // null
utils.string.jsonParse(123); // null
utils.string.isValidJSON({}); // false
```
</details>
<details>
<summary width="100%">Objects manipulation utils | <b>.obj</b></summary><br/>
- **(deepClone)** Clone object with all nested objects, no reference copies
```javascript
const utils = require('leadutils');
const test = { foo: { boo: { bar: 2 } } };
const copy = utils.obj.deepClone(test);
copy.foo.boo.bar = 0;
console.dir(test.foo.boo, copy.foo.boo); // { bar: 2 }; { bar: 0 };
```
- **(deepFreeze)** Freeze Object with all nested objects
```javascript
const utils = require('leadutils');
const test = { foo: { boo: { bar: 2 } } };
utils.obj.deepFreeze(test);
test.foo.boo.bar = 0;
console.dir(test.foo.boo); // { bar: 2 };
```
- **(deepFlatten)** Put nested array items in root array
```javascript
const utils = require('leadutils');
const test = [[1, 2, 3], [4, 5], 6, 7];
utils.obj.deepFlatten(test); // new [1,2,3,4,5,6,7]
```
- **(deepFlattenObject)** Put all nested objects properties in root object
```javascript
const utils = require('leadutils');
const test = { foo: { boo: { bar: 2 } } };
utils.obj.deepFlattenObject(test); // new {'foo.boo.bar': 2}
```
- **(dig)** Search for properties deep inside object
```javascript
const utils = require('leadutils');
const test = { foo: { boo: { bar: 2 } } };
const bar = utils.obj.dig('bar', test);
console.dir(bar); // 2;
```
</details>
<details>
<summary width="100%">Object orientated programming | <b>.oop</b></summary><br/>
- **(setDefault)** Overload operator `[]` to return default value if key not fount in object
```javascript
const utils = require('leadutils');
const test = { foo: { boo: { bar: 2 } } };
const bar = utils.oop.setDefault(test, 'not found');
console.log(bar['some key']); // not found
```
- **(defineGetter)** Add getter to object
```javascript
const utils = require('leadutils');
const test = { foo: { boo: { bar: 2 } } };
const bar = utils.oop.defineGetter(test)('key', () => 'value');
console.dir(bar.key); // value
```
- **(defineSetter)** Add setter to object
```javascript
const utils = require('leadutils');
const test = { foo: { boo: { bar: 2 } } };
const bar = utils.oop.defineSetter(test)('key', value => console.log(value));
bar.key = 3; // 3;
```
- **(mixin)** Mix two objects together, with optimization
```javascript
const utils = require('leadutils');
const test = { foo: { boo: { bar: 2 } } };
utils.oop.mixin(test, { bus: { foo: 4 }, foo: 3 });
// test = { foo: { boo: { bar: 2 } }, bus: { foo: 4 } }
```
</details>
<details>
<summary width="100%">Functional programming | <b>.fp</b></summary><br/>
- **(pipe, pipeAsync)** Combine multiple functions into one
```javascript
const utils = require('leadutils');
const pipeMagic = utils.fp.pipe(
v => v + 1,
v => v * 3,
v => console.log(v),
);
pipeMagic(0); // 3
```
- **(curry)** Function call after all arguments have been provided
```javascript
const utils = require('leadutils');
const test = utils.fp.curry((a, b, c, d) => a + b + c + d);
test(1)(2)(3, 4); // 10
```
- **(once)** Limit count of function calls to single one
```javascript
const utils = require('leadutils');
const test = utils.fp.once((a, b, c, d) => a + b + c + d);
test(1, 2, 3, 4); // 10
test(1, 2, 3, 4); // undefined
```
- **(times)** Call function multiple times
```javascript
const utils = require('leadutils');
const ctx = { count: 0 };
utils.fp.times(5, (ctx, i) => (ctx.count += i), ctx);
// ctx.count === 5
```
- **(memoize)** Cache wrapper for functions
```javascript
const utils = require('leadutils');
const test = utils.fp.memoize((a, b, c, d) => a + b + c + d);
test(1, 2, 3, 4); // cache hit
test(1, 2, 3, 4); // cached value
```
- **(chain)** Chain functions to custom context, after all calls returns provided context
```javascript
const utils = require('leadutils');
const ctx = { counter: 0 };
const chain = utils.fp.chain(ctx);
ctx.add = chain(v => (chain += v));
ctx.add(1).add(2).add(3).add(4).counter; // 10
```
- **(debounce)** It ensures that one notification is made for an event that fires multiple times.
```javascript
const utils = require('leadutils');
const debounceTest = utils.fp.debounce(() => console.log('Working'), 1000);
debounceTest();
debounceTest();
// working
setTimeout(() => debounceTest(), 1000);
// working
```
- **(throttle)** It will reduce the notifications of an event that fires multiple times.
```javascript
const utils = require('leadutils');
const throttleTest = utils.fp.throttle(() => console.log('Working'), 1000);
throttleTest();
throttleTest();
// working
setTimeout(() => throttleTest(), 1000);
// working
```
</details>
<details>
<summary width="100%">Crypto utils | <b>.crypto</b></summary><br/>
- **(hashPassword)** Asynchronous password hashing
```javascript
const utils = require('leadutils');
utils.crypto.hashPassword('secret').then(hash => console.log(hash));
// $scrypt$N=32768,r=8,p=1,maxmem=67108864$wgAA6YiiNmz2iJUx6kAvjh+cSZc7pbCvQW7r5Z2fWbs$gN84NkBtXtwoL3LZXMJEjeLoRlNjyZUV5joX+Fedk5bhE6cK2mcwpRVJV5ymcGq66NSNXAB63duDWS1eCbO3hA
```
- **(validatePassword)** Asynchronous password validation
```javascript
const utils = require('leadutils');
const hash =
'$scrypt$N=32768,r=8,p=1,maxmem=67108864$wgAA6YiiNmz2iJUx6kAvjh+cSZc7pbCvQW7r5Z2fWbs$gN84NkBtXtwoL3LZXMJEjeLoRlNjyZUV5joX+Fedk5bhE6cK2mcwpRVJV5ymcGq66NSNXAB63duDWS1eCbO3hA';
utils.crypto.validatePassword('secret', hash).then(flag => console.log(flag)); // true
utils.crypto.validatePassword('hacker', hash).then(flag => console.log(flag)); // false
```
</details>
<h2 align="center">Copyright & contributors</h2>
<p align="center">
Copyright © 2023 <a href="https://github.com/LeadFisherSolutions/Leadutils/graphs/contributors">Leadfisher contributors</a>.
Leadutils is <a href="./LICENSE">MIT licensed license</a>.<br/>
Leadutils is one of <a href="https://github.com/LeadFisherSolutions">leadfisher solutions</a>.
</p>
| [Node js] Common.js | Universal task scripts | javascript,nodejs,utilities,zero-dependencies,leadfisher,common | 2023-05-06T20:39:39Z | 2023-06-02T19:13:09Z | 2023-06-02T19:13:09Z | 1 | 0 | 28 | 0 | 0 | 2 | null | MIT | JavaScript |
mutonic/Portfolio_Microverse | master | <a name="readme-top"></a>
<div align="center">
<h3><b>Portfolio</b></h3>
</div>
<!-- TABLE OF CONTENTS -->
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ (OPTIONAL)](#faq)
- [📝 License](#license)
<!-- PROJECT DESCRIPTION -->
# 📖 Portfolio project <a name="about-project"></a>
This project aims to create a personal portfolio website using HTML and CSS. The main goal of the website is to showcase the projects that I have completed in the past, highlighting the skills that I have developed. In addition, the website will also feature a contact form that allows visitors to get in touch with me for potential future collaborations. The website will serve as a digital representation of my work and skills, helping me to establish my professional online presence.
(<a href='https://www.loom.com/share/19cafb10af5446f0bd9c6ec185404b08'>Here is my presentation of the current project, including the challenges I have encountered and my plans for future improvements.</a>)
## 🛠 Built With <a name="built-with"></a>
### Tech Stack <a name="tech-stack"></a>
<details>
<summary>HTML</summary>
<ul>
<li><a href="https://reactjs.org/">HTML</a></li>
</ul>
</details>
<details>
<summary>CSS</summary>
<ul>
<li><a href="https://learn.shayhowe.com/html-css/adding-media/">CSS</a></li>
</ul>
</details>
<details>
<summary>Git</summary>
<ul>
<li><a href="https://git-scm.com/docs/git#_git_commands">Git</a></li>
</ul>
</details>
## 🚀 Live Demo <a name="live-demo"></a>
- <a href="https://mutonic.github.io/Portfolio_Microverse/" >Live Demo </a>
<!-- Features -->
### Key Features <a name="key-features"></a>
- **Project Showcase**
- **Skills**
- **Mobile responsive**
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- GETTING STARTED -->
## 💻 Getting Started <a name="getting-started"></a>
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
### Setup
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
- npm
- Node.js
- Terminal
- Code editor
- Linters files
Example command:
Clone this repository to your desired folder:
```sh
cd my-folder
git clone git@github.com:mutonic/Portfolio_Microverse.git
```
### Install
Install this project with:
```sh
npm install --save-dev stylelint@13.x stylelint-scss@3.x stylelint-config-standard@21.x stylelint-csstree-validator@1.x
```
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- AUTHORS -->
## 👥 Authors <a name="authors"></a>
👤 **Author1**
- GitHub: [@mutonic](https://github.com/mutonic)
- Twitter: [@twitterhandle](https://twitter.com/cedricmtoni)
- LinkedIn: [LinkedIn](https://linkedin.com/in/mutoni-cedric/)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- FUTURE FEATURES -->
## 🔭 Future Features <a name="future-features"></a>
- [ ] **Annimation**
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- CONTRIBUTING -->
## 🤝 Contributing <a name="contributing"></a>
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- SUPPORT -->
## ⭐️ Show your support <a name="support"></a>
If you liked this project, don't hesitate to give it a star to support it
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- ACKNOWLEDGEMENTS -->
## 🙏 Acknowledgments <a name="acknowledgements"></a>
I would like to thank Microverse for their great curriculum and my collegues at Microverse
## 📝 License <a name="license"></a>
This project is [MIT](./LICENSE) licensed.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
| This repository serves as a portfolio, featuring a collection of projects I have completed. It showcases the skills I have utilized in these projects and provides information on how to get in touch with me for potential collaboration opportunities. | css,html,javascript | 2023-04-26T12:02:28Z | 2023-07-20T06:19:42Z | null | 3 | 15 | 107 | 0 | 0 | 2 | null | MIT | CSS |
Luiscarlosvd/To-do-list | main | <h1>To Do List Project</h1>
<a name="readme-top"></a>
<!-- TABLE OF CONTENTS -->
# 📗 Table of Contents
- [📗 Table of Contents](#-table-of-contents)
- [📖 To Do List](#-to-do-list)
- [🛠 Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Key Features ](#key-features-)
- [🚀 Live Demo ](#-live-demo-)
- [💻 Getting Started ](#-getting-started-)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#deployment)
- [👥 Author ](#-author-)
- [🔭 Future Features ](#-future-features-)
- [Walkthrough ](#walkthrough-)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [📝 License ](#-license-)
<!-- PROJECT DESCRIPTION -->
# 📖 To Do List<a name="about-project"></a>
In this project I am creating a to-do list for your day to day! 😎
## 🛠 Built With <a name="built-with"></a>
### Tech Stack <a name="tech-stack"></a>
- HTML
- JS
- CSS
<details>
<summary>Client</summary>
- HTML<br>
- JS<br>
- CSS
</details>
<details>
<summary>Server</summary>
- Null
</details>
<details>
<summary>Database</summary>
- Null
</details>
### Key Features <a name="key-features"></a>
- **Responsive Design**
- **List with tasks**
- **List created Dynamically with JS**
<!-- LIVE DEMO -->
## 🚀 Live Demo <a name="live-demo"></a>
> You can watch the live demo [here](https://luiscarlosvd.github.io/To-do-list/)
<!-- - No live demo available yet -->
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- GETTING STARTED -->
## 💻 Getting Started <a name="getting-started"></a>
To get a local copy up and running, follow these steps.
### Prerequisites
- A web browser
- A code editor
- A terminal
### Setup
Clone this repository to your desired folder:
```sh
git clone https://github.com/Luiscarlosvd/To-do-list.git
```
### Install
Install this project with:
```sh
cd To-do-List
npm install
```
### Usage
To run the project, execute the following command:
```sh
npm run dev
```
### Run tests
To run tests, run the following command:
- no tests available
<!--
Example command:
```sh
bin/rails test test/models/article_test.rb
```
--->
### Deployment
> Comming Soon...
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- AUTHORS -->
## 👥 Author <a name="authors"></a>
👤 Luis Valera
- GitHub: [@Luiscarlosvd](https://github.com/Luiscarlosvd)
- Twitter: [@Luiscarlosvd29](https://twitter.com/Luiscarlosvd29)
- LinkedIn: [Luis Valera](https://www.linkedin.com/in/luis-valera-6a5749267/)
## 🔭 Future Features <a name="future-features"></a>
- **More styling 😁**
- **Add dragging functions👌**
- **More Functionalities 😎**
## Walkthrough <a name="walkthrough"></a>
> Comming Soon...
<!-- CONTRIBUTING -->
## 🤝 Contributing <a name="contributing"></a>
Contributions, issues, and feature requests are welcome!
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- SUPPORT -->
## ⭐️ Show your support <a name="support"></a>
If you like this project, give it a ⭐️!
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 🙏 Acknowledgments <a name="acknowledgements"></a>
I would like to thank Microverse for giving me the opportunity to learn and grow as a developer. Also, I would like to thank my family and my girlfriend, they are all my support. ✨
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- LICENSE -->
## 📝 License <a name="license"></a>
This project is [MIT](./LICENSE) licensed.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
| A to-do list web page that allows users to save tasks and track completed tasks. Users can add, delete, modify and complete tasks. Built with JavaScript, HTML and CSS. | css,html,javascript | 2023-05-02T15:27:34Z | 2023-05-11T16:06:35Z | null | 2 | 6 | 44 | 2 | 0 | 2 | null | MIT | JavaScript |
RileyManda/html5-portfolio-website | main | <a name="readme-top"></a>
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [🔑 Key features](#key-features)
- [🛢 Live Demo](#live-demo)
- [🎥 Project Presentation](#project-presentation)
- [👥 Authors](#authors)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
-- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ](#faq)
- [📝 License](#license)
# 📖 [Portfolio-website] <a name="Portfolio-website"></a>
**[Portfolio-website]** Portfolio project built to showcase my skills and experience with HTML CSS semantics, git-flow, setup of linters, and code reviews and PR, as well as working with feature branches in a collaboration environment. The portfolio is a translation of a Figma UX design provided with stipulated requirements testing my attention to detail, ability to parse Figma design, and the use of grid layout and flexbox for responsive web design. The portfolio was developed with a mobile-first approach and RWD was implemented to support desktop with media queries and grid layout.
## 🛠 Built With <a name="built-with"></a>
### Tech Stack <a name="tech-stack"></a>
<summary>Javascript runtime environment</summary>
<ul>
<li><a href="https://nodejs.org/en/">Node JS</a></li>
</ul>
<summary>Version control</summary>
<ul>
<li><a href="github.com">Git Hub</a></li>
</ul>
<summary>Github Pages</summary>
<ul>
<li><a href="https://pages.github.com/">Github Pages</a></li>
</ul>
</details>
<!-- Features -->
### Key Features <a name="key-features"></a>
- **[Responsive Website]**
- **[Works Section]**
- **[About Section]**
- **[Contact Section]**
- **[Mobile Menu]**
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- LIVE DEMO -->
## 🚀 Live Demo <a name="live-demo"></a>
- [Live Demo Link](https://rileymanda.github.io/portfolio-website/)
## 🚀 Project Presentation <a name="project-presentation"></a>
- [Project Presentation](https://www.loom.com/share/e96865e13e3b4e0883dc48cd1c7e7d62)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- GETTING STARTED -->
## 💻 Getting Started <a name="getting-started"></a>
Creating your first "Portfolio-website" project
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
-A Git hub account
<br>
-Node JS
<br>
-Visual Studio Code or any other code editor of your preference
<br>
-web browser
### Setup
Clone this repository to your desired folder:<br>
```sh
cd my-folder
git clone git@github.com:RileyManda/portfolio-website.git
```
Advantages of Linters:<br>
1: improves readability-it will be easy to read and make adjustment if required easily.<br>
2:removes silly errors before execution and code review.<br>
3:Makes code look like written by a single person.<br>
4:Spreads awareness and ownership over code quality<br>
5:Having more secure and performant code.<br>
## Install Linters
You can find linters for most of the programming languages, e.g. Rubocop for Ruby or ESLint for JavaScript.
Also, there are many ways you can integrate a linter in your workflow:
-text editor plugin<br>
-GitHub Actions<br>
-GitHub apps<br>
## Set up Linters
**Note:** The npm package manager is going to create a node_modules directory to install all of your dependencies. You shouldn't commit that directory. To avoid that, you can create a .gitignore file and add node_modules to it:
# .gitignore
node_modules/
## Web Hint
This is a customizable linting tool that helps you improve your site's accessibility, speed, cross-browser compatibility, and more by checking your code for best practices and common errors.
**NOTE:** If you are using Windows, make sure you initialize npm to create `package.json` file.
```
npm init -y
```
1. Run
```
npm install --save-dev hint@7.x
```
_how to use npm: (https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)._
2. Copy [.hintrc](.hintrc) to the root directory of your project.
3. **Do not make any changes in config files - they represent style guidelines that you share with your team - which is a group of all Microverse students.**
- If you think that change is necessary - open a [Pull Request in this repository](../README.md#contributing) and let your code reviewer know about it.
4. Run
```
npx hint .
```
5. Fix validation errors.
### [Stylelint](https://stylelint.io/)
A mighty, modern linter that helps you avoid errors and enforce conventions in your styles.
1. Run
npm install --save-dev stylelint@13.x stylelint-scss@3.x stylelint-config-standard@21.x stylelint-csstree-validator@1.x
not sure how to use npm? Read this.
2. Copy .stylelintrc.json to the root directory of your project.
3. **Do not make any changes in config files - they represent style guidelines that you share with your team - which is a group of all Microverse students.**
If you think that change is necessary - open a Pull Request in this repository and let your code reviewer know about it. 4. Run npx stylelint "\*_/_.{css,scss}" on the root of your directory of your project.
5. Fix linter errors.
6. **IMPORTANT NOTE:** feel free to research auto-correct options for Stylelint if you get a flood of errors but keep in mind that correcting style errors manually will help you to make a habit of writing a clean code!
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 👥 Authors <a name="authors"></a>
👤 **Riley Manda**
- GitHub: [@RileyManda](https://github.com/RileyManda)
- Twitter: [@rilecodez](https://twitter.com/rilecodez)
- LinkedIn: [rileymanda](https://www.linkedin.com/in/rileymanda/)
## 🤝 Contributing <a name="contributing"></a>
<!-- FUTURE FEATURES -->
## 🔭 Future Features <a name="future-features"></a>
- [ ] **[Works Section]**
Works section: This section will consist of a card gallery featuring work project.
- [ ] **[About me Section]**
This feature will contain more details about me and the tech stack i am familiar with.
- [ ] **[Contact Section]**
This feature will comprise of a contact information.
- [ ] **[RWD]**
The site will be updated(Desktop Version) to utilize media queries for responsivenes to create a Desktop version.
- [ ] **[Mobile Menu Details]**
This feature will comprise of a detail view popup menu of each section of the portfolio.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- CONTRIBUTING -->
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
## ⭐️ Show your support <a name="support"></a>
If you like this project, kindly leave a comment below and share it with someone who enjoys coding! Coding is all about continuous learning and allowing yourself to be a beginner. Keep going!
<!-- ACKNOWLEDGEMENTS -->
## 🙏 Acknowledgments <a name="Microverse Inc."></a>
I'm grateful to microverse for giving me this opportunity to grow into my full potential through continuous learning and practical challenges.
Much appreciation to my Pair Coding partners for their contributions:
**Contributions:**
- Pi1998: [@Pi1998](https://github.com/Pi1998):
-Animation Transitions
- DanielAD10: [@DanielAD10](https://github.com/DanielAD10):
-Javascript click events contribution
<!-- FAQ (optional) -->
## ❓ FAQ <a name="faq"></a>
- **[Question_1]**
Do I have to use the vs code specifically?
- [Answer_1]
You can use any code editor of your chose.
- **[Question_2]**
Where can I download node JS for installation?
- [Answer_2]
Node Js can be downloaded here- https://nodejs.org/en/download/
<!-- LICENSE -->
## 📝 License <a name="license"></a>
This project is [MIT](https://choosealicense.com/licenses/mit/) licensed.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
| Portfolio project built to showcase my skills and experience with HTML CSS and Javascript semantics, git-flow, setup of linters, and code reviews and PR, as well as working with feature branches in a collaboration environment. | css3,flexbox,flexbox-grid,gitflow-workflow,grid-layout,html5,javascript | 2023-04-26T15:51:27Z | 2023-06-29T08:45:10Z | null | 3 | 42 | 319 | 0 | 1 | 2 | null | null | CSS |
antoinekllee/SummaRead | main | # SummaRead 📚✨
Introducing **SummaRead** - A Chrome extension that enhances your online reading experience by providing a clutter-free environment and AI-powered summaries. SummaRead is designed to be minimalistic, simple, straightforward, and very easy to use. It declutters articles, removes ads, and delivers quick summaries to help you stay informed and focused. Experience a more enjoyable and efficient reading journey with SummaRead, your smart reading assistant.
**Note:** This project is in its initial stages and is not yet complete. I'm actively working on improvements and new features, so stay tuned for updates!
## Key Features 🚀
<p align="center">
<img src="./assets/logo.png" width="100" height="100">
</p>
- **Clutter-Free Reading** 🧹: Automatically remove ads, pop-ups, and distracting elements from articles, leaving only the main text and relevant media.
- **AI-Powered Summaries** 🤖: Generate concise and accurate summaries of articles with the power of AI, providing an overview and saving time.
- **Customizable Appearance** 🎨: Easily switch between light and dark themes for optimal readability, and adjust text size with simple +/- buttons.
- **Quick Toggle** 🔘: Enable or disable SummaRead with a single click using the convenient toggle button in the browser toolbar.
- **Article Detection** 🔍: SummaRead automatically detects when you're viewing an article or blog post, prompting you to enable the extension.
## Tech Stack 💻
- Frontend: React.js
- Backend: Node.js
## Getting Started 🚀
### Prerequisites
- Node.js and npm installed on your machine
### Installation
1. Clone the repository
```
git clone https://github.com/antoinekllee/SummaRead.git
```
2. Navigate to the project directory
```
cd SummaRead
```
3. Install dependencies
```
npm install
```
4. Build the project
```
npm run build
```
5. Load the extension in Chrome
- Open the Chrome Extensions page (`chrome://extensions/`)
- Ensure that the "Developer mode" toggle is turned on in the top right corner
- Click the "Load unpacked" button in the top left corner and select the `dist` folder in your project directory
6. Start the development server with live reloading (optional)
```
npm start
```
Note: To see the live-reloaded changes, you will need to manually reload the extension in Chrome after each build. To do this, click the "Reload" button (circular arrow) on your extension card in the `chrome://extensions/` page.
## License 📄
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.
Experience the power of AI-based summarization and a clean reading experience with **SummaRead**! 🎉📖
| SummaRead combines the simplicity of a clean reading mode with the intelligence of AI-based summarization, transforming the way you engage with online content. | chrome-extension,javascript,nodejs,reactjs,typescript,webpack | 2023-05-07T07:55:17Z | 2023-05-07T11:32:36Z | null | 1 | 0 | 11 | 0 | 0 | 2 | null | MIT | TypeScript |
BahirHakimy/the-sky | main | <a name="readme-top"></a>
<!-- TABLE OF CONTENTS -->
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Usage](#usage)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)
<!-- PROJECT DESCRIPTION -->
# 📖 The Sky <a name="about-project"></a>
**The Sky** A weather forecast app built with `React JS`, It has a cool design/UI and it shows the weather based on user's location, It also has the search functionality for searching for a specific city's weather condition and forecast..
## 🛠 Built With <a name="built-with"></a>
### Tech Stack <a name="tech-stack"></a>
<details>
<summary>Client</summary>
<ul>
<li>HTML</li>
<li>CSS</li>
<li>Javascript</li>
<li>React Js</li>
</ul>
</details>
<details>
<summary>Server</summary>
<ul>
<li>Node js</li>
</ul>
</details>
<details>
<summary>Database</summary>
<ul>
<li>N/A</li>
</ul>
</details>
<!-- Features -->
### Key Features <a name="key-features"></a>
- **Clean Design**
- **Responsive**
<p align="right"><a href="#readme-top">👆</a></p>
<!-- LIVE DEMO -->
## 🚀 Live Demo <a name="live-demo"></a>
- [Live](https://the-sky.onrender.com/)
## Watch the walkthrough here:
- [Loom Walkthrough](https://www.loom.com/share/ea2139b9149b46659a398dfdd58e5888)
<p align="right"><a href="#readme-top">👆</a></p>
<!-- Getting Started -->
## 💻 Getting Started <a name="getting-started"></a>
To run the project locally, follow these steps.
### Prerequisites
In order to run this project you need to:
- Install [Git](https://git-scm.com/)
- Install [Node](https://nodejs.org/en/)
- Install a code editor, I suggest [VsCode](https://code.visualstudio.com/)
### Setup
Clone the repo into your local machine:
```bash
git clone https://github.com/BahirHakimy/the-sky.git
```
Install the dependencies using npm:
```bash
npm install
```
### Usage
To start the development server run
```bash
npm start
```
- this command will start the development server on `localhost:3000` address
To create and optimized production build run
```bash
npm run build
```
- this command will create a bunduled chunks of code inside `build/` folder
<p align="right"><a href="#readme-top">👆</a></p>
<!-- AUTHORS -->
## 👥 Authors <a name="authors"></a>
👤 **Bahir Hakimi**
- [<img src="https://i.stack.imgur.com/gVE0j.png" width='20'/> LinkedIn](https://www.linkedin.com/in/bahir-hakimy)
- [<img src="https://cdn-icons-png.flaticon.com/512/281/281769.png" width='20'/> Email](mailto:bahirhakimy2015@gmail.com)
- [<img src="https://upload.wikimedia.org/wikipedia/commons/thumb/4/4f/Twitter-logo.svg/2491px-Twitter-logo.svg.png" width='20'/> Twitter](https://twitter.com/bahir_hakimy)
<p align="right"><a href="#readme-top">👆</a></p>
<!-- FUTURE FEATURES -->
## 🔭 Future Features <a name="future-features"></a>
- **Animations and transitions** :eyes:
- **Design enhancements** :eyes:
<p align="right"><a href="#readme-top">👆</a></p>
<!-- Contributing -->
## 🤝 Contributing <a name="contributing"></a>
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
<p align="right"><a href="#readme-top">👆</a></p>
<!-- Show your support -->
## ⭐️ Show your support <a name="support"></a>
If you like this project leave a start for it.
<p align="right"><a href="#readme-top">👆</a></p>
<!-- ACKNOWLEDGEMENTS -->
## 🙏 Acknowledgments <a name="acknowledgements"></a>
I would like to thank Microverse for helping me in my journey to become a Fullstack developer 🌹
<p align="right"><a href="#readme-top">👆</a></p>
<!-- LICENSE -->
## 📝 License <a name="license"></a>
This project is [MIT](./LICENSE) licensed.
<p align="right"><a href="#readme-top">👆</a></p>
| A beautifully made weather app that shows the weather condition based on the users location, it uses Open Weather api to fetch weather data. | javascript,react,reactjs,tailwindcss | 2023-04-24T19:04:26Z | 2023-05-08T18:33:19Z | null | 1 | 2 | 15 | 0 | 0 | 2 | null | MIT | JavaScript |
codersreign/Javascript-Resources | main | # JAVSCRIPT RESOURCES
If you want to go for the best beginner-friendly documentation for JavaScript, click [here](https://javascript.info/).
## Topics Wise Notes
- [Callback, Callback Hell and Pyramid of Doom](https://github.com/codersreign/Javascript-Resources/blob/main/callbacks.md)
- [Promises](https://github.com/codersreign/JAVSCRIPT-RESOURCES/blob/main/promises.md)
- [Async Await](https://github.com/codersreign/JAVSCRIPT-RESOURCES/blob/main/async-await.md)
- [Event Loop](https://github.com/codersreign/JAVSCRIPT-RESOURCES/blob/main/event-loop.md)
- [Closure](https://github.com/codersreign/Javascript-Resources/blob/main/closure.md)
- [Hoisting](https://github.com/codersreign/Javascript-Resources/blob/main/closure.md)
- [Fetch API](https://github.com/codersreign/JAVSCRIPT-RESOURCES/blob/main/fetch-api.md)
- [XHR](https://github.com/codersreign/JAVSCRIPT-RESOURCES/blob/main/XHR.md)
- [ES6 Modules](https://github.com/codersreign/JAVSCRIPT-RESOURCES/blob/main/es6-modules.md)
- [Debouncing](https://github.com/codersreign/JAVSCRIPT-RESOURCES/blob/main/debouncing.md)
- [Throttling](https://github.com/codersreign/Javascript-Resources/blob/main/throttling.md)
- [Cors](https://github.com/codersreign/Javascript-Resources/blob/main/cors.md)
| The purpose of this repository is to serve as a comprehensive collection of valuable resources for JavaScript. The objective is to create an encyclopedia-like reference for everything related to JavaScript. | javascript | 2023-05-10T07:42:38Z | 2023-06-27T17:34:50Z | null | 1 | 0 | 11 | 0 | 0 | 2 | null | null | null |
GolovanovAlex/Repaire_Landing | master | # Repaire Landing
### Use Skills
---
[Demo Link <br>](https://golovanovalex.github.io/Repaire_Landing/)
## Info
Источник макета Telegram-канал [FIGMA | Макеты для верстки](https://t.me/+oXZSKMmXp6UyOGI6)
Данная верстка, была реализована пользователем.
Работа с **HTML**, **CSS** и **JS**.
Использование препроцессинга **SASS**, модуль гибкого контейнера **Flexbox**, сборщика **Gulp**. Слайдера **Swiper**.
Пройдена валидация HTML и CSS.
При помощи Telegram-бота [FIGMA | 💵 Верстай за деньги](https://t.me/HtmlCodeForMoney_bot) получил оплату за верстку этого макета.
---
Респонсивный дизайн адаптирует сайт под любой экран устройства.
 
---
## Contacts
[](https://github.com/GolovanovAlex)
[](https://t.me/GolovanovAlex)
[](https://codepen.io/AlexGolovanov)
- 📧 My Email: <a href="mailto:golovanov.a.a@yandex.ru" >Golovanov.a.a@yandex.ru</a>
- 📜 My Website: [alexgolovanov.ru](http://alexgolovanov.ru)
<sub> Made with </sub>💙
| Landing. Layout. Responsive. Макет для верстки сайта был взял с телеграм канала FIGMA | Макеты для верстки. | javascript,landing-page,responsive,scss | 2023-05-11T08:41:05Z | 2023-05-23T10:29:11Z | null | 1 | 0 | 57 | 0 | 0 | 2 | null | null | SCSS |
CaptainBawa/Bookstore | development | <a name="readme-top"></a>
<div align="center">
<img src="LinkedIn Cover Main.jpg" alt="logo" width="100%" height="auto" />
<br/>
<h3><b>Bookstore App</b></h3>
</div>
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Deployment](#triangular_flag_on_post-deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)
# 📖 Bookstore<a name="about-project"></a>
**Bookstore** is a powerful application that allows users to seamlessly manage their book collection. By leveraging an external API, the project enables users to fetch and post books effortlessly. Users can add new books to their library, edit book details, and remove unwanted books, all while seamlessly synchronizing the data with the external API. Additionally, the project provides a visual representation of the user's reading progress, allowing them to track their advancement through each book. With its intuitive interface and API integration, the React Bookstore project offers a streamlined and efficient book management experience.
## 🛠 Built With <a name="built-with"></a>
### Tech Stack <a name="tech-stack"></a>
<details>
<summary>Client</summary>
<ul>
<li><a href="https://reactjs.org/">React.js</a></li>
<li><a href="https://www.css3.com/">CSS</a></li>
</ul>
</details>
<details>
<summary>Server</summary>
<ul>
<li><a href="https://dashboard.render.com/">Render</a></li>
</ul>
</details>
<details>
<summary>Database</summary>
<ul>
<li><a href="https://us-central1-bookstore-api-e63c8.cloudfunctions.net/bookstoreApi/apps/wNk7XH3cKH6OpVXSi7sW/books">Bookstore API</a></li>
</ul>
</details>
### Key Features <a name="key-features"></a>
- **Add Book**
- **Remove Book**
- **Edit Book**
- **View Progress**
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 🚀 Live Demo <a name="live-demo"></a>
- [Live Demo Link](https://bootstore-0ouz.onrender.com/)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 💻 Getting Started <a name="getting-started"></a>
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
- [ ] git version 2.38.x
- [ ] node.js version > 12.x
- [ ] IDE
- [ ] browser (chrome, firefox, edge, safari)
### Setup
Clone this repository to your desired folder:
```sh
cd my-folder
git clone git@github.com:CaptainBawa/Bookstore.git
```
### Install
Install this project with:
```sh
cd Bookstore
npm install/npm i
```
### Usage
To run the project, execute the following command:
```sh
Live server
```
### Deployment
You can deploy this project using:
This project is deployed at Render.com, you can clone it here.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 👥 Authors <a name="authors"></a>
👤 **Collins Bawa**
- GitHub: [@CaptainBawa](https://github.com/CaptainBawa)
- Twitter: [@BawaCollins](https://twitter.com/BawaCollins)
- LinkedIn: [@captainbawa](https://www.linkedin.com/in/captainbawa/)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 🔭 Future Features <a name="future-features"></a>
- [ ] **Add Styles**
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 🤝 Contributing <a name="contributing"></a>
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/CaptainBawa/Bookstore/issues).
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## ⭐️ Show your support <a name="support"></a>
Dear Viewers!
I'm excited to be working on this project and I would be grateful for your support! By supporting this project, you are not only helping me, but you are also contributing to something meaningful that can make a difference. Your support will give me the motivation and resources necessary to keep moving forward with this project and to ensure its success. So, whether it's through your kind words, by giving a star if you like this project, your financial support, or simply by spreading the word, your support means everything to me. Thank you in advance for your support, and I can't wait to share with you the amazing things we will achieve together.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 🙏 Acknowledgments <a name="acknowledgements"></a>
I would like to thank the Microverse full-stack curriculum for the inspiration and guidance.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 📝 License <a name="license"></a>
This project is [MIT](https://github.com/CaptainBawa/Bookstore/blob/development/LICENSE) licensed.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
| is a powerful application that allows users to seamlessly manage their book collection. By leveraging an external API, the project enables users to fetch and post books effortlessly. Users can add new books to their library, edit book details, and remove unwanted books, all while seamlessly synchronizing the data with the external API. | api,css,javascript,reactjs | 2023-05-11T12:03:35Z | 2023-06-08T16:39:39Z | null | 1 | 5 | 24 | 0 | 0 | 2 | null | MIT | JavaScript |
ViniciusCuest/Infinity-squad-website | main |
# Infinity Landing Page
Landing Page | Infinity Squad.
## Features
`Done ->`
- Project preset
`In Progress`
- Figma Design
## Authors
- [@ViniciusCuest](https://github.com/ViniciusCuest)
- [@Elias](https://github.com/EliasBRodrigues)
- [@João Jesus](https://github.com/jpfcordeiro)
- [@Kaio]
## License
[MIT](https://choosealicense.com/licenses/mit/)
## Tech Stack
**Front-end** `HTML`, `CSS`, `Javascript`
## 🛠 Skills
Html, Css, Javascript, Figma, Design Patterns, Pixel Perfect Git...
| null | css,html,javascript,resposive-layout,ajax,jquery,php | 2023-05-04T15:42:53Z | 2023-06-12T01:19:01Z | null | 3 | 2 | 44 | 0 | 0 | 2 | null | MIT | PHP |
JLpensador/Pokedex | main | # Pokedex
Uma pokedex da série de jogos e filmes Pokemon.
<br>Feito com Html, Css, e JavaScript
<br> <br>
| Uma pokedex da série de jogos e filmes Pokemon. Feito com Html, Css, e JavaScript | css,css3,html,html-css,html-css-javascript,html5,javascript | 2023-05-01T20:52:19Z | 2023-10-25T15:32:38Z | null | 1 | 0 | 14 | 0 | 0 | 2 | null | null | CSS |
Amadeo-Frontend/BonDevs_dalle | main |
<h1 align="center"> BonDevs_dalle Image Generator</h1>
<div align="center">
LIVE: https://bondevs-dalle.onrender.com/
</div>
</br>
<div style="display: inline_block" align="center">
<img align="center" alt="Amadeo-HTML" height="45" width="45" src="https://raw.githubusercontent.com/devicons/devicon/master/icons/html5/html5-original.svg">
<img align="center" alt="Amadeo-CSS" height="45" width="45" src="https://raw.githubusercontent.com/devicons/devicon/master/icons/css3/css3-original.svg">
<img align="center" alt="Amadeo-JavaScript" height="45" width="45" src="https://github.com/Amadeo-Frontend/devicon/blob/master/icons/javascript/javascript-original.svg">
<img align="center" alt="Amadeo-VScode" height="45" widith="45" src="https://github.com/Amadeo-Frontend/devicon/blob/master/icons/nodejs/nodejs-original.svg">
<img align="center" alt="Amadeo-parcel" height="45" widith="45" src="https://github.com/Amadeo-Frontend/images_sites/blob/main/32607881.png">
</div>
</br>
#
<div align="center">
</div>
| null | css,html,javascript,node,parcel | 2023-05-04T20:04:54Z | 2023-05-06T05:44:28Z | null | 1 | 0 | 12 | 0 | 0 | 2 | null | null | CSS |
Shanky43/subdued-stocking-2928 | main | # subdued-stocking-2928
#1mg Project
# Tata | 1mg
## Badges
[](https://flourishing-lollipop-9ef694.netlify.app/)
Health Cube is a healthcare platform based in Bangalore, India. It provides a range of services, including online doctor consultation, lab tests, health packages, and health content. It was founded in 2023 by a team of experienced doctors and entrepreneurs with the aim of making healthcare more accessible and affordable to people across India.
## API Screenshots
## Technologies We Used
- React.js
- Chakra UI
- JavaScript
- React-Redux
- Browser LocalStorage
- npm and JSON Server
- import export ,Debouncing ,Dom , ES6.
- MongoDB
- MongoDB ATLAS
## Features
- SignIn and SignUp functionality.
- Navbar for easy navigation between pages.
- Search Products functionality and Geolocation
- Product Page with lots of filtering and Sorting options.
- Detailed product page with add-to-cart functionality.
- Cart page to manage product lists that user wants to buy.
- Checkout page calculates the shipping prices dynamically and the Payment page with many payment options.
- My Order page to track ordered Products.
## Screenshots
A glimpse of our website
### Landing Page
The landing page where users can see various categories along with their Geolocation.
### All Product Page
User can search any products according to their needs
### SignUp/SignIn Page
Users can signup/signin based on whether the user is already registered or not.
### Product Page
Show Product data by Fetching Product data from our own database.
### Individual Product Page
A complete detailed product page which displays all the details regarding the product with other functionality .
### Cart Page
Manage All the items that are added to the cart/bag by the user
### Payment Page
On the checkout page, the user enters his shipping address and credit card details in order to place the order.
### My Order Page
Users can track their ordered product from this page
### Footer Section
There is footer page where the user see terms and condition and connected to our social sites
## Demo
[](https://vercel.com/{YOUR_USERNAME}/{YOUR_PROJECT_NAME}/deployments)
https://healthcube-bisht1418.vercel.app/
## Authors
- [Shankar S](https://github.com/Shanky43)
- [Neeraj Singh Bisht](https://github.com/bisht1418)
- [Kunjan Ballawar](https://github.com/Kunjan0)
- [Disha Gupta](https://github.com/DishaGup)
| Health Cube is a healthcare platform based in Bangalore, India. It provides a range of services, including online doctor consultation, lab tests, health packages, and health content. It was founded in 2023 by a team of experienced doctors and entrepreneurs with the aim of making healthcare more accessible and affordable to people across India. | javascript,react,reactjs,chakra-ui,express-js,javascript-vanilla,mongodb,mongoose,node-js,redux | 2023-05-02T17:47:26Z | 2023-06-19T05:04:41Z | null | 5 | 21 | 113 | 3 | 2 | 2 | null | null | JavaScript |
zbahati/Online-web-development-course | main | <a name="readme-top"></a>
<h3><b>Online Web development courses</b></h3>
</div>
<!-- TABLE OF CONTENTS -->
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#triangular_flag_on_post-deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ (OPTIONAL)](#faq)
- [📝 License](#license)
<!-- PROJECT DESCRIPTION -->
# 📖 [web development Course Project] <a name="about-project"></a>
**[Online Web development Course Project]**
The "Online Web Development Courses" project is a website that offers high-quality web development courses. It includes a Home page with a navigation menu, hero section, course list, our team and Curriculum, and an About page with information about the the courses and Our latest students projects done sections, The website also features a dynamically generated "Our Team" section using JavaScript. It has a responsive layout and follows coding best practices, ensuring it is accessible and user-friendly.
## 🛠 Built With <a name="built-with"></a>
### Tech Stack <a name="tech-stack"></a>
<details>
<summary>Client</summary>
<ul>
<li><a href="">Html</a></li>
<li><a href="">Css</a></li>
<li><a href="">JavaScript</a></li>
</ul>
</details>
<details>
<summary>Server</summary>
<ul>
<li><a href="">n/a</a></li>
</ul>
</details>
<details>
<summary>Database</summary>
<ul>
<li><a href="/">n/a</a></li>
</ul>
</details>
<!-- Features -->
### Key Features <a name="key-features"></a>
- **[use linters]**
- **[Hero section]**
- **[Course lists sections]**
- **[Our team section]**
- **[Our partners section]**
- **[Latest studend projects done ]**
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- LIVE DEMO -->
## 🚀 Live Demo <a name="live-demo"></a>
<p><a href="https://zbahati.github.io/web-development-course/">Online Web development Demo </a></p>
<p>Video to introducing the project in General: <a href="https://www.loom.com/share/82c4ab60f3e44957b7ff351bfa7c1742">click here</a>
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- GETTING STARTED -->
## 💻 Getting Started <a name="getting-started"></a>
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
- you need a laptop.
- you need github installed on it.
- You need a basic knowledge of Html and Css and JavaScript
### Setup
Clone this repository to your desired folder:
- cd my-folder
- git clone https://github.com/zbahati/web-development-course.git
### Install
Install this project with:
- cd my-project
- npm install .
### Usage
To run the project, execute the following command:
- open your local server on your computer
### Run tests
To run tests, run the following command:
- npx stylelint "**/*.{css,scss}"
- npx hint .
- npx eslint .
### Deployment
You can deploy this project using: github page's
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- AUTHORS -->
## 👥 Authors <a name="authors"></a>
👤 **Bahati zirimwabagabo**
- GitHub: [zbahati](https://github.com/zbahati)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/zirimwabagabo-bahati)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- FUTURE FEATURES -->
## 🔭 Future Features <a name="future-features"></a>
- [ ] **[Nav menu toggle on mobile devices]**
- [ ] **[Add server]**
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- CONTRIBUTING -->
## 🤝 Contributing <a name="contributing"></a>
Contributions, issues, and feature requests are welcome!
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- SUPPORT -->
## ⭐️ Show your support <a name="support"></a>
show me your support by following me on github and giving me a star please .
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- ACKNOWLEDGEMENTS -->
## 🙏1. Acknowledgments <a name="acknowledgements"></a>
1.
I would like to express my gratitude to Microverse for introducing me to their bootcamp, which has provided me with the skills and knowledge necessary to complete this project. I am incredibly grateful for the support and guidance I have received from the Microverse community throughout this process. This project has been a great opportunity for me to apply what I have learned and to showcase my abilities as a software developer. Thank you, Microverse, for empowering me to achieve my goals and for being an essential part of my journey.
## 🙏2. Acknowledgments <a name="acknowledgements"></a>
We would like to acknowledge and thank Cindy Shin for her contribution to this project. Original design idea by Cindy Shin in Behance.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- LICENSE -->
## 📝 License <a name="license"></a>
This project is [MIT](./License.md) licensed.
<p align="right">(<a href="#readme-top">back to top</a>)</p> | "Online Web Development Courses: A responsive website offering high-quality courses with dynamic 'Our Team' section. User-friendly and accessible, showcasing student projects. | css,html,javascript | 2023-04-28T04:38:26Z | 2023-04-28T20:34:05Z | null | 1 | 1 | 8 | 0 | 0 | 2 | null | MIT | HTML |
adit26data/mern-stack-final | master | # Shopper.com
# About this project
This is a full stack project revolving around an Ecommerce Site that I have named Shopper.com-One stop destination for all your shoppping desires!
This project contains all user functionality like user order, add to cart functions, review posting and shipping mechanism. This is a pet project I have made to learn and understand full stack in more depth.
## Demo Video
https://github.com/adit26data/mern-stack-final/assets/98691664/40c6200f-0aa6-4d42-a797-74584bf27bfb
# Dependencies
# for frontend
react, react-redux, react-router,react-router-dom,react-alert, react-icons, react-helmet, react-js-pagination, react-material-ui-carousel, react-rating-stars-component, redux-thunk, redux-devtools-extension, overlay-navbar,axios, mui-icons-material, react-chartjs-2, charts.js, @mui/lab, system, material,styles, emotion, stripe-js,react-stripe-js, react-scripts, react-icons,
# for backend
bcryptjs, body-parser,cookie-parser, jsonwebtoken, cloudinary, crypto, dotenv, mongoose, nodemailer, validator, nodemon, express, express-fileupload,proxy
**the dependencies might conflict so try to use the stable release of each package or use --force to make them install without errors
# In the project directory, you can run:
# npm start on 3000 port
cd frontend
Runs the app in the development mode.
Open http://localhost:3000 to view it in your browser.
The page will reload when you make changes.
You may also see any lint errors in the console.
# npm run dev
Runs app on the backend server
http://localhost:4000 is the server route
use proxy package to connect them
| Shopper.com-One stop destination for you! | backend,cloudinary-api,css3,expressjs,frontend,html5,javascript,material-ui,mongodb,nodejs | 2023-05-12T17:24:36Z | 2023-09-03T14:41:35Z | null | 1 | 0 | 74 | 0 | 0 | 2 | null | GPL-3.0 | JavaScript |
blue-sky-dev/portfolio_website | main | ## Personal Portfolio
Setup:
- run ```npm i && npm start```
| Portfolio website with resume and business card | javascript,portfolio,portfolio-website,react,reactjs | 2023-05-04T14:41:24Z | 2023-05-06T13:48:32Z | null | 1 | 0 | 29 | 0 | 0 | 2 | null | null | JavaScript |
bhpcv252/webgl-icosahedron-2-exp | main | # WebGL icosahedron experiment with perlin noise
WebGL icosahedron experiment with perlin noise; created using THREE.js and Shaders.
-------
Install dependencies:
```bash
npm i
```
Start development:
```bash
npm start
```
Build Project:
```bash
npm run build
```
| WebGL icosahedron experiment with perlin noise | perlin-noise,webgl,icosahedron,shaders,threejs,glsl,javascript | 2023-04-28T05:51:24Z | 2023-04-28T19:48:31Z | null | 1 | 0 | 3 | 0 | 0 | 2 | null | null | GLSL |
unorjikingsley/Book-Store-Website | main |
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ (OPTIONAL)](#faq)
- [📝 License](#license)
<!-- PROJECT DESCRIPTION -->
[Awesome Books](https://unorjikingsley.github.io/Book-Collection/)
> **[Awesome Books]** is a...This is a simple html page which is contains a dynamic form about Awesome books, books title, and the author. I have used HTML and Javascript for this project and you can use it in your local machine just by cloning this repo.
## 🛠 Built With <a name="built-with"></a>
- HTML
- JavaScript
This project built with the help of HTML and JavaScript.
### Tech Stack <a name="tech-stack"></a>
<details>
<summary>Client</summary>
<ul>
<li><a href="https://reactjs.org/">React.js</a></li>
</ul>
</details>
### Key Features <a name="key-features"></a>
- **[Events]**
- **[Forms]**
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- LIVE DEMO -->
## 🚀 Live Demo <a name="live-demo"></a>
- [Live Demo Link](https://unorjikingsley.github.io/Book-Store-Website/)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- GETTING STARTED -->
## 💻 Getting Started <a name="getting-started"></a>
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need: Github account, and a code editor(VS-code)
### Setup
Clone this repository to your desired folder: git clone https://github.com/unorjikingsley/Book-Store-Website.git
### Install
Install this project with:git clone https://github.com/unorjikingsley/Book-Store-Website.git
### Usage
To run the project, execute the following command: Run the index.html file with Google Chrome
### Run tests
To run tests, run the following command:
### Deployment
You can deploy this project using:git pages
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- AUTHORS -->
## 👥 Authors <a name="authors"></a>
## Authors
👤 **Unorji Kingsley**
- GitHub: [@unorjikingsley](https://github.com/unorjikingsley)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- FUTURE FEATURES -->
## 🔭 Future Features <a name="future-features"></a>.
- [ ] **[Database]**
- [ ] **[More functionality]**
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- CONTRIBUTING -->
## 🤝 Contributing <a name="contributing"></a>
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues pages](https://github.com/unorjikingsley/Book-Store-Website/issues).
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- SUPPORT -->
## ⭐️ Show your support <a name="support"></a>
If you like this project... give a star
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- ACKNOWLEDGEMENTS -->
## 🙏 Acknowledgments <a name="acknowledgements"></a>
I would like to thank Microverse for the opportunity
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- LICENSE -->
## 📝 License <a name="license"></a>
This project is [MIT](https://github.com/unorjikingsley/book-store-website/blob/main/LICENSE) licensed.
| A Book store website that records how books are been borrowed and returned. Built with HTML, CSS & JavaScript | html-css-javascript,javascript | 2023-04-24T20:51:33Z | 2023-04-30T07:28:29Z | null | 1 | 0 | 6 | 0 | 0 | 2 | null | MIT | JavaScript |
chrisworman/jump-game | master | null | Web-based 2D vertical platformer game | canvas-game,canvas2d,html5,javascript,web,2d-game,2d-platformer-game,game,game-development | 2023-04-25T02:43:12Z | 2023-10-24T21:41:29Z | 2023-10-24T21:41:29Z | 1 | 11 | 153 | 2 | 0 | 2 | null | null | JavaScript |
Variable2831/Legendary-Waffle | main | 
This be used as a starting point for anyone who is interested in learning more about JavaScript and its features. This repository provides various functions and utilities for developers to use in their own projects.
Please note that this project is still a work in progress. I am actively working on it and plan to add more features soon. If you have any suggestions or feedback, please feel free to open an issue or pull request.👍
## Table of Contents
- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#license)
## Installation
To use this code repository, simply clone or download the files to your local machine. There are no dependencies or prerequisites required for using this code.
## Usage
This repository provides a variety of JavaScript functions and utilities that you can use in your own projects. Here are some examples of the functions provided:
- `randomNumber(min, max)`: generates a random number between `min` and `max`
- `shuffleArray(array)`: shuffles the elements in an array
- `capitalizeString(str)`: capitalizes the first letter of a string
You can find the complete list of functions and utilities in the `src` directory. Each function is documented with a description, input parameters, and expected output.
To use a function in your own project, simply import the function from the appropriate file and use it in your code. For example:
import { randomNumber } from './src/random.js';
const myNumber = randomNumber(1, 10);
console.log(myNumber);
## Contributing
We welcome contributions from the community! If you would like to contribute to this repository, please fork the repository, make your changes, and submit a pull request.
## License
This code repository is licensed under the MIT License, which means you are free to use, modify, and distribute the code as long as you include the license in your project. See the `LICENSE` file for more information.
☕ [You can support me by buying me a coffee.](https://www.buymeacoffee.com/Variable2831)
| This project is an open source project created using the JavaScript programming language. It is open to the public, allowing anyone to access the source code and use or modify it as they see fit. | javascript | 2023-05-01T14:09:39Z | 2023-05-07T12:56:18Z | null | 1 | 0 | 94 | 0 | 0 | 2 | null | MIT | JavaScript |
RoshanAAS/energized-baseball-7687 | main |
<img src="https://energized-baseball-7687-roshanaas.vercel.app/static/media/BusyKids.0653874d086f04d99ce6.png" alt="Logo" title="Project Logo">
<h1><b>React Group Project</b></h1>
<h1>Name - Busy Kids</h1>
This is the Logo of the The Busy Kids website. The Busy Kids is an online Finance Teaching Website which is teaches Finance Awareness to kids and alos provides the best team of instructors. From this website, kids can learn some baisc day to day life used finance system and play some financial games.
To see the live site click the below link.
[See Live](https://energized-baseball-7687-roshanaas.vercel.app/)
<h1>Built with</h1>
React JS,
redux,
HTML,
CSS,
JavaScript,
JSON server
<h1>Used libraries</h1>
node modules,
Styled-Components,
HTML Components,
Chakra Ui,
react-router-dom
<h1>Features</h1>
Signup,
Login,
Sorting,
Searching Functionality,
filtering ,
Pagination,
Real Time Payment
Firebase authentication
| Busy Kids is a virtual bank for kids, where you can teach them about the value of money in a safe environment. Kids will learn how to budget, save up for goals and spend responsibly using our cool easy-to-use app and website, while teachers have control over the students accounts and activities. | chakra-ui,firebase,javascript,razerpay,reactjs,styled-components | 2023-05-02T18:37:23Z | 2023-05-16T19:03:17Z | null | 4 | 40 | 105 | 0 | 2 | 2 | null | null | JavaScript |
harshi0102/math-magician-project | development | <a name="readme-top"></a>
<div align="center">
<br/>
<h3><b>Math Magician Project</b></h3>
</div>
<!-- TABLE OF CONTENTS -->
# 📗 Table of Contents
- [📗 Table of Contents](#-table-of-contents)
- [📖 About the Project ](#-about-the-project-)
- [Built With](#built-with)
- [Live Demo](#live-demo)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage](#usage)
- [Run Test](#run-test)
- [Deployment](#deployment)
- [Author](#author)
- [Future Features](#future-features)
- [🤝 Contributing](#-contributing)
- [Show your support](#show-your-support)
- [Acknowledgments](#acknowledgments)
- [📝 License](#-license)
<!-- PROJECT DESCRIPTION -->
# 📖 About the Project <a name="about-project"></a>
"Math-magician" is about building Single Page application based on an external API.
I have setup the environment and tools needed to develop a React application. In the following projects,I will develop the actual application.
<!-- > Describe your project in 1 or 2 sentences. --->
Phase 1- setup branch
- [ ] The easiest way to create a React application is using Create React App (CRA) and following the instructions in this [guide](https://create-react-app.dev/docs/getting-started/).
- [ ] The application should run in the browser without errors.
Phase 2- setup2 branch
All the project requirements for the step 2 of the project - Components have been implemented:
I have created a directory called components from CRA(text,images,styles).Inside components, created a new Calculator.js file and then created a react component that matches the below design.
Phase 3- Step3 branch
I have created a new directory called logic and inside it I wrote code in calculate.js and operate.js after installing big.js using npm.I implemented click event handlers using the math logic from calculate.js and operate.js in my react component just to make my calculator buttons to work according to the funcationality i.e the button should subtract a given value when clicked on subtract button.
Phase4- Fetch API Branch
I have implemented and used external Api i.e API NINJAS and created a new component for displaying a quote .I fetched data inside of a new component that shows a loading and error state. I imported the new componenet into my main component which is next to the calculator component.
Phase5 -Full Website(Math-Magician) branch
I developed full website with three pages i.e Home, calculator and Quote. For every page, I created a to display navigation links for all 3 routes on each page. I have used react basic styling to improve the look and feel of the pages.
Phase 6-Test(Math-Magician) branch
All the requirements from the test phase of the project have been implemented as follow:
-Set up React Testing Library.
-Wrote unit tests for the files operate.js and calculate.js using Jest.
-Created unit tests for all React components:
-Used Jest snapshots to test the components.
-Used React Testing Library to simulate user interaction.
-Ran full tests suite using Jest.
## Built With
- Major languages: Javascript
- Frameworks: React.js
- Technologies used: Node.js, Babel, Jest, webpack
- Tested with: - ESLint (JavaScript linting), Stylelint (style linting)
## Live Demo
-[Click here for live demo](https://math-magician-reactproject.onrender.com/)
### Prerequisites
- Internet connection and browser
- A text editor(preferably Visual Studio Code)
- Browser
### Setup
- This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
### Install
- [Git](https://git-scm.com/downloads)
- [Node](https://nodejs.org/en/download/)
### Usage
- Clone the repository using `git clone https://github.com/harshi0102/math-magician-project.git`
- Change directory into the project folder: `cd math-magician-project`
- Run `npm install`
- Run `npm start`
- A new browser will open automatically with application loaded
## Run Test
Available Scripts
In the project directory, you can run:
`npm start`
Runs the app in the development mode.\
Open [http://localhost:3000](http://localhost:3000) to view it in your browser.
The page will reload when you make changes.\
You may also see any lint errors in the console.
`npm test`
Launches the test runner in the interactive watch mode.\
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
`npm run build`
Builds the app for production to the `build` folder.\
It correctly bundles React in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.\
Your app is ready to be deployed!
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
`npm run eject`
**Note: this is a one-way operation. Once you `eject`, you can't go back!**
If you aren't satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own.
You don't have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it.
### Deployment
- [Click here for live demo](https://math-magician-reactproject.onrender.com/)
## Author
👤 **Harshika Govind**
- GitHub: [@harshi0102](https://github.com/harshi0102)
- Twitter: [@harshika0102me](https://twitter.com/harshika0102me)
- LinkedIn: [harshikagovind](https://linkedin.com/in/harshikagovind)
👤 **Abdul-Aziz Fakhriddinov**
- GitHub: [@githubhandle](https://github.com/AFakhriddinov)
- Twitter: [@facebookhandle](https://www.facebook.com/abdulaziz.faxriddinov)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/abdul-aziz-fakhriddinov-5297a6107/)
### Future Features
- **[Make complete website]**
- **[Dynamic usage of routers for navigation in the website]**
## 🤝 Contributing
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/harshi0102/math-magician-project/issues).
## Show your support
Give a ⭐️ if you like this project!
## Acknowledgments
I would like to thank Microverse
## 📝 License
This project is [MIT](https://github.com/harshi0102/math-magician-project/blob/development/LICENSE) licensed.
| Math Magician Project-"Math-magician" is about building Single Page application based on an external API where user can perform calculations using calculator | javascript,react,reactjs | 2023-05-01T08:23:41Z | 2023-05-22T10:45:22Z | null | 2 | 6 | 71 | 0 | 0 | 2 | null | MIT | JavaScript |
sharminkhan0/My-1st-responsive-portfolio-with-html-css-js | main | <a name="readme-top"></a>
<!--
!!! IMPORTANT !!!
This README is an example of how you could professionally present your codebase.
Writing documentation is a crucial part of your work as a professional software developer and cannot be ignored.
You should modify this file to match your project and remove sections that don't apply.
REQUIRED SECTIONS:
- Table of Contents
- About the Project
- Built With
- Live Demo
- Getting Started
- Authors
- Future Features
- Contributing
- Show your support
- Acknowledgements
- License
OPTIONAL SECTIONS:
- FAQ
After you're finished please remove all the comments and instructions!
For more information on the importance of a professional README for your repositories: https://github.com/microverseinc/curriculum-transversal-skills/blob/main/documentation/articles/readme_best_practices.md
-->
<div align="center">
<!-- You are encouraged to replace this logo with your own! Otherwise you can also remove it. -->
<img src="sharmin-khan-logo-1.png" alt="logo" width="280" height="auto" />
<br/>
</div>
<!-- TABLE OF CONTENTS -->
# 📗 Table of Contents
📖 About the Project
🛠 Built With
Tech Stack
Key Feature
🚀 Live Demo
💻 Getting Started
Prerequisites
Setup
Install
Usage
Run tests
Deployment
👥 Authors
🔭 Future Features
🤝 Contributing
⭐️ Show your support
🙏 Acknowledgements
📝 License
📖 My-1st-responsive portfolio The project is designed to provide information, improve basic coding knowledge, and provide practice. Built with HTML, CSS, and JavaScript. The main objective of this project is to start practicing the professional way to work with CSS HTML and JavaScript in responsive design, using the basic structure, data query, flexbox and all following a template in Google. My-1st-responsive portfolio Project
🛠 Built With
Tech Stack
Client
Key Features
Add the linter for the project to fix the errors and clean the codeok_hand
User-friendly Interface: Simple and intuitive interface for a seamless user experience. rocket
Responsive for different devices
# 🚀 Live Demo
Live Demo Link
(https://sharminkhan0.github.io/My-1st-responsive-portfolio-with-html-css-js/)
# 💻 Getting Started
To get a local copy up and running, follow these steps.
Prerequisites
In order to run this project you need:
Visual Studio
Github
git
Setup
Clone this repository to your desired folder:
Example commands::
git clone https://github.com/sharminkhan0/My-1st-responsive-portfolio-with-html-css-js.git
Install
please first install the node package files
npm install
Usage
In order to use this project you create branch to add more feature.
But in order to run the project use below commands.
npm run build (It will create a production ready file)
npm start (It will run the server on your machine)
Run Linters
I have added linters or tests in order to avoid typos and ensure good practice in this project.So while using this repository if you need to check your work no matters have worked on html, css and js you can use below commands
In order to run the linter test on index.html or any html file. use below command
npx hint .
To run linter test on stylesheets. Use below command
npx stylelint "**/*.{css,scss}"
DDeployment
You can deploy your project using github free source. (back to top)
👥 Authors
👤 Sharmin Khan
👤 NoelLincoln
GitHub: @sharminkhan0 (back to top)
🔭 Future Features
[add more interactive buttons and sections]
[style it beautifully] (back to top)
🤝 Contributing
Contributions, issues, and feature requests are welcome!
Feel free to check the issues page.
(back to top)
⭐️ Show your support
If you like this project please don't hesitate to support me with your valued contribution and don't forget to star the repo to reach more people.
(back to top)
🙏 Acknowledgments
I would like to thank unique way of practicing how to code, and also Freecodecamp and w3school for their practical articles that helped me to make this project.
(back to top)
📝 License This project is MIT licensed.
| Following industry best practices, this individual portfolio website was painstakingly designed utilizing the most recent web technologies, such as HTML, CSS, and JavaScript. As a consequence, visitors will have a smooth user experience while viewing an attractive and engaging presentation of projects and abilitie | css-animations,css-flexbox,css-grid,css-grid-layout,css3,css3-animations,dynamic-programming,html5,javascript,linter-config | 2023-04-30T21:02:51Z | 2023-08-18T03:24:13Z | null | 1 | 5 | 97 | 0 | 0 | 2 | null | null | HTML |
gabjoao/Life-is-Strange-Page | master |
Uma Landing Page feita para estudos.
Utilizado: *HTML, CSS* e *JS*.
Foi utilizado a franquia de jogos Life is Strange, desenvolvida pela **Dontnod Entertainment**. Todo os direitos à desenvolvedora.
---
A página principal conta com as seguintes partes:
* A primeira sendo o resumo do jogo.
* A segunda sendo a apresentação dos três jogos principais da série, onde pode levar para uma página reservada para cada jogo.
* A terceira parte é uma apresentação dos Spin-Offs do jogo.
* A página finaliza com um formulário, o qual não tem utilidade real.
As páginas tem adaptação para mobile e dispositivos móveis com o Media Querry.
Toda a organização das páginas foi feito utilizando Flexbox, a página de contato utiliza Grid.
Feito em colaboração com [@glovackimax](https://github.com/glovackimax).
https://gabjoao.github.io/Life-is-Strange-Page/
| Uma página comercial da franquia de jogos Life is Strange. Feita com HTML, CSS e JS. | css,html,dark-theme,html-css-javascript,javascript,js,landing-page,theme-switch,study,study-project | 2023-04-30T22:33:01Z | 2023-10-03T01:12:17Z | null | 2 | 0 | 22 | 0 | 0 | 2 | null | null | CSS |
IrakliGvelesiani/PlantCorner | master | <h1 align="center">
Responsive Plants Website 🌱<br/>
<a href="https://plantcorner.netlify.app" target="_blank">PlantCorner</a>
</h1>
<br/>
<p align="center">
<a href="https://plantcorner.netlify.app" target="_blank">
<img src="https://api.netlify.com/api/v1/badges/ac95dc32-745f-48e2-8e2f-5795d50b580f/deploy-status" alt="Netlify Status" />
</a>
</p>
### Responsive Plants Website 🌱
- Responsive Plants Website Using HTML, CSS and JavaScript.
- Contains animations when scrolling.
- Includes a dark and light mode.
- Developed first with the Mobile First methodology, then for desktop.
- Compatible with all mobile devices and with a beautiful and pleasant user interface.
| null | css,css3,html,javascript,responsive,scss | 2023-04-25T18:02:21Z | 2023-06-06T17:23:34Z | null | 1 | 0 | 5 | 0 | 1 | 2 | null | null | SCSS |
Ellyboi/Math-Magicians | dev | # Math-Magicians-React
<a name="readme-top"></a>
<!-- TABLE OF CONTENTS -->
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Math-magicians Presentation](#vgs-presentation)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#triangular_flag_on_post-deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ](#faq)
- [📝 License](#license)
<!-- PROJECT DESCRIPTION -->
# 📖 jsCapstone-project <a name="about-project"></a>
> In this project, I build a basic React Math Margicians calculator.
## 🛠 Built With <a name="built-with"></a>
### Tech Stack <a name="tech-stack"></a>
> This project uses the following stack :
<details>
<summary>Client</summary>
<ul>
<li><a href="https://www.w3schools.com/html/">HTML</a></li>
<li><a href="https://www.w3schools.com/css/">CSS</a></li>
<li><a href="https://www.w3schools.com/js/">JavaScript</a></li>
<li><a href="https://reactnative.dev/">React</a></li>
</ul>
</details>
<!-- Features -->
### Key Features <a name="key-features"></a>
> Here are some key features of the application :
- **The home page**
<p align="right">(<a href="#readme-top">back to top</a>)</p>
[🚀 Live Demo](https://math-magicians-wpnn.onrender.com)
<!-- GETTING STARTED -->
## 💻 Getting Started <a name="getting-started"></a>
> Clone the repository by clicking on the 'Code' button and copy the link
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
- npm install
- npm start
### Setup
Clone this repository to your desired folder:
Example commands:
```sh
cd my-folder
https://github.com/Ellyboi/math-magicians-react.git
```
### Install
Install this project with:
### Usage
To run the project, execute the following command:
Open the index.html file in a web browser using live server
<!--
Example command:
```sh
rails server
```
--->
### Run tests
To run tests, run the following command:
Use npm test for the mock Jest
Example command:
To run the webhint linter
```sh
npx hint .
```
To run the stylehint linter
```sh
npx stylehint "**/*.{css,scss}"
```
To run the ESLint linter
```sh
npx eslint .
```
### Deployment
You can deploy this project using:
- [Netlify](https://charming-nougat-0d03a1.netlify.app/)
### Project documentation
Here is a documentation of our code:
[video](https://drive.google.com/file/d/1x3A61KS4p-l4cauWAvEhheclVeoLSsdE/view)
<!--
Example:
```sh
```
-->
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- AUTHORS -->
## 👥 Authors <a name="authors"></a>
👤 **Vitoesi Elijah**
- GitHub: [@Ellyboi](https://github.com/Ellyboi)
- Twitter: [@Elijahvitoesi](https://twitter.com/Elijahvitoesi)
- LinkedIn: [Vitoesi Elijah](https://www.linkedin.com/in/vitoesi-elijah-61961611a/)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- FUTURE FEATURES -->
## 🔭 Future Features <a name="future-features"></a>
- Contact Information
- Navigation bar
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- CONTRIBUTING -->
## 🤝 Contributing <a name="contributing"></a>
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- SUPPORT -->
## ⭐️ Show your support <a name="support"></a>
If you like this project star it!
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- ACKNOWLEDGEMENTS -->
## 🙏 Acknowledgments <a name="acknowledgements"></a>
I would like to thank the Microverse team.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- LICENSE -->
## 📝 License <a name="license"></a>
This project is [licensed](./LICENSE) .
<p align="right">(<a href="#readme-top">back to top</a>)</p>
| Math Magicians is a project that allows the users to make simple calculations and read a random and funny quote. I use React to build it. | css,html5,javascript,reactjs | 2023-04-25T21:16:27Z | 2023-05-04T19:17:35Z | null | 1 | 7 | 30 | 0 | 0 | 2 | null | MIT | JavaScript |
code-bootcamp/cumadi | main | ### Md.
* 프로덕트명 : 커마디
* 개발기간 : `2023년 5월 1일 ~ 2023년 5월 26일 (4주)`
* 서비스 핵심 요약 : 마크다운으로 작성한 블로그 글들을 시리즈로 엮어서 판매하는 서비스
------
#### 📄 설치 및 실행 방법
```bash
// Node v16 or later
// npm install -g yarn
```
1. Cloning Source from Repository
```bash
$ git clone https://github.com/code-bootcamp/mcb2_team01_client.git
```
2. Initialize Workspace & Installing required packages
```bash
$ yarn install
```
3. Starting Server (ssr enabled)
```bash
$ yarn dev
```
4. (In case you want to build static resource and run) Build and Start Server
```bash
$ yarn build
$ yarn start
```
------
### 😂 팀원 소개
| 이름 | 역할 | 담당 | GitHub | 이메일 |
| :----: | :------: | :--------------------------------------------------------- | :----------------------------------------------------------: | :--------------------: |
| 박예림 | 팀장, FE | 포스트 작성, <br />수정 | [](https://github.com/yerimpark103) | yerimpark103@gmail.com |
| 유승우 | FE | 포스트 조회, <br />포스트 질문답변 댓글, <br />포스트 통계 | [](https://github.com/berenickt) | dhktjdyd12@naver.com |
| 박소현 | FE | 시리즈 결제, <br />시리즈 장바구니 | [](https://github.com/ParkSohyunee) | sohyunee016@gmail.com |
| 전필성 | FE | 로그인, <br />유저 정보 수정 | [](https://github.com/jeonpilseong) | abcabc3502@gmail.com |
| 김세환 | FE | 시리즈 목록, <br />시리즈 리뷰 | [](https://github.com/dragonfruitlemonade) | tpghks9245@gmail.com |
------
### 💡 기획의도 및 서비스 소개
- `기획의도`
- 어떤 정보를 습득하고 배우기 위해 어떤 분야이든 관련 책을 읽는 것이 가장 빠르다고 생각했었습니다.
- 과거부터 일반 블로그와 보고서 등을 썼을 떄, 글과 별개로 디자인이 가독성 좋지 않은 것이 불만이었습니다.
- 그러다 발견한 것이 마크다운이었고, 마크다운으로 글을 쓰는데만 집중할 수 있어 좋았습니다.
- 현재 많은 개발자들이 사용하는 블로그 플랫폼인 Velog가 있지만,
작성한 글들을 책처럼 엮어서 판매도 할 수 있으면 좋겠다는 생각이 들었습니다.
- google books, 알라딘, YES 24 등의 해당 플랫폼에서만 전자책을 읽게 제한했고,
그 플랫폼들의 가독성들이 정말 불편하게 느껴졌고,
이런 점들이 몇몇 사람들이 ebook보다 종이책을 선호하게 되지 않았나 생각했습니다.
- 그러다 ‘점프투파이썬’책을 만들어주신 위키독스를 운영하시는 박응용님의 플랫폼의 글들이 온라인 글임에도 오프라인 글과 다름없이 잘 읽히는 걸 알게되었고, 이 역시 마크다운으로 작성한 걸 알게되었습니다.
- 따라서 독자가 더 나은 환경에서 글들을 읽을 수 있을 거 같아 이 서비스를 생각하게 되었습니다.
- 여러가지 블로그 포스트를 보면서 중요하다 생각하는 문장이나 문단을 캡쳐하여 저장하고,
사람들과 논의할 수 있는 플랫폼이 있었으면 좋겠다는 생각이 들었습니다.
- `핵심 개선 포인트`
- 마크다운 블로그 + ebook 책들을 내가 원하는 환경에서 읽기
- 현재 메모 시장에서 Notion으로 인해 개발자가 아닌 직종의 사람들도 마크다운의 유용함을 알게되었다고 생각합니다.
그렇지만 Notion의 경우 무료든, 유료든 양이 많아지면 속도가 너무 느리고, 따로 글들을 판매할 수는 없습니다.
- 책들을 더 빠른 시간 내 엮어서 출시 가능
- 문장/문단 단위 포스트 스크랩 + 커뮤니티 공유 기능
- 기억하고 싶은 글에 하이라이팅을 하고 사람들과 공유하여 논의할 수 있습니다.
- `기대효과`
- 저 자신이 수 년간 블로그 글들을 작성하면서,
이런 서비스가 있었으면 해서 생각한 것이라 블로그 글 쓰는 걸 좋아하는 사람들이 한번 써볼 것 같습니다.
- 또 Notion이나 메모로 정리를 좋아하는 사람들이 이 서비스를 한 번 써볼 것 같습니다.
------
### 사용한 Front-end 기술
| 기술명 | 사용이유 |
| :--------------------: | ------------------------------------------------------------ |
| React | 2005년 Ajax로 Google Maps 같은 서비스가 등장하면서 SPA(Single Page Application) 시대에 접어들었고 Angular, React, Vue의 CSR(Client Side Rendering) 시대에 오면서 클라이언트 측에서 모든 걸 해결하기 시작했습니다. <br />서버에서 index.html을 보내주게 되면, 어플리케이션에는 필요한 링크만 들어있습니다. 그래서 처음 접속하면 빈 화면만 보이고, 링크된 JavaScript를 서버로 부터 다운로드 받습니다. 여기서 React Native, Electron 같은 React 관련 프레임워크와 리액트 개발자 커뮤니티가 커지면서, 현재 시장에서 높은 점유율을 가지고 있는 React를 선택했습니다. |
| Next.js | React 뿐만 아니라 Vue, Angular 같은 CSR 패러다임의 문제점은 크게 2가지인데, 첫 번째 사용자가 첫 화면을 보는데 시간이 오래 걸린다는 점, 두 번째 좋지 않은 SEO(Search Engin Optimization)입니다. 구글, 네이버 같은 검색엔진들은 서버에 등록된 웹사이트를 돌아다니며 HTML을 분석하는데, CSR에서 작동하는 HTML body는 대부분 텅텅 비어있기 떄문에, 검색엔진들이 CSR로 작성된 웹페이지를 분석하는데, 많은 어려움을 겪습니다. <br />이런 2가지 문제점을 해결하기 위해 재등장한 것이 SSR(Server Side Rendering)입니다. SSR은 사실 CSR보다 더 오래된 기술로 Ajax가 나오기 전에 웹 페이지를 생성하는 기술이 SSR이었고, 과거에 사용한 기술들이 PHP, AJP, JSP 등 입니다. <br />사용자가 처음 웹 사이트에 접속하면, 서버에 필요한 데이터를 모두 가져와서 HTML 파일을 만들고, 만들어진 HTML 파일을 동적으로 제어하는 코드들과 함께 클라이언트로 보내, 첫 번째 페이지 로딩이 빨라진다는 장점과 HTML에 컨텐츠가 담겨있기 때문에 더 효율적인 SEO가 가능합니다. <br />거기다 TTV(Time To View), TTI(Time To Interact) 측면에서 최종적으로 JS파일을 받아와야지만, 사용자가 상호작용할 수 있는 인터렉션이 가능해져서, SSR은 사용자가 사이트를 보는 시간과 실제 인터렉션이 가능한 시간과의 공백시간이 있습니다. <br />위 공백시간 문제점을 해결하기 위해 SSG(Static Site Generation)이 등장하는데, 정적으로 웹 사이트를 미리 생성해서 서버에 배포해놓는 개념입니다. Gatsby+React로도 이를 만들 수 있지만, Next.js에서도 SSG를 지원하면서, SSR+SSG를 잘 섞어서 유연하게 사용할 수 있어 선택했습니다. |
| Emotion | CSS-in-JS 라이브러리로, HTML, CSS로만 디자인을 하면, HTML 태그들이 다 div, span 등으로 디자인해서 해당 태그가 기능을 위한 태그인지 헷갈릴 수 있는데, Styled-Component나 Emotion같은 CSS-in-JS 라이브러리를 쓰게되면, 해당 태그가 어떤 의미인지 파악하는데 도움을 줄 수 있으며, CSS 관리가 편해지며, React 컴포넌트의 재사용성과 유지보수성을 높일 수 있어서 선택했습니다. |
| GraphQL & ApolloClient | REST-API의 POST 메소드를 응용해 만든 데이터 통신 기술로 모든 데이터를 받아오는 REST API와 달리, 필요한 데이터만 불러오는 식으로 동작해, 불필요한 데이터 전송을 막을 수 있습니다. |
| TypeScript | JavaScript는 따로 타입을 지정하지 않아도 알아서 인식하고, 호이스팅 등의 기능을 통해 선언과 초기화의 위치가 바뀌어도 문제없이 동작합니다. 이는 브레이브와 파이어폭스, JavaScript 창시자인 브랜든 아이크가 자기가 만든 언어가 이렇게 널리 쓰일줄 모른채 10일만에 개발했기 때문입니다. <br />이런 관대함은 디버깅을 어렵게하는 단점이 존재합니다. 그래서 MS사에서 다른 언어처럼 타임의 엄격함을 쓰기 위해 JavaScript 확장판격인 TypeScript를 쓰는 것이 유지보수 관점에서 더 좋기 때문에 선택했습니다. |
* 기타 주요 라이브러리
* Recoil : 전역 상태 관리
* [TOAST UI](https://ui.toast.com/)
* [React-Markdown](https://github.com/remarkjs/react-markdown)
* [I’mPort (portone)](https://portone.io/korea/ko?utm_source=google&utm_medium=google_sa&utm_campaign=pf_conversion_2302_kr&utm_content=homepage&gclid=Cj0KCQjw0tKiBhC6ARIsAAOXutlMBCAYcUxS81oGxjWOzfpZIzER3O0xBCwwKMcaLqD334rNd6s5NacaArhAEALw_wcB)
* [Chart.js](https://www.chartjs.org/)
------
### ⚙️ User Flow
[Figma](https://www.figma.com/file/UcJCOUMxYDAOOXe2f9yt3h/%ED%94%84%EB%A1%9C%EC%A0%9D%ED%8A%B8?type=design&node-id=19-4339&t=r7YAW1day9QVRR0S-0)
------
### ⚙️ ER 다이어그램
------
#### ⚙️ API 정의서
------
### 🔮 기능 시연자료
#### 회원 - 회원가입, 로그인
* 회원가입
* 이메일로 회원가입을 할 수 있으며, 등록한 이메일로 로그인이 가능합니다.
------
#### 마이페이지 - 비밀번호 수정,
* 로그인을 한 뒤에는 마이페이지 > 프로필 수정하기에서
* 유저의 프로필 사진과 자기소개를 등록할 수 있으며,
* 비밀번호를 수정할 수 있습니다.
------
#### 포스트 - 생성, 조회, 수정, 삭제, 좋아요
* 포스트 작성, 조회, 수정, 삭제
* 저희 사이트는 마크다운 형식으로 작성된 글들을 조회할 수 있으며,
* 좋아요를 누를 수 있고,
* 다시 보고 싶은 글들을 드래그하여 저장할 수 있습니다.
* 저장된 글을 마이페이지 > 하이라이트모음에서 확인 가능합니다.
------
#### 포스트 댓글, 답변 - 생성, 조회, 수정, 삭제
* 포스트를 조회하며 다른 유저들이 댓글을 달면, 작성자가 답변을 달아 서로 소통할 수 있습니다.
------
#### 포스트 통계
* 작성자는 자기가 작성한 포스트의 조회 수를 확인할 수 있습니다.
------
#### 포스트 메모
* 포스트의 글들을 따로 저장해 확인할 수 있습니다.
------
#### 작성포스트, 작성시리즈
* 작성자는 자기가 등록한 포스트들, 작성한 시리즈를 마이페이지에서 조회할 수 있습니다.
------
#### 시리즈 - 생성, 조회, 수정, 삭제
* 작성자는 포스트들을 시리즈로 묶어서 판매가 가능합니다.
------
#### 시리즈 리뷰
------
#### 시리즈 장바구니, 결제
* 다른 유저들은 만들어진 시리즈를 장바구니에 담을 수 있습니다.
* 장바구니 아이콘을 클릭하여 유료 / 무료 시리즈를 구매할 수 있습니다.
* 구매한 내역은 마이페이지 > 내가 구매한 시리즈에서 확인 가능합니다.
| [커마디] 마크다운으로 포스트를 작성, 블로그를 운영하면서, 글들을 엮은 시리즈를 판매할 수 있는 서비스 | react,apollo-client,emotion,javascript,nextjs,recoil,typescript | 2023-05-01T02:07:41Z | 2023-05-26T07:01:23Z | null | 19 | 62 | 460 | 0 | 4 | 2 | null | null | TypeScript |
yasin64035/Socket-Shop-MERN | master | null | This MERN Stack E-commerce Website is a fully functional online shopping platform that allows users to browse products, add them to their cart, and checkout securely using the Stripe payment gateway. Built using MongoDB, Express, React, Node.js, and Socket.io . | ecommerce-website,javascript,mern,mern-project,mern-stack,react | 2023-04-28T02:53:48Z | 2023-05-04T07:26:06Z | null | 1 | 0 | 9 | 0 | 1 | 2 | null | NOASSERTION | JavaScript |
Raiady/Jogo-Memoria-com-java-Script | main | # Jogo-Memoria-com-java-Script
:video_game: Realizado como projeto a criação de um jogo da memoria utilizando HTML,CSS e Java Script :1st_place_medal:
https://user-images.githubusercontent.com/83443899/235685481-afe535be-0b8a-43cc-adc5-7d97b857f116.mp4
| Realizado como projeto a criação de um jogo da memoria utilizando HTML,CSS e Java Script | css,game,html,javascript,jogo,jogo-da-memoria | 2023-05-02T13:36:15Z | 2023-05-02T13:52:36Z | null | 1 | 0 | 9 | 0 | 0 | 2 | null | null | JavaScript |
IngoSchriek/petpalz-website-project | main | # Pet Palz
Welcome to Pet Palz, an online pet shop platform on the internet.
## Features
* User-friendly navigation.
* Search for the product you're looking for.
* Give your rating feedback for each product and review the average rating.
* Filter the products based on brands, sizes, and more.
* Register and log in with Pet Palz to start adding new products to your cart.
* Each product has its own description and specifications.
* Responsive to each type of screen size.
* Carousel, product categorization, and more.
## Getting Started
To get started using Pet Palz, simply [visit the website](https://petpalz-website-project.vercel.app/) and start exploring!
## The Creation Process
With this project, I wanted to make it big and challenge myself, so I thought that making an e-commerce website would give me a great experience and an opportunity to use my knowledge in practice. I started having some troubles, the bigger problem for me doing this project was finding and creating images, but along the project, I was getting better and also improving a lot my tech skills. At this time I knew just the very basics of JavaScript, but with some searching, I could figure out how to make dynamic changes on the page using it. The search system and the filter system were fun to create, and the parts that required me most of problem-solving were my favorite parts. At the end of the project, I got a lot of confidence to build projects even better. I hope you enjoy it!
| Hi! Pet palz is an online pet shop e-commerce website, I hope you enjoy it! (Read README.md) | css,e-commerce,flask,html,javascript,mongodb,python,web | 2023-05-12T13:13:13Z | 2023-07-09T10:32:47Z | null | 1 | 0 | 40 | 0 | 0 | 2 | null | null | CSS |
emilyfas/mario-game | main | # Mário Game
No Jogo do Mario, o objetivo é ajudar o personagem principal, Mario, a evitar obstáculos que aparecem infinitas vezes na tela. O jogador precisa clicar na barra de espaço do teclado para fazer o Mario pular e evitar colidir com os obstáculos. Caso o Mario colida com um obstáculo, o jogo é encerrado.
<div align="center">
</div>
<div align=center>
</div>
## Visualizar o Projeto
Você pode visualizar o projeto clicando no link abaixo:
https://emilyfas.github.io/mario-game/
---
# Índice
* [Título e Imagem de capa](#mário-game)
* [Visualizar o projeto](#visualizar-o-projeto)
* [Índice](#índice)
* [Recursos Aprimorados](#recursos-aprimorados)
* [Como Jogar](#como-jogar)
* [Tecnologias utilizadas](#tecnologias-utilizadas)
* [Contato](#contato)
* [Creditos](#creditos)
---
## Recursos Aprimorados
1. Tela de Game Over: Agora, quando o jogador perde, é exibida uma tela de Game Over, indicando que o Mario colidiu com um obstáculo. Isso adiciona uma camada de feedback visual ao jogo.
2. Botão de Reinício: Após o jogo terminar, o jogador pode reiniciá-lo facilmente com um novo botão de reinício. Isso evita a necessidade de recarregar a página para jogar novamente.
3. Novas Teclas de Funcionalidade: Além das teclas de salto existentes, foram adicionadas novas teclas de funcionalidade para oferecer mais opções de interação durante o jogo.
<div align="right">
[Índice :point_up:](#índice)
</div>
## Como Jogar:
1. [Abra o jogo](https://emilyfas.github.io/mario-game/) no seu navegador.
2. Ao iniciar o jogo, o Mario estará em posição inicial.
3. Clique em na barra de espaço do teclado para fazer o Mario pular e evitar colidir com os obstáculos.
4. Caso o Mario colida com um obstáculo, o jogo é encerrado. A tela de Game Over será exibida.
5. Para jogar novamente, clique no botão de reinício ou na tecla <i>Enter</i>.
---
<div id="tecnologias-utilizadas">
## Tecnologias usadas no projeto:
</div>
<div align="right">
[Índice :point_up:](#índice)
</div>
---
<div id="contato">
## Contato:
### Emilly Fernandes
Alguns meios de contato:
<div>
<a href="https://wa.me/5531989018696?text=Me+mande+um+Oi+%3A%29" target="_blank"><img src="https://img.shields.io/badge/WhatsApp-25D366?style=for-the-badge&logo=whatsapp&logoColor=white" target="_blank"></a>
<a href="https://instagram.com/emillygarai" target="_blank"><img src="https://img.shields.io/badge/-Instagram-%23E4405F?style=for-the-badge&logo=instagram&logoColor=white" target="_blank"></a>
<a href="https://twitter.com/emilly_fernads" target="_blank"><img src="https://img.shields.io/badge/Twitter-1DA1F2?style=for-the-badge&logo=twitter&logoColor=white" target="_blank"></a>
<a href = "mailto:emilly.fernandesads@gmail.com"><img src="https://img.shields.io/badge/Gmail-D14836?style=for-the-badge&logo=gmail&logoColor=white" target="_blank"></a>
<a href="https://www.linkedin.com/in/emilly-fernandes" target="_blank"><img src="https://img.shields.io/badge/-LinkedIn-%230077B5?style=for-the-badge&logo=linkedin&logoColor=white" target="_blank"></a>
</div>
</div>
<div align="right">
[Índice :point_up:](#índice)
</div>
---
<div id="creditos">
## Creditos
Link de acesso ao vídeo do projeto inicial:
https://youtu.be/r9buAwVBDhA
Projeto foi feito pelo canal "Manual do Dev", o professor tem uma didática ótima, consegui entender muitas que estava tendo dificuldade através deste projeto.
Este projeto foi inicialmente inspirado no tutorial Como criar um jogo SIMPLES usando JavaScript e HTML (https://youtu.be/r9buAwVBDhA) e aprimorado por [Emilly Fernandes]. Agradecimentos especiais a [Manual do Dev] pela criação do projeto base que serviu para muita evolução e aprendizagem.
<div align="right">
[Índice :point_up:](#índice)
</div>
</div>
| Jogo do mario "melhorado" do tutorial "Como criar um jogo SIMPLES usando JavaScript e HTML" do manual do dev no youtube. | css,css3,front-end,frontend,frontend-web,game,game-development,html,html-css-javascript,html5 | 2023-05-06T19:41:29Z | 2023-06-28T17:56:00Z | null | 1 | 0 | 63 | 0 | 0 | 2 | null | MIT | CSS |
adityatupe-code/E-commerce-Capstone-Assignment-main | main | <img width="960" alt="Loginflip" src="https://github.com/adityatupe-code/E-commerce-Capstone-Assignment-main/assets/114912746/aa1757e4-c3e0-44b4-9af6-80ecdd00863a">
<img width="960" alt="mainpageflip" src="https://github.com/adityatupe-code/E-commerce-Capstone-Assignment-main/assets/114912746/f059d26d-098d-449f-80bb-3532052c786b">
<img width="960" alt="buy" src="https://github.com/adityatupe-code/E-commerce-Capstone-Assignment-main/assets/114912746/4291f0e6-673e-4af7-9bdc-f429766a9969">
<img width="960" alt="cart" src="https://github.com/adityatupe-code/E-commerce-Capstone-Assignment-main/assets/114912746/965eb161-a6a3-409d-bf09-5bcaa7cbde8f">
# E-commerce-Capstone-Assignment-main
E-Commerce-Bookbuy-Capstone-Assignment-main
| E-Commerce-Bookbuy-Capstone-Assignment-main | axios,express,javascript,mongodb,react,redux-toolkit | 2023-05-12T18:05:30Z | 2023-05-12T18:56:19Z | null | 1 | 0 | 3 | 0 | 0 | 2 | null | null | JavaScript |
vercel/ai | main | packages/core/README.md | Build AI-powered applications with React, Svelte, Vue, and Solid | artificial-intelligence,huggingface,javascript,language-model,llm,openai,react,svelte,typescript,vercel | 2023-05-23T15:04:08Z | 2024-05-23T15:37:40Z | 2024-05-23T14:16:22Z | 213 | 872 | 963 | 158 | 1,076 | 8,036 | null | NOASSERTION | TypeScript |
LiteLoaderQQNT/LiteLoaderQQNT | main | # LiteLoaderQQNT
LiteLoaderQQNT 是 QQNT 的插件加载器，一般在 QQNT 的环境内简称为 LiteLoader。
它可以让你自由地为 QQNT 添加各种插件，并实现例如美化主题、增加功能等各种功能。
详情查看 LiteLoaderQQNT 官网：https://liteloaderqqnt.github.io
| QQNT 插件加载器：LiteLoaderQQNT —— 轻量 · 简洁 · 开源 | javascript,qqnt,loader,qq,liteloaderqqnt | 2023-05-27T13:20:30Z | 2024-04-23T13:26:40Z | 2024-04-08T15:02:14Z | 24 | 59 | 71 | 20 | 193 | 4,151 | null | MIT | JavaScript |
vercel/modelfusion | main | # ModelFusion
> ### The TypeScript library for building AI applications.
[](https://www.npmjs.com/package/modelfusion)
[](https://opensource.org/licenses/MIT)
[](https://modelfusion.dev)
[](https://twitter.com/lgrammel)
[Introduction](#introduction) | [Quick Install](#quick-install) | [Usage](#usage-examples) | [Documentation](#documentation) | [Examples](#more-examples) | [Contributing](#contributing) | [modelfusion.dev](https://modelfusion.dev)
## Introduction
> [!IMPORTANT]
> [ModelFusion has joined Vercel](https://vercel.com/blog/vercel-ai-sdk-3-1-modelfusion-joins-the-team) and is being integrated into the [Vercel AI SDK](https://sdk.vercel.ai/docs/introduction). We are bringing the best parts of modelfusion to the Vercel AI SDK, starting with text generation, structured object generation, and tool calls. Please check out the AI SDK for the latest developments.
**ModelFusion** is an abstraction layer for integrating AI models into JavaScript and TypeScript applications, unifying the API for common operations such as **text streaming**, **object generation**, and **tool usage**. It provides features to support production environments, including observability hooks, logging, and automatic retries. You can use ModelFusion to build AI applications, chatbots, and agents.
- **Vendor-neutral**: ModelFusion is a non-commercial open source project that is community-driven. You can use it with any supported provider.
- **Multi-modal**: ModelFusion supports a wide range of models including text generation, image generation, vision, text-to-speech, speech-to-text, and embedding models.
- **Type inference and validation**: ModelFusion infers TypeScript types wherever possible and validates model responses.
- **Observability and logging**: ModelFusion provides an observer framework and logging support.
- **Resilience and robustness**: ModelFusion ensures seamless operation through automatic retries, throttling, and error handling mechanisms.
- **Built for production**: ModelFusion is fully tree-shakeable, can be used in serverless environments, and only uses a minimal set of dependencies.
## Quick Install
```sh
npm install modelfusion
```
Or use a starter template:
- [ModelFusion terminal app starter](https://github.com/lgrammel/modelfusion-terminal-app-starter)
- [Next.js, Vercel AI SDK, Llama.cpp & ModelFusion starter](https://github.com/lgrammel/modelfusion-llamacpp-nextjs-starter)
- [Next.js, Vercel AI SDK, Ollama & ModelFusion starter](https://github.com/lgrammel/modelfusion-ollama-nextjs-starter)
## Usage Examples
> [!TIP]
> The basic examples are a great way to get started and to explore in parallel with the [documentation](https://modelfusion.dev/guide/function/). You can find them in the [examples/basic](https://github.com/lgrammel/modelfusion/tree/main/examples/basic) folder.
You can provide API keys for the different [integrations](https://modelfusion.dev/integration/model-provider/) using environment variables (e.g., `OPENAI_API_KEY`) or pass them into the model constructors as options.
### [Generate Text](https://modelfusion.dev/guide/function/generate-text)
Generate text using a language model and a prompt. You can stream the text if it is supported by the model. You can use images for multi-modal prompting if the model supports it (e.g. with [llama.cpp](https://modelfusion.dev/integration/model-provider/llamacpp)).
You can use [prompt styles](https://modelfusion.dev/guide/function/generate-text#prompt-styles) to use text, instruction, or chat prompts.
#### generateText
```ts
import { generateText, openai } from "modelfusion";
const text = await generateText({
model: openai.CompletionTextGenerator({ model: "gpt-3.5-turbo-instruct" }),
prompt: "Write a short story about a robot learning to love:\n\n",
});
```
Providers: [OpenAI](https://modelfusion.dev/integration/model-provider/openai), [OpenAI compatible](https://modelfusion.dev/integration/model-provider/openaicompatible), [Llama.cpp](https://modelfusion.dev/integration/model-provider/llamacpp), [Ollama](https://modelfusion.dev/integration/model-provider/ollama), [Mistral](https://modelfusion.dev/integration/model-provider/mistral), [Hugging Face](https://modelfusion.dev/integration/model-provider/huggingface), [Cohere](https://modelfusion.dev/integration/model-provider/cohere)
#### streamText
```ts
import { streamText, openai } from "modelfusion";
const textStream = await streamText({
model: openai.CompletionTextGenerator({ model: "gpt-3.5-turbo-instruct" }),
prompt: "Write a short story about a robot learning to love:\n\n",
});
for await (const textPart of textStream) {
process.stdout.write(textPart);
}
```
Providers: [OpenAI](https://modelfusion.dev/integration/model-provider/openai), [OpenAI compatible](https://modelfusion.dev/integration/model-provider/openaicompatible), [Llama.cpp](https://modelfusion.dev/integration/model-provider/llamacpp), [Ollama](https://modelfusion.dev/integration/model-provider/ollama), [Mistral](https://modelfusion.dev/integration/model-provider/mistral), [Cohere](https://modelfusion.dev/integration/model-provider/cohere)
#### streamText with multi-modal prompt
Multi-modal vision models such as GPT 4 Vision can process images as part of the prompt.
```ts
import { streamText, openai } from "modelfusion";
import { readFileSync } from "fs";
const image = readFileSync("./image.png");
const textStream = await streamText({
model: openai
.ChatTextGenerator({ model: "gpt-4-vision-preview" })
.withInstructionPrompt(),
prompt: {
instruction: [
{ type: "text", text: "Describe the image in detail." },
{ type: "image", image, mimeType: "image/png" },
],
},
});
for await (const textPart of textStream) {
process.stdout.write(textPart);
}
```
Providers: [OpenAI](https://modelfusion.dev/integration/model-provider/openai), [OpenAI compatible](https://modelfusion.dev/integration/model-provider/openaicompatible), [Llama.cpp](https://modelfusion.dev/integration/model-provider/llamacpp), [Ollama](https://modelfusion.dev/integration/model-provider/ollama)
### [Generate Object](https://modelfusion.dev/guide/function/generate-object)
Generate typed objects using a language model and a schema.
#### generateObject
Generate an object that matches a schema.
```ts
import {
ollama,
zodSchema,
generateObject,
jsonObjectPrompt,
} from "modelfusion";
const sentiment = await generateObject({
model: ollama
.ChatTextGenerator({
model: "openhermes2.5-mistral",
maxGenerationTokens: 1024,
temperature: 0,
})
.asObjectGenerationModel(jsonObjectPrompt.instruction()),
schema: zodSchema(
z.object({
sentiment: z
.enum(["positive", "neutral", "negative"])
.describe("Sentiment."),
})
),
prompt: {
system:
"You are a sentiment evaluator. " +
"Analyze the sentiment of the following product review:",
instruction:
"After I opened the package, I was met by a very unpleasant smell " +
"that did not disappear even after washing. Never again!",
},
});
```
Providers: [OpenAI](https://modelfusion.dev/integration/model-provider/openai), [Ollama](https://modelfusion.dev//integration/model-provider/ollama), [Llama.cpp](https://modelfusion.dev//integration/model-provider/llama.cpp)
#### streamObject
Stream a object that matches a schema. Partial objects before the final part are untyped JSON.
```ts
import { zodSchema, openai, streamObject } from "modelfusion";
const objectStream = await streamObject({
model: openai
.ChatTextGenerator(/* ... */)
.asFunctionCallObjectGenerationModel({
fnName: "generateCharacter",
fnDescription: "Generate character descriptions.",
})
.withTextPrompt(),
schema: zodSchema(
z.object({
characters: z.array(
z.object({
name: z.string(),
class: z
.string()
.describe("Character class, e.g. warrior, mage, or thief."),
description: z.string(),
})
),
})
),
prompt: "Generate 3 character descriptions for a fantasy role playing game.",
});
for await (const { partialObject } of objectStream) {
console.clear();
console.log(partialObject);
}
```
Providers: [OpenAI](https://modelfusion.dev/integration/model-provider/openai), [Ollama](https://modelfusion.dev//integration/model-provider/ollama), [Llama.cpp](https://modelfusion.dev//integration/model-provider/llama.cpp)
### [Generate Image](https://modelfusion.dev/guide/function/generate-image)
Generate an image from a prompt.
```ts
import { generateImage, openai } from "modelfusion";
const image = await generateImage({
model: openai.ImageGenerator({ model: "dall-e-3", size: "1024x1024" }),
prompt:
"the wicked witch of the west in the style of early 19th century painting",
});
```
Providers: [OpenAI (Dall·E)](https://modelfusion.dev/integration/model-provider/openai), [Stability AI](https://modelfusion.dev/integration/model-provider/stability), [Automatic1111](https://modelfusion.dev/integration/model-provider/automatic1111)
### [Generate Speech](https://modelfusion.dev/guide/function/generate-speech)
Synthesize speech (audio) from text. Also called TTS (text-to-speech).
#### generateSpeech
`generateSpeech` synthesizes speech from text.
```ts
import { generateSpeech, lmnt } from "modelfusion";
// `speech` is a Uint8Array with MP3 audio data
const speech = await generateSpeech({
model: lmnt.SpeechGenerator({
voice: "034b632b-df71-46c8-b440-86a42ffc3cf3", // Henry
}),
text:
"Good evening, ladies and gentlemen! Exciting news on the airwaves tonight " +
"as The Rolling Stones unveil 'Hackney Diamonds,' their first collection of " +
"fresh tunes in nearly twenty years, featuring the illustrious Lady Gaga, the " +
"magical Stevie Wonder, and the final beats from the late Charlie Watts.",
});
```
Providers: [Eleven Labs](https://modelfusion.dev/integration/model-provider/elevenlabs), [LMNT](https://modelfusion.dev/integration/model-provider/lmnt), [OpenAI](https://modelfusion.dev/integration/model-provider/openai)
#### streamSpeech
`generateSpeech` generates a stream of speech chunks from text or from a text stream. Depending on the model, this can be fully duplex.
```ts
import { streamSpeech, elevenlabs } from "modelfusion";
const textStream: AsyncIterable<string>;
const speechStream = await streamSpeech({
model: elevenlabs.SpeechGenerator({
model: "eleven_turbo_v2",
voice: "pNInz6obpgDQGcFmaJgB", // Adam
optimizeStreamingLatency: 1,
voiceSettings: { stability: 1, similarityBoost: 0.35 },
generationConfig: {
chunkLengthSchedule: [50, 90, 120, 150, 200],
},
}),
text: textStream,
});
for await (const part of speechStream) {
// each part is a Uint8Array with MP3 audio data
}
```
Providers: [Eleven Labs](https://modelfusion.dev/integration/model-provider/elevenlabs)
### [Generate Transcription](https://modelfusion.dev/guide/function/generate-transcription)
Transcribe speech (audio) data into text. Also called speech-to-text (STT).
```ts
import { generateTranscription, openai } from "modelfusion";
import fs from "node:fs";
const transcription = await generateTranscription({
model: openai.Transcriber({ model: "whisper-1" }),
mimeType: "audio/mp3",
audioData: await fs.promises.readFile("data/test.mp3"),
});
```
Providers: [OpenAI (Whisper)](https://modelfusion.dev/integration/model-provider/openai), [Whisper.cpp](https://modelfusion.dev/integration/model-provider/whispercpp)
### [Embed Value](https://modelfusion.dev/guide/function/embed)
Create embeddings for text and other values. Embeddings are vectors that represent the essence of the values in the context of the model.
```ts
import { embed, embedMany, openai } from "modelfusion";
// embed single value:
const embedding = await embed({
model: openai.TextEmbedder({ model: "text-embedding-ada-002" }),
value: "At first, Nox didn't know what to do with the pup.",
});
// embed many values:
const embeddings = await embedMany({
model: openai.TextEmbedder({ model: "text-embedding-ada-002" }),
values: [
"At first, Nox didn't know what to do with the pup.",
"He keenly observed and absorbed everything around him, from the birds in the sky to the trees in the forest.",
],
});
```
Providers: [OpenAI](https://modelfusion.dev/integration/model-provider/openai), [OpenAI compatible](https://modelfusion.dev/integration/model-provider/openaicompatible), [Llama.cpp](https://modelfusion.dev/integration/model-provider/llamacpp), [Ollama](https://modelfusion.dev/integration/model-provider/ollama), [Mistral](https://modelfusion.dev/integration/model-provider/mistral), [Hugging Face](https://modelfusion.dev/integration/model-provider/huggingface), [Cohere](https://modelfusion.dev/integration/model-provider/cohere)
### [Classify Value](https://modelfusion.dev/guide/function/classify)
Classifies a value into a category.
```ts
import { classify, EmbeddingSimilarityClassifier, openai } from "modelfusion";
const classifier = new EmbeddingSimilarityClassifier({
embeddingModel: openai.TextEmbedder({ model: "text-embedding-ada-002" }),
similarityThreshold: 0.82,
clusters: [
{
name: "politics" as const,
values: [
"they will save the country!",
// ...
],
},
{
name: "chitchat" as const,
values: [
"how's the weather today?",
// ...
],
},
],
});
// strongly typed result:
const result = await classify({
model: classifier,
value: "don't you love politics?",
});
```
Classifiers: [EmbeddingSimilarityClassifier](https://modelfusion.dev/guide/function/classify#embeddingsimilarityclassifier)
### [Tokenize Text](https://modelfusion.dev/guide/function/tokenize-text)
Split text into tokens and reconstruct the text from tokens.
```ts
const tokenizer = openai.Tokenizer({ model: "gpt-4" });
const text = "At first, Nox didn't know what to do with the pup.";
const tokenCount = await countTokens(tokenizer, text);
const tokens = await tokenizer.tokenize(text);
const tokensAndTokenTexts = await tokenizer.tokenizeWithTexts(text);
const reconstructedText = await tokenizer.detokenize(tokens);
```
Providers: [OpenAI](https://modelfusion.dev/integration/model-provider/openai), [Llama.cpp](https://modelfusion.dev/integration/model-provider/llamacpp), [Cohere](https://modelfusion.dev/integration/model-provider/cohere)
### [Tools](https://modelfusion.dev/guide/tools)
Tools are functions (and associated metadata) that can be executed by an AI model. They are useful for building chatbots and agents.
ModelFusion offers several tools out-of-the-box: [Math.js](https://modelfusion.dev/guide/tools/available-tools/mathjs), [MediaWiki Search](https://modelfusion.dev/guide/tools/available-tools/mediawiki-search), [SerpAPI](https://modelfusion.dev/guide/tools/available-tools/serpapi), [Google Custom Search](https://modelfusion.dev/guide/tools/available-tools/google-custom-search). You can also create [custom tools](https://modelfusion.dev/guide/tools).
#### [runTool](https://modelfusion.dev/guide/tools/run-tool)
With `runTool`, you can ask a tool-compatible language model (e.g. OpenAI chat) to invoke a single tool. `runTool` first generates a tool call and then executes the tool with the arguments.
```ts
const { tool, toolCall, args, ok, result } = await runTool({
model: openai.ChatTextGenerator({ model: "gpt-3.5-turbo" }),
too: calculator,
prompt: [openai.ChatMessage.user("What's fourteen times twelve?")],
});
console.log(`Tool call:`, toolCall);
console.log(`Tool:`, tool);
console.log(`Arguments:`, args);
console.log(`Ok:`, ok);
console.log(`Result or Error:`, result);
```
#### [runTools](https://modelfusion.dev/guide/tools/run-tools)
With `runTools`, you can ask a language model to generate several tool calls as well as text. The model will choose which tools (if any) should be called with which arguments. Both the text and the tool calls are optional. This function executes the tools.
```ts
const { text, toolResults } = await runTools({
model: openai.ChatTextGenerator({ model: "gpt-3.5-turbo" }),
tools: [calculator /* ... */],
prompt: [openai.ChatMessage.user("What's fourteen times twelve?")],
});
```
#### [Agent Loop](https://modelfusion.dev/guide/tools/agent-loop)
You can use `runTools` to implement an agent loop that responds to user messages and executes tools. [Learn more](https://modelfusion.dev/guide/tools/agent-loop).
### [Vector Indices](https://modelfusion.dev/guide/vector-index)
```ts
const texts = [
"A rainbow is an optical phenomenon that can occur under certain meteorological conditions.",
"It is caused by refraction, internal reflection and dispersion of light in water droplets resulting in a continuous spectrum of light appearing in the sky.",
// ...
];
const vectorIndex = new MemoryVectorIndex<string>();
const embeddingModel = openai.TextEmbedder({
model: "text-embedding-ada-002",
});
// update an index - usually done as part of an ingestion process:
await upsertIntoVectorIndex({
vectorIndex,
embeddingModel,
objects: texts,
getValueToEmbed: (text) => text,
});
// retrieve text chunks from the vector index - usually done at query time:
const retrievedTexts = await retrieve(
new VectorIndexRetriever({
vectorIndex,
embeddingModel,
maxResults: 3,
similarityThreshold: 0.8,
}),
"rainbow and water droplets"
);
```
Available Vector Stores: [Memory](https://modelfusion.dev/integration/vector-index/memory), [SQLite VSS](https://modelfusion.dev/integration/vector-index/sqlite-vss), [Pinecone](https://modelfusion.dev/integration/vector-index/pinecone)
### [Text Generation Prompt Styles](https://modelfusion.dev/guide/function/generate-text#prompt-styles)
You can use different prompt styles (such as text, instruction or chat prompts) with ModelFusion text generation models. These prompt styles can be accessed through the methods `.withTextPrompt()`, `.withChatPrompt()` and `.withInstructionPrompt()`:
#### Text Prompt Style
```ts
const text = await generateText({
model: openai
.ChatTextGenerator({
// ...
})
.withTextPrompt(),
prompt: "Write a short story about a robot learning to love",
});
```
#### Instruction Prompt Style
```ts
const text = await generateText({
model: llamacpp
.CompletionTextGenerator({
// run https://huggingface.co/TheBloke/Llama-2-7B-Chat-GGUF with llama.cpp
promptTemplate: llamacpp.prompt.Llama2, // Set prompt template
contextWindowSize: 4096, // Llama 2 context window size
maxGenerationTokens: 512,
})
.withInstructionPrompt(),
prompt: {
system: "You are a story writer.",
instruction: "Write a short story about a robot learning to love.",
},
});
```
#### Chat Prompt Style
```ts
const textStream = await streamText({
model: openai
.ChatTextGenerator({
model: "gpt-3.5-turbo",
})
.withChatPrompt(),
prompt: {
system: "You are a celebrated poet.",
messages: [
{
role: "user",
content: "Suggest a name for a robot.",
},
{
role: "assistant",
content: "I suggest the name Robbie",
},
{
role: "user",
content: "Write a short story about Robbie learning to love",
},
],
},
});
```
### [Image Generation Prompt Templates](https://modelfusion.dev/guide/function/generate-image/prompt-format)
You an use prompt templates with image models as well, e.g. to use a basic text prompt. It is available as a shorthand method:
```ts
const image = await generateImage({
model: stability
.ImageGenerator({
//...
})
.withTextPrompt(),
prompt:
"the wicked witch of the west in the style of early 19th century painting",
});
```
| Prompt Template | Text Prompt |
| --------------- | ----------- |
| Automatic1111 | ✅ |
| Stability | ✅ |
### Metadata and original responses
ModelFusion model functions return rich responses that include the raw (original) response and metadata when you set the `fullResponse` argument to `true`.
```ts
// access the raw response (needs to be typed) and the metadata:
const { text, rawResponse, metadata } = await generateText({
model: openai.CompletionTextGenerator({
model: "gpt-3.5-turbo-instruct",
maxGenerationTokens: 1000,
n: 2, // generate 2 completions
}),
prompt: "Write a short story about a robot learning to love:\n\n",
fullResponse: true,
});
console.log(metadata);
// cast to the raw response type:
for (const choice of (rawResponse as OpenAICompletionResponse).choices) {
console.log(choice.text);
}
```
### Logging and Observability
ModelFusion provides an [observer framework](https://modelfusion.dev/guide/util/observer) and [logging support](https://modelfusion.dev/guide/util/logging). You can easily trace runs and call hierarchies, and you can add your own observers.
#### Enabling Logging on a Function Call
```ts
import { generateText, openai } from "modelfusion";
const text = await generateText({
model: openai.CompletionTextGenerator({ model: "gpt-3.5-turbo-instruct" }),
prompt: "Write a short story about a robot learning to love:\n\n",
logging: "detailed-object",
});
```
## Documentation
### [Guide](https://modelfusion.dev/guide)
- [Model Functions](https://modelfusion.dev/guide/function/)
- [Generate text](https://modelfusion.dev/guide/function/generate-text)
- [Generate object](https://modelfusion.dev/guide/function/generate-object)
- [Generate image](https://modelfusion.dev/guide/function/generate-image)
- [Generate speech](https://modelfusion.dev/guide/function/generate-speech)
- [Generate transcription](https://modelfusion.dev/guide/function/generate-transcription)
- [Tokenize Text](https://modelfusion.dev/guide/function/tokenize-text)
- [Embed Value](https://modelfusion.dev/guide/function/embed)
- [Classify Value](https://modelfusion.dev/guide/function/classify)
- [Tools](https://modelfusion.dev/guide/tools)
- [Run Tool](https://modelfusion.dev/guide/tools/run-tool)
- [Run Tools](https://modelfusion.dev/guide/tools/run-tools)
- [Agent Loop](https://modelfusion.dev/guide/tools/agent-loop)
- [Available Tools](https://modelfusion.dev/guide/tools/available-tools/)
- [Custom Tools](https://modelfusion.dev/guide/tools/custom-tools)
- [Advanced](https://modelfusion.dev/guide/tools/advanced)
- [Vector Indices](https://modelfusion.dev/guide/vector-index)
- [Upsert](https://modelfusion.dev/guide/vector-index/upsert)
- [Retrieve](https://modelfusion.dev/guide/vector-index/retrieve)
- [Text Chunks](https://modelfusion.dev/guide/text-chunk/)
- [Split Text](https://modelfusion.dev/guide/text-chunk/split)
- [Utilities](https://modelfusion.dev/guide/util/)
- [API Configuration](https://modelfusion.dev/guide/util/api-configuration)
- [Base URL](https://modelfusion.dev/guide/util/api-configuration/base-url)
- [Headers](https://modelfusion.dev/guide/util/api-configuration/headers)
- [Retry strategies](https://modelfusion.dev/guide/util/api-configuration/retry)
- [Throttling strategies](https://modelfusion.dev/guide/util/api-configuration/throttle)
- [Logging](https://modelfusion.dev/guide/util/logging)
- [Observers](https://modelfusion.dev/guide/util/observer)
- [Runs](https://modelfusion.dev/guide/util/run)
- [Abort signals](https://modelfusion.dev/guide/util/abort)
- [Experimental](https://modelfusion.dev/guide/experimental/)
- [Guards](https://modelfusion.dev/guide/experimental/guard)
- [Server](https://modelfusion.dev/guide/experimental/server/)
- [Cost calculation](https://modelfusion.dev/guide/experimental/cost-calculation)
- [Troubleshooting](https://modelfusion.dev/guide/troubleshooting)
- [Bundling](https://modelfusion.dev/guide/troubleshooting/bundling)
### [Integrations](https://modelfusion.dev/integration/model-provider)
### [Examples & Tutorials](https://modelfusion.dev/tutorial)
### [Showcase](https://modelfusion.dev/tutorial/showcase)
### [API Reference](https://modelfusion.dev/api/modules)
## More Examples
### [Basic Examples](https://github.com/lgrammel/modelfusion/tree/main/examples/basic)
Examples for almost all of the individual functions and objects. Highly recommended to get started.
### [StoryTeller](https://github.com/lgrammel/storyteller)
> _multi-modal_, _object streaming_, _image generation_, _text to speech_, _speech to text_, _text generation_, _object generation_, _embeddings_
StoryTeller is an exploratory web application that creates short audio stories for pre-school kids.
### [Chatbot (Next.JS)](https://github.com/lgrammel/modelfusion/tree/main/examples/chatbot-next-js)
> _Next.js app_, _OpenAI GPT-3.5-turbo_, _streaming_, _abort handling_
A web chat with an AI assistant, implemented as a Next.js app.
### [Chat with PDF](https://github.com/lgrammel/modelfusion/tree/main/examples/pdf-chat-terminal)
> _terminal app_, _PDF parsing_, _in memory vector indices_, _retrieval augmented generation_, _hypothetical document embedding_
Ask questions about a PDF document and get answers from the document.
### [Next.js / ModelFusion Demos](https://github.com/lgrammel/modelfusion/tree/main/examples/nextjs)
> _Next.js app_, _image generation_, _transcription_, _object streaming_, _OpenAI_, _Stability AI_, _Ollama_
Examples of using ModelFusion with Next.js 14 (App Router):
- image generation
- voice recording & transcription
- object streaming
### [Duplex Speech Streaming (using Vite/React & ModelFusion Server/Fastify)](https://github.com/lgrammel/modelfusion/tree/main/examples/speech-streaming-vite-react-fastify)
> _Speech Streaming_, _OpenAI_, _Elevenlabs_ _streaming_, _Vite_, _Fastify_, _ModelFusion Server_
Given a prompt, the server returns both a text and a speech stream response.
### [BabyAGI Agent](https://github.com/lgrammel/modelfusion/tree/main/examples/babyagi-agent)
> _terminal app_, _agent_, _BabyAGI_
TypeScript implementation of the BabyAGI classic and BabyBeeAGI.
### [Wikipedia Agent](https://github.com/lgrammel/modelfusion/tree/main/examples/wikipedia-agent)
> _terminal app_, _ReAct agent_, _GPT-4_, _OpenAI functions_, _tools_
Get answers to questions from Wikipedia, e.g. "Who was born first, Einstein or Picasso?"
### [Middle school math agent](https://github.com/lgrammel/modelfusion/tree/main/examples/middle-school-math-agent)
> _terminal app_, _agent_, _tools_, _GPT-4_
Small agent that solves middle school math problems. It uses a calculator tool to solve the problems.
### [PDF to Tweet](https://github.com/lgrammel/modelfusion/tree/main/examples/pdf-to-tweet)
> _terminal app_, _PDF parsing_, _recursive information extraction_, _in memory vector index, \_style example retrieval_, _OpenAI GPT-4_, _cost calculation_
Extracts information about a topic from a PDF and writes a tweet in your own style about it.
### [Cloudflare Workers](https://github.com/lgrammel/modelfusion/tree/main/examples/cloudflare-workers)
> _Cloudflare_, _OpenAI_
Generate text on a Cloudflare Worker using ModelFusion and OpenAI.
## Contributing
### [Contributing Guide](https://github.com/lgrammel/modelfusion/blob/main/CONTRIBUTING.md)
Read the [ModelFusion contributing guide](https://github.com/lgrammel/modelfusion/blob/main/CONTRIBUTING.md) to learn about the development process, how to propose bugfixes and improvements, and how to build and test your changes.
| The TypeScript library for building AI applications. | chatbot,gpt-3,javascript,js,llm,openai,ts,typescript,whisper,ai | 2023-05-25T09:47:54Z | 2024-05-06T13:11:42Z | 2024-02-24T10:43:17Z | 80 | 279 | 2,522 | 30 | 71 | 969 | null | MIT | TypeScript |
ChrisCavs/aimless.js | main | <img width="490" alt="Aimless.js" src="https://github.com/ChrisCavs/aimless.js/assets/32932937/9db1ddae-b7a4-47f1-a5e4-daee5761ecd1">
[](https://www.npmjs.com/package/aimless.js) [](https://www.npmjs.com/package/aimless.js) [](https://twitter.com/intent/tweet?text=Aimless.js%20the%20missing%20JS%20randomness%20library&url=https://github.com/ChrisCavs/aimless.js&hashtags=javascript,random,developers,frontend)
The missing JS randomness library. [See a demo](https://chriscavs.github.io/aimless-demo/).
## Why?
Outside of large game engines and frameworks, there is very little support for generating random numbers in JavaScript. Sure, there are quite a number of substitutes for the native `Math.random` function. However, these replacements aren't always easy to use, and aren't feature-rich.
Aimless is the missing JS randomness library. It's tiny (< 6kB), unopinionated, dependency-free, and provides a variety of helpful random number utilities to make your life easier. Best of all, it's compatible with all your favorite PRNGs.
## Getting Started
Follow these steps:
1. [Install](#install)
2. [Using Custom PRNG](#using-custom-prng)
3. [Review API](#api)
## Install
Install and add it to your `package.json` dependencies.
```
$ npm install aimless.js --save
```
Then `import` utility functions into the file where you'll use them.
```es6
import { bool, intRange } from 'aimless.js'
```
## Using Custom PRNG
Aimless.js is compatible with any custom PRNG that returns a number `num >= 0` and `num < 1`. Every function accepts an `engine` to be used.
```es6
import { bool } from 'aimless.js'
const engine = () => 0
bool(engine) // false
```
Additionally, every function in Aimless has a counterpart named `withEngine`. This function will return its counterpart with a closure around your engine, so you don't need to pass it every time.
```es6
import { boolWithEngine } from 'aimless.js'
const engine = () => 0
const bool = boolWithEngine(engine)
bool() // false
```
Every function will default to using the provided `defaultEngine` if no custom engine is provided. The default engine uses `crypto.getrandomvalues` when available, with a fallback of `Math.random`.
## API
### bool(engine)
Returns either `true` or `false`.
### char(string, engine)
Returns a random character from the provided `string`.
```es6
const randomChar = char('the missing JS randomness library')
// could return 's', ' ', 'l', etc
```
### customDist(function, engine)
Returns a random number following a custom distribution of your choosing. `function` should take in a number between `0` and `1`.
```es6
const randomOfCustomDist = customDist(
(randomNumber) => randomNumber / 2
)
```
### exponentialDist(lambda, engine)
Returns a random number following an exponential distribution with the provided `lambda`.
```es6
const samples = []
const lambda = 0.5
for (let i = 0; i < 100000; i++) {
const randomValue = exponentialDist(lambda)
samples.push(randomValue)
}
// you can expect the mean of `samples` to be (1 / lambda) +/- 0.01,
// generating more samples will ensure a mean of (1 / lambda)
```
### floatRange(min, max, engine)
Returns a random float between `min` and `max`.
```es6
const randomFloat = floatRange(0.1, 0.2)
```
### intRange(min, max, engine)
Returns a random integer between `min` and `max`.
```es6
const randomInteger = intRange(5, 10)
```
### intSequence(min, max, engine)
Returns an array with all integers between `min` and `max` in random order.
```es6
const intSeq = intSequence(-1, 3)
// could return [3,-1,2,1,0], [0,2,-1,3,1], etc
```
### normalDist(mean, stdDev, engine)
Returns a random number following a normal distribution with mean `mean` and standard deviation `stdDev`.
```es6
const samples = []
for (let i = 0; i < 100000; i++) {
const randomValue = normalDist(0, 1)
samples.push(randomValue)
}
// you can expect the mean of `samples` to be 0 +/- 0.01,
// generating more samples will ensure a mean of 0
```
### normalFloat(engine)
Returns a random float between `-1` and `1`.
### oneOf(array, engine)
Returns a random item from the `array` provided.
```es6
const randomItem = oneOf([1,2,3])
const randomObj = oneOf([{a:1}, {b:2}, {c:3}])
```
### seedFunc(seed)
Returns a seeded random number generator. Seeded RNGs produce random numbers, but are predictable if you use the same seed. **note**: the Park-Miller PRNG is used to provide the seeded function, therefore, an `engine` is not accepted.
```es6
const seededFunction = seedFunc(1)
seededFunction() // 0.000007825903601782307
seededFunction() // 0.13153778773875702
seededFunction() // 0.7556053220812281
const newSeeded = seedFunc(1)
newSeeded() // 0.000007825903601782307
newSeeded() // 0.13153778773875702
newSeeded() // 0.7556053220812281
```
### sequence(array, engine)
Returns a new array with the same items contained in `array` but in random order.
```es6
const randomSeq = sequence([1,2,3])
// could return [3,1,2], [2,3,1], etc.
```
### sign(engine)
Returns either `-1` or `1`.
### uniqFuncIntRange(min, max, engine)
Returns a **unique** random number between `min` and `max`, using the provided `engine`. If no `engine` is passed, the defaultEngine will be used. If there are no unique values left to return, `null` will be returned.
```es6
const uniqueRNG = uniqFuncIntRange(1, 3)
uniqueRNG() // 2
uniqueRNG() // 3
uniqueRNG() // 1
uniqueRNG() // null
```
### uniqFuncSequence(array, engine)
Returns a **unique** random number from the provided `array`, using the provided `engine`. If no `engine` is passed, the defaultEngine will be used. If there are no unique values left to return, `null` will be returned.
```es6
const uniqueRNG = uniqFuncSequence([10, 20, 30])
uniqueRNG() // 20
uniqueRNG() // 30
uniqueRNG() // 10
uniqueRNG() // null
```
### uuid(engine)
Returns a valid RFC4122 version4 ID hex string, using the provided `engine`.
```es6
const id = uuid()
console.log(id) // ef486db4-7f49-43b3-a1ea-b0e0a22bc944
```
### weighted(numbers, weights, engine)
Returns one of the `numbers` provided, biased towards the corresponding `weights` provided. `numbers` can include floats.
```es6
const weightedDiceRoll = weighted(
[1,2,3,4,5,6],
[1,1,1,1,1,10]
)
// will return 6 much more often than the other options
```
## Contributing
If you have any ideas for the project, please [open an issue](https://github.com/ChrisCavs/aimless.js/issues). I monitor issues frequently and it is a great place for active discussion on new features, refactors, etc. Even if your idea is half-baked, it may well be worth opening an issue and starting a discussion!
If you'd like, you can also open a [pull request](https://github.com/ChrisCavs/aimless.js/pulls). I am happy to review your code or branch off of it. However, please note that I am unlikely to merge code directly into aimless.js due to code quality / copywrite concerns. If you're just tooling around with an idea, an [issue](https://github.com/ChrisCavs/aimless.js/issues) might have more success.
## Browser Support
Aimless relies on ES5 array methods, and is supported in all modern browsers. Support for legacy or depricated browsers is not planned.
## License
[MIT](https://opensource.org/licenses/MIT). © 2023 Christopher Cavalea
| The missing JavaScript randomness library. | crypto,dependency-free,distribution-function,javascript,random,weighted-random | 2023-05-17T23:34:31Z | 2023-06-12T19:59:10Z | 2023-06-12T19:59:10Z | 2 | 7 | 36 | 3 | 14 | 827 | null | MIT | TypeScript |
adamritter/fastgron | main | # fastgron
Make JSON greppable super fast!
fastgron transforms JSON into discrete assignments to make it easier to grep for what you want and see the absolute 'path' to it. It eases the exploration of APIs that return large blobs of JSON but have terrible documentation.
`fastgron` is a high-performance JSON to GRON converter, developed in C++20, utilizing simdjson library.
It's 50x faster than [gron](https://github.com/tomnomnom/gron) on big files (400MB/s input / 1.8GB/s output on M1 Macbook Pro), so it makes big JSON files greppable.
```console
$ fastgron "https://api.github.com/repos/adamritter/fastgron/commits?per_page=1" | fgrep commit.author
json[0].commit.author = {}
json[0].commit.author.name = "adamritter"
json[0].commit.author.email = "58403584+adamritter@users.noreply.github.com"
json[0].commit.author.date = "2023-05-30T18:04:25Z"
```
fastgron can work backwards too, enabling you to turn your filtered data back into JSON:
```console
$ fastgron "https://api.github.com/repos/adamritter/fastgron/commits?per_page=1" | fgrep commit.author | fastgron --ungron
[
{
"commit": {
"author": {
"date": "2023-05-30T18:11:03Z",
"email": "58403584+adamritter@users.noreply.github.com",
"name": "adamritter"
}
}
}
]
```
## Quick Install
- Arch: `yay -S fastgron-git`
- Homebrew: `brew install fastgron --build-from-source`
- Nix: `nix profile install github:adamritter/fastgron#fastgron`
- Ubuntu: Download the latest binary from [releases](https://github.com/adamritter/fastgron/releases).
- Windows: Download the latest binary from [releases](https://github.com/adamritter/fastgron/releases). Note that libcurl support is missing from the released binary, so `http` and `https` URLs can't yet be read directly.
## Usage
```console
$ cat testdata/two.json
{
"name": "Tom",
"github": "https://github.com/tomnomnom/",
"likes": ["code", "cheese", "meat"],
"contact": {
"email": "mail@tomnomnom.com",
"twitter": "@TomNomNom"
}
}
```
```console
$ fastgron testdata/two.json
json = {}
json.name = "Tom"
json.github = "https://github.com/tomnomnom/"
json.likes = []
json.likes[0] = "code"
json.likes[1] = "cheese"
json.likes[2] = "meat"
json.contact = {}
json.contact.email = "mail@tomnomnom.com"
json.contact.twitter = "@TomNomNom"
```
```console
$ fastgron --help
Usage: fastgron [OPTIONS] [FILE | URL] [.path]
positional arguments:
FILE file name (or '-' for standard input)
options:
-h, --help show this help message and exit
-V, --version show version information and exit
-s, --stream enable stream mode
-F, --fixed-string PATTERN filter output by fixed string.
If -F is provided multiple times, multiple patterns are searched.
-v, --invert-match select non-matching lines for fixed string search
-i, --ignore-case ignore case distinctions in PATTERN
--sort sort output by key
--user-agent set user agent
--header Name:value set custom HTTP header, can be used multiple times
-u, --ungron ungron: convert gron output back to JSON
-p, -path filter path, for example .#.3.population or cities.#.population
-p is optional if path starts with . and file with that name doesn't exist
More complex path expressions: .{id,users[1:-3:2].{name,address}}
[[3]] is an index accessor without outputting on the path.
{globalid:id,user:users:[[1]],...} -- path renaming with accessor. It's a minimal, limited implementation right now.
--no-indent don't indent output
--root root path, default is json
--semicolon add semicolon to the end of each line
--no-spaces don't add spaces around =
-c, --color colorize output
--no-color don't colorize output
```
The file name can be - or missing, in that case the data is read from stdin.
## JSON lines (-s or --stream)
```js
json = []
json[0] = {}
json[0].one = 1
json[0].two = 2
json[0].three = []
json[0].three[0] = 1
json[0].three[1] = 2
json[0].three[2] = 3
json[1] = {}
json[1].one = 1
json[1].two = 2
json[1].three = []
json[1].three[0] = 1
json[1].three[1] = 2
json[1].three[2] = 3
```
## Speed (50x speedup compared to gron on 190MB file)
While there's a 50x speedup for converting JSON to GRON, gron is not able to convert a 800MB file back to JSON.
It takes 8s for fastgron to convert the 840MB file back to JSON.
citylots.json can be downloaded here: https://github.com/zemirco/sf-city-lots-json/blob/master/citylots.json
```
time fastgron ~/Downloads/citylots.json > /dev/null
fastgron ~/Downloads/citylots.json > /dev/null 0.38s user 0.07s system 99% cpu 0.447 total
time gron --no-sort ~/Downloads/citylots.json >/dev/null
gron --no-sort ~/Downloads/citylots.json > /dev/null 27.60s user 30.73s system 158% cpu 36.705 total
time fastgron --sort ~/Downloads/citylots.json > /dev/null
fastgron --sort ~/Downloads/citylots.json > /dev/null 1.05s user 0.41s system 99% cpu 1.464 total
time gron ~/Downloads/citylots.json > /dev/null
gron ~/Downloads/citylots.json > /dev/null 52.34s user 48.46s system 117% cpu 1:25.80 total
time fastgron ~/Downloads/citylots.json | rg UTAH
json.features[132396].properties.STREET = "UTAH"
json.features[132434].properties.STREET = "UTAH"
json.features[132438].properties.STREET = "UTAH"
json.features[132480].properties.STREET = "UTAH"
...
json.features[139041].properties.STREET = "UTAH"
json.features[139489].properties.STREET = "UTAH"
fastgron ~/Downloads/citylots.json 0.39s user 0.11s system 80% cpu 0.629 total
rg UTAH 0.07s user 0.05s system 19% cpu 0.629 total
time fastgron -u citylots.gson > c2.json
fastgron -u citylots.gson > c2.json 5.62s user 0.47s system 99% cpu 6.122 total
time gron -u citylots.gson > c3.json
[2] 8270 killed gron -u citylots.gson > c3.json
gron -u citylots.gson > c3.json 66.99s user 61.06s system 189% cpu 1:07.75 total
```
Path finding is 18x faster than jq and 5x faster than jj:
- `jq`: 3.252s
```console
$ time jq -cM ".features[10000].properties.LOT_NUM" < ~/Downloads/citylots.json
"091"
jq -cM ".features[10000].properties.LOT_NUM" < ~/Downloads/citylots.json 2.91s user 0.28s system 97% cpu 3.252 total
```
- `jj`: 0.972s
```console
$ time jj -r features.10000.properties.LOT_NUM < ~/Downloads/citylots.json
"091"
jj -r features.10000.properties.LOT_NUM < ~/Downloads/citylots.json 0.87s user 0.71s system 161% cpu 0.972 total
```
- `fastgron`: 0.176s
```console
$ time build/fastgron .features.10000.properties.LOT_NUM < ~/Downloads/citylots.json
json.features[10000].properties.LOT_NUM = "091"
build/fastgron .features.10000.properties.LOT_NUM < ~/Downloads/citylots.json 0.07s user 0.10s system 95% cpu 0.176 total
```
## Building
To build and run this project, you need:
- A C++20 compatible compiler
- [CMake](https://cmake.org/) (version 3.8 or higher)
- libcurl installed (Optional)
### Nix
1. Enable [Flakes](https://nixos.wiki/wiki/Flakes) locally.
1. Run `nix build` to build the `fastgron` binary locally.
For a development environment, either:
- Enable `direnv` in your shell then approve the use of [`.envrc`](./.envrc) via `direnv allow` or
- explicitly enter a development shell via `nix develop`.
### Ubuntu
Here are the steps to build, test, and install `fastgron`:
```bash
apt install cmake clang libcurl4-openssl-dev libssl-dev zlib1g-dev
git clone https://github.com/adamritter/fastgron.git
cd fastgron
cmake -B build -DCMAKE_CXX_COMPILER=/usr/bin/clang++ && cmake --build build
cmake install build/
```
## Future development ideas:
- Paths: Implement more complex path queries: using \*, [] , multiple exlusive paths using {}. {} also could be extended for allowing
simple path renaming and value setting, like {.name:.author.name,.address:.author.address,is_person:true}
- Path autocompletion is much better with gron type paths than js style functions, the code should take advantage of it
- memory mapping would be great, but it depends on the underlying SIMDJSON library not needing padding.
- CSV support would probably be helpful (using csv2 header only library for example), as there are some big CSV files out there.
toml / yaml support is not out of the question, but I don't know about people using it in general
- multiple file support would probably be great, which would make it easy to merge multiple files (especially with giving
different --root values to different files)
- after the filters get useful enough, directly outputting JSON is also an option, it can be much faster than gron and then ungron
together, as there's no need to build up maps of values
- for streaming / ndjson, multi-threaded implementation should be used
- the code should be accessible as a library as well, especially when it gets more powerful
- simply appending GRON code, like setting some paths/values maybe a useful simple feature
- A fastjq implementation could be created from the learnings of this project
- --skip-initializations, --output-json
- Beat other benchmarks: https://colab.research.google.com/github/dcmoura/spyql/blob/master/notebooks/json_benchmark.ipynb#scrollTo=Ub3wTHktDQtX
| High-performance JSON to GRON (greppable, flattened JSON) converter | gron,javascript,json | 2023-05-27T19:00:45Z | 2024-01-07T00:26:43Z | 2023-12-06T18:53:50Z | 4 | 8 | 234 | 3 | 9 | 578 | null | MIT | C++ |
aralroca/default-composer | main | <div align="center">
<img src="./logo.svg" alt="Default composer logo" width="100" height="100" />
<h1>
<div><b>Default composer</b></div>
</h1>
</div>
_A **tiny** (~500B) **JavaScript library** that allows you to set **default values** for **nested objects**_
[](https://badge.fury.io/js/default-composer)
[](https://unpkg.com/default-composer)
[](https://github.com/aralroca/default-composer/actions/workflows/test.yml)
[](https://github.com/aralroca/default-composer#maintenance-status)
[](https://www.npmjs.com/package/default-composer)
[![PRs Welcome][badge-prwelcome]][prwelcome]<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
[](#contributors-)
<!-- ALL-CONTRIBUTORS-BADGE:END -->
[badge-prwelcome]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square
[prwelcome]: http://makeapullrequest.com
"default-composer" is a JavaScript library that allows you to set default values for **nested objects**. The library replaces empty strings/arrays/objects, null, or undefined values in an existing object with the defined default values, which helps simplify programming logic and reduce the amount of code needed to set default values.
**Content**:
- [1. Installation](#installation)
- [2. Usage](#usage)
- [3. API](#api)
- [`defaultComposer`](#defaultcomposer)
- [`setConfig`](#setconfig)
- [`isDefaultableValue`](#isdefaultablevalue)
- [`mergeArrays`](#mergearrays)
- [4. TypeScript](#typescript)
- [5. Contributing](#contributing)
- [6. License](#license)
- [7. Credits](#credits)
- [8. Contributors](#contributors-)
## Installation
You can install "default-composer" using npm:
```bh
npm install default-composer
```
or with yarn:
```bh
yarn add default-composer
```
## Usage
To use "default-composer", simply import the library and call the `defaultComposer()` function with the default values object and the original object that you want to set default values for. For example:
```js
import { defaultComposer } from "default-composer";
const defaults = {
name: "Aral 😊",
surname: "",
isDeveloper: true,
isDesigner: false,
age: 33,
address: {
street: "123 Main St",
city: "Anytown",
state: "CA",
},
emails: ["contact@aralroca.com"],
hobbies: ["programming"],
};
const originalObject = {
name: "Aral",
emails: [],
phone: "555555555",
age: null,
address: {
zip: "54321",
},
hobbies: ["parkour", "computer science", "books", "nature"],
};
const result = defaultComposer(defaults, originalObject);
console.log(result);
```
This will output:
```js
{
name: 'Aral',
surname: '',
isDeveloper: true,
isDesigner: false,
emails: ['contact@aralroca.com'],
phone: '555555555',
age: 33,
address: {
street: '123 Main St',
city: 'Anytown',
state: 'CA',
zip: '54321'
},
hobbies: ['parkour', 'computer science', 'books', 'nature'],
}
```
## API
### `defaultComposer`
```js
defaultComposer(defaultsPriorityN, [..., defaultsPriority2, defaultsPriority1, objectWithData])
```
This function takes one or more objects as arguments and returns a new object with default values applied. The first argument should be an object containing the default values to apply. Subsequent arguments should be the objects to apply the default values to.
If a property in a given object is either empty, null, or undefined, and the corresponding property in the defaults object is not empty, null, or undefined, the default value will be used.
**Example**:
```js
import { defaultComposer } from "default-composer";
const defaultsPriority1 = {
name: "Aral 😊",
hobbies: ["reading"],
};
const defaultsPriority2 = {
name: "Aral 🤔",
age: 33,
address: {
street: "123 Main St",
city: "Anytown",
state: "CA",
zip: "12345",
},
hobbies: ["reading", "hiking"],
};
const object = {
address: {
street: "",
city: "Anothercity",
state: "NY",
zip: "",
},
hobbies: ["running"],
};
const result = defaultComposer(defaultsPriority2, defaultsPriority1, object);
console.log(result);
```
This will output:
```js
{
name: 'Aral 😊',
age: 33,
address: {
street: '123 Main St',
city: 'Anothercity',
state: 'NY',
zip: '12345'
},
hobbies: ['running']
}
```
### `setConfig`
`setConfig` is a function that allows you to set configuration options for `defaultComposer`.
This is the available configuration:
- **`isDefaultableValue`**, is a function that determines whether a value should be considered defaultable or not.
- **`mergeArrays`**, is a boolean to define if you want to merge arrays (`true`) or not (`false`), when is set to `false` is just replacing to the default value when the original array is empty. By default is `false`.
#### `isDefaultableValue`
You can use `setConfig` to provide your own implementation of `isDefaultableValue` if you need to customize this behavior.
```ts
type IsDefaultableValueParams = ({
key,
value,
defaultableValue,
}: {
key: string;
value: unknown;
defaultableValue: boolean; // In case you want to re-use the default behavior
}) => boolean;
```
The `defaultableValue` boolean is the result of the default behavior of `isDefaultableValue`. By default, is detected as `defaultableValue` when is `null`, `undefined`, an empty `string`, an empty `array`, or an empty `object`.
Here is an example of how you can use `setConfig`:
```ts
import { defaultComposer, setConfig } from "default-composer";
const isNullOrWhitespace = ({ key, value }) => {
return value === null || (typeof value === "string" && value.trim() === "");
};
setConfig({ isDefaultableValue: isNullOrWhitespace });
const defaults = { example: "replaced", anotherExample: "also replaced" };
const originalObject = { example: " ", anotherExample: null };
const result = defaultComposer<any>(defaults, originalObject);
console.log(result); // { example: 'replaced', anotherExample: 'also replaced' }
```
Here is another example of how you can use `setConfig` reusing the `defaultableValue`:
```ts
import { defaultComposer, setConfig } from "default-composer";
setConfig({
isDefaultableValue({ key, value, defaultableValue }) {
return (
defaultableValue || (typeof value === "string" && value.trim() === "")
);
},
});
const defaults = { example: "replaced", anotherExample: "also replaced" };
const originalObject = { example: " ", anotherExample: null };
const result = defaultComposer<any>(defaults, originalObject);
console.log(result); // { example: 'replaced', anotherExample: 'also replaced' }
```
#### `mergeArrays`
Example to merge arrays:
```ts
const defaults = {
hobbies: ["reading"],
};
const object = {
hobbies: ["running"],
};
setConfig({ mergeArrays: true});
defaultComposer<any>(defaults, object)) // { hobbies: ["reading", "running"]}
```
## TypeScript
In order to use in TypeScript you can pass a generic with the expected output, and all the expected input by default should be partials of this generic.
Example:
```ts
type Addres = {
street: string;
city: string;
state: string;
zip: string;
};
type User = {
name: string;
age: number;
address: Address;
hobbies: string[];
};
const defaults = {
name: "Aral 😊",
hobbies: ["reading"],
};
const object = {
age: 33,
address: {
street: "",
city: "Anothercity",
state: "NY",
zip: "",
},
hobbies: [],
};
defaultComposer<User>(defaults, object);
```
## Contributing
Contributions to "default-composer" are welcome! If you find a bug or want to suggest a new feature, please open an issue on the GitHub repository. If you want to contribute code, please fork the repository and submit a pull request with your changes.
## License
"default-composer" is licensed under the MIT license. See [LICENSE](LICENSE) for more information.
## Credits
"default-composer" was created by [Aral Roca](https://github.com/aralroca).
<img src="https://img.shields.io/twitter/follow/aralroca?style=social&logo=twitter"
alt="follow on Twitter"></a>
## Contributors ✨
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<table>
<tbody>
<tr>
<td align="center" valign="top" width="14.28%"><a href="https://aralroca.com"><img src="https://avatars.githubusercontent.com/u/13313058?v=4?s=100" width="100px;" alt="Aral Roca Gomez"/><br /><sub><b>Aral Roca Gomez</b></sub></a><br /><a href="https://github.com/aralroca/default-composer/commits?author=aralroca" title="Code">💻</a> <a href="#maintenance-aralroca" title="Maintenance">🚧</a></td>
<td align="center" valign="top" width="14.28%"><a href="http://robinpokorny.com"><img src="https://avatars.githubusercontent.com/u/68341?v=4?s=100" width="100px;" alt="Robin Pokorny"/><br /><sub><b>Robin Pokorny</b></sub></a><br /><a href="https://github.com/aralroca/default-composer/commits?author=robinpokorny" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/leeferwagen"><img src="https://avatars.githubusercontent.com/u/1287545?v=4?s=100" width="100px;" alt="Muslim Idris"/><br /><sub><b>Muslim Idris</b></sub></a><br /><a href="https://github.com/aralroca/default-composer/commits?author=leeferwagen" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/namhtpyn"><img src="https://avatars.githubusercontent.com/u/16488178?v=4?s=100" width="100px;" alt="namhtpyn"/><br /><sub><b>namhtpyn</b></sub></a><br /><a href="#infra-namhtpyn" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/Josuto"><img src="https://avatars.githubusercontent.com/u/6097850?v=4?s=100" width="100px;" alt="Josu Martinez"/><br /><sub><b>Josu Martinez</b></sub></a><br /><a href="https://github.com/aralroca/default-composer/issues?q=author%3AJosuto" title="Bug reports">🐛</a></td>
</tr>
</tbody>
</table>
<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->
<!-- ALL-CONTRIBUTORS-LIST:END -->
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
| A tiny (~500B) JavaScript library that allows you to set default values for nested objects | composer,defaults,javascript,json,merge,mix,nested-objects,tree,typescript | 2023-05-26T15:56:47Z | 2023-11-22T16:03:29Z | 2023-11-22T16:03:29Z | 5 | 20 | 49 | 0 | 10 | 459 | null | MIT | TypeScript |
AkshatOP/Poketwo-Autocatcher | main |
# Poketwo-AUTOCATCHER
A second generation **free** and open-source Pokétwo autocatcher, created with the goal of preventing people from wasting their money on buying autocatchers online.
😄😇 **Star this Repo if you find it useful**
---
### Youtube Tutorial
https://www.youtube.com/watch?v=Qqog9HaNU8Y
---
### Features
The bot has the following features:
- ⚙️ Easy Setup (simply run a script and enter the correct information, no 'coding' needed)
- ⬆️ Auto-levelling (Level up all your duel Pokémon to level 100 **overnight** by just selecting them!)
- 📜 Log all the pokemons it catch in your desired channel!
- 💲 **Completely free** and open-source (you can see the code as it is currently)
- 💕 **Trustworthy**; this autocatcher is **completely** open-source (meaning you can see the latest code)
- 📜 Support for all Pokémon in poketwo (GEN9 TOO!!)
- 🏎️ Super fast; the autocatcher can even handle Incense!
- 🔍 Pokétwo-Resistant - the autocatcher is undetectable due to it's method of catching
- 🔊 Say command `$say <text>` to trade pokemons/manipulate bot
- ✅ Can click any button by using `$click <messageID>`
- 🌟 Can react to any message by using `$react <messageID>`
### Requirements
Please note that this autocatcher requires NODEJS installed on your system or in any other platform you are trying to run it onto
## Invite Poke Name Bot to make the autocatcher run . [Invite Link](https://discord.com/oauth2/authorize?client_id=874910942490677270&permissions=412317379648&scope=applications.commands%20bot)
## Alternatively You can invite Sierra too! [Invite link](https://discord.com/oauth2/authorize?client_id=696161886734909481&permissions=8&scope=bot%20applications.commands)(but i prefer only use pokename only)
#### <b>Running the bot</b>
To start up the bot for the first time, STAR THIS REPO then clone the repo by this link to your local machine or replit (wherever you wish) [click here](https://github.com/AkshatOP/Poketwo-Autocatcher.git)
Once you have done that hit `npm install` in console.
## **Specific Channel Support**
If you want to run the bot so that it catches only in specific channels then Head over to LINE 17 of #index.js and fill the array with channel IDs of those channel you want to catch in.
*Leave it like [ ] if you don't want this feature*
## **Help**
Use $help command to get info about list of commands bot have in it
## **Captcha**
If Captcha comes , The bot stops it's catching and goes to a short sleep. You can solve the captcha from any ID and then use the command `$captcha_completed` for the bot to wake up
## **Config.json**
After That enter in the following fields in **Config.json**:
##### <b>TOKEN</b>:
Paste in your discord account's user token. You can find instructions on this [here](https://www.youtube.com/watch?v=3W9tAEsK7RM)
*CAUTION*
If you are using repl.it and don't want your token to be leaked. Follow this [tutorial](https://www.youtube.com/watch?v=BKlv__1OoGc) to secure your token and apply that fix in line 130 of index.js.
##### <b>spamChannelID</b>:
This will allow the bot to use your preferred channel to spam as well as catch Pokétwo spawns. Make sure you paste this carefully, as If you set it to the wrong channel it will spam and catch there.
##### <b>logChannelID</b>:
This will allow the bot to use your preferred channel to log the pokemons caught in a desired channel of yours.
##### <b>errorChannelID</b>:
This will allow the bot to use your preferred channel to log the errors of code in a desired channel of yours.
##### <b>OwnerID</b>:
This will be the user-ID of the account controlling the bot (for using "$say" and "$captcha_completed" command)
##### <b>ocrSpaceApiKey</b>:
This is the MOST IMPORTANT part. You have to create an ocrSpace account and put it's API key. Click [here](https://ocr.space/ocrapi/freekey) to get free API-KEY
After you've entered that in, the autocatcher should start successfully. (if not, check if you have entered in the right fields)
> Remember to cd into your autocatcher folder as well. If you need any help with something, feel free to open a Github Issue.
> ALL Done you can now start your bot by typing `node index.js` or `node .` in the console
### Auto-levelling
To enable auto-levelling, just select the pokemon in that autocatcher ID and let it auto-level
If you want to contribute to the community Please post the json you made after a few weeks of use of this bot here or DM me that json in Discord 🙂
---
## **DISCLAIMER**
Please note that self botting is against Discord's Terms of Service and being discovered using a self bot may result in your account being banned. To avoid this, keep knowledge of your self bot to a minimum and use a throwaway account. I am not responsible for any accounts lost due to the self bot. I also recommend checking the self bot channel's messages occasionally to see if Pokétwo has sent a captcha. **If it has, it would be a good idea to solve it.**
---
## Support Server
[Click here to join support server](https://discord.gg/FJD29BV8Np)
---
## Acknowledgements
### Creators
* 🔥⃤•AK_ØPᵈᵉᵛ✓#6326 [Click to DM](https://discordapp.com/users/503928755341885450)
* akshatop [Click to DM](https://discordapp.com/users/503928755341885450)
### Contributors
* 🔥⃤•AK_ØPᵈᵉᵛ✓#6326
---
| Poketwo Autocatcher for FREE to stop those premium selling developers for sh*t | autocatcher,catch-pokemon,discord,discord-js,javascript,nodejs,pokecord,pokemon,poketwo,poketwo-bot | 2023-05-31T04:51:46Z | 2024-02-15T07:50:52Z | null | 2 | 1 | 36 | 0 | 122 | 398 | null | MIT | JavaScript |
luguosong/programming-notes | main | # 知识点思维导图
| Programming Learning Blog | java,font-end,css,html5,javascript,nodejs,docker,linux,latex | 2023-05-17T07:02:59Z | 2024-05-22T09:03:52Z | null | 94 | 20 | 1,743 | 0 | 1 | 389 | null | GPL-3.0 | JavaScript |
ishwarrimal/frontend-interview-preps | main | # Ultimate Frontend Interview Preparation Guide
Topics we will be covering:
1. [**JavaScript**](./JavaScript/) : Basic and Advance.
2. [**React**](./React/) : Commonly asked questions and core concepts.
3. [**CSS**](./CSS/) : Commonly asked questions and a few concepts.
4. [**Web Fundamentals**](./Web%20Fundamentals/) : A lot of important topics.
5. [**DSA**](./DSA/) : Code for data structures and miscellaneous concepts.
## Note
Your feedback will help me improve this repo, so request you to share your feedback with me over email or write a LinkedIn post and tag me or raise a PR with your feedback on `feedbacks.md` file directly.
## About
Hi, I am _Ishwar Rimal_ and I maintain this repo. [Read more about me](https://github.com/ishwarrimal).
I have close to **8 years** of experience in the software industry. I've been working mostly at startups and have recently joined a product-based MNC.
Recently after giving a few interviews and preparing an interview guide for myself, I thought of making it public for everyone to access and get benefitted, and it's turning out to be useful to a lot of people.
This repo is open to everyone for contribution.
I am looking for a couple of folks to help me maintain this repo. Feel free to reach out if you're interested.
## Some Feedback this repo got
- A special thanks to Ishwar Rimal for his outstanding contribution! His Frontend Interview Repository has been my secret weapon during interview preparations. Ishwar, your dedication to knowledge sharing is truly inspiring, and it's made a world of difference in my career.
- Read more [here](https://github.com/ishwarrimal/frontend-interview-preps/blob/main/feedbacks.md)
## How this Course is structured
There are 5 different folders in this repo:
1. [**CSS**](./CSS/)
2. [**JavaScript**](./JavaScript/)
3. [**React**](./React/)
4. [**Web Fundamentals**](./Web%20Fundamentals/)
5. [**DSA**](./DSA/)
Each folder contains information about the content.
# Found some issue in the repo?
Create a new issue.
Please use a clear and descriptive title that summarizes the issue.
You can either contribute and resolve the issue yourself, or you can patiently await someone else to address it. It's important to note that simply opening a new issue is also appreciated and recognized.
If you have any questions or need further assistance, feel free to reach out to me or open an issue.
## Contributors ✨
Thanks go to these wonderful people :
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<table>
<tbody>
<tr>
<td align="center" valign="top" width="25%"><a href="https://github.com/ishwarrimal"><img src="https://avatars.githubusercontent.com/u/17489662?v=4" width="100px;"/><br /><sub><b>Ish</b></sub></a><br /></td>
<td align="center" valign="top" width="25%"><a href="https://github.com/SahulKola"><img src="https://avatars.githubusercontent.com/u/39924419?v=4" width="100px;"/><br /><sub><b>Sai Kumar Kola</b></sub></a><br /></td>
<td align="center" valign="top" width="25%"><a href="https://github.com/Abhii-07"><img src="https://avatars.githubusercontent.com/u/97459166?v=4" width="100px;"/><br /><sub><b>Abhijeet Hiwale</b></sub></a><br /></td>
<td align="center" valign="top" width="25%"><a href="https://github.com/Gvinod1991"><img src="https://avatars.githubusercontent.com/u/13873668?v=4" width="100px;"/><br /><sub><b>Vinod Godti</b></sub></a><br /></td>
</tr>
<tr>
<td align="center" valign="top" width="25%"><a href="https://github.com/RakeshSangem"><img src="https://avatars.githubusercontent.com/u/107752425?v=4" width="100px;"/><br /><sub><b>Rakesh Sangem</b></sub></a><br /></td>
<td align="center" valign="top" width="25%"><a href="https://github.com/nikitabarnawal"><img src="https://avatars.githubusercontent.com/u/6332886?v=4" width="100px;"/><br /><sub><b>Nikita Barnwal</b></sub></a><br /></td>
<td align="center" valign="top" width="25%"><a href="https://github.com/someoneme"><img src="https://avatars.githubusercontent.com/u/22216510?v=4" width="100px;"/><br /><sub><b>Hardik Ahuja</b></sub></a><br /></td>
</tr>
</tbody>
</table>
<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->
<!-- ALL-CONTRIBUTORS-LIST:END -->
Happy coding! 🚀
| Everything required to crack frontend interview | css,html,javascript,reactjs,react | 2023-05-31T16:30:27Z | 2024-01-25T14:06:21Z | null | 10 | 44 | 224 | 3 | 103 | 371 | null | MIT | JavaScript |
repalash/threepipe | master | # ThreePipe
A new way to work with three.js, 3D models and rendering on the web.
[ThreePipe](https://threepipe.org/) —
[Github](https://github.com/repalash/threepipe) —
[Examples](https://threepipe.org/examples/) —
[API Reference](https://threepipe.org/docs/) —
[WebGi](https://webgi.xyz/docs/)
[](https://www.npmjs.com/package/threepipe)
[](https://discord.gg/apzU8rUWxY)
[](https://opensource.org/license/apache-2-0/)
[](https://twitter.com/repalash)
ThreePipe is a 3D framework built on top of [three.js](https://threejs.org/) in TypeScript with a focus on rendering quality, modularity, and extensibility.
Key features include:
- Simple, intuitive API for creating 3D model viewers/configurators/editors on web pages, with many built-in presets for common workflows and use-cases.
- Companion [editor](https://threepipe.org/examples/tweakpane-editor/) to create, edit and configure 3D scenes in the browser.
- Modular architecture that allows you to easily extend the viewer, scene objects, materials, shaders, rendering, post-processing and serialization with custom functionality.
- Plugin system along with a rich library of built-in plugins that allows you to easily add new features to the viewer.
- [uiconfig](https://github.com/repalash/uiconfig.js) compatibility to automatically generate configuration UIs in the browser.
- Modular rendering pipeline with built-in deferred rendering, post-processing, RGBM HDR rendering, etc.
- Material extension framework to modify/inject/build custom shader code into existing materials at runtime from plugins.
- Extendable asset import, export and management pipeline with built-in support for gltf, glb, obj+mtl, fbx, materials(pmat/bmat), json, zip, png, jpeg, svg, webp, ktx2, ply, 3dm and many more.
- Automatic serialization of all viewer and plugin settings in GLB(with custom extensions) and JSON formats.
- Automatic disposal of all three.js resources with built-in reference management.
## Examples
Code samples and demos covering various usecases and test are present in the [examples](./examples/) folder.
Try them: https://threepipe.org/examples/
View the source code by pressing the code button on the top left of the example page.
To make changes and run the example, click on the CodePen button on the top right of the source code.
## Table of Contents
- [ThreePipe](#threepipe)
- [Examples](https://threepipe.org/examples/)
- [Table of Contents](#table-of-contents)
- [Getting Started](#getting-started)
- [HTML/JS Quickstart (CDN)](#htmljs-quickstart-cdn)
- [React](#react)
- [Vue.js](#vuejs)
- [Svelte](#svelte)
- [NPM/YARN Package](#npmyarn)
- [Installation](#installation)
- [Loading a 3D Model](#loading-a-3d-model)
- [License](#license)
- [Status](#status)
- [Documentation (API Reference)](#documentation)
- [WebGi](#webgi)
- [Contributing](#contributing)
- [Features](#features)
- [File Formats](#file-formats)
- [Loading files](#loading-files)
- [3D models](#3d-models)
- [Materials](#materials)
- [Images/Textures](#imagestextures)
- [zip files](#zip-files)
- [txt, json files](#txt-json-files)
- [Data URLs](#data-urls)
- [Local files, File and Blob](#local-files-file-and-blob)
- [Background, Environment maps](#background-environment-maps)
- [SVG strings](#svg-strings)
- [Exporting files](#exporting-files)
- [Exporting 3D models](#exporting-3d-models)
- [Exporting Materials](#exporting-materials)
- [Exporting Canvas Images](#exporting-canvas-images)
- [Exporting Images/Textures](#exporting-imagestextures)
- [Exporting Render Targets](#exporting-render-targets)
- [Render Pipeline](#render-pipeline)
- [Material Extension](#material-extension)
- [UI Configuration](#ui-configuration)
- [Serialization](#serialization)
- [Plugin System](#plugin-system)
- [Viewer API](#viewer-api)
- [ThreeViewer](#threeviewer)
- [RenderManager](#rendermanager)
- [RootScene](#rootscene)
- [ICamera](#icamera)
- [AssetManager](#assetmanager)
- [AssetImporter](#assetimporter)
- [AssetExporter](#assetexporter)
- [MaterialManager](#materialmanager)
- [Other classes and interfaces](#other-classes-and-interfaces)
- [Plugins](#threepipe-plugins)
- [TonemapPlugin](#tonemapplugin) - Add tonemap to the final screen pass
- [DropzonePlugin](#dropzoneplugin) - Drag and drop local files to import and load
- [ProgressivePlugin](#progressiveplugin) - Post-render pass to blend the last frame with the current frame
- [DepthBufferPlugin](#depthbufferplugin) - Pre-rendering of depth buffer
- [NormalBufferPlugin](#normalbufferplugin) - Pre-rendering of normal buffer
- [GBufferPlugin](#gbufferplugin) - Pre-rendering of depth-normal and flags buffers in a single pass
- [SSAOPlugin](#ssaoplugin) - Add SSAO(Screen Space Ambient Occlusion) for physical materials.
- [CanvasSnapshotPlugin](#canvassnapshotplugin) - Add support for taking snapshots of the canvas
- [PickingPlugin](#pickingplugin) - Adds support for selecting objects in the viewer with user interactions and selection widgets
- [TransformControlsPlugin](#transformcontrolsplugin) - Adds support for moving, rotating and scaling objects in the viewer with interactive widgets
- [ContactShadowGroundPlugin](#contactshadowgroundplugin) - Adds a ground plane at runtime with contact shadows
- [GLTFAnimationPlugin](#gltfanimationplugin) - Add support for playing and seeking gltf animations
- [PopmotionPlugin](#popmotionplugin) - Integrates with popmotion.io library for animation/tweening
- [CameraViewPlugin](#cameraviewplugin) - Add support for saving, loading, animating, looping between camera views
- [RenderTargetPreviewPlugin](#rendertargetpreviewplugin) - Preview any render target in a UI panel over the canvas
- [GeometryUVPreviewPlugin](#geometryuvpreviewplugin) - Preview UVs of any geometry in a UI panel over the canvas
- [FrameFadePlugin](#framefadeplugin) - Post-render pass to smoothly fade to a new rendered frame over time
- [VignettePlugin](#vignetteplugin) - Add Vignette effect by patching the final screen pass
- [ChromaticAberrationPlugin](#chromaticaberrationplugin) - Add Chromatic Aberration effect by patching the final screen pass
- [FilmicGrainPlugin](#filmicgrainplugin) - Add Filmic Grain effect by patching the final screen pass
- [NoiseBumpMaterialPlugin](#noisebumpmaterialplugin) - Sparkle Bump/Noise Bump material extension for PhysicalMaterial
- [CustomBumpMapPlugin](#custombumpmapplugin) - Custom Bump Map material extension for PhysicalMaterial
- [ClearcoatTintPlugin](#clearcoattintplugin) - Clearcoat Tint material extension for PhysicalMaterial
- [FragmentClippingExtensionPlugin](#fragmentclippingextensionplugin) - Fragment/SDF Clipping material extension for PhysicalMaterial
- [HDRiGroundPlugin](#hdrigroundplugin) - Add support for ground projected hdri/skybox to the webgl background shader.
- [VirtualCamerasPlugin](#virtualcamerasplugin) - Add support for rendering virtual cameras before the main one every frame.
- [EditorViewWidgetPlugin](#editorviewwidgetplugin) - Adds an interactive ViewHelper/AxisHelper that syncs with the main camera.
- [Object3DWidgetsPlugin](#object3dwidgetsplugin) - Automatically create light and camera helpers/gizmos when they are added to the scene.
- [Object3DGeneratorPlugin](#object3dwidgetsplugin) - Provides UI and API to create scene objects like lights, cameras, meshes, etc.
- [DeviceOrientationControlsPlugin](#deviceorientationcontrolsplugin) - Adds a controlsMode to the mainCamera for device orientation controls(gyroscope rotation control).
- [PointerLockControlsPlugin](#pointerlockcontrolsplugin) - Adds a controlsMode to the mainCamera for pointer lock controls.
- [ThreeFirstPersonControlsPlugin](#threefirstpersoncontrolsplugin) - Adds a controlsMode to the mainCamera for first person controls from threejs.
- [Rhino3dmLoadPlugin](#rhino3dmloadplugin) - Add support for loading .3dm files
- [PLYLoadPlugin](#plyloadplugin) - Add support for loading .ply files
- [STLLoadPlugin](#stlloadplugin) - Add support for loading .stl files
- [KTX2LoadPlugin](#ktx2loadplugin) - Add support for loading .ktx2 files
- [KTXLoadPlugin](#ktxloadplugin) - Add support for loading .ktx files
- [SimplifyModifierPlugin](#simplifymodifierplugin) - Boilerplate for plugin to simplify geometries
- [MeshOptSimplifyModifierPlugin](#meshoptsimplifymodifierplugin) - Simplify geometries using meshoptimizer library
- [Packages](#threepipe-packages)
- [@threepipe/plugin-tweakpane](#threepipeplugin-tweakpane) Tweakpane UI Plugin
- [@threepipe/plugin-blueprintjs](#threepipeplugin-blueprintjs) BlueprintJs UI Plugin
- [@threepipe/plugin-tweakpane-editor](#threepipeplugin-tweakpane-editor) - Tweakpane Editor Plugin
- [@threepipe/plugins-extra-importers](#threepipeplugins-extra-importers) - Plugin for loading more file types supported by loaders in three.js
- [@threepipe/plugin-blend-importer](#threepipeplugin-blend-importer) - Blender to add support for loading .blend file
- [@threepipe/plugin-geometry-generator](#threepipeplugin-geometry-generator) - Generate parametric geometry types that can be re-generated from UI/API.
- [@threepipe/plugin-gaussian-splatting](#threepipeplugin-gaussian-splatting) - Gaussian Splatting plugin for loading and rendering splat files
## Getting Started
### HTML/JS Quickstart (CDN)
```html
<canvas id="three-canvas" style="width: 800px; height: 600px;"></canvas>
<script type="module">
import {ThreeViewer, DepthBufferPlugin} from 'https://threepipe.org/dist/index.mjs'
const viewer = new ThreeViewer({canvas: document.getElementById('three-canvas')})
// Add some plugins
viewer.addPluginSync(new DepthBufferPlugin())
// Load an environment map
const envPromise = viewer.setEnvironmentMap('https://threejs.org/examples/textures/equirectangular/venice_sunset_1k.hdr')
const modelPromise = viewer.load('https://threejs.org/examples/models/gltf/DamagedHelmet/glTF/DamagedHelmet.gltf', {
autoCenter: true,
autoScale: true,
})
Promise.all([envPromise, modelPromise]).then(([env, model]) => {
console.log('Loaded', model, env, viewer)
})
</script>
```
Check it in action: https://threepipe.org/examples/#html-js-sample/
Check out the details about the [ThreeViewer API](#viewer-api) and more [plugins](#threepipe-plugins) below.
### React
A sample [react](https://react.dev) component in tsx to render a model with an environment map.
```tsx
import React from 'react'
function ThreeViewerComponent({src, env}: {src: string, env: string}) {
const canvasRef = React.useRef(null)
React.useEffect(() => {
const viewer = new ThreeViewer({canvas: canvasRef.current})
const envPromise = viewer.setEnvironmentMap(env)
const modelPromise = viewer.load(src)
Promise.all([envPromise, modelPromise])
return () => {
viewer.dispose()
}
}, [])
return (
<canvas id="three-canvas" style={{width: 800, height: 600}} ref={canvasRef} />
)
}
```
Check it in action: https://threepipe.org/examples/#react-tsx-sample/
Other examples in js: https://threepipe.org/examples/#react-js-sample/ and jsx: https://threepipe.org/examples/#react-jsx-sample/
### Vue.js
A sample [vue.js](https://vuejs.org/) component in js to render a model with an environment map.
```js
const ThreeViewerComponent = {
setup() {
const canvasRef = ref(null);
onMounted(() => {
const viewer = new ThreeViewer({ canvas: canvasRef.value });
const envPromise = viewer.setEnvironmentMap('https://threejs.org/examples/textures/equirectangular/venice_sunset_1k.hdr');
const modelPromise = viewer.load('https://threejs.org/examples/models/gltf/DamagedHelmet/glTF/DamagedHelmet.gltf');
Promise.all([envPromise, modelPromise])
onBeforeUnmount(() => {
viewer.dispose();
});
});
return { canvasRef };
},
};
```
Check it in action: https://threepipe.org/examples/#vue-html-sample/
Another example with Vue SFC(Single file component): https://threepipe.org/examples/#vue-sfc-sample/
### Svelte
A sample [svelte](https://svelte.dev/) component in js to render a model with an environment map.
```html
<script>
import {onDestroy, onMount} from 'svelte';
import {ThreeViewer} from 'threepipe';
let canvasRef;
let viewer;
onMount(() => {
viewer = new ThreeViewer({canvas: canvasRef});
const envPromise = viewer.setEnvironmentMap('https://threejs.org/examples/textures/equirectangular/venice_sunset_1k.hdr');
const modelPromise = viewer.load('https://threejs.org/examples/models/gltf/DamagedHelmet/glTF/DamagedHelmet.gltf');
Promise.all([envPromise, modelPromise])
});
onDestroy(() => viewer.dispose())
</script>
<canvas bind:this={canvasRef} id="three-canvas" style="width: 800px; height: 600px"></canvas>
```
Check it in action: https://threepipe.org/examples/#svelte-sample/
### NPM/YARN
### Installation
```bash
npm install threepipe
```
### Loading a 3D Model
First, create a canvas element in your HTML page:
```html
<canvas id="three-canvas" style="width: 800px; height: 600px;"></canvas>
```
Then, import the viewer and create a new instance:
```typescript
import {ThreeViewer, IObject3D} from 'threepipe'
// Create a viewer
const viewer = new ThreeViewer({canvas: document.getElementById('three-canvas') as HTMLCanvasElement})
// Load an environment map
await viewer.setEnvironmentMap('https://threejs.org/examples/textures/equirectangular/venice_sunset_1k.hdr')
// Load a model
const result = await viewer.load<IObject3D>('https://threejs.org/examples/models/gltf/DamagedHelmet/glTF/DamagedHelmet.gltf', {
autoCenter: true,
autoScale: true,
})
```
That's it! You should now see a 3D model on your page.
The 3D model can be opened in the [editor](https://threepipe.org/examples/tweakpane-editor/) to view and edit the scene settings, objects, materials, lights, cameras, post-processing, etc. and exported as a GLB file. All settings are automatically serialized and saved in the GLB file, which can be loaded into the viewer. Any plugins used in the editor can be added to the viewer to add the same functionality. The plugin data is automatically loaded(if the plugin is added) when the model is added to the scene.
The viewer initializes with a Scene, Camera, Camera controls(Orbit Controls), several importers, exporters and a default rendering pipeline. Additional functionality can be added with plugins.
Check out the GLTF Load example to see it in action or to check the JS equivalent code: https://threepipe.org/examples/#gltf-load/
Check out the [Plugins](#plugin-system) section below to learn how to add additional functionality to the viewer.
## License
The core framework([src](https://github.com/repalash/threepipe/tree/master/src), [dist](https://github.com/repalash/threepipe/tree/master/dist), [examples](https://github.com/repalash/threepipe/tree/master/examples) folders) and any [plugins](https://github.com/repalash/threepipe/tree/master/plugins) without a separate license are under the Free [Apache 2.0 license](https://github.com/repalash/threepipe/tree/master/LICENSE).
Some plugins(in the [plugins](https://github.com/repalash/threepipe/tree/master/plugins) folder) might have different licenses. Check the individual plugin documentation and the source folder/files for more details.
## Status
The project is in `alpha` stage and under active development. Many features will be added but the core API will not change significantly in future releases.
Check out [WebGi](https://webgi.xyz/) for an advanced tailor-made solution for e-commerce, jewelry, automobile, apparel, furniture etc.
## Documentation
Check the list of all functions, classes and types in the [API Reference Docs](https://threepipe.org/docs/).
## WebGi
Check out WebGi - Premium Photo-realistic 3D rendering framework and tools for web applications and online commerce along with custom modules and rendering solutions for e-commerce, jewelry, automobile, apparel, furniture and other retail applications.
[Homepage](https://webgi.xyz/) — [Docs](https://webgi.xyz/docs/)
[](https://twitter.com/pixotronics)
## Contributing
Contributions to ThreePipe are welcome and encouraged! Feel free to open issues and pull requests on the GitHub repository.
# Features
## File Formats
ThreePipe Asset Manager supports the import of the following file formats out of the box:
* **Models**: gltf, glb, obj+mtl, fbx, drc
* **Materials**: mat, pmat, bmat (json based), registered material template slugs
* **Images**: webp, png, jpeg, jpg, svg, ico, avif, hdr, exr
* **Misc**: json, vjson, zip, txt
Plugins can add additional formats:
* Models
* 3dm - Using [Rhino3dmLoadPlugin](#Rhino3dmLoadPlugin)
* ply - Using [PLYLoadPlugin](#PLYLoadPlugin)
* usdz - Using [USDZLoadPlugin](#USDZLoadPlugin)
* stl - Using [STLLoadPlugin](#STLLoadPlugin)
* ktx - Using [KTXLoadPlugin](#KTXLoadPlugin)
* ktx2 - Using [KTX2LoadPlugin](#KTX2LoadPlugin)
Plugins to support more model formats are available in the package [@threepipe/plugins-extra-importers](#threepipeplugins-extra-importers) including .3ds,
.3mf, .collada, .amf, .bvh, .vox, .gcode, .mdd, .pcd, .tilt, .wrl, .mpd, .vtk, .xyz
## Loading files
ThreePipe uses the [AssetManager](https://threepipe.org/docs/classes/AssetManager.html) to load files.
The AssetManager has support for loading files from URLs, local files and data URLs.
The AssetManager also adds support for loading files from a zip archive. The zip files are automatically unzipped, and the files are loaded from the zip archive.
[viewer.load()](https://threepipe.org/docs/classes/ThreeViewer.html#load) is a high-level wrapper for loading files from the AssetManager.
It automatically adds the loaded object to the scene and returns a promise that resolves to the loaded object,
the materials are also automatically registered to the material manager.
AssetManager internally uses [AssetImporter](https://threepipe.org/docs/classes/AssetImporter.html),
which provides a low-level API
for managing three.js [LoadingManager](https://threejs.org/docs/#api/en/loaders/LoadingManager)
and adding and registering loaders for different file types.
If the purpose is not to add files to the scene then [viewer.assetManager.importer.import()](https://threepipe.org/docs/classes/AssetImporter.html#import) method can be used
to import files from the `AssetImporter`.
viewer.assetManager.loadImported()](https://threepipe.org/docs/classes/AssetManager.html#loadImported)
can then be called to load the imported files after any processing.
The `viewer.load()`, `viewer.assetManager.addAsset()`
and `viewer.assetManager.addAssetSingle()` methods perform combination of `import` and `loadImported`.
### 3D models
The 3d models are added to `viewer.scene.modelRoot` on `viewer.load` unless some option is specified.
```typescript
const objectGlb = await viewer.load<IObject3D>('https://example.com/file.glb')
const objectFbx = await viewer.load<IObject3D>('https://example.com/file.fbx')
const objectObj = await viewer.load<IObject3D>('https://example.com/file.obj') // .mtl referenced in obj is automatically loaded
// ... load any 3d model file as an object
```
Here, we are casting to [IObject3D](https://threepipe.org/docs/interfaces/IObject3D.html) type
to get the proper type and autocomplete for the object.
`IObject3D` inherits [Object3D](https://threejs.org/docs/#api/en/core/Object3D) from three.js and adds some additional properties.
For JavaScript, the type can be omitted.
```javascript
const objectGlb = await viewer.load('https://example.com/file.glb')
```
When loading models, several options can be passed to automatically process the model first time, like `autoScale`, `autoCenter`, `addToRoot` etc. Check [AddObjectOptions](https://threepipe.org/docs/interfaces/AddObjectOptions.html) and [ImportAddOptions](https://threepipe.org/docs/interfaces/ImportAddOptions.html) for more details.
### Materials
The materials downloaded as PMAT/BMAT/JSON etc from threepipe,
webgi or the editor can be loaded
and registered with the [MaterialManager](https://threepipe.org/docs/classes/MaterialManager)
using the `viewer.load` method.
Custom material types can also be registered by plugins(like dmat for diamonds), which can also be loaded automatically using the `viewer.load` method.
```typescript
const pMaterial = await viewer.load<PhysicalMaterial>('https://example.com/file.pmat')
const bMaterial = await viewer.load<UnlitMaterial>('https://example.com/file.bmat')
// ... load any material file as a material
```
Casting to [PhysicalMaterial](https://threepipe.org/docs/classes/PhysicalMaterial) or [UnlitMaterial](https://threepipe.org/docs/classes/UnlitMaterial) is optional but recommended to get the proper type and autocomplete for the material.
To assign the material on any object, set it to `object.material`
```typescript
// find a loaded mesh in the scene
const object = viewer.scene.getObjectByName('objectName');
// assign the material
object.material = pMaterial;
```
To copy the properties without changing the material reference, use `material.copy()` or `material.setValues()` methods.
```typescript
object.material.copy(pMaterial);
// or use material manager to apply to multiple materials.
viewer.assetManager.materialManager.applyMaterial(pMaterial, 'METAL') // apply props to all materials/objects with the name METAL
```
TODO: add examples for material load and copy
### Images/Textures
Images can be loaded using the `viewer.load` method.
There is built-in support for loading all image formats supported by the browser (webp, png, jpeg, jpg, svg, ico, avif) and hdr, exr, hdr.png formats for all browsers.
More formats like ktx2, ktx, etc. can be added using plugins.
```typescript
const texture = await viewer.load<ITexture>('https://example.com/file.png')
// ... load any image file as a texture
```
Casting to [ITexture](https://threepipe.org/docs/interfaces/ITexture.html) is optional
but recommended to get the proper type and autocomplete for the texture.
It inherits from three.js [Texture](https://threejs.org/docs/#api/en/textures/Texture) and adds some additional properties.
To assign the texture on any material, set it to `material.map`
```typescript
// find a loaded mesh in the scene
const object = viewer.scene.getObjectByName('objectName');
const material = object.material as PhysicalMaterial;
// assign the texture
material.map = texture;
material.setDirty() // to let the viewer know that the material has changed and needs to re-render the scene. This will also trigger fade effect if FrameFadePlugin is added.
```
Check out the image load example to see it in action or to check the JS equivalent code: https://threepipe.org/examples/#image-load/
### Zip files
.zip files are automatically unzipped and the files are sent to re-load recursively when loaded with `viewer.load`.
Any level of zip hierarchy is flattened.
Loading files like .gltf with references to assets inside the zip file,
any relative references are also automatically resolved.
This is supported for file types like gltf, glb, obj,
etc which support references to external files and has `root` set to `true in [IImporter](https://threepipe.org/docs/interfaces/IImporter.html).
```typescript
const objectGltf = await viewer.load<IObject3D>('https://example.com/model.gltf.zip')
```
If we know that the zip file contains a single gltf with all the assets, we can cast the result to [IObject3D](https://threepipe.org/docs/interfaces/IObject3D.html) type.
To load multiple assets from zip files like multiple textures or materials, use `viewer.assetManager.addAsset` method which returns a promise of array of loaded assets.
```typescript
const textures = await viewer.assetManager.addAsset<ITexture[]>('https://example.com/textures.zip')
const materials = await viewer.assetManager.addAsset<IMaterial[]>('https://example.com/materials.zip')
```
The auto import of zip contents can be disabled to get the files and blobs in the zip
```typescript
const zip = await viewer.load<any>('https://example.com/file.zip', {autoImportZipContents: false})
```
TODO - add example for loading zip files.
### txt, json files
Text and JSON files can be loaded using the `viewer.load` method and return strings and objects respectively.
```typescript
const text = await viewer.load<string>('https://example.com/file.txt')
const json = await viewer.load<any>('https://example.com/file.json')
```
### Data URLs
Data URLs can be loaded using the `viewer.load` method. The correct mime-type is required to be set in the data URL for finding the correct importer.
```typescript
const dataUrl = 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUA' // ... some data url
const texture = await viewer.load<ITexture>(dataUrl)
```
### Local files, File and Blob
Local files can be loaded using the `viewer.load` method by passing a [IAsset](https://threepipe.org/docs/interfaces/IAsset) object with [File](https://developer.mozilla.org/en-US/docs/Web/API/File) or [Blob](https://developer.mozilla.org/en-US/docs/Web/API/Blob) object.
```typescript
const file: File|Blob = fileObject // create a new file, blob or get from input element
const text = await viewer.load<IObject>({
// a path/name is required to determine the proper importer by extension. `file.name` can also be used if available
path: 'file.glb',
file
})
```
The same can be done for any file type.
To load a `Map` of files(like when multiple files are dragged and dropped on the webpage) with internal references to other files, use `viewer.assetManager.importer.importFiles` method. Check the source for [DropzonePlugin](#dropzoneplugin) for an example.
### Background, Environment maps
The background and environment maps can be set using the `viewer.setBackgroundMap` and `viewer.setEnvironmentMap` methods respectively. These accept both loaded textures from `viewer.load` and direct URLs. Files can be of any image format including hdr, exr.
```typescript
await viewer.setEnvironmentMap('https://example.com/file.hdr')
await viewer.setBackgroundMap('https://example.com/file.png')
```
The same texture can be set to both by setting `setBackground` or `setEnvironment` to true in the options:
```typescript
await viewer.setEnvironmentMap('https://example.com/file.hdr', {setBackground: true})
```
Check the HDR Load example to see it in action: https://threepipe.org/examples/#hdr-load/
### SVG strings
SVG strings can be converted to data urls using the [svgUrl](https://repalash.com/ts-browser-helpers/functions/svgUrl.html) string template function
```typescript
const svgDataUrl = svgUrl`<svg viewBox="0 0 100 100" xmlns="http://www.w3.org/2000/svg"> ... </svg>`;
const texture = await viewer.load<ITexture>(dataUrl)
```
### Custom file types
Custom file importers/loaders can be registered to the `AssetImporter` using the `addImporter` method.
```typescript
class CustomLoader extends FileLoader implements ILoader{
constructor(manager?: LoadingManager) {
super(manager);
}
load(url: string, onLoad: (data: any) => void, onProgress?: (event: ProgressEvent) => void, onError?: (event: ErrorEvent) => void): Mesh {
this.setResponseType('json')
return super.load(url, (json: any)=>{
const mat = new PhysicalMaterial(json)
onLoad?.(mat)
}, onProgress, onError)
}
}
viewer.assetManager.importer.addImporter(new Importer(CustomLoader, ['ext'], ['mime/type'], false))
// load the file
const mat = await viewer.load<PhysicalMaterial>('https://example.com/file.ext')
```
## Exporting files
Threepipe has support for exporting various asset type with AssetManager,
as well as support to export viewer and plugin configuration, arbitrary objects etc using the [serialization](#serialization) system.
[viewer.export()](https://threepipe.org/docs/classes/ThreeViewer.html#export) is a high-level wrapper for exporting scene objects, materials, textures, render targets, viewer/scene configuration and plugin configurations.
AssetManager internally uses [AssetExporter](https://threepipe.org/docs/classes/AssetExporter.html) to export files.
AssetExporter includes some basic exporters for glb, exr, textures,
and materials and a system to register exporters for different file types with plugins or custom exporters.
### Exporting 3D models
Export the root scene as glb
```typescript
const blob = await viewer.exportScene({
viewerConfig: true, // default = true. export all viewer and plugin configuration. if false only the model root object is exported.
})
// download the file
downloadBlob(blob, 'scene.glb')
```
Export a single object from the scene as glb
```typescript
const object = viewer.scene.getObjectByName('objectName');
const glb: Blob = await viewer.export(object, {
exportExt: 'glb', // default = glb for models
embedUrlImages: true, // default = false. embed images in glb even when url is available.
})
// download the file
downloadBlob(glb, 'object.glb')
```
Check the example [glb-export](https://threepipe.org/examples/#glb-export/) to see a demo.
### Exporting Materials
Export a material
```typescript
const material = viewer.assetManager.materialManager.findMaterialsByName('materialName')[0];
// or
// const material = viewer.scene.getObjectByName('objectName').material;
const blob = await viewer.export(material)
// download the file
downloadBlob(blob, 'material.' + blob.ext)
```
Check the example [pmat-material-export](https://threepipe.org/examples/#pmat-material-export/) to see a demo.
### Exporting Canvas Images
Canvas Screenshot/snapshot can be exported as png, jpeg or webp(if supported by the browser)
```typescript
const blob = await viewer.getScreenshotBlob({mimeType: 'image/' + type, quality: 0.85})
// or to get data url:
// const dataUrl = await viewer.getScreenshotDataUrl({mimeType: 'image/' + type, quality: 0.85})
// download the file
downloadBlob(blob, 'screenshot.' + blob.ext)
```
Check the example [image-snapshot-export](https://threepipe.org/examples/#image-snapshot-export/) to see a demo.
### Exporting Textures
Textures can be exported to JSON using `viewer.export` or `AssetExporter`
```typescript
const texture = await viewer.load('https://example.com/file.jpeg')
const blob = await viewer.export(texture)
downloadBlob(blob, texture.name + '.' + blob.ext)
```
Render target textures can be exported with `viewer.renderManager.exportRenderTarget` or `viewer.export`,
read about [Exporting Render Targets](#exporting-render-targets) below.
TODO: add examples for texture export
Textures and Uint8 Data Textures can be exported as a data url or copied to a new canvas
```typescript
// get a base64 data url
const dataUrl = textureToDataUrl(texture, 4096, false, 'image/png') // texture or data texture, max-size, flipY, mimeType
// or copy to a new canvas
const canvas = textureToCanvas(texture, 4096) // texture or data texture, max-size
```
Data Textures of type Half float and Float can be exported with `viewer.export`
```typescript
const dataTex = await viewer.load('https://example.com/file.hdr')
const blob = await viewer.export(dataTexture, {exportExt: 'exr'})
```
Check the example [hdr-to-exr](https://threepipe.org/examples/#hdr-to-exr/) to see a demo of HDR to EXR conversion.
TODO: add support to export unsigned byte textures as png, jpeg, webp
### Exporting Images/Textures
Exporting Textures as Images with image of types ImageBitmap, HTMLImageElement,
HTMLOrSVGImageElement, CanvasImageSource, HTMLCanvasElement,
OffscreenCanvas can be exported to png data urls with [imageBitmapToBase64](https://repalash.com/ts-browser-helpers/functions/imageBitmapToBase64.html) function.
```typescript
const texture = await viewer.load('https://example.com/file.jpeg')
const dataUrl = await imageBitmapToBase64(texture.image, 'image/png', 0.85);
```
TODO: add support for texture export as images in AssetExporter
### Exporting Render Targets
Unsigned byte render targets can be exported as png, jpeg or webp(if supported by the browser)
```typescript
const depthPlugin = viewer.addPluginSync(DepthBufferPlugin, UnsignedByteType)
// wait for the first render
const blob = await viewer.export(depthPlugin.target!, {exportExt: 'png'})
if (blob) downloadBlob(blob, target.texture.name + '.' + blob.ext)
```
Half float and float render targets can be exported as exr
```typescript
const depthPlugin = viewer.addPluginSync(DepthBufferPlugin, HalfFloatType)
// wait for the first render
const blob = await viewer.export(depthPlugin.target!, {exportExt: 'exr'})
if (blob) downloadBlob(blob, target.texture.name + '.' + blob.ext)
```
Note: `exportExt` is determined automatically if not specified.
## Render pipeline
Threepipe includes a [RenderManager](https://threepipe.org/docs/classes/RenderManager.html) for managing the composition pipeline, and provides helpers for rendering and render target management.
The RenderManager includes a [EffectComposer](https://threejs.org/docs/#api/en/postprocessing/EffectComposer) from three.js for rendering passes and a [WebGLRenderer](https://threejs.org/docs/#api/en/renderers/WebGLRenderer) for rendering,
but the pass management and sorting is managed by the RenderManager itself.
The RenderManager inherits from [RenderTargetManager](https://threepipe.org/docs/classes/RenderTargetManager.html)
which provides utilities for creating, tracking and destroying dedicated and temporary render targets.
### Render Targets
Render targets can be created
using the `viewer.renderManager.createTarget` and `viewer.renderManager.createTargetCustom` methods.
These can then be disposed using the `viewer.renderManager.disposeTarget` method when not needed anymore.
Or to create temp targets for one time use `viewer.renderManager.getTempTarget` and `viewer.renderManager.releaseTempTarget` methods.
can be used.
All created render targets are tracked in the RenderManager,
and are resized and disposed automatically when needed along with the viewer.
```typescript
const newTarget = viewer.renderManager.createTarget({sizeMultiplier: 1})
// or
const newTarget2 = viewer.renderManager.createTarget({size: {
width: 1024,
height: 1024,
},
type: HalfFloatType
})
// or clone an existing target
const newTarget3 = viewer.renderManager.composerTarget.clone()
// for multi-sample render target
const newTarget4 = viewer.renderManager.createTarget({sizeMultiplier: 1, samples: 4})
// or create a custom target
const newTarget5 = viewer.renderManager.createTargetCustom(
{width: 1024, height: 1024},
{type: HalfFloatType},
WebGLCubeRenderTarget
)
// dispose targets
viewer.renderManager.disposeTarget(newTarget)
viewer.renderManager.disposeTarget(newTarget2)
viewer.renderManager.disposeTarget(newTarget3)
viewer.renderManager.disposeTarget(newTarget4)
viewer.renderManager.disposeTarget(newTarget5)
// get a temporary target
const tempTarget = viewer.renderManager.getTempTarget({sizeMultiplier: 1})
// release the temporary target
viewer.renderManager.releaseTempTarget(tempTarget)
```
Note: Render targets created with a sizeMultiplier are automatically resized when the canvas is resized.
### Passes
By default, the render pipeline includes 2 passes -
[RenderPass](https://threejs.org/docs/#api/en/postprocessing/RenderPass) for rendering the scene hierarchy and [ScreenPass](https://threejs.org/docs/#api/en/postprocessing/ShaderPass)
for rendering the final output on the canvas.
More passes can be added and removed from the pipeline
using the [registerPass](https://threepipe.org/docs/classes/RenderManager.html#registerPass) and [unregisterPass](https://threepipe.org/docs/classes/RenderManager.html#unregisterPass) methods.
The pipeline passes need
to follow the interface of [IPipelinePass](https://threepipe.org/docs/interfaces/IPipelinePass.html) and [IPipelinePassPlugin](https://threepipe.org/docs/interfaces/IPipelinePassPlugin.html).
Which adds some important parameters over the three.js Pass,
like pass id and support for defining where the pass should be added in the pipeline and it's dependants.
```typescript
const pass = new GBufferRenderPass('customPass', viewer.renderManager.createTarget({sizeMultiplier: 1}))
pass.before = ['render'] // Add the pass before the render pass
pass.after = [] // Add the pass after these passes (none in this case)
pass.required = ['render'] // render pass is required to be in the pipeline for this
viewer.renderManager.registerPass(pass)
```
Note:
See [PipelinePassPlugin](https://threepipe.org/docs/classes/PipelinePassPlugin.html) for an abstract plugin
that provides the boilerplate to create a plugin that registers a custom pass in the pipeline.
Check [NormalBufferPlugin](https://threepipe.org/docs/classes/NormalBufferPlugin.html) for an example of that.
Note: All effects in post-processing or material extension need not be a separate pass in the pipeline.
Most effects can be achieved with either extending the scene object material shaders or the Screen Pass material shader
using [Material extension](#material-extension) system
## Material Extension
Threepipe includes a Material extension system along with a material manager.
The material manager is used to register materials and material extensions.
The material extensions are used to extend any material in the scene,
or any plugin/pass with additional uniforms, defines, shader snippets and provides hooks.
The material extensions are automatically applied to all materials in the scene that are compatible,
when the extension is registered or when the material is added to the scene.
Threepipe includes several built-in materials like
[PhysicalMaterial](https://threepipe.org/docs/classes/PhysicalMaterial.html),
[UnlitMaterial](https://threepipe.org/docs/classes/UnlitMaterial.html),
[ExtendedShaderMaterial](https://threepipe.org/docs/classes/ExtendedShaderMaterial.html), [LegacyPhongMaterial](https://threepipe.org/docs/classes/LegacyPhongMaterial.html),
that include support for extending the material.
Any three.js material can be made extendable,
check the `ShaderPass2` class for a simple example that adds support for material extension to three.js ShaderPass.
The material extensions must follow the [MaterialExtension](https://threepipe.org/docs/interfaces/MaterialExtension.html) interface.
Many plugins create their own material extensions either for the scene materials or shader passes(like the screen pass).
Some plugins like `DepthBufferPlugin` also provides helper material extensions for other custom plugins
to fetch value in the depth buffer.
A sample material extension
```typescript
const extension: MaterialExtension = {
shaderExtender: (shader)=> {
// change the shader properties like shader.fragmentShader, etc
},
parsFragmentSnippet: ` // add some code before the main function in the fragment shader
uniform sampler2D tTexture;
uniform float opacity;
`,
extraUniforms: {
tTexture: ()=>({value: getTexture()}),
opacity: {value: 1}
// add additional uniforms, these can be IUniform or functions that return IUniform
},
extraDefines: {
['DEPTH_PACKING']: BasicDepthPacking,
['SOME_DEFINE']: ()=>"1",
// add additional defines, these can be values or functions that return values
},
priority: 100, // priority when using multiple extensions on the same material
isCompatible: (material) => material.isMeshBasicMaterial, // check if the material is compatible with this extension,
computeCacheKey: (material) => material.uuid, // a custom cache key for the material extension. Shader is recompiled when this is changed
onObjectRender: (object: Object3D, material: IMaterial) => {
// called when some object is rendererd which has a material with this extension.
},
// uiConfig
// check more properties and hooks in the MaterialExtension interface
}
// The extension can be registered to all the materials using the MaterialManager
viewer.assetManager.materialManager.registerMaterialExtension(extension)
// or register it on a single material (like the Screen Pass)
viewer.renderManager.screenPass.material.registerMaterialExtensions([extension])
```
## UI Configuration
Most of the classes and plugins in Threepipe include [uiconfig.js](https://repalash.com/uiconfig.js/) support
and can be used to create configuration UIs, 3d configurators and even full-editors.
The UIs are automatically generated based on the configuration object under `.uiConfig` property on all objects.
These are of type [UiObjectConfig](https://repalash.com/uiconfig.js/interfaces/UiObjectConfig.html).
In some classes, the ui configs are also generated using typescript decorators.
The `uiConfig` is also added to all three.js objects and materials when they are added to the scene.
The UIs can be generated at runtime using any of the UI plugins like [TweakpaneUIPlugin](#threepipeplugin-tweakpane), [BlueprintJsUiPlugin](#threepipeplugin-blueprintjs)
An example showing how to create a UI for a material
```typescript
const ui = viewer.addPluginSync(TweakpaneUiPlugin)
const object = viewer.scene.getObjectByName('objectName');
const material = object.material as PhysicalMaterial;
ui.appendChild(material.uiConfig)
```
See it in action: https://threepipe.org/examples/#material-uiconfig/
Check more examples showing [Viewer UI](https://threepipe.org/examples/#viewer-uiconfig/),
[Scene UI](https://threepipe.org/examples/#scene-uiconfig/),
[Object UI](https://threepipe.org/examples/#object-uiconfig/), [Camera UI](https://threepipe.org/examples/#camera-uiconfig/)
[TweakpaneEditorPlugin](#threepipeplugin-tweakpane-editor) further uses the Tweakpane configuration panel along with various plugins to create an 3d editor.
Custom UI configuration can be created to generate custom UI for the editor or tweaking.
This can be done by using typescript decorators or defining the UI in javascript as a [UiObjectConfig](https://repalash.com/uiconfig.js/interfaces/UiObjectConfig.html) object.
Here is a sample of extending the orbit controls class with decorators to automatically generate UI.
```typescript
@uiPanelContainer('Orbit Controls')
export class OrbitControlsWithUi extends OrbitControls implements IUiConfigContainer {
// for autocomplete
uiConfig?: UiObjectConfig<void, 'panel'>
@uiToggle() enabled = true
@uiToggle() dollyZoom = false
@uiToggle() enableDamping = true
@uiInput() dampingFactor = 0.08
@uiToggle() autoRotate = false
@uiInput() autoRotateSpeed = 2.0
@uiToggle() enableZoom = true
@uiInput() zoomSpeed = 0.15
@uiInput() maxZoomSpeed = 0.20
@uiToggle() enableRotate = true
@uiInput() rotateSpeed = 2.0
@uiToggle() enablePan = true
@uiInput() panSpeed = 1.0
@uiInput() autoPushTarget = false
@uiInput() autoPullTarget = false
@uiInput() minDistance = 0.35
@uiInput() maxDistance = 1000
@uiInput() minZoom = 0.01
@uiInput() maxZoom = 1000
@uiInput() minPolarAngle = 0
@uiInput() maxPolarAngle = Math.PI
@uiInput() minAzimuthAngle = -10000 // should be -Infinity but this breaks the UI
@uiInput() maxAzimuthAngle = 10000
}
```
Check out the full source code:
[./src/three/controls/OrbitControls3.ts](./src/three/controls/OrbitControls3.ts) for proper implementation
See it in action: https://threepipe.org/examples/#camera-uiconfig/ Open the Camera UI and click on the Orbit Controls panel.
There are many available decorators like `uiToggle`, `uiSlider`, `uiInput`, `uiNumber`, `uiColor`, `uiImage`.
Check the complete list in the [uiconfig.js documentation](https://repalash.com/uiconfig.js/).
The UI configuration can also be created using json objects in both typescript and javascript
```javascript
const viewer = new ThreeViewer({...})
const ui = viewer.addPluginSync(TweakpaneUiPlugin)
const state = {
position: new Vector3(),
scale: 1,
}
ui.appendChild({
type: 'folder',
label: 'Custom UI',
children: [
{
type: 'vec3',
label: 'Position',
property: [state, 'position']
},
{
type: 'slider',
label: ()=>'Scale', // everything can be a function as well.
property: [state, 'scale'],
bounds: [1, 2],
stepSize: 0.1,
}
]
})
```
TODO: create example/codepen for this
## Serialization
Easy serialization of all threepipe and most three.js objects are supported out of the box using the Asset Manager.
Fine control over serialization is also supported
using the [ThreeSerialization](https://threepipe.org/docs/classes/ThreeSerialization.html) class
Call `ThreeSerialization.serialize` on any object to serialize it.
and `ThreeSerialization.deserialize` to deserialize the serialized object.
This is done by performing a nested serialization of all the properties of the object.
It's possible to implement custom serializers for custom types and classes and is done for three.js primitives,
objects and plugins in threepipe
To make a custom data class that is serializable,
mark it using `@serializable` decorator and any properties using `@serialize` decorator.
```typescript
@serializable('DataClass')
class DataClass{
@serialize() prop1 = 1
@serialize() prop2 = 'string'
@serialize() prop3 = new Vector3()
@serialize() prop4 = new PhysicalMaterial()
@serialize() prop4 = {
prop1: 1,
prop2: 'string',
prop3: new Vector3(),
prop4: new PhysicalMaterial(),
}
}
const data = new DataClass()
const serialized = ThreeSerialization.serialize(data)
const deserialized = ThreeSerialization.deserialize(serialized)
```
The classes without a `@serializable` decorator are serialized as plain objects.
These can still include `@serialize` decorator to mark the properties are serializable
but these classes cannot be deserialized into a new instance of the class.
The ThreeViewer and plugins are an example of these.
When deserialized they need an object to deserialize into.
This ensures there is always just one instance.
With this, the serialization system works like `toJSON` and `fromJSON` methods in three.js.
Check the [plugin system](#plugin-system) below for more details on how to mark properties as serializable for plugins.
```typescript
class CustomClass{
@serialize() prop1 = 1
@serialize() prop2 = 'string'
@serialize() prop3 = new Vector3()
@serialize() prop4 = new PhysicalMaterial()
}
const obj = new DataClass()
const serialized = ThreeSerialization.serialize(data)
// now to deserialize we need to pass in the object to deserialize into
ThreeSerialization.deserialize(serialized, obj)
```
## Plugin System
Threepipe includes a plugin system for adding additional features to the viewer in a modular way.
The plugins can be added synchronously or asynchronously using `viewer.addPluginSync` and `viewer.addPlugin` methods respectively.
It is recommended to create custom plugins for reusable features,
as they provide built-in features for ui configuration,
serialization, integration with editors etc and are easy to manage and tree-shake in the code.
Check out the list of plugins in the [Plugin List](#threepipe-plugins) section below.
To create new plugins,
simply implement the `IViewerPlugin` interface or extend the [AViewerPluginSync](https://threepipe.org/docs/classes/AViewerPluginSync.html) or [AViewerPluginAsync](https://threepipe.org/docs/classes/AViewerPluginAsync.html) classes.
The only difference is that in async the `onAdded` and `onRemove` functions are async
Here is a sample plugin
```typescript
@uiFolder("Sample Plugin") // This creates a folder in the Ui. (Supported by TweakpaneUiPlugin)
export class SamplePlugin extends AViewerPluginSync<"sample-1" | "sample-2"> {
// These are the list of events that this plugin can dispatch.
static readonly PluginType = "SamplePlugin"; // This is required for serialization and handling plugins. Also used in viewer.getPluginByType()
@uiToggle() // This creates a checkbox in the Ui. (Supported by TweakpaneUiPlugin)
@serialize() // Adds this property to the list of serializable. This is also used when serializing to glb in AssetExporter.
enabled = true;
// A plugin can have custom properties.
@uiSlider("Some Number", [0, 100], 1) // Adds a slider to the Ui, with custom bounds and step size (Supported by TweakpaneUiPlugin)
@serialize("someNumber")
@onChange(SamplePlugin.prototype._updateParams) // this function will be called whenevr this value changes.
val1 = 0;
// A plugin can have custom properties.
@uiInput("Some Text") // Adds a slider to the Ui, with custom bounds and step size (Supported by TweakpaneUiPlugin)
@onChange(SamplePlugin.prototype._updateParams) // this function will be called whenevr this value changes.
@serialize()
val2 = "Hello";
@uiButton("Print Counters") // Adds a button to the Ui. (Supported by TweakpaneUiPlugin)
public printValues = () => {
console.log(this.val1, this.val2);
this.dispatchEvent({ type: "sample-1", detail: { sample: this.val1 } }); // This will dispatch an event.
}
constructor() {
super();
this._updateParams = this._updateParams.bind(this);
}
private _updateParams() {
console.log("Parameters updated.");
this.dispatchEvent({ type: "sample-2" }); // This will dispatch an event.
}
onAdded(v: ThreeViewer): void {
super.onAdded(v);
// Do some initialization here.
this.val1 = 0;
this.val2 = "Hello";
v.addEventListener("preRender", this._preRender);
v.addEventListener("postRender", this._postRender);
v.addEventListener("preFrame", this._preFrame);
v.addEventListener("postFrame", this._postFrame);
this._viewer!.scene.addEventListener("addSceneObject", this._objectAdded); // this._viewer can also be used while this plugin is attached.
}
onRemove(v: ThreeViewer): void {
// remove dispose objects
v.removeEventListener("preRender", this._preRender);
v.removeEventListener("postRender", this._postRender);
v.removeEventListener("preFrame", this._preFrame);
v.removeEventListener("postFrame", this._postFrame);
this._viewer!.scene.removeEventListener("addSceneObject", this._objectAdded); // this._viewer can also be used while this plugin is attached.
super.onRemove(v);
}
private _objectAdded = (ev: IEvent<any>) => {
console.log("A new object, texture or material is added to the scene.", ev.object);
};
private _preFrame = (ev: IEvent<any>) => {
// This function will be called before each frame. This is called even if the viewer is not dirty, so it's a good place to do viewer.setDirty()
};
private _preRender = (ev: IEvent<any>) => {
// This is called before each frame is rendered, only when the viewer is dirty.
};
// postFrame and postRender work the same way as preFrame and preRender.
}
```
Notes:
* All plugins that are present in the dependencies array when the plugin is added to the viewer, are created and attached to the viewer in `super.onAdded`
* Custom events can be dispatched with `this.dispatchEvent`, and subscribed to with `plugin.addEventListener`. The event type must be described in the class signature for typescript autocomplete to work.
* Event listeners and other hooks can be added and removed in `onAdded` and `onRemove` functions for the viewer and other plugins.
* To the viewer render the next frame, `viewer.setDirty()` can be called, or set `this.dirty = true` in preFrame and reset in postFrame to stop the rendering. (Note that rendering may continue if some other plugin sets the viewer dirty like `ProgressivePlugin` or any of the animation plugins). Check `isConverged` in `ProgressivePlugin` to check if its the final frame.
* All Plugins which inherit from AViewerPlugin support serialisation. Create property `serializeWithViewer = false` to disable serialisation with the viewer in config and glb or `toJSON: any = undefined` to disable serialisation entirely
* `plugin.toJSON()` and `plugin.fromJSON()` or `ThreeSerialization` can be used to serialize and deserialize plugins. `viewer.exportPluginConfig` and `viewer.importPluginConfig` also exist for this.
* @serialize('label') decorator can be used to mark any public/private variable as serializable. label (optional) corresponds to the key in JSON.
* @serialize supports instances of ITexture, IMaterial, all primitive types, simple JS objects, three.js math classes(Vector2, Vector3, Matrix3...), and some more.
* uiDecorators can be used to mark properties and functions that will be shown in the Ui. The Ui shows up automatically when TweakpaneUiPlugin/BlueprintJsUiPlugin is added to the viewer. Plugins have special features in the UI for download preset and saving state.
Check various plugins in the source code for more examples.
# Viewer API
[ThreeViewer](https://threepipe.org/docs/classes/ThreeViewer.html) - is the main entry point to 3d rendering on the canvas.
- `.renderManager`: [ViewerRenderManager](https://threepipe.org/docs/classes/ViewerRenderManager.html) & [RenderManager](https://threepipe.org/docs/classes/RenderManager.html) & [RenderTargetManager](https://threepipe.org/docs/classes/RenderTargetManager.html) - Render manager for managing the rendering and composition pipeline, and provides helpers for rendering and render target management
- `.renderer`: [IWebGLRenderer](https://threepipe.org/docs/interfaces/IWebGLRenderer.html) - for rendering. Instance of three.js [WebGLRenderer](https://threejs.org/docs/#api/en/renderers/WebGLRenderer)
- `.composer`: [EffectComposer2](https://threepipe.org/docs/classes/EffectComposer2.html) - for rendering passes. Instance of three.js [EffectComposer](https://threejs.org/docs/#api/en/postprocessing/EffectComposer)
- `.context`: [WebGLRenderingContext](https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext) - WebGL rendering context
- `.renderPass`: [ExtendedRenderPass](https://threepipe.org/docs/classes/ExtendedRenderPass.html) - Render pass for rendering the scene. Instance of three.js [RenderPass](https://threejs.org/docs/#api/en/postprocessing/RenderPass) with extra features
- `.screenPass`: [ScreenPass](https://threepipe.org/docs/classes/ScreenPass.html) - Screen pass for rendering the final output. Instance of three.js [ShaderPass](https://threejs.org/docs/#api/en/postprocessing/ShaderPass) with extra features.
- `.scene`: [RootScene](https://threepipe.org/docs/classes/RootScene.html) - Main scene used for rendering. Instance of three.js [Scene](https://threejs.org/docs/#api/en/scenes/Scene)
- `.mainCamera`: [PerspectiveCamera2](https://threepipe.org/docs/classes/PerspectiveCamera2.html) - Main camera currently being used for rendering. Instance of three.js [PerspectiveCamera](https://threejs.org/docs/#api/en/cameras/PerspectiveCamera)
- `.assetManager`: [AssetManager](https://threepipe.org/docs/classes/AssetManager.html) - Asset manager for loading, managing and exporting assets
- `.importer`: [AssetImporter](https://threepipe.org/docs/classes/AssetImporter.html) - for importing assets
- `.exporter`: [AssetExporter](https://threepipe.org/docs/classes/AssetExporter.html) - for exporting assets
- `.materialManager`: [MaterialManager](https://threepipe.org/docs/classes/MaterialManager.html) - for managing materials and material extensions
- `.plugins`: `Record`<`string`, [IViewerPlugin](https://threepipe.org/docs/interfaces/IViewerPlugin.html)> - Plugins added to the viewer
- `.uiConfig`: [UiObjectConfig](https://repalash.com/uiconfig.js/interfaces/UiObjectConfig.html) - UI confguration for the viewer. Used to automatically generate UIs for the viewer and plugins.
## ThreeViewer
Source Code: [src/viewer/ThreeViewer.ts](./src/viewer/ThreeViewer.ts)
API Reference: [ThreeViewer](https://threepipe.org/docs/classes/ThreeViewer.html)
`ThreeViewer` is the main entry point to the viewer. It provides all the API for managing the scene, camera, rendering, plugins, etc.
It is initialized with either a canvas element or a `HTMLElement` for the container.
The canvas element is used for rendering, and the options are used to configure the viewer.
If the canvas element is not provided, a new canvas element is created and appended to the container.
More options can be passed in the constructor to configure various built-in plugins and rendering features in the viewer.
### Constructor
```typescript
import {ThreeViewer, CameraViewPlugin} from 'threepipe'
// Create a viewer. All options except canvas/container are optional
const viewer = new ThreeViewer({
canvas: document.getElementById('mcanvas') as HTMLCanvasElement,
// or a container like:
// container: document.getElementById('mcontainer'),
// container: document.body,
// Set the render scale to render at device resolution and clamp to max 2.
renderScale: 'auto',
// or Set the render scale to render at device resolution
// renderScale: window.devicePixelRatio,
// modify the screen shader: See ScreenPass and ScreenPass.glsl for more details
screenShader: `diffuseColor = diffuseColor * 2.0;`,
// Add TonemapPlugin
tonemap: true,
// Use MSAA(anti-aliasing)
msaa: false,
// Use Uint8 RGBM HDR Render Pipeline. Provides better performance with post-processing. RenderManager Uses Half-float if set to false.
rgbm: true,
// Use rendered gbuffer as depth-prepass / z-prepass.
zPrepass: false,
// Options for AssetManager
assetManager: {
// Use a custom CacheStorage
storage: caches.open('threepipe-assetmanager'),
},
// Use DropzonePlugin to add support for file drag and drop
// Enable and set properties
dropzone: {
// Set allowed extensions
allowedExtensions: ['png', 'glb', 'gltf'],
// Automatically add downloaded assets
autoAdd: true
// autoImport: true,
// domElement: document.body,
// addOptions: { ... }
// importOptions: { ... }
},
// By default its false
// dropzone: false,
// To Enable without options
// dropzone: true
// Add some plugins after viewer creation.
plugins: [CameraViewPlugin, new CustomPlugin()],
// Shorthand to load files immediately after viewer initialization
load: {
src: 'https://example.com/file.glb',
environment: 'https://example.com/file.hdr',
background: 'https://example.com/file.png',
},
onLoad: (viewer) => {
// Called when all the files are loaded
},
})
```
Check the interface [ThreeViewerOptions](https://threepipe.org/docs/interfaces/ThreeViewerOptions.html) for all the options.
To dispose off the viewer and all its resources call [`viewer.dispose()`](https://threepipe.org/docs/classes/ThreeViewer.html#dispose) method.
To dispose only the scene objects and not the complete viewer, use `viewer.scene.disposeSceneModels()`
### Plugin Functions
```typescript
import {ThreeViewer, TonemapPlugin, DepthBufferPlugin, NormalBufferPlugin} from 'threepipe'
const viewer = new ThreeViewer({...})
// Add a plugin
const plugin = viewer.addPluginSync(new TonemapPlugin())
// plugins can be added with just the class also
const plugin2 = viewer.addPluginSync(TonemapPlugin)
// Add multiple plugins at once
viewer.addPluginsSync([
TonemapPlugin,
new NormalBufferPlugin(),
DepthBufferPlugin,
// ...
])
// Get a plugin
const plugin3 = viewer.getPlugin(TonemapPlugin)
// Get or add a plugin, when not sure if the plugin is already added
const plugin4 = viewer.getOrAddPluginSync(TonemapPlugin)
// Remove a plugin
viewer.removePluginSync(TonemapPlugin)
```
Note: all sync functions above have async counterparts like `addPlugin`, `getOrAddPlugin`,
`removePlugin` that are used for async plugins.
There are no async plugins built-in to threepipe yet.
### Import/Export Functions
```typescript
import {ThreeViewer} from 'threepipe'
const viewer = new ThreeViewer({...})
// Load a 3d model
const object = await viewer.load<IObject3D>('https://example.com/file.glb')
// Load a material
const material = await viewer.load<PhysicalMaterial>('https://example.com/file.pmat')
// Load an image
const texture = await viewer.load<ITexture>('https://example.com/file.png')
// Import a model without adding to the scene
const imported = await viewer.import('https://example.com/file.glb')
// Export the complete scene with viewer configuraion
const exportedScene = await viewer.exportScene({})
// Export an object
const exported = await viewer.export(object)
// Export a material
const exportedMaterial = await viewer.export(material)
// Export a texture
const exportedTexture = await viewer.export(texture)
// Export viewer and plugins configurations
const exportedConfig = await viewer.export(viewer)
// Export plugin configuration
const exportedPlugin = await viewer.exportPlugin(viewer.getPlugin(PluginClass))
// Set Background Image
await viewer.setBackgroundMap('https://example.com/file.png')
// Set Environment Map
await viewer.setEnvironmentMap('https://example.com/file.hdr')
// Add an imported object or a created three.js object to the scene
viewer.addSceneObject(imported)
```
[`viewer.load`](https://threepipe.org/docs/classes/ThreeViewer.html#load) - Loads a single asset by path or [IAsset](https://threepipe.org/docs/interfaces/IAsset.html) object, and adds to the scene if its 3d object or loads it if it's a configuration It is the same as [AssetManager.addAssetSingle](https://threepipe.org/docs/classes/AssetManager.html#addAssetSingle). Use [AssetManager.addAsset](https://threepipe.org/docs/classes/AssetManager.html#addAsset) to load multiple assets from the same path like in case of zip bundles.
[`viewer.import`](https://threepipe.org/docs/classes/ThreeViewer.html#import) - Load a single asset but does not add to the scene or load the configuration. It is the same as [AssetManager.importer.importSingle](https://threepipe.org/docs/classes/AssetImporter.html#importSingle). Use [AssetManager.importer.import](https://threepipe.org/docs/classes/AssetImporter.html#import) to import multiple assets from the same path like in case of zip bundles.
[`viewer.export`](https://threepipe.org/docs/classes/ThreeViewer.html#export) - Exports an object, material, texture, render target or plugin configuration and returns a Blob. It is similar to [AssetManager.exporter.exportObject](https://threepipe.org/docs/classes/AssetExporter.html#exportObject) but adds support for exporting plugin and self(viewer) configs.
[`viewer.exportScene`](https://threepipe.org/docs/classes/ThreeViewer.html#exportScene) - Exports the scene model root and all configurations into a bundled `glb` file and returns a blob.
[`viewer.exportPlugin`](https://threepipe.org/docs/classes/ThreeViewer.html#exportPlugin) - Exports a plugin configuration and returns a blob.
[`viewer.setBackgroundMap`](https://threepipe.org/docs/classes/ThreeViewer.html#setBackgroundMap) - Sets the background map to the given texture or url. Also sets it as environment map if `setEnvironment` is `true` in the options.
[`viewer.setEnvironmentMap`](https://threepipe.org/docs/classes/ThreeViewer.html#setEnvironmentMap) - Sets the environment map to the given texture or url. Also sets it as background if `setBackground` is `true` in the options.
[`viewer.addSceneObject`](https://threepipe.org/docs/classes/ThreeViewer.html#addSceneObject) - Adds an imported object or a created three.js object to the scene model root. If an imported scene model root is passed, it will be loaded with viewer configuration, unless `importConfig` is `false` in the options.
### Frame/Rendering Events
```typescript
import {ThreeViewer} from 'threepipe'
const viewer = new ThreeViewer({...})
// Add a callback to be called before every frame, irrespective of whether enything is being rendered that frame
viewer.addEventListener('preFrame', (ev)=>{
console.log(ev);
// change something
viewer.setDirty() // let the viewer know to re-render the scene from this frame
})
// Add a callback to be called after every frame, irrespective of whether enything was rendered that frame
viewer.addEventListener('postFrame', (ev)=>{
console.log(ev);
// change something
viewer.setDirty() // let the viewer know to re-render the scene from next frame
})
// Add a callback to be called before every render, only if something is being rendered that frame
viewer.addEventListener('preRender', (ev)=>{
// canvas is about to be rendered, or re-rendered for progressive rendering
console.log(ev, viewer.renderManager.frameCount);
})
// Add a callback to be called after every render, only if something was rendered that frame
viewer.addEventListener('postRender', (ev)=>{
// canvas is rendered, or re-rendered for progressive rendering
console.log(ev);
})
// Listen to viewer.setDirty() calls
viewer.addEventListener('update', (ev)=>{
// viewer.setDirty() was called by some plugin or code
console.log(ev);
})
// to remove an event listener, first keep a reference to the callback
const callback = (ev)=>{ return }
viewer.addEventListener('preFrame', callback)
// then remove it
viewer.removeEventListener('preFrame', callback)
// Add a callback to be called only once for an event
viewer.doOnce('postFrame', () => viewer.canvas.toDataURL('image/png'))
// Enable/disable rendering in the viewer
viewer.renderEnabled = false
// do something with the canvas or load assets
await viewer.load('https://example.com/file.glb')
await viewer.load('https://example.com/file1.glb')
await viewer.load('https://example.com/file2.glb')
viewer.renderEnabled = true // all the assets will be rendered together in the next frame
```
Check the [IViewerEvent](https://threepipe.org/docs/interfaces/IViewerEvent.html) interface for all the event types.
[`viewer.addEventListener`](https://threepipe.org/docs/classes/ThreeViewer.html#addEventListener) - Adds a callback to be called on the given event. The callback is called with an [IViewerEvent](https://threepipe.org/docs/interfaces/IViewerEvent.html) object.
[`viewer.removeEventListener`](https://threepipe.org/docs/classes/ThreeViewer.html#removeEventListener) - Removes a callback from the given event.
[`viewer.doOnce`](https://threepipe.org/docs/classes/ThreeViewer.html#doOnce) - Adds a callback to be called only once for the given event. The listener will be added and automatically removed after the first call.
### Utility Functions
```typescript
import {ThreeViewer} from 'threepipe'
const viewer = new ThreeViewer({...})
// Set the final render size directly and fit in container based on mode.
viewer.setRenderSize({width: 800, height: 600}, 'cover')
// Set size of the canvas
viewer.setSize({width: 800, height: 600})
// Set the render scale
viewer.renderManager.renderScale = Math.min(window.devicePixelRatio, 2)
// Traverse scene objects
viewer.traverseSceneObjects((object) => {
console.log(object)
// do something with object
})
// If the size is set by css or manually by javascript use `resize` to update the viewer
viewer.resize()
// Trigger re-render with `setDirty` when something changes and viewer is not notified internally
viewer.setDirty()
// Get snapshot of the canvas as a blob
const blob = await viewer.getScreenshotBlob({mimeTye: 'image/png', quality: 90})
// Get snapshot of the canvas as a data url
const dataUrl = await viewer.getScreenshotDataUrl({mimeTye: 'image/jpeg', quality: 85})
// Dispose viewer and all resources
viewer.canvas.remove() // canvas needs to be removed separately from the DOM
viewer.dispose()
```
[`viewer.setRenderSize`](https://threepipe.org/docs/classes/ThreeViewer.html#setRenderSize) - Sets the rendering resolution and fits the canvas in container based on the mode. The modes are `cover`, `contain`, `fill`, `scale-down` and `none`. The canvas size and render scale is calculated automatically to match the render render.
[`viewer.setSize`](https://threepipe.org/docs/classes/ThreeViewer.html#setSize) - Sets the size of the canvas and updates the renderer and the camera. If no width/height is passed, canvas is set to 100% of the container.
[`viewer.traverseSceneObjects`](https://threepipe.org/docs/classes/ThreeViewer.html#traverseSceneObjects) - Loop through all the objects in the scene model root hierarchy and calls the callback function with each object.
[`viewer.resize`](https://threepipe.org/docs/classes/ThreeViewer.html#resize) - Mark that the canvas is resized. If the size is changed, the renderer and all render targets are resized.
[`viewer.setDirty`](https://threepipe.org/docs/classes/ThreeViewer.html#setDirty) - Triggers re-render on next `requestAnimationFrame` call.
[`viewer.getScreenshotBlob`](https://threepipe.org/docs/classes/ThreeViewer.html#getScreenshotBlob) - Returns a blob of the canvas screenshot. The blob can be used to download the screenshot or upload to a server.
[`viewer.getScreenshotDataUrl`](https://threepipe.org/docs/classes/ThreeViewer.html#getScreenshotDataUrl) - Returns a data url of the canvas screenshot. The data url can be used to display the screenshot in an image element.
[`viewer.dispose`](https://threepipe.org/docs/classes/ThreeViewer.html#dispose) - Disposes the viewer and all its resources. Use this to dispose the viewer when it is no longer needed. Note: the canvas element is not removed from the DOM and needs to be removed separately.
## RenderManager
Source Code: [src/viewer/ViewerRenderManager.ts](./src/viewer/ViewerRenderManager.ts), [src/rendering/RenderManager.ts](./src/rendering/RenderManager.ts), [src/rendering/RenderTargetManager.ts](./src/rendering/RenderTargetManager.ts)
API Reference: [ViewerRenderManager](https://threepipe.org/docs/classes/ViewerRenderManager.html), [RenderManager](https://threepipe.org/docs/classes/RenderManager.html), [RenderTargetManager](https://threepipe.org/docs/classes/RenderTargetManager.html)
It manages the rendering, composition/postprocessing of the scene and provides helpers for rendering and render target management.
```typescript
const viewer = new ThreeViewer({...})
const renderManager = viewer.renderManager
// Get the effect composer
const composer = renderManager.composer
// Get the three.js webgl renderer
const renderer = renderManager.renderer
// Get the main Render Pass in the pipeline
const renderPass = renderManager.renderPass
// Get the main Screen Pass in the pipeline
const screenPass = renderManager.screenPass
// Set the render scale
renderManager.renderScale = Math.min(window.devicePixelRatio, 2)
// Register a custom composer pass
const customPass: IPipelinePass = new CustomPass()
renderManager.registerPass(customPass)
// Unregister a custom composer pass
renderManager.unregisterPass(customPass)
// The pipeline is automatically created and sorted based on dependencies in pipeline pass.
// To check the built pipeline
console.log(renderManager.pipeline)
// Set a custom render pipeline
renderManager.autoBuildPipeline = false
renderManager.pipeline = ['depth', 'render', 'screen']
// Check the total frames rendererd
console.log(renderManager.totalFrameCount)
// Get the current frame count in progressive rendering
console.log(renderManager.frameCount)
// Force reset shadows when some object is moved
renderManager.resetShadows()
// Render Target Management
// Get the main composer target
const composerTarget = renderManager.composerTarget
// clone the target to get a copy of the target with all the default options
const clonedTarget = composeTarget.clone()
// Create a render target, same size as the canvas. The target are automatically resized when the canvas is resized
const renderTarget = renderManager.createTarget({
sizeMultiplier: 1, // size multiplier from the canvas. 0.5 will be half width and height of the canvas
type: UnsignedByteType,
// ... // See CreateRenderTargetOptions for all options
})
// Create a render target of custom size
const renderTarget = renderManager.createTarget({
size: {
width: 1024,
height: 1024,
},
type: HalfFloatType,
// ...
})
// Dispose the render target
renderManager.disposeTarget(renderTarget)
// Create and release temporary targets for in-pass rendering.
const tempTarget = renderManager.getTempTarget({
sizeMultiplier: 0.5,
type: HalfFloatType,
// ...
})
// do something
renderManager.releaseTempTarget(tempTarget)
// Set how many temporary targets can remain in memory for a specific set of options
renderManager.maxTempPerKey = 10 // default = 5
// Copy/Blit a texture to the canvas or another render target with standard or a custom material
renderManager.blit(destination, {source: sourceTexture})
// Clear color of the canvas
renderManager.clearColor({r: 0, g: 0, b: 0, a: 1, depth: true, viewport: new Vector4(...)})
// Clear of a render target
renderManager.clearColor(renderTarget, {r: 0, g: 0, b: 0, a: 1, target: renderTarget})
// Export a render target to a blob. The type is automatically picked from exr to png based on the render target
const blob = renderManager.exportRenderTarget(renderTarget, 'auto')
// Export a render target to png/jpeg data url. This will clamp any floating point targets to fit in png/jpeg
const dataUrl = renderManager.renderTargetToDataUrl(renderTarget, 'image/png')
// Read render target pixels to array buffer. Returns Uint8Array|Uint16Array|Float32Array based on the render target type
const buffer = renderManager.renderTargetToBuffer(renderTarget)
```
[`renderManager.composer`](https://threepipe.org/docs/classes/ViewerRenderManager.html#composer) - The three.js [EffectComposer](https://threejs.org/docs/#api/en/postprocessing/EffectComposer) used for rendering the pipeline.
[`renderManager.renderer`](https://threepipe.org/docs/classes/ViewerRenderManager.html#renderer) - The three.js [WebGLRenderer](https://threejs.org/docs/#api/en/renderers/WebGLRenderer) used for rendering
[`renderManager.context`](https://threepipe.org/docs/classes/ViewerRenderManager.html#context) - Access the WebGL rendering context for the canvas.
[`renderManager.renderPass`](https://threepipe.org/docs/classes/ViewerRenderManager.html#renderPass) - The main render pass used in the render pipeline. Instance of three.js [RenderPass](https://threejs.org/docs/#api/en/postprocessing/RenderPass) with extra features like z prepass, rgbm rendering, blurred transmission, msaa and other optimizations.
[`renderManager.screenPass`](https://threepipe.org/docs/classes/ViewerRenderManager.html#screenPass) - The main screen pass used in the render pipeline. Instance of three.js [ShaderPass](https://threejs.org/docs/#api/en/postprocessing/ShaderPass) with extra features like material extension, custom fragment, overriding read buffer, re-render to screen on change, etc
[`renderManager.renderScale`](https://threepipe.org/docs/classes/RenderManager.html#renderScale) - Sets the render scale. All targets are scaled by this factor. This is equivalent to calling `EffectComposer.setPixelRatio` and `WebGLRenderer.setPixelRatio` in three.js.
[`renderManager.resetShadows`](https://threepipe.org/docs/classes/RenderManager.html#resetShadows) - Resets all shadow maps in the scene. This is useful when some object is moved and the shadows need to be updated. This is automatically called when `scene.setDirty` or any `object.setDirty` is called, and during animation with plugins.
### Rendering Pipeline
[`renderManager.registerPass`](https://threepipe.org/docs/classes/RenderManager.html#registerPass) - Registers a custom composer pass to the render pipeline. See [IPipelinePass](https://threepipe.org/docs/interfaces/IPipelinePass.html) interface.
[`renderManager.unregisterPass`](https://threepipe.org/docs/classes/RenderManager.html#unregisterPass) - Unregisters a custom composer pass from the render pipeline.
[`renderManager.pipeline`](https://threepipe.org/docs/classes/RenderManager.html#pipeline) - The render pipeline array. The array is automatically sorted based on dependencies in the pipeline passes.
[`renderManager.autoBuildPipeline`](https://threepipe.org/docs/classes/RenderManager.html#autoBuildPipeline) - If `true`, the pipeline is automatically created and sorted based on dependencies in pipeline pass. If `false`, the pipeline is built only once and is not changed after that. The default value is `true`.
[`renderManager.totalFrameCount`](https://threepipe.org/docs/classes/RenderManager.html#totalFrameCount) - The total frames rendered since the render manager was created.
[`renderManager.frameCount`](https://threepipe.org/docs/classes/RenderManager.html#frameCount) - The current frame count in progressive rendering. This is useful for progressive rendering effects like progressive shadows, gi, denoising, baking, anti-aliasing, and many other effects.
### Render Targets management
[`renderManager.composerTarget`](https://threepipe.org/docs/classes/RenderManager.html#composerTarget), [`renderManager.composerTarget1`](https://threepipe.org/docs/classes/RenderManager.html#composerTarget1) - The main targets used in [EffectComposer2](https://threepipe.org/docs/classes/EffectComposer2)
[`renderManager.createTarget`](https://threepipe.org/docs/classes/RenderTargetManager.html#createTarget) - Creates a render target with the given options. The render target is automatically resized when the canvas is resized if `sizeMultiplier` is used. See [CreateRenderTargetOptions](https://threepipe.org/docs/interfaces/CreateRenderTargetOptions.html) for options
[`renderManager.disposeTarget`](https://threepipe.org/docs/classes/RenderTargetManager.html#disposeTarget) - Disposes a render target and removes it from the render target manager.
[`renderManager.getTempTarget`](https://threepipe.org/docs/classes/RenderTargetManager.html#getTempTarget) - Gets a temporary render target with the given options. The render target is automatically resized when the canvas is resized if `sizeMultiplier` is used. See [CreateRenderTargetOptions](https://threepipe.org/docs/interfaces/CreateRenderTargetOptions.html) for options
[`renderManager.releaseTempTarget`](https://threepipe.org/docs/classes/RenderTargetManager.html#releaseTempTarget) - Releases a temporary render target and adds it back to the render target manager.
[`renderManager.maxTempPerKey`](https://threepipe.org/docs/classes/RenderTargetManager.html#maxTempPerKey) - Sets how many temporary targets can remain in memory for a specific set of options. The default value is `5`.
### Helpers
[`renderManager.blit`](https://threepipe.org/docs/classes/RenderManager.html#blit) - Blits a texture to the canvas or another render target with standard or a custom material. See [RendererBlitOptions](https://threepipe.org/docs/interfaces/RendererBlitOptions.html) for options.
[`renderManager.clearColor`](https://threepipe.org/docs/classes/RenderManager.html#clearColor) - Clears the color of the canvas or a render target.
[`renderManager.exportRenderTarget`](https://threepipe.org/docs/classes/RenderManager.html#exportRenderTarget) - Exports a render target to a blob. The type is automatically picked from exr to png based on the render target.
[`renderManager.renderTargetToDataUrl`](https://threepipe.org/docs/classes/RenderManager.html#renderTargetToDataUrl) - Exports a render target to png/jpeg data url string. This will clamp any floating point targets to fit in png/jpeg. See [RenderTargetToDataUrlOptions](https://threepipe.org/docs/interfaces/RenderTargetToDataUrlOptions.html) for options.
[`renderManager.renderTargetToBuffer`](https://threepipe.org/docs/classes/RenderManager.html#renderTargetToBuffer) - Reads render target pixels to a Uint8Array|Uint16Array|Float32Array array buffer.
## RootScene
Source Code: [src/core/object/RootScene.ts](./src/core/object/RootScene.ts)
API Reference: [RootScene](https://threepipe.org/docs/classes/RootScene.html)
RootScene is the main scene that is rendered in the canvas.
It is an instance of three.js [Scene](https://threejs.org/docs/#api/en/scenes/Scene) with extra features including separation between model root and others,
backgroundColor, background map and background intensity,
environment map rotation and intensity, fixed env map direction patch, event bubbling in the scene hierarchy, scene config serialization, main camera management,
automatic active near far management based on scene bounds, disposing complete scene hierarchy, etc
```typescript
const viewer = new ThreeViewer({...})
const scene = viewer.scene
// List oll loaded objects in the model root
console.log(scene.modelRoot.children)
// Set the background color
scene.setBackgroundColor('#ffffff')
// or
// scene.backgroundColor = new Color('#ffffff')
// or
// scene.backgroundColor.set('#ffffff')
// scene.onBackgroundChange() // this must be called when not using a setter or set function.
// Set a texture as background (or use viewer.setBackgroundMap). When both color and texture are set, they are multiplied
scene.background = customTexture
// Set the background same as the environment map
scene.background = 'environment' // background is automatically changed when the environment changes.
// or
// scene.background = scene.environment
// Set the background intensity
scene.backgroundIntensity = 2
// Set a texture as environment map (or use viewer.setEnvironmentMap)
scene.environment = customTexture
// Set the environment intensity
scene.envMapIntensity = 2
// Set the environment map rotation
scene.environment.rotation = Math.PI / 2
// Set Fixed env direction (rotate environment according the the camera)
scene.fixedEnvMapDirection = true
// Get the main camera used for rendering
const camera: PerspectiveCamera2 = scene.mainCamera
// Set camera props
camera.position.set(0, 0, 10)
camera.target.set(0, 0, 0)
camera.setDirty() // this needs to be called to notify the viewer to re-render the scene
// Traverse the model root hierarchy (or just use viewer.traverseSceneObjects)
scene.modelRoot.traverse((object) => {
console.log(object)
// do something with object
})
// Access the default camera (same as mainCamera if not changed explicitly)
const defaultCamera: ICamera = scene.defaultCamera
// Dispose all assets in the modelRoot
scene.disposeSceneModels()
// Remove all objects from the modelRoot
scene.clearSceneModels()
// Dispose the scene and all its resources and children
scene.dispose()
// Get bounds of the scene model root
const bounds = scene.getBounds(true, true) // true for precise bounds and ignore invisible
// Add an object to the scene or its model root depending on the options (or just use viewer.addSceneObject)
scene.addObject(object, {addToRoot: false}) // adds to the scene directly when addToRoot is true
// Load an imported model root from the asset importer
scene.loadModelRoot(object)
// notify that something has changed in the scene for re-render
scene.setDirty()
// notify that some object has changed in the scene for scene refresh(like shadow refresh, ground etc) and re-render
scene.refreshScene()
// or
scene.setDirty({refreshScene: true})
// set geometryChanged: false to prevent shadow recompute
scene.refreshScene({geometryChanged: false})
// refresh active near far. (in most cases this is done automatically and need not be called)
scene.refreshActiveNearFar()
```
[`scene.modelRoot`](https://threepipe.org/docs/classes/RootScene.html#modelRoot) - The root object. All the objects loaded in the viewer are added to this object. And this is exported when exporting the gltf. Everything else like meta or UI objects can be added outside this.
[`scene.backgroundColor`](https://threepipe.org/docs/classes/RootScene.html#backgroundColor) - The background color of the scene. Can be a `Color | null`. This is not the same as `scene.background`. When both backgroundColor and background are set, they are multiplied.
[`scene.background`](https://threepipe.org/docs/classes/RootScene.html#background) - The background of the scene. This is the same as `scene.background` in three.js. This can be a texture or a color or null, but it's preferred to use `scene.backgroundColor` for color, and this for texture, then both can be used together.
[`scene.setBackgroundColor`](https://threepipe.org/docs/classes/RootScene.html#setBackgroundColor) - Set the background color from a string, number or color. Same as setting `backgroundColor` to a new color value.
[`scene.backgroundIntensity`](https://threepipe.org/docs/classes/RootScene.html#backgroundIntensity) - The background intensity of the scene. This is the same as `scene.backgroundIntensity` in three.js.
[`scene.environment`](https://threepipe.org/docs/classes/RootScene.html#environment) - The environment map of the scene. This is the same as `scene.environment` in three.js.
`scene.environment.rotation` - The rotation of the environment map around the y-axis.
[`scene.envMapIntensity`](https://threepipe.org/docs/classes/RootScene.html#envMapIntensity) - The environment intensity of the scene.
[`scene.fixedEnvMapDirection`](https://threepipe.org/docs/classes/RootScene.html#fixedEnvMapDirection) - If `true`, the environment map is rotated according to the camera. This is the same as `scene.fixedEnvMapDirection` in three.js.
[`scene.mainCamera`](https://threepipe.org/docs/classes/RootScene.html#mainCamera) - The main camera used for rendering. This is the same as `scene.mainCamera` in three.js.
[`scene.defaultCamera`](https://threepipe.org/docs/classes/RootScene.html#defaultCamera) - The default camera used for rendering. This is the same as `scene.defaultCamera` in three.js.
[`scene.disposeSceneModels`](https://threepipe.org/docs/classes/RootScene.html#disposeSceneModels) - Disposes all assets in the modelRoot.
[`scene.clearSceneModels`](https://threepipe.org/docs/classes/RootScene.html#clearSceneModels) - Removes all objects from the modelRoot.
[`scene.dispose`](https://threepipe.org/docs/classes/RootScene.html#dispose) - Disposes the scene and all its resources and children.
[`scene.getBounds`](https://threepipe.org/docs/classes/RootScene.html#getBounds) - Gets the bounds of the scene model root. Returns an instance of three.js [Box3](https://threejs.org/docs/#api/en/math/Box3) with min and max bounds according to parameters.
[`scene.addObject`](https://threepipe.org/docs/classes/RootScene.html#addObject) - Adds an object to the scene or its model root depending on the options. If `addToRoot` is `true`, the object is added to the model root, else it is added to the scene directly.
[`scene.setDirty`](https://threepipe.org/docs/classes/RootScene.html#setDirty) - Notifies that something has changed in the scene for re-render.
[`scene.refreshScene`](https://threepipe.org/docs/classes/RootScene.html#refreshScene) - Notifies that some object has changed in the scene for scene refresh(like shadow refresh, ground etc) and re-render. Slower than `setDirty`, as it refreshes shadows, updates bounds, etc.
[`scene.refreshActiveNearFar`](https://threepipe.org/docs/classes/RootScene.html#refreshActiveNearFar) - Refreshes active near far. (in most cases this is done automatically and need not be called)
[`scene.loadModelRoot`](https://threepipe.org/docs/classes/RootScene.html#loadModelRoot) - Loads an imported model root from the asset importer. This is used internally and in most cases, you don't need to call this.
### Scene Events
RootScene dispatches many events that are useful when writing app logic or plugins
`'sceneUpdate'` - Listen to `refreshScene` called in RootScene. When some object changes.
`'addSceneObject'` - When a new object is added to the scene
`'mainCameraChange'` - When the main camera is changed to some other camera.
`'mainCameraUpdate'` - When some properties in the current main camera has changed.
`'environmentChanged'` - When the environment map changes
`'backgroundChanged'` - When the background map or color changes
`'materialUpdate`' - When a material in the scene has updated. (setDirty called on the material)
`'objectUpdate`' - When a object in the scene has updated. (setDirty called on the object)
`'textureUpdate`' - When a texture in the scene has updated. (setDirty called on the texture)
`'cameraUpdate`' - When a camera in the scene has updated.
(setDirty called on the camera)
`'geometryUpdate`' - When a geometry in the scene has updated.
(setDirty called on the geometry)
`'geometryChanged`' - When a geometry is changed on any mesh
`'materialChanged'` - When a material is changed on any mesh
Check [IObject3DEventTypes](https://threepipe.org/docs/interfaces/IObject3DEventTypes.html) and[ISceneEventTypes](https://threepipe.org/docs/interfaces/ISceneEventTypes.html) for more information.
## ICamera
Source Code: [src/core/camera/PerspectiveCamera2.ts](./src/core/camera/PerspectiveCamera2.ts), [src/core/ICamera.ts](./src/core/ICamera.ts)
API Reference: [PerspectiveCamera2](https://threepipe.org/docs/classes/PerspectiveCamera2.html), [ICamera](https://threepipe.org/docs/interfaces/ICamera.html)
ICamera is an interface for a camera that extends the three.js [Camera](https://threejs.org/docs/#api/en/cameras/Camera).
PerspectiveCamera2 implements the interface,
extending from three.js [PerspectiveCamera](https://threejs.org/docs/#api/en/cameras/PerspectiveCamera) with extra features like target, automatic aspect management, automatic near far management(from RootScene), camera control attachment and hooks(like OrbitControls) and the ability to set as the main camera in the root scene.
```typescript
import {OrbitControls3} from './OrbitControls3'
const viewer = new ThreeViewer({...})
const camera: PerspectiveCamera2 = viewer.scene.mainCamera
// Set the camera position
camera.position.set(0, 0, 10)
// Set the camera target (where the camera looks at)
camera.target.set(0, 0, 0)
// Set the camera fov
camera.fov = 45
// Set the camera aspect ratio
camera.autoAspect = false // disable automatic aspect management based on the canvas size
camera.aspect = 1
// Set camera near far bounds.
// Near, Far plane will be calculated automatically within these limits
// Try changing these values when encountering z-fighting issues or far-plane clipping
camera.minNearPlane = 0.5 // min near plane
camera.maxFarPlane = 10 // max far plane
// Set a custom camera near far
camera.autoNearFar = false // disable automatic near far management based on the scene bounds
camera.minNearPlane = 0.1 // near plane
camera.maxFarPlane = 1000 // far plane
// this needs to be called to notify the viewer to re-render the scene
// in most cases this is done internally. But calling this does not have much impact
camera.setDirty()
// Check if user can interact with the camera. Also checks if its the main camera.
console.log(camera.canUserInteract)
// Get the camera controls (orbit controls for the default camera)
const controls: OrbitControls3 = camera.controls
// Disable controls
controls.enabled = false
// Change the controls mode
camera.controlsMode = 'none' // this will remove the current controls.
// Register a custom camera controls
camera.setControlsCtor('customOrbit', (camera, domElement) => new CustomOrbitControls(camera, domElement))
// Set the camera controls
camera.controlsMode = 'customOrbit' // this will initialize the controls with the customOrbit constructor and set it on the camera
// Disable interactions to the camera. (eg when animating)
camera.setInteractions(false, 'animation')
// Enable interactions back
camera.setInteractions(true, 'animation') // this will enable interactions when all the keys have been set to true(which were set to false earlier)
// Force refresh aspect ratio (this is done automatically with a ResizeObserver on the canvas in the viewer)
camera.refreshAspect()
// Set the camera as the main camera
camera.activateMain()
// Deactivate the camera as the main camera
camera.deactivateMain()
```
[`camera.target`](https://threepipe.org/docs/classes/PerspectiveCamera2.html#target) - The target of the camera. This is the same as `controls.target` in three.js. The target is always in world-space coordinates, as opposed to position, rotation, and scale which are always relative to their parent.
[`camera.autoAspect`](https://threepipe.org/docs/classes/PerspectiveCamera2.html#autoAspect) - If `true`, the aspect ratio is automatically calculated based on the canvas size.
[`camera.aspect`](https://threepipe.org/docs/classes/PerspectiveCamera2.html#aspect) - The aspect ratio of the camera. This is the same as `camera.aspect` in three.js. This is only used when `camera.autoAspect` is `false`.
[`camera.minNearPlane`](https://threepipe.org/docs/classes/PerspectiveCamera2.html#minNearPlane) - The minimum near plane of the camera. This is the same as `camera.near` in three.js when `camera.autoNearFar` is `false`, otherwise it is the minimum near plane distance from the camera allowed when computing automatically
[`camera.maxFarPlane`](https://threepipe.org/docs/classes/PerspectiveCamera2.html#maxFarPlane) - The maximum far plane of the camera. This is the same as `camera.far` in three.js when `camera.autoNearFar` is `false`, otherwise it is the maximum far plane distance from the camera allowed when computing automatically
[`camera.autoNearFar`](https://threepipe.org/docs/classes/PerspectiveCamera2.html#autoNearFar) - If `true` (default), the near and far planes are automatically calculated based on the scene bounds.
[`camera.setDirty`](https://threepipe.org/docs/classes/PerspectiveCamera2.html#setDirty) - Notifies that something has changed in the camera for re-render.
[`camera.canUserInteract`](https://threepipe.org/docs/classes/PerspectiveCamera2.html#canUserInteract) - Checks if user can interact with the camera. Also checks if it's the main camera.
[`camera.controls`](https://threepipe.org/docs/classes/PerspectiveCamera2.html#controls) - Get the current camera controls set on the camera. This can be changed by changing `controlsMode`
[`camera.controlsMode`](https://threepipe.org/docs/classes/PerspectiveCamera2.html#controlsMode) - Get or set the current controls that are attached to the camera. More modes can be registered with `setControlsCtor`. Default for the default camera is `orbit` and `none` for any new cameras.
[`camera.setControlsCtor`](https://threepipe.org/docs/classes/PerspectiveCamera2.html#setControlsCtor) - Register a custom camera controls constructor. The controls can be set by setting `controlsMode` to the key/name of the controls.
[`camera.setInteractions`](https://threepipe.org/docs/classes/PerspectiveCamera2.html#setInteractions) - If `true`, the camera can be interacted with. This is useful when animating the camera or using the window scroll or programmatically automating the viewer. Using this multiple plugins can disable interactions and it will be enabled again when all of them enable it back.
[`camera.refreshAspect`](https://threepipe.org/docs/classes/PerspectiveCamera2.html#refreshAspect) - Force refresh aspect ratio (this is done automatically with a ResizeObserver on the canvas in the viewer or when `viewer.resize()` is called)
[`camera.activateMain`](https://threepipe.org/docs/classes/PerspectiveCamera2.html#activateMain) - Set the camera as the main camera. This is the same as doing `scene.mainCamera = camera`. The camera needs to be in the scene hierarchy for this to work.
[`camera.deactivateMain`](https://threepipe.org/docs/classes/PerspectiveCamera2.html#deactivateMain) - Deactivate the camera as the main camera.
See also [CameraViewPlugin](#cameraviewplugin) for camera focus animation.
Note: The constructor signature of `PerspectiveCamera2` is different `PerspectiveCamera`(from three.js), since it requires the canvas and the controlsMode during creation.
Because of this `PerspectiveCamera0` is provided with the same signature as `PerspectiveCamera` for compatibility, in case the controls functionality is not required.
## AssetManager
Source Code: [src/assetmanager/AssetManager.ts](./src/assetmanager/AssetManager.ts)
API Reference: [AssetManager](https://threepipe.org/docs/classes/AssetManager.html)
`AssetManager` is a class that manages the loading and exporting of assets and provides helpers for caching assets. It is used internally in the viewer and can be used to load assets outside the viewer. It provides a modular framework for adding more asset loaders and exporters.
```typescript
const viewer = new ThreeViewer({...})
const assetManager = viewer.assetManager
// Add an asset or an asset bundle
const assets = await assetManager.addAsset('https://example.com/model.zip')
// or
const assets = await assetManager.addAsset({
path: 'https://example.com/model.zip',
file: blob,
})
// Get the storage used in the asset manager for caching
const storage: Cache | Storage = assetManager.storage
// Get the importer. Provides low level functions to import assets
const importer = assetManager.importer
// import a file by asset or url
const file = await importer.import('https://example.com/model.gltf')
// Import a Map<string, File> from drag drop
const res = await importer.importFiles(mapOfFiles, {})
// Register a custom path that maps to a File object. Useful when some file types have path references to other files.
importer.registerFile('/myFile.png', file) // this returns the three.js loader for that kind of file.
// Unregister the path
importer.unregisterFile('/myFile.png')
// Unregister all files and clear the loader cache(memory, not storage)
importer.clearCache()
// Add custom importers (check extra load plugins for more examples)
importer.addImporter(new Importer(class extends PLYLoader implements ILoader {
transform(res: BufferGeometry, _: AnyOptions): Mesh | undefined {
return res ? new Mesh(res, new PhysicalMaterial({color: new Color(1, 1, 1)})) : undefined
}
}, ['ply'], ['text/plain+ply'], false))
// Get the exporter. Provides low level functions to export assets
const exporter = assetManager.exporter
// Export any IObject3D, IMaterial, ITexture, IRenderTarget
const exported = exporter.exportObject(obj, options)
// Add a custom exporter
exporter.addExporter({
ext: ['gltf', 'glb'], // file extensions
extensions: [], // extensions for the exporter
ctor: (assetExporter, iexporter) => {
return new GLTFExporter2()
}
})
// Material Manager
const materialManager = assetManager.materialManager
// Create a material of type
const mat = materialManager.create('physical')
const mat2 = materialManager.create('unlit')
// find or create a material by uuid
const mat = materialManager.findOrCreate('00000000-0000-0000-0000-000000000000', {color: '#ffffff'})
// find a material creation template
const template = materialManager.findTemplate('physical')
// Get all materials
const materials = materialManager.getAllMaterials()
// Get all materials of type
const materials = materialManager.getMaterialsOfType(PhysicalMaterial.TypeSlug)
// register a custom material to the manager for tracking and extensions
// Note all materials created in threepipe internally are registered automatically on creation or when added to any scene object.
materialManager.registerMaterial(customMat)
// unregister
materialManager.unregisterMaterial(customMat)
// clear all material references
materialManager.clearMaterials()
// Register a custom material template
materialManager.registerTemplate({
generator: (params: any) => new PhysicalMaterial(params),
name: 'custom',
materialType: PhysicalMaterial.TYPE,
params: {
color: '#ffffff',
roughness: 0.5,
metalness: 0.5,
},
})
const mat3 = materialManager.create('custom')
// convert a standard three.js material to threepipe material
const mat4 = materialManager.convertToIMaterial(new ShadowMaterial(), {materialTemplate: 'test'})
// register a custom material extension for all materials in the viewer
materialManager.registerMaterialExtension(customExtension)
// unregister
materialManager.unregisterMaterialExtension(customExtension)
// remove all extensions
materialManager.clearExtensions()
// Apply a material properties to other material(s) in the scene by name or uuid
materialManager.applyMaterial(goldMaterial, 'METAL') // this will copy the properties from goldMaterial to all the materials(or objects) in the viewer with the name METAL.
// export a material as JSON. Note: use AssetExporter instead to export all the embedded assets and properties properly.
const blob = materialManager.exportMaterial(mat)
// dispose manager and all materials.
materialManager.dispose()
```
[`assetManager.addAsset`](https://threepipe.org/docs/classes/AssetManager.html#addAsset) - Add an asset or an asset bundle. Returns a promise that resolves to an array of asset objects. An asset can contain multiple objects, hence an array is returned. Use shorthand `viewer.load(path)` to load a single asset from a single file.
[`assetManager.storage`](https://threepipe.org/docs/classes/AssetManager.html#storage) - Get the storage used in the asset manager for caching. This is the storage that can be passed in the `ThreeViewer` contructor options.
[`assetManager.importer`](https://threepipe.org/docs/classes/AssetManager.html#importer) - Get the importer. Provides low-level functions to import assets. This is an instance of [AssetImporter](https://threepipe.org/docs/classes/AssetImporter.html).
[`assetManager.exporter`](https://threepipe.org/docs/classes/AssetManager.html#exporter) - Get the exporter. Provides low-level functions to export assets. This is an instance of [AssetExporter](https://threepipe.org/docs/classes/AssetExporter.html).
### AssetImporter
[`importer.import`](https://threepipe.org/docs/classes/AssetImporter.html#import) - Import a file by asset or url. Returns a promise that resolves to a [File](https://threepipe.org/docs/classes/File.html) object.
[`importer.importFiles`](https://threepipe.org/docs/classes/AssetImporter.html#importFiles) - Import a Map<string, File> from drag and drop. Returns a promise that resolves to a Map<string, any[]> of imported object arrays.
[`importer.registerFile`](https://threepipe.org/docs/classes/AssetImporter.html#registerFile) - Register a custom path that maps to a File object. Useful when some file types have path references to other files. Like when importing a .zip with a .gltf file that references a .bin file, or when loading remote files from custom local cache implementation.
[`importer.unregisterFile`](https://threepipe.org/docs/classes/AssetImporter.html#unregisterFile) - Unregister the path.
[`importer.clearCache`](https://threepipe.org/docs/classes/AssetImporter.html#clearCache) - Unregister all the registered files and clear the loader cache(memory cache, not cache-storage).
[`importer.addImporter`](https://threepipe.org/docs/classes/AssetImporter.html#addImporter) - Add custom importers (check extra load plugins for more examples). This allows to pass a class to a ILoader, that is used to import assets. Loaders are only created when a file is being loaded of that type. And they remain in the loader cache until `clearCache` or `clearLoaderCache` is called.
### AssetExporter
[`exporter.exportObject`](https://threepipe.org/docs/classes/AssetExporter.html#exportObject) - Export any IObject3D, IMaterial, ITexture, IRenderTarget. Returns a promise that resolves to an exported object. Use `viewer.export` or `AssetExporterPlugin`, which provide more features and shortcuts to export viewer, scene and plugins as well.
[`exporter.addExporter`](https://threepipe.org/docs/classes/AssetExporter.html#addExporter) - Add a custom exporter for a custom file type.
### MaterialManager
[`materialManager.create`](https://threepipe.org/docs/classes/MaterialManager.html#create) - Create a new material of a given type and with passed properties. Returns an implementation of [IMaterial](https://threepipe.org/docs/interfaces/IMaterial.html).
[`materialManager.findOrCreate`](https://threepipe.org/docs/classes/MaterialManager.html#findOrCreate) - Find or create a material by uuid. Returns an instance of [IMaterial](https://threepipe.org/docs/interfaces/IMaterial.html). If a material with the uuid exists, it is returned, else a new material is created with the passed properties.
[`materialManager.findTemplate`](https://threepipe.org/docs/classes/MaterialManager.html#findTemplate) - Find a material creation template. Returns an instance of [IMaterialTemplate](https://threepipe.org/docs/interfaces/IMaterialTemplate.html). Material templates are used to create materials of a given type with default properties.
[`materialManager.getAllMaterials`](https://threepipe.org/docs/classes/MaterialManager.html#getAllMaterials) - Get all materials registered with the manager.
[`materialManager.getMaterialsOfType`](https://threepipe.org/docs/classes/MaterialManager.html#getMaterialsOfType) - Get all materials of a specific type. Pass in the typeslug from the class like `pmat` or `dmat` to identify the material.
[`materialManager.registerMaterial`](https://threepipe.org/docs/classes/MaterialManager.html#registerMaterial) - Register a new material to the manager for tracking and extensions. Note: all materials created in threepipe internally or any that are set to any object in the scene are registered automatically on creation or when used
[`materialManager.unregisterMaterial`](https://threepipe.org/docs/classes/MaterialManager.html#unregisterMaterial) - Unregister a material from the manager.
[`materialManager.clearMaterials`](https://threepipe.org/docs/classes/MaterialManager.html#clearMaterials) - Clear all registered material references.
[`materialManager.registerTemplate`](https://threepipe.org/docs/classes/MaterialManager.html#registerTemplate) - Register a custom material template. Requires an instance of [IMaterialTemplate](https://threepipe.org/docs/interfaces/IMaterialTemplate.html). Material templates are used to create materials of a given type with default properties.
[`materialManager.convertToIMaterial`](https://threepipe.org/docs/classes/MaterialManager.html#convertToIMaterial) - Convert/upgrade a standard three.js material to threepipe material, by making it conform to [IMaterial](https://threepipe.org/docs/interfaces/IMaterial.html).
[`materialManager.registerMaterialExtension`](https://threepipe.org/docs/classes/MaterialManager.html#registerMaterialExtension) - Register a custom material extension for all materials in the viewer. Requires an instance of [IMaterialExtension](https://threepipe.org/docs/interfaces/IMaterialExtension.html). Material extensions are used to add custom properties, methods, uniforms, defines, shader patches etc to predefined materials. The extensions are added to the material when the mateiral or extension is registered to the manager.
[`materialManager.unregisterMaterialExtension`](https://threepipe.org/docs/classes/MaterialManager.html#unregisterMaterialExtension) - Unregister a material extension from the manager.
[`materialManager.clearExtensions`](https://threepipe.org/docs/classes/MaterialManager.html#clearExtensions) - Remove all material extensions from the manager.
[`materialManager.applyMaterial`](https://threepipe.org/docs/classes/MaterialManager.html#applyMaterial) - Apply a material properties to other material(s) in the scene by name or uuid. This is useful when you want to change the properties of all materials with a given name or uuid. This can also be a regex, in that case a regex.match will be performed on the material/object name.
[`materialManager.exportMaterial`](https://threepipe.org/docs/classes/MaterialManager.html#exportMaterial) - Export a material as JSON. Note: use `viewer.export` or `AssetExporter` instead to export all the embedded assets properly.
[`materialManager.dispose`](https://threepipe.org/docs/classes/MaterialManager.html#dispose) - Dispose manager and all materials.
## Other classes and interfaces
Threepipe provides various interfaces and classes for for three.js objects with upgraded features like UI events, serialization, etc.
These can be used while developing new apps to get better developer experience and features.
When standard three.js instances are added to the scene, they are automatically upgraded automatically at runtime to make them work with the rest of the framework.
Some important interfaces:
* [IObject3D](https://threepipe.org/docs/interfaces/IObject3D.html) - Interface for an extended version of three.js [Object3D](https://threejs.org/docs/#api/en/core/Object3D).
* [ILight](https://threepipe.org/docs/interfaces/ILight.html) - Interface for an extended version of three.js [Light](https://threejs.org/docs/#api/en/lights/Light).
* [ICamera](https://threepipe.org/docs/interfaces/ICamera.html) - Interface for an extended version of three.js [Camera](https://threejs.org/docs/#api/en/cameras/Camera).
* [IMaterial](https://threepipe.org/docs/interfaces/IMaterial.html) - Interface for an extended version of three.js [Material](https://threejs.org/docs/#api/en/materials/Material).
* [ITexture](https://threepipe.org/docs/interfaces/ITexture.html) - Interface for an extended version of three.js [Texture](https://threejs.org/docs/#api/en/textures/Texture).
* [IRenderTarget](https://threepipe.org/docs/interfaces/IRenderTarget.html) - Interface for an extended version of three.js [WebGLRenderTarget](https://threejs.org/docs/#api/en/renderers/WebGLRenderTarget).
* [IGeometry](https://threepipe.org/docs/interfaces/IGeometry.html) - Interface for an extended version of three.js [BufferGeometry](https://threejs.org/docs/#api/en/core/BufferGeometry).
* [IScene](https://threepipe.org/docs/interfaces/IScene.html) - Interface for an extended version of three.js [Scene](https://threejs.org/docs/#api/en/scenes/Scene).
* [IRenderManager](https://threepipe.org/docs/interfaces/IRenderManager.html) - Interface for rendering and render target manager.
Some important classes
* [Mesh2](https://threepipe.org/docs/classes/Mesh2.html) - Extends three.js [Mesh](https://threejs.org/docs/#api/en/objects/Mesh) and implements [IObject3D](https://threepipe.org/docs/interfaces/IObject3D.html).
* [PerspectiveCamera2](https://threepipe.org/docs/classes/PerspectiveCamera2.html) - Extends three.js [PerspectiveCamera](https://threejs.org/docs/#api/en/cameras/PerspectiveCamera) and implements [ICamera](https://threepipe.org/docs/interfaces/ICamera.html). (different constructor than PerspectiveCamera)
* [PerspectiveCamera0](https://threepipe.org/docs/classes/PerspectiveCamera0.html) - Extends three.js [PerspectiveCamera](https://threejs.org/docs/#api/en/cameras/PerspectiveCamera) and implements [ICamera](https://threepipe.org/docs/interfaces/ICamera.html). (same constructor than PerspectiveCamera)
* [BufferGeometry2](https://threepipe.org/docs/classes/BufferGeometry2.html) - Extends three.js [BufferGeometry](https://threejs.org/docs/#api/en/core/BufferGeometry) and implements [IGeometry](https://threepipe.org/docs/interfaces/IGeometry.html).
* [RootScene](https://threepipe.org/docs/classes/RootScene.html) - Extends three.js [Scene](https://threejs.org/docs/#api/en/scenes/Scene) and implements [IScene](https://threepipe.org/docs/interfaces/IScene.html).
* [RenderManager](https://threepipe.org/docs/classes/RenderManager.html) - Implements [IRenderManager](https://threepipe.org/docs/interfaces/IRenderManager.html).
* [PhysicalMaterial](https://threepipe.org/docs/classes/PhysicalMaterial.html) - Extends three.js [MeshPhysicalMaterial](https://threejs.org/docs/#api/en/materials/MeshPhysicalMaterial) and implements [IMaterial](https://threepipe.org/docs/interfaces/IMaterial.html).
* [UnlitMaterial](https://threepipe.org/docs/classes/UnlitMaterial.html) - Extends three.js [MeshBasicMaterial](https://threejs.org/docs/#api/en/materials/MeshBasicMaterial) and implements [IMaterial](https://threepipe.org/docs/interfaces/IMaterial.html).
* [LineMaterial2](https://threepipe.org/docs/classes/LineMaterial2.html) - Extends three.js [LineMaterial](https://threejs.org/docs/#api/en/materials/LineMaterial) and implements [IMaterial](https://threepipe.org/docs/interfaces/IMaterial.html).
* [UnlitLineMaterial](https://threepipe.org/docs/classes/UnlitLineMaterial.html) - Extends three.js [LineBasicMaterial](https://threejs.org/docs/#api/en/materials/LineBasicMaterial) and implements [IMaterial](https://threepipe.org/docs/interfaces/IMaterial.html).
* [DirectionalLight2](https://threepipe.org/docs/classes/DirectionalLight2.html) - Extends three.js [DirectionalLight](https://threejs.org/docs/#api/en/lights/DirectionalLight) and implements [ILight](https://threepipe.org/docs/interfaces/ILight.html).
* [SpotLight2](https://threepipe.org/docs/classes/SpotLight2.html) - Extends three.js [SpotLight](https://threejs.org/docs/#api/en/lights/SpotLight) and implements [ILight](https://threepipe.org/docs/interfaces/ILight.html).
* [PointLight2](https://threepipe.org/docs/classes/PointLight2.html) - Extends three.js [PointLight](https://threejs.org/docs/#api/en/lights/PointLight) and implements [ILight](https://threepipe.org/docs/interfaces/ILight.html).
* [HemisphereLight2](https://threepipe.org/docs/classes/HemisphereLight2.html) - Extends three.js [HemisphereLight](https://threejs.org/docs/#api/en/lights/HemisphereLight) and implements [ILight](https://threepipe.org/docs/interfaces/ILight.html).
* [AmbientLight2](https://threepipe.org/docs/classes/AmbientLight2.html) - Extends three.js [AmbientLight](https://threejs.org/docs/#api/en/lights/AmbientLight) and implements [ILight](https://threepipe.org/docs/interfaces/ILight.html).
* [RectAreaLight2](https://threepipe.org/docs/classes/RectAreaLight2.html) - Extends three.js [RectAreaLight](https://threejs.org/docs/#api/en/lights/RectAreaLight) and implements [ILight](https://threepipe.org/docs/interfaces/ILight.html).
# Threepipe Plugins
ThreePipe has a simple plugin system that allows you to easily add new features to the viewer. Plugins can be added to the viewer using the `addPlugin` and `addPluginSync` methods. The plugin system is designed to be modular and extensible. Plugins can be added to the viewer at any time and can be removed using the `removePlugin` and `removePluginSync` methods.
## TonemapPlugin
[//]: # (todo: image)
[Example](https://threepipe.org/examples/#tonemap-plugin/) —
[Source Code](./src/plugins/postprocessing/TonemapPlugin.ts) —
[API Reference](https://threepipe.org/docs/classes/TonemapPlugin.html)
TonemapPlugin adds a post-processing material extension to the ScreenPass in render manager
that applies tonemapping to the color. The tonemapping operator can be changed
by setting the `toneMapping` property of the plugin. The default tonemapping operator is `ACESFilmicToneMapping`.
Other Tonemapping properties can be like `exposure`, `contrast` and `saturation`
TonemapPlugin is added by default in ThreeViewer unless `tonemap` is set to `false` in the options.
## DropzonePlugin
[//]: # (todo: image)
[Example](https://threepipe.org/examples/#dropzone-plugin/) —
[Source Code](./src/plugins/interaction/DropzonePlugin.ts) —
[API Reference](https://threepipe.org/docs/classes/DropzonePlugin.html)
DropzonePlugin adds support for drag and drop of local files to automatically import, process and load them into the viewer.
DropzonePlugin can be added by default in ThreeViewer
by setting the `dropzone` property to `true` or an object of `DropzonePluginOptions` in the options.
```typescript
import {DropzonePlugin, ThreeViewer} from 'threepipe'
const viewer = new ThreeViewer({
canvas: document.getElementById('mcanvas') as HTMLCanvasElement,
dropzone: true, // just set to true to enable drag drop functionatility in the viewer
})
```
To set custom options,
pass an object of [DropzonePluginOptions](https://threepipe.org/docs/interfaces/DropzonePluginOptions.html) type to the `dropzone` property.
```typescript
import {DropzonePlugin, ThreeViewer} from 'threepipe'
const viewer = new ThreeViewer({
canvas: document.getElementById('mcanvas') as HTMLCanvasElement,
dropzone: { // this can also be set to true and configured by getting a reference to the DropzonePlugin
allowedExtensions: ['gltf', 'glb', 'hdr', 'png', 'jpg', 'json', 'fbx', 'obj', 'bin', 'exr'], // only allow these file types. If undefined, all files are allowed.
addOptions: {
disposeSceneObjects: true, // auto dispose of old scene objects
autoSetEnvironment: true, // when hdr is dropped
autoSetBackground: true, // when any image is dropped
autoCenter: true, // auto center the object
autoScale: true, // auto scale according to radius
autoScaleRadius: 2,
license: 'Imported from dropzone', // Any license to set on imported objects
importConfig: true, // import config from file
},
// check more options in the DropzonePluginOptions interface
},
})
```
## ProgressivePlugin
[//]: # (todo: image)
[Example](https://threepipe.org/examples/#progressive-plugin/) —
[Source Code](./src/plugins/pipeline/ProgressivePlugin.ts) —
[API Reference](https://threepipe.org/docs/classes/ProgressivePlugin.html)
Progressive Plugin adds a post-render pass to blend the last frame with the current frame.
This is used as a dependency in other plugins for progressive rendering effect which is useful for progressive shadows, gi, denoising, baking, anti-aliasing, and many other effects. The helper function `convergedPromise` returns a new promise that can be used to wait for the progressive rendering to converge.
## DepthBufferPlugin
[//]: # (todo: image)
[Example](https://threepipe.org/examples/#depth-buffer-plugin/) —
[Source Code](./src/plugins/pipeline/DepthBufferPlugin.ts) —
[API Reference](https://threepipe.org/docs/classes/DepthBufferPlugin.html)
Depth Buffer Plugin adds a pre-render pass to the render manager and renders a depth buffer to a target. The render target can be accessed by other plugins throughout the rendering pipeline to create effects like depth of field, SSAO, SSR, etc.
```typescript
import {ThreeViewer, DepthBufferPlugin} from 'threepipe'
const viewer = new ThreeViewer({...})
const depthPlugin = viewer.addPluginSync(new DepthBufferPlugin(HalfFloatType))
const depthTarget = depthPlugin.target;
// Use the depth target by accesing `depthTarget.texture`.
```
The depth values are based on camera near far values, which are controlled automatically by the viewer. To manually specify near, far values and limits, it can be set in the camera userData. Check the [example](https://threepipe.org/examples/#depth-buffer-plugin/) for more details.
## NormalBufferPlugin
[//]: # (todo: image)
[Example](https://threepipe.org/examples/#normal-buffer-plugin/) —
[Source Code](./src/plugins/pipeline/NormalBufferPlugin.ts) —
[API Reference](https://threepipe.org/docs/classes/NormalBufferPlugin.html)
Normal Buffer Plugin adds a pre-render pass to the render manager and renders a normal buffer to a target. The render target can be accessed by other plugins throughout the rendering pipeline to create effects like SSAO, SSR, etc.
Note: Use [`GBufferPlugin`](#GBufferPlugin) if using both `DepthBufferPlugin` and `NormalBufferPlugin` to render both depth and normal buffers in a single pass.
```typescript
import {ThreeViewer, NormalBufferPlugin} from 'threepipe'
const viewer = new ThreeViewer({...})
const normalPlugin = viewer.addPluginSync(new NormalBufferPlugin())
const normalTarget = normalPlugin.target;
// Use the normal target by accessing `normalTarget.texture`.
```
## GBufferPlugin
[//]: # (todo: image)
[Example](https://threepipe.org/examples/#gbuffer-plugin/) —
[Source Code](./src/plugins/pipeline/GBufferPlugin.ts) —
[API Reference](https://threepipe.org/docs/classes/GBufferPlugin.html)
GBuffer Plugin adds a pre-render pass to the render manager and renders depth+normals to a target and some customizable flags to another. The multiple render target and textures can be accessed by other plugins throughout the rendering pipeline to create effects like SSAO, SSR, etc.
```typescript
import {ThreeViewer, GBufferPlugin} from 'threepipe'
const viewer = new ThreeViewer({...})
const gBufferPlugin = viewer.addPluginSync(new GBufferPlugin())
const gBuffer = gBufferPlugin.target;
const normalDepth = gBufferPlugin.normalDepthTexture;
const gBufferFlags = gBufferPlugin.flagsTexture;
```
## SSAOPlugin
[//]: # (todo: image)
[Example](https://threepipe.org/examples/#ssao-plugin/) —
[Source Code](./src/plugins/pipeline/SSAOPlugin.ts) —
[API Reference](https://threepipe.org/docs/classes/SSAOPlugin.html)
SSAO Plugin adds support for [Screen Space Ambient Occlusion](https://en.wikipedia.org/wiki/Screen_space_ambient_occlusion) to the viewer. Simply add the plugin to the viewer to use it.
This is done by adding a pre-render pass to the render manager which renders SSAO to a custom render target. SSAOPlugin depends on [GBufferPlugin](#gbufferplugin), and is automatically added if not already.
This render target is then used by all PhysicalMaterial(s) in the scene during the main RenderPass to get the AO data. SSAO can also be disabled from the UI of the material.
Note: Use with [ProgressivePlugin](#progressiveplugin) and `TemporalAAPlugin` for best results.
```typescript
import {ThreeViewer, SSAOPlugin} from 'threepipe'
const viewer = new ThreeViewer({...})
const ssaoPlugin = viewer.addPluginSync(new SSAOPlugin())
// get the buffer.
console.log(ssaoPlugin.target);
// disable ssao for a material in the scene
material.userData.ssaoDisabled = true
```
> In the target/buffer - The ssao data is in the `r` channel to remain compatible with ORM. `gba` contains the depth in vec3(xyz) format.
> Note that its `ssaoDisabled`, so setting it to `true` will disable the effect.
## CanvasSnapshotPlugin
[//]: # (todo: image)
[Example](https://threepipe.org/examples/#canvas-snapshot-plugin/) —
[Source Code](./src/plugins/export/CanvasSnapshotPlugin.ts) —
[API Reference](https://threepipe.org/docs/classes/CanvasSnapshotPlugin.html)
Canvas Snapshot Plugin adds support for taking snapshots of the canvas and exporting them as images and data urls. It includes options to take snapshot of a region, mime type, quality render scale and scaling the output image. Check out the interface [CanvasSnapshotOptions](https://threepipe.org/docs/interfaces/CanvasSnapshotOptions.html) for more details.
```typescript
import {ThreeViewer, CanvasSnapshotPlugin} from 'threepipe'
const viewer = new ThreeViewer({...})
const snapshotPlugin = viewer.addPluginSync(new CanvasSnapshotPlugin())
// download a snapshot.
await snapshotPlugin.downloadSnapshot('image.webp', { // all parameters are optional
scale: 1, // scale the final image
timeout: 0, // wait before taking the snapshot, in ms
quality: 0.9, // quality of the image (0-1) only for jpeg and webp
displayPixelRatio: 2, // render scale
mimeType: 'image/webp', // mime type of the image
waitForProgressive: true, // wait for progressive rendering to finish (ProgressivePlugin). true by default
rect: { // region to take snapshot. eg. crop center of the canvas
height: viewer.canvas.clientHeight / 2,
width: viewer.canvas.clientWidth / 2,
x: viewer.canvas.clientWidth / 4,
y: viewer.canvas.clientHeight / 4,
},
})
// get data url (string)
const dataUrl = await snapshotPlugin.getDataUrl({ // all parameters are optional
displayPixelRatio: 2, // render scale
mimeType: 'image/webp', // mime type of the image
})
// get File
const file = await snapshotPlugin.getFile('file.jpeg', { // all parameters are optional
mimeType: 'image/jpeg', // mime type of the image
})
```
## PickingPlugin
[//]: # (todo: image)
[Example](https://threepipe.org/examples/#picking-plugin/) —
[Source Code](./src/plugins/interaction/PickingPlugin.ts) —
[API Reference](https://threepipe.org/docs/classes/PickingPlugin.html)
Picking Plugin adds support for selecting and hovering over objects in the viewer with user interactions and selection widgets.
When the plugin is added to the viewer, it starts listening to the mouse move and click events over the canvas.
When an object is clicked, it is selected,
and if a UI plugin is added, the uiconfig for the selected object is populated in the interface.
The events `selectedObjectChanged`, `hoverObjectChanged`, and `hitObject` can be listened to on the plugin.
Picking plugin internally uses [ObjectPicker](https://threepipe.org/docs/classes/ObjectPicker.html),
check out the documentation or source code for more information.
```typescript
import {ThreeViewer, PickingPlugin} from 'threepipe'
const viewer = new ThreeViewer({...})
const pickingPlugin = viewer.addPluginSync(new PickingPlugin())
// Hovering events are also supported, but since its computationally expensive for large scenes it is disabled by default.
pickingPlugin.hoverEnabled = true
pickingPlugin.addEventListener('hitObject', (e)=>{
// This is fired when the user clicks on the canvas.
// The selected object hasn't been changed yet, and we have the option to change it or disable selection at this point.
// e.intersects.selectedObject contains the object that the user clicked on.
console.log('Hit: ', e.intersects.selectedObject)
// It can be changed here
// e.intersects.selectedObject = e.intersects.selectedObject.parent // select the parent
// e.intersects.selectedObject = null // unselect
// Check other properties on the event like intersects, mouse position, normal etc.
console.log(e)
})
pickingPlugin.addEventListener('selectedObjectChanged', (e)=>{
// This is fired when the selected object is changed.
// e.object contains the new selected object. It can be null if nothing is selected.
console.log('Selected: ', e.object)
})
// Objects can be programmatically selected and unselected
// to select
pickingPlugin.setSelectedObject(object)
// get the selected object
console.log(pickingPlugin.getSelectedObject())
// to unselect
pickingPlugin.setSelectedObject(null)
// Select object with camera animation to the object
pickingPlugin.setSelectedObject(object, true)
pickingPlugin.addEventListener('hoverObjectChanged', (e)=>{
// This is fired when the hovered object is changed.
// e.object contains the new hovered object.
console.log('Hovering: ', e.object)
})
```
## TransformControlsPlugin
[//]: # (todo: image)
[Example](https://threepipe.org/examples/#transform-controls-plugin/) —
[Source Code](./src/plugins/interaction/TransformControlsPlugin.ts) —
[API Reference](https://threepipe.org/docs/classes/TransformControlsPlugin.html)
Transform Controls Plugin adds support for moving, rotating and scaling objects in the viewer with interactive widgets.
Under the hood, TransformControlsPlugin uses [TransformControls2](https://threepipe.org/docs/classes/TransformControls2) to provide the interactive controls, it is a extended version of three.js [TransformControls](https://threejs.org/docs/#examples/en/controls/TransformControls).
When the plugin is added to the viewer, it interfaces with the [PickingPlugin](#pickingplugin) and shows the control gizmos when an object is selected and hides them when the object is unselected.
If the `PickingPlugin` is not added to the viewer before the `TransformControlsPlugin`, it is added automatically with the plugin.
```typescript
import {ThreeViewer, TransformControlsPlugin} from 'threepipe'
const viewer = new ThreeViewer({...})
const transfromControlsPlugin = viewer.addPluginSync(new TransformControlsPlugin())
// Get the underlying transform controls
console.log(transfromControlsPlugin.transformControls)
```
## ContactShadowGroundPlugin
[//]: # (todo: image)
[Example](https://threepipe.org/examples/#contact-shadow-ground-plugin/) —
[Source Code](./src/plugins/extras/ContactShadowGroundPlugin.ts) —
[API Reference](https://threepipe.org/docs/classes/ContactShadowGroundPlugin.html)
Contact Shadow Ground Plugin adds a ground plane with three.js contact shadows to the viewer scene.
The plane is added to the scene root at runtime and not saved with scene export. Instead the plugin settings are saved with the scene.
It inherits from the base class [BaseGroundPlugin](https://threepipe.org/docs/classes/BaseGroundPlugin.html) which provides generic ground plane functionality. Check the source code for more details. With the property `autoAdjustTransform`, the ground plane is automatically adjusted based on the bounding box of the scene.
```typescript
import {ThreeViewer, ContactShadowGroundPlugin} from 'threepipe'
const viewer = new ThreeViewer({...})
viewer.addPluginSync(new ContactShadowGroundPlugin())
```
## GLTFAnimationPlugin
[//]: # (todo: image)
[Example](https://threepipe.org/examples/#gltf-animation-plugin/) —
[Source Code](./src/plugins/animation/GLTFAnimationPlugin.ts) —
[API Reference](https://threepipe.org/docs/classes/GLTFAnimationPlugin.html)
Manages playback of GLTF animations.
The GLTF animations can be created in any 3d software that supports GLTF export like Blender.
If animations from multiple files are loaded, they will be merged in a single root object and played together.
The time playback is managed automatically, but can be controlled manually by setting {@link autoIncrementTime} to false and using {@link setTime} to set the time.
This plugin is made for playing, pausing, stopping, all the animations at once, while it is possible to play individual animations, it is not recommended.
To play individual animations, with custom choreography, use the {@link GLTFAnimationPlugin.animations} property to get reference to the animation clips and actions. Create your own mixers and control the animation playback like in three.js
## PopmotionPlugin
[//]: # (todo: image)
[Example](https://threepipe.org/examples/#popmotion-plugin/) —
[Source Code](./src/plugins/animation/PopmotionPlugin.ts) —
[API Reference](https://threepipe.org/docs/classes/PopmotionPlugin.html)
Provides animation/tweening capabilities to the viewer using the [popmotion.io](https://popmotion.io/) library.
Overrides the driver in popmotion to sync with the viewer and provide ways to store and stop animations.
```typescript
import {PopmotionPlugin, ThreeViewer} from 'threepipe'
const viewer = new ThreeViewer({...})
const cube = viewer.scene.getObjectByName('cube');
const popmotion = viewer.addPluginSync(new PopmotionPlugin())
// Move the object cube 1 unit up.
const anim = popmotion.animateTarget(cube, 'position', {
to: cube.position.clone().add(new Vector3(0,1,0)),
duration: 500, // ms
onComplete: () => isMovedUp = true,
onStop: () => throw(new Error('Animation stopped')),
})
// Alternatively, set the property directly in onUpdate.
const anim1 = popmotion.animate({
from: cube.position.y,
to: cube.position.y + 1,
duration: 500, // ms
onUpdate: (v) => {
cube.position.setY(v)
cube.setDirty()
},
onComplete: () => isMovedUp = true,
onStop: () => throw(new Error('Animation stopped')),
onEnd: () => console.log('Animation ended'), // This runs after both onComplete and onStop
})
// await for animation. This promise will reject only if an exception is thrown in onStop or onComplete. onStop rejects if throwOnStop is true
await anim.promise.catch((e)=>{
console.log(e, 'animation stopped before completion')
});
// or stop the animation
// anim.stop()
// Animate the color
await popmotion.animateAsync({ // Also await for the animation.
from: '#' + cube.material.color.getHexString(),
to: '#' + new Color().setHSL(Math.random(), 1, 0.5).getHexString(),
duration: 1000, // 1s
onUpdate: (v) => {
cube.material.color.set(v)
cube.material.setDirty()
},
})
```
Note: The animation is started when the animate or animateAsync function is called.
## CameraViewPlugin
[//]: # (todo: image)
[Example](https://threepipe.org/examples/#camera-view-plugin/) —
[Source Code](./src/plugins/animation/CameraViewPlugin.ts) —
[API Reference](https://threepipe.org/docs/classes/CameraViewPlugin.html)
CameraViewPlugin adds support to save and load camera views, which can then be animated to.
It uses PopmotionPlugin internally to animate any camera to a saved view or to loop through all the saved views.
It also provides a UI to manage the views.
```typescript
import {CameraViewPlugin, ThreeViewer, CameraView, Vector3, Quaternion, EasingFunctions, timeout} from 'threepipe'
const viewer = new ThreeViewer({...})
const cameraViewPlugin = viewer.addPluginSync(new CameraViewPlugin())
const intialView = cameraViewPlugin.getView()
// or = viewer.scene.mainCamera.getView()
// create a new view
const view = new CameraView(
'My View', // name
new Vector3(0, 0, 10), // position
new Vector3(0, 0, 0), // target
new Quaternion(0, 0, 0, 1), // quaternion rotation
1 // zoom
)
// or clone a view
const view2 = intialView.clone()
view2.position.add(new Vector3(0, 5, 0)) // move up 5 units
// animate the main camera to a view
await cameraViewPlugin.animateToView(
view,
2000, // in ms, = 2sec
EasingFunctions.easeInOut,
).catch(()=>console.log('Animation stopped'))
// stop any/all animations
cameraViewPlugin.stopAllAnimations()
// add views to the plugin
cameraViewPlugin.addView(view)
cameraViewPlugin.addView(view2)
cameraViewPlugin.addView(intialView)
cameraViewPlugin.addCurrentView() // adds the current view of the main camera
// loop through all the views once
cameraViewPlugin.animDuration = 2000 // default duration
cameraViewPlugin.animEase = EasingFunctions.easeInOutSine // default easing
await cameraViewPlugin.animateAllViews()
// loop through all the views forever
cameraViewPlugin.viewLooping = true
await timeout(10000) // wait for some time
// stop looping
cameraViewPlugin.viewLooping = false
```
## RenderTargetPreviewPlugin
[//]: # (todo: image)
[Example](https://threepipe.org/examples/#render-target-preview/) —
[Source Code](./src/plugins/ui/RenderTargetPreviewPlugin.ts) —
[API Reference](https://threepipe.org/docs/classes/RenderTargetPreviewPlugin.html)
RenderTargetPreviewPlugin is a useful development and debugging plugin that renders any registered render-target to the screen in small collapsable panels.
```typescript
import {ThreeViewer, RenderTargetPreviewPlugin, NormalBufferPlugin} from 'threepipe'
const viewer = new ThreeViewer({...})
const normalPlugin = viewer.addPluginSync(new NormalBufferPlugin(HalfFloatType))
const previewPlugin = viewer.addPluginSync(new RenderTargetPreviewPlugin())
// Show the normal buffer in a panel
previewPlugin.addTarget(()=>normalPlugin.target, 'normal', false, false)
```
## GeometryUVPreviewPlugin
[//]: # (todo: image)
[Example](https://threepipe.org/examples/#geometry-uv-preview/) —
[Source Code](./src/plugins/ui/GeometryUVPreviewPlugin.ts) —
[API Reference](https://threepipe.org/docs/classes/GeometryUVPreviewPlugin.html)
GeometryUVPreviewPlugin is a useful development and debugging plugin
that adds a panel to the viewer to show the UVs of a geometry.
```typescript
import {ThreeViewer, GeometryUVPreviewPlugin, SphereGeometry} from 'threepipe'
const viewer = new ThreeViewer({...})
const previewPlugin = viewer.addPluginSync(new GeometryUVPreviewPlugin())
const geometry = new SphereGeometry(1, 32, 32)
// Show the normal buffer in a panel
previewPlugin.addGeometry(geometry, 'sphere')
```
## FrameFadePlugin
[//]: # (todo: image)
[Example](https://threepipe.org/examples/#frame-fade-plugin/) —
[Source Code](./src/plugins/pipeline/FrameFadePlugin.ts) —
[API Reference](https://threepipe.org/docs/classes/FrameFadePlugin.html)
FrameFadePlugin adds a post-render pass to the render manager and blends the last frame with the current frame over time. This is useful for creating smooth transitions between frames for example when changing the camera position, material, object properties, etc to avoid a sudden jump.
```typescript
import {ThreeViewer, FrameFadePlugin} from 'threepipe'
const viewer = new ThreeViewer({...})
const fadePlugin = viewer.addPluginSync(new FrameFadePlugin())
// Make some changes in the scene (any visual change that needs to be faded)
// Start transition and wait for it to finish
await fadePlugin.startTransition(400) // duration in ms
```
To stop a transition, call `fadePlugin.stopTransition()`. This will immediately set the current frame to the last frame and stop the transition. The transition is also automatically stopped when the camera is moved or some pointer event occurs on the canvas.
The plugin automatically tracks `setDirty()` function calls in objects, materials and the scene. It can be triggerred by calling `setDirty` on any material or object in the scene. Check the [example](https://threepipe.org/examples/#frame-fade-plugin/) for a demo. This can be disabled by options in the plugin.
## VignettePlugin
[//]: # (todo: image)
[Example](https://threepipe.org/examples/#vignette-plugin/) —
[Source Code](./src/plugins/postprocessing/VignettePlugin.ts) —
[API Reference](https://threepipe.org/docs/classes/VignettePlugin.html)
VignettePlugin adds a post-processing material extension to the ScreenPass in render manager
that applies a vignette effect to the final render. The parameters `power` and `color` can be changed to customize the effect.
```typescript
import {ThreeViewer, VignettePlugin} from 'threepipe'
const viewer = new ThreeViewer({...})
const vignettePlugin = viewer.addPluginSync(VignettePlugin)
// Change the vignette color
vignettePlugin.power = 1
vignettePlugin.color = new Color(0.5, 0, 0)
// or
// vignettePlugin.color.set('#ff0000'); vignettePlugin.setDirty() // Call setDirty to tell the plugin that color has changed
```
## ChromaticAberrationPlugin
[//]: # (todo: image)
[Example](https://threepipe.org/examples/#chromatic-aberration-plugin/) —
[Source Code](./src/plugins/postprocessing/ChromaticAberrationPlugin.ts) —
[API Reference](https://threepipe.org/docs/classes/ChromaticAberrationPlugin.html)
ChromaticAberrationPlugin adds a post-processing material extension to the ScreenPass in render manager
that applies a chromatic-aberration effect to the final render. The parameter `intensity` can be changed to customize the effect.
```typescript
import {ThreeViewer, ChromaticAberrationPlugin} from 'threepipe'
const viewer = new ThreeViewer({...})
const chromaticAberrationPlugin = viewer.addPluginSync(ChromaticAberrationPlugin)
// Change the chromaticAberration color
chromaticAberrationPlugin.intensity = 0.5
```
## FilmicGrainPlugin
[//]: # (todo: image)
[Example](https://threepipe.org/examples/#filmic-grain-plugin/) —
[Source Code](./src/plugins/postprocessing/FilmicGrainPlugin.ts) —
[API Reference](https://threepipe.org/docs/classes/FilmicGrainPlugin.html)
FilmicGrainPlugin adds a post-processing material extension to the ScreenPass in render manager
that applies a filmic-grain effect to the final render. The parameters `power` and `color` can be changed to customize the effect.
```typescript
import {ThreeViewer, FilmicGrainPlugin} from 'threepipe'
const viewer = new ThreeViewer({...})
const filmicGrainPlugin = viewer.addPluginSync(FilmicGrainPlugin)
// Change the filmicGrain color
filmicGrainPlugin.intensity = 10
filmicGrainPlugin.multiply = false
```
## NoiseBumpMaterialPlugin
[//]: # (todo: image)
[Example](https://threepipe.org/examples/#noise-bump-material-plugin/) —
[Source Code](./src/plugins/material/NoiseBumpMaterialPlugin.ts) —
[API Reference](https://threepipe.org/docs/classes/NoiseBumpMaterialPlugin.html)
NoiseBumpMaterialPlugin adds a material extension to PhysicalMaterial to add support for sparkle bump / noise bump by creating procedural bump map from noise to simulate sparkle flakes.
It uses voronoise function from blender along with several additions to generate the noise for the generation.
It also adds a UI to the material to edit the settings.
It uses `WEBGI_materials_noise_bump` glTF extension to save the settings in glTF/glb files.
```typescript
import {ThreeViewer, NoiseBumpMaterialPlugin} from 'threepipe'
const viewer = new ThreeViewer({...})
const noiseBump = viewer.addPluginSync(NoiseBumpMaterialPlugin)
// Add noise bump to a material
NoiseBumpMaterialPlugin.AddNoiseBumpMaterial(material, {
flakeScale: 300,
})
// Change properties with code or use the UI
material.userData._noiseBumpMat!.bumpNoiseParams = [1, 1]
material.setDirty()
// Disable
material.userData._noiseBumpMat!.hasBump = false
material.setDirty()
```
## CustomBumpMapPlugin
[//]: # (todo: image)
[Example](https://threepipe.org/examples/#custom-bump-map-plugin/) —
[Source Code](./src/plugins/material/CustomBumpMapPlugin.ts) —
[API Reference](https://threepipe.org/docs/classes/CustomBumpMapPlugin.html)
CustomBumpMapPlugin adds a material extension to PhysicalMaterial to support custom bump maps.
A Custom bump map is similar to the built-in bump map, but allows using an extra bump map and scale to give a combined effect.
This plugin also has support for bicubic filtering of the custom bump map and is enabled by default.
It also adds a UI to the material to edit the settings.
It uses `WEBGI_materials_custom_bump_map` glTF extension to save the settings in glTF/glb files.
```typescript
import {ThreeViewer, CustomBumpMapPlugin} from 'threepipe'
const viewer = new ThreeViewer({...})
const customBump = viewer.addPluginSync(CustomBumpMapPlugin)
// Add noise bump to a material
customBump.enableCustomBump(material, bumpMap, 0.2)
// Change properties with code or use the UI
material.userData._customBumpMat = texture
material.setDirty()
// Disable
material.userData._hasCustomBump = false
// or
material.userData._customBumpMat = null
material.setDirty()
```
## ClearcoatTintPlugin
[//]: # (todo: image)
[Example](https://threepipe.org/examples/#clearcoat-tint-plugin/) —
[Source Code](./src/plugins/material/ClearcoatTintPlugin.ts) —
[API Reference](https://threepipe.org/docs/classes/ClearcoatTintPlugin.html)
ClearcoatTintPlugin adds a material extension to PhysicalMaterial which adds tint and thickness to the built-in clearcoat properties.
It also adds a UI to the material to edit the settings.
It uses `WEBGI_materials_clearcoat_tint` glTF extension to save the settings in glTF/glb files.
```typescript
import {ThreeViewer, ClearcoatTintPlugin} from 'threepipe'
const viewer = new ThreeViewer({...})
const clearcoatTint = viewer.addPluginSync(ClearcoatTintPlugin)
material.clearcoat = 1
// add initial properties
ClearcoatTintPlugin.AddClearcoatTint(material, {
tintColor: '#ff0000',
thickness: 1,
})
// Change properties with code or use the UI
material.userData._clearcoatTint!.tintColor = '#ff0000'
material.setDirty()
// Disable
material.userData._clearcoatTint.enableTint = false
material.setDirty()
```
## FragmentClippingExtensionPlugin
[//]: # (todo: image)
[Example](https://threepipe.org/examples/#fragment-clipping-extension-plugin/) —
[Source Code](./src/plugins/material/FragmentClippingExtensionPlugin.ts) —
[API Reference](https://threepipe.org/docs/classes/FragmentClippingExtensionPlugin.html)
FragmentClippingExtensionPlugin adds a material extension to PhysicalMaterial to add support for fragment clipping.
Fragment clipping allows to clip fragments of the material in screen space or world space based on a circle, rectangle, plane, sphere, etc.
It uses fixed SDFs with params defined by the user for clipping.
It also adds a UI to the material to edit the settings.
It uses `WEBGI_materials_fragment_clipping_extension` glTF extension to save the settings in glTF/glb files.
```typescript
import {ThreeViewer, FragmentClippingExtensionPlugin} from 'threepipe'
const viewer = new ThreeViewer({...})
const fragmentClipping = viewer.addPluginSync(FragmentClippingExtensionPlugin)
// add initial properties
FragmentClippingExtensionPlugin.AddFragmentClipping(material, {
clipPosition: new Vector4(0.5, 0.5, 0, 0),
clipParams: new Vector4(0.1, 0.05, 0, 1),
})
// Change properties with code or use the UI
material.userData._fragmentClipping!.clipPosition.set(0, 0, 0, 0)
material.setDirty()
// Disable
material.userData._clearcoatTint.clipEnabled = false
material.setDirty()
```
## HDRiGroundPlugin
[//]: # (todo: image)
[Example](https://threepipe.org/examples/#hdri-ground-plugin/) —
[Source Code](./src/plugins/extras/HDRiGroundPlugin.ts) —
[API Reference](https://threepipe.org/docs/classes/HDRiGroundPlugin.html)
HDRiGroundPlugin patches the background shader in the renderer to add support for ground projected environment map/skybox. Works simply by setting the background same as the environemnt and enabling the plugin.
The world radius, tripod height, and origin position(center offset) can be set in the plugin.
The plugin is disabled by default when added. Set `.enabled` to enable it or pass `true` in the constructor.
If the background is not the same as the environment when enabled, the user will be prompted for this, unless `promptOnBackgroundMismatch` is set to `false` in the plugin.
```typescript
import {ThreeViewer, HDRiGrounPlugin} from 'threepipe'
const viewer = new ThreeViewer({...})
const hdriGround = viewer.addPluginSync(new HDRiGrounPlugin())
// Load an hdr environment map
await viewer.setEnvironmentMap('https://threejs.org/examples/textures/equirectangular/venice_sunset_1k.hdr')
// set background to environment
viewer.scene.background = 'environment'
// or
// viewer.scene.background = viewer.scene.environemnt
// enable the plugin
hdriGround.enabled = true
```
Check the [example](https://threepipe.org/examples/#hdri-ground-plugin/) for a demo.
## VirtualCamerasPlugin
[//]: # (todo: image)
[Example](https://threepipe.org/examples/#virtual-cameras-plugin/) —
[Source Code](./src/plugins/rendering/VirtualCamerasPlugin.ts) —
[API Reference](https://threepipe.org/docs/classes/VirtualCamerasPlugin.html)
VirtualCamerasPlugin adds support for rendering to multiple virtual cameras in the viewer. These cameras are rendered in preRender callback just before the main camera is rendered. The virtual cameras can be added to the plugin and removed from it.
The feed to the virtual camera is rendered to a Render Target texture which can be accessed and re-rendered in the scene or used in other plugins.
```typescript
import {ThreeViewer, VirtualCamerasPlugin} from 'threepipe'
const viewer = new ThreeViewer({...})
const virtualCameras = viewer.addPluginSync(new VirtualCamerasPlugin())
const camera = new PerspectiveCamera2('orbit', viewer.canvas, false, 45, 1)
camera.name = name
camera.position.set(0, 5, 0)
camera.target.set(0, 0.25, 0)
camera.userData.autoLookAtTarget = true // automatically look at the target (in setDirty)
camera.setDirty()
camera.addEventListener('update', ()=>{
viewer.setDirty() // if the camera is not added to the scene it wont update automatically when camera.setDirty is called(like from the UI)
})
const vCam = virtualCameras.addCamera(camera)
console.log(vCam.target) // target is a WebGLRenderTarget/IRenderTarget
```
Check the [virtual camera](https://threepipe.org/examples/#virtual-camera/) example for using the texture in the scene.
## EditorViewWidgetPlugin
[//]: # (todo: image)
[Example](https://threepipe.org/examples/#editor-view-widget-plugin/) —
[Source Code](./src/plugins/interaction/EditorViewWidgetPlugin.ts) —
[API Reference](https://threepipe.org/docs/classes/EditorViewWidgetPlugin.html)
EditorViewWidgetPlugin adds a ViewHelper in the parent of the viewer canvas to show the current camera view and allow the user to change the camera view to one of the primary world axes.
Simply add the plugin to the viewer to see the widget.
```typescript
import {ThreeViewer, EditorViewWidgetPlugin} from 'threepipe'
const viewer = new ThreeViewer({...})
const plugin = viewer.addPluginSync(new EditorViewWidgetPlugin())
// to hide the widget
plugin.enabled = false
```
## Object3DWidgetsPlugin
[//]: # (todo: image)
[Example](https://threepipe.org/examples/#object3d-widgets-plugin/) —
[Source Code](./src/plugins/extras/Object3DWidgetsPlugin.ts) —
[API Reference](https://threepipe.org/docs/classes/Object3DWidgetsPlugin.html)
Object3DWidgetsPlugin adds support for light and camera helpers/gizmos in the viewer.
A helper is automatically created when any supported light or camera is added to the scene.
Simply add the plugin to the viewer to see the widget.
Support for additional types of helpers can be added dynamically or by other plugins by pushing a helper constructor to the `Object3DWidgetsPlugin.helpers` array, and calling `Object3DWidgetsPlugin.refresh()`.
The helper class prototype should implement the `IObject3DHelper` interface. Check `DirectionalLightHelper2` for an example.
```typescript
import {ThreeViewer, Object3DWidgetsPlugin, Object3DGeneratorPlugin} from 'threepipe'
const viewer = new ThreeViewer({...})
// Add the plugin to add support
const plugin = viewer.addPluginSync(new Object3DWidgetsPlugin())
// Add some lights or cameras to the scene. (This can be done before adding the plugin as well)
// Using Object3DGeneratorPlugin to create a camera and add it to the scene.
const generator = viewer.getOrAddPluginSync(Object3DGeneratorPlugin)
generator.generate('camera-perspective', {
position: new Vector3(5, 5, 0),
name: 'My Camera'
})
// to hide the widgets
plugin.enabled = false
// to add support for a custom helper
plugin.helpers.push(MyCustomHelper)
plugin.refresh()
```
## Object3DGeneratorPlugin
[//]: # (todo: image)
[Example](https://threepipe.org/examples/#object3d-generator-plugin/) —
[Source Code](./src/plugins/extras/Object3DGeneratorPlugin.ts) —
[API Reference](https://threepipe.org/docs/classes/Object3DGeneratorPlugin.html)
Object3DGeneratorPlugin adds support for creating different types of lights and camera objects in the viewer.
Call the `generate` method with any type to generate a type of object(like lights, cameras, mesh etc).
Support for the following types of generators is included in the plugin:
* camera-perspective - Creates instance of `PerspectiveCamera2`
* light-directional - Creates instance of `DirectionalLight2`
* light-ambient - Creates instance of `AmbientLight2`
* light-point - Creates instance of `PointLight2`
* light-spot - Creates instance of `SpotLight2`
* light-hemisphere - Creates instance of `HemisphereLight2`
* light-rect-area - Creates instance of `RectAreaLight2`
Additional types of generators can be added dynamically or by other plugins by adding a custom generator function to the `Object3DGeneratorPlugin.generators` object. This is done by [GeometryGeneratorPlugin](#threepipeplugin-geometry-generator) to add various type of primitive objects like plane, sphere, etc
A custom generator can take in any kind object as parameters and should return an `IObject3D`.
Sample Usage
```typescript
import {ThreeViewer, Object3DWidgetsPlugin, Object3DGeneratorPlugin, Mesh2} from 'threepipe'
const viewer = new ThreeViewer({...})
const generator = viewer.addPluginSync(Object3DGeneratorPlugin)
generator.generate('camera-perspective', {
position: new Vector3(5, 5, 0),
name: 'My Camera'
})
const light = generator.generate('light-spot', {
position: new Vector3(5, 0, 0),
})
// to add support for a custom helper
plugin.generators['custom-object'] = (params)=>{
const object = new Mesh2(new PlaneGeometry(1,1), new PhysicalMaterial())
object.name = params.name ?? 'Custom Mesh'
if(params.position) object.position.copy(params.position)
return object
}
const obj = generator.generate('custom-object', {
position: new Vector3(5, 0, 0),
})
// Add Object3DWidgetsPlugin to see the added lights and cameras.
viewer.addPluginSync(new Object3DWidgetsPlugin())
```
Check the [example](https://threepipe.org/examples/#object3d-generator-plugin/) for the UI.
## DeviceOrientationControlsPlugin
[//]: # (todo: image)
[Example](https://threepipe.org/examples/#device-orientation-controls-plugin/) —
[Source Code](./src/plugins/interaction/DeviceOrientationControlsPlugin.ts) —
[API Reference](https://threepipe.org/docs/classes/DeviceOrientationControlsPlugin.html)
DeviceOrientationControlsPlugin enables controlling the main camera rotation in the scene with device orientation. This only works on devices which have a gyroscope(but can also be emulated in devtools in chrome).
After the plugin is added, it adds support for setting `deviceOrientation` as the key in `scene.mainCamera.controlMode`.
When the controls is started (for the first time), the current camera rotation is and the device orientation is saved and used as reference. To reset the saved device orientation, call `resetView` in the controls.
Sample Usage
```typescript
import {ThreeViewer, DeviceOrientationControlsPlugin, Mesh2} from 'threepipe'
const viewer = new ThreeViewer({...})
viewer.addPluginSync(DeviceOrientationControlsPlugin)
// after some user action
viewer.scene.mainCamera.controlsMode = 'deviceOrientation'
// to reset the saved device orientation
viewer.scene.mainCamera.controls.resetView()
// switch back to default orbit controls
viewer.scene.mainCamera.controlsMode = 'orbit'
```
## PointerLockControlsPlugin
[//]: # (todo: image)
[Example](https://threepipe.org/examples/#pointer-lock-controls-plugin/) —
[Source Code](./src/plugins/interaction/PointerLockControlsPlugin.ts) —
[API Reference](https://threepipe.org/docs/classes/PointerLockControlsPlugin.html)
PointerLockControlsPlugin adds support for using PointerLockControls from three.js. It works similar to controls in first person shooter, captures the mouse pointer and uses it to look around with the camera.
After the plugin is added, it adds support for setting `pointerLock` as the key in `scene.mainCamera.controlMode`.
Sample Usage
```typescript
import {ThreeViewer, PointerLockControlsPlugin, Mesh2} from 'threepipe'
const viewer = new ThreeViewer({...})
viewer.addPluginSync(PointerLockControlsPlugin)
// after some user action
viewer.scene.mainCamera.controlsMode = 'pointerLock'
// listen to lock/unlock events
viewer.scene.mainCamera.controls?.addEventListener('lock', ()=> console.log('pointer locked'))
viewer.scene.mainCamera.controls?.addEventListener('unlock', ()=> console.log('pointer unlocked'))
// switch back to default orbit controls
viewer.scene.mainCamera.controlsMode = 'orbit'
```
## ThreeFirstPersonControlsPlugin
[//]: # (todo: image)
[Example](https://threepipe.org/examples/#three-first-person-controls-plugin/) —
[Source Code](./src/plugins/interaction/ThreeFirstPersonControlsPlugin.ts) —
[API Reference](https://threepipe.org/docs/classes/ThreeFirstPersonControlsPlugin.html)
ThreeFirstPersonControlsPlugin adds support for using FirstPersonControls from three.js. It works similar to idle look around in first person games, it does not captures the mouse pointer.
After the plugin is added, it adds support for setting `threeFirstPerson` as the key in `scene.mainCamera.controlMode`.
Sample Usage
```typescript
import {ThreeViewer, ThreeFirstPersonControlsPlugin, Mesh2} from 'threepipe'
const viewer = new ThreeViewer({...})
viewer.addPluginSync(ThreeFirstPersonControlsPlugin)
// after some user action
viewer.scene.mainCamera.controlsMode = 'threeFirstPerson'
// switch back to default orbit controls
viewer.scene.mainCamera.controlsMode = 'orbit'
```
## Rhino3dmLoadPlugin
[Example](https://threepipe.org/examples/#rhino3dm-load/) —
[Source Code](./src/plugins/import/Rhino3dmLoadPlugin.ts) —
[API Reference](https://threepipe.org/docs/classes/Rhino3dmLoadPlugin.html)
Adds support for loading .3dm files generated by [Rhino 3D](https://www.rhino3d.com/). This plugin includes some changes with how 3dm files are loaded in three.js. The changes are around loading layer and primitive properties when set as reference in the 3dm files.
It also adds some helpful options to process the model after load.
```typescript
import {Rhino3dmLoadPlugin} from 'threepipe'
const rhino3dmPlugin = viewer.addPluginSync(new Rhino3dmLoadPlugin())
rhino3dmPlugin.importMaterials = true // import materials source from 3dm file
rhino3dmPlugin.forceLayerMaterials = true // force material source to be layer in 3dm file.
rhino3dmPlugin.hideLineMesh = true // hide all lines and points in the model.
rhino3dmPlugin.replaceWithInstancedMesh = true // replace meshes with the same parent, geometry and material with a single instance mesh.
const mesh = await viewer.load('file.3dm')
```
## PLYLoadPlugin
[Example](https://threepipe.org/examples/#ply-load/) —
[Source Code](./src/plugins/import/PLYLoadPlugin.ts) —
[API Reference](https://threepipe.org/docs/classes/PLYLoadPlugin.html)
Adds support for loading .ply ([Polygon file format](https://en.wikipedia.org/wiki/PLY_(file_format))) files.
```typescript
import {PLYLoadPlugin} from 'threepipe'
viewer.addPluginSync(new PLYLoadPlugin())
const mesh = await viewer.load('file.ply')
```
## USDZLoadPlugin
[Example](https://threepipe.org/examples/#usdz-load/) —
[Source Code](./src/plugins/import/USDZLoadPlugin.ts) —
[API Reference](https://threepipe.org/docs/classes/USDZLoadPlugin.html)
Adds support for loading .usdz and .usda ([Universal Scene Description](https://graphics.pixar.com/usd/docs/index.html)) files.
```typescript
import {USDZLoadPlugin} from 'threepipe'
viewer.addPluginSync(new USDZLoadPlugin())
const mesh = await viewer.load('file.usdz')
const mesh2 = await viewer.load('file.usda')
```
## STLLoadPlugin
[Example](https://threepipe.org/examples/#stl-load/) —
[Source Code](./src/plugins/import/STLLoadPlugin.ts) —
[API Reference](https://threepipe.org/docs/classes/STLLoadPlugin.html)
Adds support for loading .stl ([Stereolithography](https://en.wikipedia.org/wiki/STL_(file_format))) files.
```typescript
import {STLLoadPlugin} from 'threepipe'
viewer.addPluginSync(new STLLoadPlugin())
const mesh = await viewer.load('file.stl')
```
## KTX2LoadPlugin
[Example](https://threepipe.org/examples/#ktx2-load/) —
[Source Code](./src/plugins/import/KTX2LoadPlugin.ts) —
[API Reference](https://threepipe.org/docs/classes/KTX2LoadPlugin.html)
Adds support for loading .ktx2 ([Khronos Texture](https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/) files.
KTX2LoadPlugin also adds support for exporting loaded .ktx2 files in glTF files with the [KHR_texture_basisu](https://www.khronos.org/registry/KHR/textures/2.0-extensions/KHR_texture_basisu/) extension.
```typescript
import {KTX2LoadPlugin} from 'threepipe'
viewer.addPluginSync(new KTX2LoadPlugin())
const texture = await viewer.load('file.ktx2')
```
## KTXLoadPlugin
[Example](https://threepipe.org/examples/#ktx-load/) —
[Source Code](./src/plugins/import/KTXLoadPlugin.ts) —
[API Reference](https://threepipe.org/docs/classes/KTXLoadPlugin.html)
Adds support for loading .ktx ([Khronos Texture](https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/) files.
Note: This plugin only adds support for loading .ktx file, and not exporting them in the bundled .glb. Use .ktx2 files instead of .ktx files for better compression and performance.
```typescript
import {KTXLoadPlugin} from 'threepipe'
viewer.addPluginSync(new KTXLoadPlugin())
const texture = await viewer.load('file.ktx')
```
## SimplifyModifierPlugin
[Example](https://threepipe.org/examples/#simplify-modifier-plugin/) —
[Source Code](./src/plugins/extras/SimplifyModifierPlugin.ts) —
[API Reference](https://threepipe.org/docs/classes/SimplifyModifierPlugin.html)
Boilerplate for implementing a plugin for simplifying geometries.
This is a base class and cannot be used directly.
A sample to use it:
```typescript
class SimplifyModifierPluginImpl extends SimplifyModifierPlugin {
protected _simplify(geometry: IGeometry, count: number) {
return new SimplifyModifier().modify(geometry, count) as IGeometry
}
}
const plugin = viewer.addPluginSync(new SimplifyModifierPluginImpl())
const root = await viewer.load('file.glb')
plugin.simplifyAll(root, {factor: 0.75})
```
Check the [example](https://threepipe.org/examples/#simplify-modifier-plugin/) for full implementation.
## MeshOptSimplifyModifierPlugin
[Example](https://threepipe.org/examples/#meshopt-simplify-modifier-plugin/) —
[Source Code](./src/plugins/extras/MeshOptSimplifyModifierPlugin.ts) —
[API Reference](https://threepipe.org/docs/classes/MeshOptSimplifyModifierPlugin.html)
Simplify modifier using [meshoptimizer](https://github.com/zeux/meshoptimizer) library. It Loads the library at runtime from a customisable CDN URL.
Note: It does not guarantee that the geometry will be simplified to the exact target count.
```typescript
const simplifyModifier = viewer.addPluginSync(new MeshOptSimplifyModifierPlugin())
const root = await viewer.load('file.glb')
simplifyModifier.simplifyAll(root, {factor: 0.75})
```
# @threepipe Packages
Additional plugins can be found in the [plugins](plugins/) directory.
These add support for integrating with other libraries, adding new features, and other functionality with different licenses.
## @threepipe/plugin-tweakpane
[Tweakpane](https://tweakpane.github.io/docs/) UI plugin for ThreePipe
[//]: # (todo: image)
[Example](https://threepipe.org/examples/#tweakpane-ui-plugin/) —
[Source Code](./plugins/tweakpane/src/TweakpaneUiPlugin.ts) —
[API Reference](https://threepipe.org/plugins/tweakpane/docs/classes/TweakpaneUiPlugin.html)
NPM: `npm install @threepipe/plugin-tweakpane`
CDN: https://threepipe.org/plugins/tweakpane/dist/index.mjs
TweakpaneUiPlugin adds support for using [uiconfig-tweakpane](https://github.com/repalash/uiconfig-tweakpane)
to create a configuration UI in applications using the [Tweakpane](https://tweakpane.github.io/docs/) library.
The plugin takes the [uiconfig](https://github.com/repalash/uiconfig.js)
that's defined in the viewer and all the objects to automatically render a UI in the browser.
```typescript
import {IObject3D, ThreeViewer, TonemapPlugin} from 'threepipe'
import {TweakpaneUiPlugin} from '@threepipe/plugin-tweakpane'
const viewer = new ThreeViewer({...})
// Add the plugin
const plugin = viewer.addPluginSync(new TweakpaneUiPlugin(true)) // true to show expanded the UI by default
// Add the UI for the viewer
plugin.appendChild(viewer.uiConfig)
// Add UI for some plugins
plugin.setupPlugins(TonemapPlugin, DropzonePlugin)
```
## @threepipe/plugin-blueprintjs
[Blueprint.js](https://blueprintjs.com/) UI plugin for ThreePipe
[//]: # (todo: image)
[Example](https://threepipe.org/examples/#blueprintjs-ui-plugin/) —
[Source Code](./plugins/blueprintjs/src/BlueprintJsUiPlugin.ts) —
[API Reference](https://threepipe.org/plugins/blueprintjs/docs/classes/BlueprintJsUiPlugin.html)
NPM: `npm install @threepipe/plugin-blueprintjs`
CDN: https://threepipe.org/plugins/blueprintjs/dist/index.mjs
BlueprintJsUiPlugin adds support for using [uiconfig-blueprint](https://github.com/repalash/uiconfig-blueprint)
to create a configuration UI in applications using the [BlueprintJs](https://blueprintjs.com/) library.
The plugin takes the [uiconfig](https://github.com/repalash/uiconfig.js)
that's defined in the viewer and all the objects to automatically render a UI in the browser.
```typescript
import {IObject3D, ThreeViewer, TonemapPlugin} from 'threepipe'
import {BlueprintJsUiPlugin} from '@threepipe/plugin-blueprintjs'
const viewer = new ThreeViewer({...})
// Add the plugin
const plugin = viewer.addPluginSync(new BlueprintJsUiPlugin(true)) // true to show expanded the UI by default
// Add the UI for the viewer
plugin.appendChild(viewer.uiConfig)
// Add UI for some plugins
plugin.setupPlugins(TonemapPlugin, DropzonePlugin)
```
## @threepipe/plugin-tweakpane-editor
Tweakpane Editor Plugin for ThreePipe
[//]: # (todo: image)
[Example](https://threepipe.org/examples/#tweakpane-editor/) —
[Source Code](./plugins/tweakpane-editor/src/TweakpaneEditorPlugin.ts) —
[API Reference](https://threepipe.org/plugins/tweakpane-editor/docs/classes/TweakpaneEditorPlugi —
NPM: `npm install @threepipe/plugin-tweakpane-editor`
CDN: https://threepipe.org/plugins/tweakpane-editor/dist/index.mjs
TweakpaneEditorPlugin uses TweakpaneUiPlugin to create an editor for editing viewer,
plugins, model and material configurations in the browser.
```typescript
import {IObject3D, ThreeViewer, TonemapPlugin} from 'threepipe'
import {TweakpaneEditorPlugin} from '@threepipe/plugin-tweakpane-editor'
const viewer = new ThreeViewer({...})
viewer.addPluginSync(new TweakpaneUiPlugin(true))
const editor = viewer.addPluginSync(new TweakpaneEditorPlugin())
// Add some plugins to the viewer
await viewer.addPlugins([
new ViewerUiConfigPlugin(),
// new SceneUiConfigPlugin(), // this is already in ViewerUiPlugin
new DepthBufferPlugin(HalfFloatType, true, true),
new NormalBufferPlugin(HalfFloatType, false),
new RenderTargetPreviewPlugin(false),
])
// Load the plugin UI in the editor and tweakpane ui with categories.
editor.loadPlugins({
['Viewer']: [ViewerUiConfigPlugin, SceneUiConfigPlugin, DropzonePlugin, FullScreenPlugin],
['GBuffer']: [DepthBufferPlugin, NormalBufferPlugin],
['Post-processing']: [TonemapPlugin],
['Debug']: [RenderTargetPreviewPlugin],
})
```
## @threepipe/plugins-extra-importers
Exports several plugins to add support for various file types.
[Example](https://threepipe.org/examples/#extra-importer-plugins/) —
[Source Code](./plugins/extra-importers/src/index.ts) —
[API Reference](https://threepipe.org/plugins/extra-importers/docs)
NPM: `npm install @threepipe/plugins-extra-importers`
CDN: https://threepipe.org/plugins/extra-importers/dist/index.mjs
This package exports several plugins to add support for several file types using the following plugins
- [TDSLoadPlugin](https://threepipe.org/plugins/extra-importers/docs/classes/TDSLoadPlugin.html) - Load 3DS Max (.3ds) files
- [ThreeMFLoadPlugin](https://threepipe.org/plugins/extra-importers/docs/classes/ThreeMFLoadPlugin.html) - Load 3MF (.3mf) files
- [ColladaLoadPlugin](https://threepipe.org/plugins/extra-importers/docs/classes/ColladaLoadPlugin.html) - Load Collada (.dae) files
- [AMFLoadPlugin](https://threepipe.org/plugins/extra-importers/docs/classes/AMFLoadPlugin.html) - Load AMF (.amf) files
- [BVHLoadPlugin](https://threepipe.org/plugins/extra-importers/docs/classes/BVHLoadPlugin.html) - Load BVH (.bvh) files
- [VOXLoadPlugin](https://threepipe.org/plugins/extra-importers/docs/classes/VOXLoadPlugin.html) - Load MagicaVoxel (.vox) files
- [GCodeLoadPlugin](https://threepipe.org/plugins/extra-importers/docs/classes/GCodeLoadPlugin.html) - Load GCode (.gcode) files
- [MDDLoadPlugin](https://threepipe.org/plugins/extra-importers/docs/classes/MDDLoadPlugin.html) - Load MDD (.mdd) files
- [PCDLoadPlugin](https://threepipe.org/plugins/extra-importers/docs/classes/PCDLoadPlugin.html) - Load Point cloud data (.pcd) files
- [TiltLoadPlugin](https://threepipe.org/plugins/extra-importers/docs/classes/TiltLoadPlugin.html) - Load Tilt Brush (.tilt) files
- [VRMLLoadPlugin](https://threepipe.org/plugins/extra-importers/docs/classes/VRMLLoadPlugin.html) - Load VRML (.wrl) files
- [MPDLoadPlugin](https://threepipe.org/plugins/extra-importers/docs/classes/MPDLoadPlugin.html) - Load LDraw (.mpd) files
- [VTKLoadPlugin](https://threepipe.org/plugins/extra-importers/docs/classes/VTKLoadPlugin.html) - Load VTK (.vtk) files
- [XYZLoadPlugin](https://threepipe.org/plugins/extra-importers/docs/classes/XYZLoadPlugin.html) - Load XYZ (.xyz) files
To add all the plugins at once use `extraImporters`. This adds support for loading all the above file types.
```typescript
import {ThreeViewer} from 'threepipe'
import {extraImporters} from '@threepipe/plugins-extra-importers'
const viewer = new ThreeViewer({...})
viewer.addPluginsSync(extraImporters)
// Now load any file as is.
const model = await viewer.load<IObject3D>('file.3mf')
// To load the file as a data url, use the correct mimetype
const model1 = await viewer.load<IObject3D>('data:model/3mf;base64,...')
```
Remove the `<IObject3D>` if using javascript and not typescript.
## @threepipe/plugin-blend-importer
Exports [BlendImporterPlugin](https://threepipe.org/plugins/blend-importer/docs/classes/BlendLoadPlugin.html) which adds support for loading .blend files.
It uses [js.blend](https://github.com/acweathersby/js.blend) for parsing blend file structure.
Note: This is still a WIP.
Currently working: `Mesh`, `BufferGeometry` and basic `PointLight`.
To be added: `PhysicalMaterial`, `UnlitMaterial` (similar to blender-gltf-io plugin)
[Example](https://threepipe.org/examples/#blend-load/) —
[Source Code](./plugins/blend-importer/src/index.ts) —
[API Reference](https://threepipe.org/plugins/blend-importer/docs)
NPM: `npm install @threepipe/plugin-blend-importer`
```typescript
import {ThreeViewer} from 'threepipe'
import {BlendLoadPlugin} from '@threepipe/plugin-blend-importer'
const viewer = new ThreeViewer({...})
viewer.addPluginSync(BlendLoadPlugin)
// Now load any .blend file.
const model = await viewer.load<IObject3D>('path/to/file.blend')
// To load the file as a data url, use the correct mimetype
const model1 = await viewer.load<IObject3D>('data:application/x-blender;base64,...')
```
[//]: # ( TODO: The plugin should parse and references to other assets and find them relative to the .blend file or the current location.)
## @threepipe/plugin-geometry-generator
Exports [GeometryGeneratorPlugin](https://threepipe.org/plugins/geometry-generator/docs/classes/BlendLoadPlugin.html) with several Geometry generators to create parametric and updatable geometries like plane, circle, sphere, box, torus, cylinder, cone etc.
[Example](https://threepipe.org/examples/#geometry-generator-plugin/) —
[Source Code](./plugins/geometry-generator/src/index.ts) —
[API Reference](https://threepipe.org/plugins/geometry-generator/docs)
NPM: `npm install @threepipe/plugin-geometry-generator`
The generated geometries/meshes include the parameters in the userData and can be re-generated by changing the parameters from the UI or the plugin API.
Includes the following generator which inherit from [AGeometryGenerator](https://threepipe.org/plugins/geometry-generator/docs/classes/AGeometryGenerator.html):
- **plane**: [PlaneGeometryGenerator](https://threepipe.org/plugins/geometry-generator/docs/classes/PlaneGeometryGenerator),
- **sphere**: [SphereGeometryGenerator](https://threepipe.org/plugins/geometry-generator/docs/classes/SphereGeometryGenerator),
- **box**: [BoxGeometryGenerator](https://threepipe.org/plugins/geometry-generator/docs/classes/BoxGeometryGenerator),
- **circle**: [CircleGeometryGenerator](https://threepipe.org/plugins/geometry-generator/docs/classes/CircleGeometryGenerator),
- **torus**: [TorusGeometryGenerator](https://threepipe.org/plugins/geometry-generator/docs/classes/TorusGeometryGenerator),
- **cylinder**: [CylinderGeometryGenerator](https://threepipe.org/plugins/geometry-generator/docs/classes/CylinderGeometryGenerator),
Sample Usage:
```typescript
import {ThreeViewer, UnlitMaterial} from 'threepipe'
import {GeometryGeneratorPlugin} from '@threepipe/plugin-geometry-generator'
const viewer = new ThreeViewer({...})
const generator = viewer.addPluginSync(GeometryGeneratorPlugin)
const sphere = generator.generateObject('sphere', {radius: 3})
viewer.scene.addObject(sphere)
// to update the geometry
generator.updateGeometry(sphere.geometry, {radius: 4, widthSegments: 100})
// to add a custom generator
generator.generators.custom = new CustomGenerator('custom') // Extend from AGeometryGenerator or implement GeometryGenerator interface
// refresh the ui so the new generator is available to select.
generator.uiConfig.uiRefresh?.()
// change the material type for all objects
generator.defaultMaterialClass = UnlitMaterial // by default its PhysicalMaterial
viewer.scene.addObject(generator.generateObject('box', {width: 2, height: 2, depth: 2}))
```
## @threepipe/plugin-gaussian-splatting
Exports [GaussianSplattingPlugin](https://threepipe.org/plugins/gaussian-splatting/docs/classes/GaussianSplattingPlugin.html) which adds support for loading .blend files.
It uses [`three-gaussian-splat`](./plugins/gaussian-splatting/src/three-gaussian-splat), a rewrite of [@zappar/three-guassian-splat](https://github.com/zappar-xr/three-gaussian-splat) (and [gsplat.js](https://github.com/huggingface/gsplat.js) and [antimatter15/splat](https://github.com/antimatter15/splat)) for loading splat files and rendering gaussian splats.
[Example](https://threepipe.org/examples/#splat-load/) —
[Source Code](./plugins/gaussian-splatting/src/index.ts) —
[API Reference](https://threepipe.org/plugins/gaussian-splatting/docs)
NPM: `npm install @threepipe/plugin-gaussian-splatting`
Note: This is still a WIP.
Currently working:
* Importing .splat files (just array buffer of gaussian splat attributes)
* ThreeGaussianSplatPlugin (Same as GaussianSplattingPlugin), add importer and update events to the viewer
* GaussianSplatMaterialExtension for adding gaussian splat functionality to any material like Unlit, Physical
* GaussianSplatMesh a subclass of Mesh2 for holding the gaussian splat geometry and a material with gaussian splat extension. also handles basic raycast in the splat geometry. (assuming simple points)
* GaussianSplatGeometry holds the geometry data and and the sort worker. Computes correct bounding box and sphere.
* SplatLoader for loading splat files and creating the geometry and material.
* GaussianSplatMaterialUnlit, GaussianSplatMaterialRaw
* GaussianSplatMaterialPhysical, working but normals are hardcoded to 0,1,0
TBD:
* Exporting/embedding splat files into glb
* Rendering to depth/gbuffer
* Estimate normals/read from file
* Lighting in GaussianSplatMaterialPhysical
```typescript
import {ThreeViewer} from 'threepipe'
import {GaussianSplattingPlugin} from '@threepipe/plugin-gaussian-splatting'
const viewer = new ThreeViewer({...})
viewer.addPluginSync(GaussianSplattingPlugin)
// Now load any .splat file.
const model = await viewer.load<GaussianSplatMesh>('path/to/file.splat')
```
## @threepipe/plugin-svg-renderer
Exports [ThreeSVGRendererPlugin](https://threepipe.org/plugins/svg-renderer/docs/classes/ThreeSVGRendererPlugin.html) and [BasicSVGRendererPlugin](https://threepipe.org/plugins/svg-renderer/docs/classes/BasicSVGRendererPlugin.html) which provide support for rendering the 3d scene as [SVG(Scalable Vector Graphics)](https://developer.mozilla.org/en-US/docs/Web/SVG). The generated SVG is compatible with browser rendering and other software like figma, illustrator etc.
[Example](https://threepipe.org/examples/#three-svg-renderer/) —
[Source Code](./plugins/svg-renderer/src/index.ts) —
[API Reference](https://threepipe.org/plugins/svg-renderer/docs) —
[GPLV3 License](./plugins/svg-renderer/LICENSE)
NPM: `npm install @threepipe/plugin-svg-renderer`
Note: This is still a WIP. API might change slightly
`ThreeSVGRendererPlugin` uses [`three-svg-renderer`](./plugins/svg-renderer/src/three-svg-renderer), which is a modified version of [three-svg-renderer](https://www.npmjs.com/package/three-svg-renderer) (GPLV3 Licenced).
The plugin renderers meshes in the viewer scene to svg objects by computing polygons and contours of the geometry in view space. Check [LokiResearch/three-svg-renderer](https://github.com/LokiResearch/three-svg-renderer?tab=readme-ov-file#references) for more details.
In the modified version that is used here, support for some types of geometries is added and a rendered image in screen-space is used to create raster fill images for paths along with some other small changes. Check out the [Example](https://threepipe.org/examples/#three-svg-renderer/) for demo. See also [svg-geometry-playground example](https://threepipe.org/examples/#svg-geometry-playground/) for usage with other plugins `PickingPlugin`, `TransformControlsPlugin` and `GeometryGeneratorPlugin`.
Note that this does not support all the features of three.js and may not work with all types of materials and geometries. Check the examples for a list of sample models that do and don't work.
`BasicSVGRendererPlugin` is a sample plugin using [SVGRenderer](https://threejs.org/docs/index.html?q=svg#examples/en/renderers/SVGRenderer) from three.js addons. This renders all triangles in the scene to separate svg paths. Check the three.js docs for more details. Check out the [Example](https://threepipe.org/examples/#basic-svg-renderer/) for demo.
```typescript
import {ThreeViewer} from 'threepipe'
import {ThreeSVGRendererPlugin} from '@threepipe/plugin-svg-renderer'
const viewer = new ThreeViewer({...})
const svgRender = viewer.addPluginSync(ThreeSVGRendererPlugin)
svgRender.autoRender = true // automatically render when camera or any object changes.
svgRender.autoMakeSvgObjects = true // automatically create SVG objects for all meshes in the scene.
// svgRender.makeSVGObject(object) // manually create SVG object for an object. (if autoMakeSvgObjects is false)
// Now load or generate any 3d model. Make sure its not very big. And the meshes are optimized.
const model = await viewer.load<IOBject3D>('path/to/file.glb')
// clear the background of the viewer
// this is only required if rgbm = false in the viewer
viewer.scene.backgroundColor = null
// this is only required if rgbm = true in the viewer
viewer.renderManager.screenPass.clipBackground = true
// disable damping to get better experience.
viewer.scene.mainCamera.controls!.enableDamping = false
// hide the canvas to see the underlying svg node.
// note: do not set the display to none or remove the canvas as OrbitControls and other plugins might still be tracking the canvas.
viewer.canvas.style.opacity = '0'
// 3d pipeline can also be disabled like this if `drawImageFills` is `false` to get better performance. Do this only after loading the model.
// await viewer.doOnce('postFrame') // wait for the first frame to be rendered (for autoScale etc)
// viewer.renderManager.autoBuildPipeline = false
// viewer.renderManager.pipeline = [] // this will disable main viewer rendering
```
| A 3D viewer framework built on top of three.js with a focus on rendering, modularity and extensibility. | 3d,graphics,graphics-library,three,threejs,webgl,javascript,typescript | 2023-05-25T23:58:58Z | 2024-05-12T20:13:32Z | null | 1 | 0 | 208 | 2 | 12 | 306 | null | Apache-2.0 | TypeScript |
jofftiquez/faker-js-ui | main | <p align="center"><img width="200px" src="./faker-js-ui-logo.png"></p>
# Faker.js UI
[Watch Demo Here](https://youtu.be/QYoqCh-wj_Q)
Web App and Browser Extension for [Faker.js](https://fakerjs.dev/).
Now available in [Chrome Web Store](https://chrome.google.com/webstore/detail/fakerjs-ui/onahjokmphbfmdihclgeehajfnpkpaja)!
The [app website](https://github.com/jofftiquez/fakerjsui.com) is also open for contribution.
## Features in development
- [X] Auto-fill forms using appropriate Faker.js methods
- [ ] Add prompt for arguments so users can maximize the parameters for each methods
- [X] Preview of copied/generated data
## Development
There are 2 modes to develop Faker.js UI:
- **Web App (SPA)**: The Web App is a Quasar Framework and Vue.js 3 that can be run locally and deployed to a static hosting site.
- **Browser Extension**: The Browser Extension is a Quasar Framework and Vue.js 3 that can be run locally and deployed to the Chrome Web Store.
To run the Web App locally:
```bash
# Install dependencies
yarn install
# Run the app
yarn dev:spa # or yarn build:spa to build for production
```
To run the Browser Extension locally:
```bash
# Install dependencies
yarn install
# Run the app
yarn dev:bex # or yarn build:bex to build for production
```
| Use Faker.js UI to easiliy generate fake (but realistic) data for testing and development using Faker.js. | faker,fakerjs,javascript,fakerui,hacktoberfest | 2023-05-18T03:54:46Z | 2023-10-04T06:19:44Z | 2023-08-18T08:57:56Z | 3 | 6 | 67 | 2 | 7 | 200 | null | null | JavaScript |
parthwebdev/UI-Components | main | null | Some Awesome UI Components made with HTML, CSS and JavaScript. | animation,carousel,component,css,css-animations,css3,html,html5,javascript,login | 2023-05-31T15:05:04Z | 2024-05-19T10:37:08Z | null | 1 | 0 | 69 | 0 | 55 | 176 | null | null | CSS |
midudev/noticias.dev | main | # noticias.dev
😮 Esta es una mejora del README para practicar PULL REQUEST en el repositorio de midudev! | Newsletter para mantenerte al día de las noticias de programación | desarrollo-web,frontend,javascript,programacion,programador | 2023-06-06T08:59:51Z | 2024-05-20T07:29:11Z | null | 5 | 6 | 93 | 1 | 8 | 170 | null | NOASSERTION | MDX |
mdbootstrap/TW-Elements-React | master | # TW Elements React [<img src="https://tecdn.b-cdn.net/img/logo/te-react-logo.webp" width="45" align="right" alt="tw-elements">](https://tw-elements.com/docs/react/)<a href="https://www.npmjs.com/package/tw-elements-react"><img src="https://img.shields.io/npm/dt/tw-elements-react.svg" alt="Total Downloads"></a> <a href="https://github.com/mdbootstrap/TW-Elements-React/releases"><img src="https://img.shields.io/npm/v/tw-elements-react.svg" alt="Latest Release"></a> <a href="https://twitter.com/intent/tweet/?text=Thanks+@TWElement+for+creating+an+amazing+collection+of+open+source+components+for+@tailwindcss%20https://tw-elements.com/docs/react/&hashtags=tailwindCSS,bootstrap,webdesign,react,100DaysOfCode,DevCommunity"><img src="https://img.shields.io/twitter/url/http/shields.io.svg?style=social&label=Let%20us%20know%20you%20were%20here%21&"></a>
TW Elements React is a huge collection of free, interactive React components for Tailwind CSS.
<table>
<tbody>
<tr>
<td>
<a href="https://tw-elements.com/docs/react/" alt="TW Elements tutorials" rel="dofollow">
<img width="600" src="https://tecdn.b-cdn.net/img/react-big.jpg">
</a>
</td>
<td>
<ul>
<li>500+ UI components</li>
<li>Dark mode support</li>
<li>Easy theming & customization</li>
<li>Simple, 1 minute install</li>
<li>Free for personal & commercial use</li>
</ul>
<p><b><a href="https://tw-elements.com/docs/react/getting-started/quick-start/">Get started with TW Elements React now!</a></b></p>
</td>
</tr>
</tbody>
</table>
---
## Table of Contents
- [Table of Contents](#table-of-contents)
- [Community](#community)
- [Coming soon](#coming-soon)
- [Components](#components)
- [Installation](#installation)
---
## Community
TW Elements is a **community-driven** project.
We invite you to **track our [live progress 👁️](https://github.com/orgs/mdbootstrap/projects/3/)** on the upcoming release.
In the meantime you can also:
- Motivate us with some [words of encouragament ❤️](https://github.com/mdbootstrap/TWd-Elements/discussions/categories/kind-words-general-feedback)
- Share your [ideas & feature requests 💡](https://github.com/mdbootstrap/TW-Elements/discussions/categories/share-ideas-request-features)
- Aks for help & help others in our [community support 🙏](https://github.com/mdbootstrap/TW-Elements/discussions/categories/support-from-community)
- **Engage, discuss & have fun in our [open-source community 💬](https://github.com/mdbootstrap/TW-Elements/discussions)**
**If you want to help the project grow, start by simply sharing it with your peers!**
- [Share via Dev.to](<https://dev.to/new?prefill=---%0Atitle%3A%20500+%20open-source%20components%20for%20TailwindCSS%20and%20React%20%0Apublished%3A%20true%0Atags%3Atailwindcss%0A---%0A%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20[](https://tw-elements.com/docs/react/)%20%20%20%20%20%20%20%20\n%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20I%27d%20like%20to%20share%20my%20latest%20discovery%20with%20you.%20\n%20%20%20%20%20%20%20%20[Tailwind%20Elements](https://tw-elements.com/docs/react/)%20is%20currently,%20the%20most%20popular%203rd%20party%20UI%20kit%20for%20TailwindCSS%20with%20over%2010k%20Github%20stars.%20%20%20%20%20%20%20%20[](https://github.com/mdbootstrap/TW-Elements/)%20%20%20%20%20%20%20%20It%27s%20a%20**huge%20collection%20of%20stunning%20components**%20made%20with%20attention%20to%20the%20smallest%20detail.%20%20%20%20%20%20%20%20%20Forms,%20cards,%20buttons,%20and%20hundreds%20of%20others.%20%20%20%20%20%20%20%20%20All%20components%20have%20**dark%20mode**%20and%20very%20intuitive%20**theming%20options**.%20%20%20%20%20%20%20%20The%20project%20is%20supported%20by%20an%20[engaged%20community%20on%20GitHub](https://github.com/mdbootstrap/TW-Elements/discussions),%20I%20recommend%20you%20check%20it%20out%20and%20join%20one%20of%20the%20many%20discussions.%20%20%20%20%20%20%20%20\n%20%20%20%20%20%20%20%20You%20will%20find%20installation%20instructions%20[here](https://tw-elements.com/docs/react/getting-started/installation),%20and%20you%20can%20track%20the%20progress%20of%20the%20project%20live%20%20%20%20%20%20%20%20%20[here](https://tw-elements.com/docs/react/getting-started/changelog/).%20%20%20%20%20%20%20%20\n%20%20%20%20%20%20%20%20The%20project%20was%20kickstarted%20by%20@MDBootstrap,%20a%20group%20of%20open-source%20developers%20behind%20[MDB%20UI%20Kit](https://github.com/mdbootstrap/mdb-ui-kit)%20-%20a%20high-quality%20UI%20kit%20for%20Bootstrap,%20and%20also%20behind%20[MDB%20GO](https://mdbgo.com/)%20-%20hosting%20and%20deployment%20platform.%20%20%20%20%20%20%20%20\n%20%20%20%20%20%20%20%20I%20highly%20recommend%20you%20to%20check%20it%20out!%20%20%20%20%20%20%20%20\n%20%20%20%20%20%20%20%20%7B%25%20link%20mdbootstrap/tw-elements-breakthrough-version-is-here-59hh%20%25%7D%20%20%20%20%20%20%20%20\n>)
- [Share via Twitter](https://twitter.com/intent/tweet?text=500%2B%20open-source%20components%20for%20%23TailwindCSS%20%F0%9F%A4%A9%0Ahttps%3A//tw-elements.com/docs/react/%0A%0ACongrats%20%40MDBootstrap%20%40ascensus_mdb%20%40dawidadach%20for%20this%20awesome%20design%20collection!%0A%0AI%20will%20keep%20using%20it%20in%20my%20projects%20for%20sure!%0A%0A%23uiux%20%23webdevelopment%20%23HTML%20%23CSS%20%23design%20%23Webdesign%20%23programming%20)
- [Share via Facebook](https://www.facebook.com/sharer/sharer.php?u=https%3A//tw-elements.com/docs/react/)
- [Share via LinkedIn](http://www.linkedin.com/shareArticle?url=https%3A%2F%2Ftw-elements.com/docs/react/%2F&title=500%2B%20open-source%20components%20for%20TailwindCSS)
- [Share via Pinterest](https://www.pinterest.com/pin/create/button?url=https://tw-elements.com/&media=https://tw-elements.com/img/components-big.jpg&description=TailwindElements)
- [Share via Reddit](https://reddit.com/submit?url=https://tw-elements.com/docs/react/&title=500+%20open-source%20components%20for%20TailwindCSS)
- [Share via StumbleUpon](https://www.stumbleupon.com/submit?url=https://tw-elements.com/docs/react/&title=500+%20open-source%20components%20for%20TailwindCSS)
- [Share via Vkontakte](https://vk.com/share.php?url=https://tw-elements.com/docs/react/)
- [Share via Weibo](https://service.weibo.com/share/share.php?url=https://tw-elements.com/docs/react/&title=500+%20open-source%20components%20for%20TailwindCSS)
- [Share via Hackernews](https://news.ycombinator.com/submitlink?u=https://tw-elements.com/docs/react/&t=500+%20open-source%20components%20for%20TailwindCSS)
- [Share via Gmail](https://mail.google.com/mail/?view=cm&to=%7Bemail_address%7D&su=Check%20out%20this%20project&body=Hello,%0AI%27m%20reaching%20out%20to%20recommend%20my%20latest%20discovery.%0A%0AIt%27s%20over%20500+%20open-source%20components%20for%20TailwindCSS%20with%20excellent%20support%20and%20an%20awesome%20community:%0Ahttps://tw-elements.com/docs/react/%0A%0AI%20hope%20you%20will%20find%20it%20useful.%0ABest%20regards,&bcc=%7Bemail_address%7D&cc=%7Bemail_address%7D)
- [Share via email](mailto:?subject=Check%20out%20this%20project&body=Hello%2C%0AI'm%20reaching%20out%20to%20recommend%20my%20latest%20discovery.%0A%0AIt's%20over%20500%20%20open-source%20components%20for%20Tailwind%20CSS%20with%20excellent%20support%20and%20an%20awesome%20community%3A%0Ahttps%3A%2F%2Ftw-elements.com/docs/react/%2F%0A%0AI%20hope%20you%20will%20find%20it%20useful.%0ABest%20regards%2C)
Thank you!
---
## Coming soon
Check out the upcoming features - watch our **[social profiles](https://twitter.com/TailwindElement/)** to **get early access**!
<table>
<tr>
<td>
<a href="#">
<img alt="Builder" src="https://mdbootstrap.com/img/tw-demo/drag-and-drop.webp">
</a>
</td>
<td>
<a href="#">
<img alt="Templates" src="https://mdbootstrap.com/img/tw-demo/templates.webp">
</a>
</td>
<td>
<a href="#">
<img alt="Design blocks" src="https://mdbootstrap.com/img/tw-demo/design-blocks.webp">
</a>
</td>
</tr>
<tr>
<td align="center"><b>Drag & drop builder</b></td>
<td align="center"><b>Templates</b></td>
<td align="center"><b>Design blocks</b></td>
</tr>
</table>
---
## Components
A collection of stunning components made with attention to the smallest details. Forms, cards, buttons, and hundreds of others – in TW Elements React you will find all the essential elements necessary for every project.
<table>
<tr>
<td>
<a href="#">
<img alt="Datepicker" src="https://mdbootstrap.com/img/tw-demo/datepicker.webp">
</a>
</td>
<td>
<a href="#">
<img alt="Dropdown" src="https://mdbootstrap.com/img/tw-demo/dropdown.webp">
</a>
</td>
<td>
<a href="https://tw-elements.com/docs/react/components/modal/">
<img alt="Modal" src="https://mdbootstrap.com/img/tw-demo/modal.webp">
</a>
</td>
</tr>
<tr>
<td align="center"><b>Datepicker (coming soon)</b></td>
<td align="center"><b>Dropdown (coming soon)</b></td>
<td align="center"><b>Modal</b></td>
</tr>
<tr>
<td>
<a href="#">
<img alt="Charts" src="https://mdbootstrap.com/img/tw-demo/charts.webp">
</a>
</td>
<td>
<a href="#">
<img alt="Tooltips" src="https://mdbootstrap.com/img/tw-demo/tooltips-1.webp">
</a>
</td>
<td>
<a href="#">
<img alt="Carousel" src="https://mdbootstrap.com/img/tw-demo/carousel.webp">
</a>
</td>
</tr>
<tr>
<td align="center"><b>Charts (coming soon)</b></td>
<td align="center"><b>Tooltips (coming soon)</b></td>
<td align="center"><b>Carousel (coming soon)</b></td>
</tr>
<tr>
<td>
<a href="https://tw-elements.com/docs/react/components/accordion/">
<img alt="Accordion" src="https://mdbootstrap.com/img/tw-demo/accordion.webp">
</a>
</td>
<td>
<a href="https://tw-elements.com/docs/react/navigation/tabs/">
<img alt="Tabs" src="https://mdbootstrap.com/img/tw-demo/tabs.webp">
</a>
</td>
<td>
<a href="#">
<img alt="Stepper" src="https://mdbootstrap.com/img/tw-demo/stepper.webp">
</a>
</td>
</tr>
<tr>
<td align="center"><b>Accordion</b></td>
<td align="center"><b>Tabs</b></td>
<td align="center"><b>Stepper (coming soon)</b></td>
</tr>
<tr>
<td>
<a href="#">
<img alt="Tailwind CSS Time picker" src="https://mdbootstrap.com/img/tw-demo/timepicker.webp">
</a>
</td>
<td>
<a href="https://tw-elements.com/docs/react/navigation/footer/">
<img alt="Tailwind CSS Tables" src="https://mdbootstrap.com/img/tw-demo/footer.webp">
</a>
</td>
<td>
<a href="#">
<img alt="Tailwind CSS Navbar" src="https://mdbootstrap.com/img/tw-demo/navbar.webp">
</a>
</td>
</tr>
<tr>
<td align="center"><b>Timepicker (coming soon)</b></td>
<td align="center"><b>Footer</b></td>
<td align="center"><b>Navbar (coming soon)</b></td>
</tr>
<!--New row-->
<tr>
<td>
<a href="#">
<img alt="Tailwind CSS Time picker" src="https://mdbootstrap.com/docs/standard/pro/demo/assets/images/components-pro/alert-1.webp">
</a>
</td>
<td>
<a href="https://tw-elements.com/docs/react/components/avatar/">
<img alt="Tailwind CSS Tables" src="https://mdbootstrap.com/docs/standard/pro/demo/assets/images/avatar.webp">
</a>
</td>
<td>
<a href="https://tw-elements.com/docs/react/components/badges/">
<img alt="Tailwind CSS Navbar" src="https://mdbootstrap.com/docs/standard/pro/demo/assets/images/components-free/badge-1.webp">
</a>
</td>
</tr>
<tr>
<td align="center"><b>Alerts (coming soon)</b></td>
<td align="center"><b>Avatar</b></td>
<td align="center"><b>Badges</b></td>
</tr>
<!--New row-->
<tr>
<td>
<a href="https://tw-elements.com/docs/react/components/button-group/">
<img alt="Tailwind CSS Time picker" src="https://mdbootstrap.com/docs/standard/pro/demo/assets/images/components-free/button-group-1.webp">
</a>
</td>
<td>
<a href="https://tw-elements.com/docs/react/components/buttons/">
<img alt="Tailwind CSS Tables" src="https://mdbootstrap.com/docs/standard/pro/demo/assets/images/components-free/button-2.webp">
</a>
</td>
<td>
<a href="https://tw-elements.com/docs/react/components/cards/">
<img alt="Tailwind CSS Navbar" src="https://mdbootstrap.com/docs/standard/pro/demo/assets/images/components-free/card-1.webp">
</a>
</td>
</tr>
<tr>
<td align="center"><b>Button group</b></td>
<td align="center"><b>Buttons</b></td>
<td align="center"><b>Cards</b></td>
</tr>
<!--New row-->
<tr>
<td>
<a href="#">
<img alt="Tailwind CSS Time picker" src="https://mdbcdn.b-cdn.net/wp-content/themes/mdbootstrap4/content/en/_mdb5/standard/pro/demo-new/assets/images/chips.webp">
</a>
</td>
<td>
<a href="https://tw-elements.com/docs/react/components/collapse/">
<img alt="Tailwind CSS Tables" src="https://mdbootstrap.com/docs/standard/pro/demo/assets/images/components-free/collapse-1.webp">
</a>
</td>
<td>
<a href="#">
<img alt="Tailwind CSS Navbar" src="https://mdbcdn.b-cdn.net/wp-content/themes/mdbootstrap4/content/en/_mdb5/standard/pro/demo-new/assets/images/lightbox.webp">
</a>
</td>
</tr>
<tr>
<td align="center"><b>Chips (coming soon)</b></td>
<td align="center"><b>Collapse</b></td>
<td align="center"><b>Gallery (coming soon)</b></td>
</tr>
<!--New row-->
<tr>
<td>
<a href="#">
<img alt="Tailwind CSS Time picker" src="https://mdbootstrap.com/docs/standard/pro/demo/assets/images/components-free/header-1.webp">
</a>
</td>
<td>
<a href="https://tw-elements.com/docs/react/components/link/">
<img alt="Tailwind CSS Tables" src="https://mdbootstrap.com/docs/standard/pro/demo/assets/images/link.webp">
</a>
</td>
<td>
<a href="https://tw-elements.com/docs/react/components/listgroup/">
<img alt="Tailwind CSS Navbar" src="https://mdbootstrap.com/docs/standard/pro/demo/assets/images/components-free/list-group-1.webp">
</a>
</td>
</tr>
<tr>
<td align="center"><b>Jumbotron (coming soon)</b></td>
<td align="center"><b>Link</b></td>
<td align="center"><b>List group</b></td>
</tr>
<!--New row-->
<tr>
<td>
<a href="#">
<img alt="Tailwind CSS Time picker" src="https://mdbootstrap.com/docs/standard/pro/demo/assets/images/notification.webp">
</a>
</td>
<td>
<a href="https://tw-elements.com/docs/react/components/paragraphs/">
<img alt="Tailwind CSS Tables" src="https://mdbootstrap.com/docs/standard/pro/demo/assets/images/paragraphs.webp">
</a>
</td>
<td>
<a href="https://tw-elements.com/docs/react/components/placeholders/">
<img alt="Tailwind CSS Navbar" src="https://mdbootstrap.com/docs/standard/pro/demo/assets/images/components-free/placeholder-1.webp">
</a>
</td>
</tr>
<tr>
<td align="center"><b>Notifications (coming soon)</b></td>
<td align="center"><b>Paragraphs</b></td>
<td align="center"><b>Placeholders</b></td>
</tr>
<!--New row-->
<tr>
<td>
<a href="#">
<img alt="Tailwind CSS Time picker" src="https://mdbootstrap.com/docs/standard/pro/demo/assets/images/components-free/popover-1.webp">
</a>
</td>
<td>
<a href="https://tw-elements.com/docs/react/components/progress/">
<img alt="Tailwind CSS Tables" src="https://mdbootstrap.com/docs/standard/pro/demo/assets/images/components-free/progress-1.webp">
</a>
</td>
<td>
<a href="https://tw-elements.com/docs/react/components/rating/">
<img alt="Tailwind CSS Navbar" src="https://mdbootstrap.com/docs/standard/pro/demo/assets/images/components-pro/rating-1.webp">
</a>
</td>
</tr>
<tr>
<td align="center"><b>Popover (coming soon)</b></td>
<td align="center"><b>Progress</b></td>
<td align="center"><b>Rating</b></td>
</tr>
<!--New row-->
<tr>
<td>
<a href="https://tw-elements.com/docs/react/components/scroll-back-to-top-button/">
<img alt="Tailwind Component" src="https://mdbootstrap.com/docs/standard/pro/demo/assets/images/scroll-back-to-top.webp">
</a>
</td>
<td>
<a href="https://tw-elements.com/docs/react/components/social-buttons/">
<img alt="Tailwind Component" src="https://mdbootstrap.com/docs/standard/pro/demo/assets/images/social-media.webp">
</a>
</td>
<td>
<a href="https://tw-elements.com/docs/react/components/spinners/">
<img alt="Tailwind Component" src="https://mdbootstrap.com/docs/standard/pro/demo/assets/images/components-free/spinner-1.webp">
</a>
</td>
</tr>
<tr>
<td align="center"><b>Scroll to top</b></td>
<td align="center"><b>Social buttons</b></td>
<td align="center"><b>Spinners</b></td>
</tr>
<!--New row-->
<tr>
<td>
<a href="https://tw-elements.com/docs/react/components/timeline/">
<img alt="Tailwind Component" src="https://mdbootstrap.com/docs/standard/pro/demo/assets/images/timeline.webp">
</a>
</td>
<td>
<a href="#">
<img alt="Tailwind Component" src="https://mdbootstrap.com/docs/standard/pro/demo/assets/images/components-pro/toast-1.webp">
</a>
</td>
<td>
<a href="#">
<img alt="Tailwind Component" src="https://mdbootstrap.com/docs/standard/pro/demo/assets/images/components-free/tooltip-1.webp">
</a>
</td>
</tr>
<tr>
<td align="center"><b>Timeline</b></td>
<td align="center"><b>Toast (coming soon)</b></td>
<td align="center"><b>Tooltip (coming soon)</b></td>
</tr>
<!--New row-->
<tr>
<td>
<a href="#">
<img alt="Tailwind Component" src="https://mdbootstrap.com/docs/standard/pro/demo/assets/images/video.webp">
</a>
</td>
<td>
<a href="#">
<img alt="Tailwind Component" src="https://mdbootstrap.com/docs/standard/pro/demo/assets/images/video-carousel.webp">
</a>
</td>
<td>
<a href="https://tw-elements.com/docs/react/forms/checkbox/">
<img alt="Tailwind Component" src="https://mdbootstrap.com/docs/standard/pro/demo/assets/images/components-free/checkbox-1.webp">
</a>
</td>
</tr>
<tr>
<td align="center"><b>Video (coming soon)</b></td>
<td align="center"><b>Video carousel (coming soon)</b></td>
<td align="center"><b>Checkbox</b></td>
</tr>
<!--New row-->
<tr>
<td>
<a href="https://tw-elements.com/docs/react/forms/file-input/">
<img alt="Tailwind Component" src="https://mdbootstrap.com/docs/standard/pro/demo/assets/images/file-upload.webp">
</a>
</td>
<td>
<a href="#">
<img alt="Tailwind Component" src="https://mdbootstrap.com/docs/standard/pro/demo/assets/images/input-group.webp">
</a>
</td>
<td>
<a href="https://tw-elements.com/docs/react/forms/login-form/">
<img alt="Tailwind Component" src="https://mdbootstrap.com/docs/standard/pro/demo/assets/images/login-form.webp">
</a>
</td>
</tr>
<tr>
<td align="center"><b>File input</b></td>
<td align="center"><b>Input group (coming soon)</b></td>
<td align="center"><b>Login form</b></td>
</tr>
<!--New row-->
<tr>
<td>
<a href="https://tw-elements.com/docs/react/forms/radio/">
<img alt="Tailwind Component" src="https://mdbootstrap.com/docs/standard/pro/demo/assets/images/components-free/radio-1.webp">
</a>
</td>
<td>
<a href="https://tw-elements.com/docs/react/forms/range/">
<img alt="Tailwind Component" src="https://mdbootstrap.com/docs/standard/pro/demo/assets/images/components-free/range-1.webp">
</a>
</td>
<td>
<a href="https://tw-elements.com/docs/react/forms/registration-form/">
<img alt="Tailwind Component" src="https://mdbootstrap.com/docs/standard/pro/demo/assets/images/registration-form.webp">
</a>
</td>
</tr>
<tr>
<td align="center"><b>Radio</b></td>
<td align="center"><b>Range</b></td>
<td align="center"><b>Registration form</b></td>
</tr>
<!--New row-->
<tr>
<td>
<a href="https://tw-elements.com/docs/react/forms/search/">
<img alt="Tailwind Component" src="https://mdbootstrap.com/docs/standard/pro/demo/assets/images/components-free/search-1.webp">
</a>
</td>
<td>
<a href="#">
<img alt="Tailwind Component" src="https://mdbootstrap.com/docs/standard/pro/demo/assets/images/components-pro/select-1.webp">
</a>
</td>
<td>
<a href="https://tw-elements.com/docs/react/forms/switch/">
<img alt="Tailwind Component" src="https://mdbootstrap.com/docs/standard/pro/demo/assets/images/switch.webp">
</a>
</td>
</tr>
<tr>
<td align="center"><b>Search</b></td>
<td align="center"><b>Select (coming soon)</b></td>
<td align="center"><b>Switch</b></td>
</tr>
<!--New row-->
<tr>
<td>
<a href="#">
<img alt="Tailwind Component" src="https://mdbootstrap.com/docs/standard/pro/demo/assets/images/textarea.webp">
</a>
</td>
<td>
<a href="https://tw-elements.com/docs/react/data/tables/">
<img alt="Tailwind Component" src="https://mdbootstrap.com/docs/standard/pro/demo/assets/images/components-free/table-1.webp">
</a>
</td>
<td>
<a href="https://tw-elements.com/docs/react/methods/ripple/">
<img alt="Tailwind Component" src="https://mdbootstrap.com/docs/standard/pro/demo/assets/images/ripple.webp">
</a>
</td>
</tr>
<tr>
<td align="center"><b>Textarea (coming soon)</b></td>
<td align="center"><b>Tables</b></td>
<td align="center"><b>Ripple</b></td>
</tr>
<!--New row-->
<tr>
<td>
<a href="#">
<img alt="Tailwind Component" src="https://mdbcdn.b-cdn.net/wp-content/themes/mdbootstrap4/content/en/_mdb5/standard/pro/demo-new/assets/images/animations2.webp">
</a>
</td>
<td>
<a href="https://tw-elements.com/docs/react/content-styles/mask/">
<img alt="Tailwind Component" src="https://mdbootstrap.com/docs/standard/pro/demo/assets/images/components-free/mask-1.webp">
</a>
</td>
<td>
<a href="https://tw-elements.com/docs/react/content-styles/shadows/">
<img alt="Tailwind Component" src="https://mdbootstrap.com/docs/standard/pro/demo/assets/images/components-free/shadow-1.webp">
</a>
</td>
</tr>
<tr>
<td align="center"><b>Animations (coming soon)</b></td>
<td align="center"><b>Masks</b></td>
<td align="center"><b>Shadows</b></td>
</tr>
</table>
---
## Installation
##### NPM
1. Before starting the project make sure to install [Node.js (LTS)](https://nodejs.org/en/ "Node.js (LTS)") version 14+, 16+ and [TailwindCSS](https://tailwindcss.com/ "TailwindCSS").
2. Run the following command to install the package via NPM:
```
npm install tw-elements-react
```
3. Add the TW Elements React css file to your main js/tsx file
```javascript
import "tw-elements-react/dist/css/tw-elements-react.min.css";
```
4. TW Elements is a plugin and should be included inside the **tailwind.config.js** file. It is also recommended to extend the content array with a js file that loads dynamic component classes:
```javascript
module.exports = {
content: [
"./index.html",
"./src/**/*.{js,ts,jsx,tsx}",
"./node_modules/tw-elements-react/dist/js/**/*.js",
],
theme: {
extend: {},
},
darkMode: "class",
plugins: [require("tw-elements-react/dist/plugin.cjs")],
};
```
5. Components will work after importing the package:
```javascript
import { TECollapse } from "tw-elements-react";
```
##### MDB GO / CLI
Create, deploy and host anything with a single command.
1. To start using MDB GO / CLI install it with one command:
```
npm install -g mdb-cli
```
2. Log into the CLI using your MDB account:
```
mdb login
```
3. Initialize a project and choose **TW Elements React** from the list:
```
mdb init tw-elements-react
```
4. Install the dependencies (inside the project directory):
```
npm install
```
5. Run the app:
```
npm start
```
6. Publish when you're ready:
```
mdb publish
```
| TW Elements for React - 𝙃𝙪𝙜𝙚 collection of Tailwind + React components, sections and templates 😎 | component,components,components-library,javascript,react,react-template,reactjs,reactjs-components,tailwind-css,tailwind-css-template | 2023-05-17T10:31:14Z | 2023-10-30T08:08:49Z | null | 12 | 75 | 133 | 29 | 28 | 138 | null | NOASSERTION | HTML |
HeyPuter/terminal | trunk | # Important notice
Puter's terminal has moved. [Click here to see what's new!](https://github.com/HeyPuter/puter)
<hr />
<h3 align="center"><img width="150" alt="HiTIDE logo" src="./doc/logo.png"></h3>
<h3 align="center">Puter Terminal Emulator</h3>
<p align="center">
<a href="https://puter.com/app/terminal"><strong>« LIVE DEMO »</strong></a>
<br />
<br />
<a href="https://puter.com">Puter.com</a>
·
<a href="https://discord.com/invite/PQcx7Teh8u">Discord</a>
·
<a href="https://reddit.com/r/puter">Reddit</a>
·
<a href="https://twitter.com/HeyPuter">X (Twitter)</a>
</p>
<h3 align="center"><img alt="animated demo" src="./doc/readme-gif.gif">
</h3>
<hr>
This is a [Puter](https://puter.com)-compatible pure-javascript terminal emulator
built on [xtermjs](https://xtermjs.org/).
It integrates with an external shell provider.
We develop and test the terminal emulator alongside [Puter's shell: phoenix](https://github.com/HeyPuter/phoenix).
## The Terminal as a Whole
This terminal emulator alongside `phoenix` give you an AGPL-3.0-licensed pure-javascript
terminal experience which integrates with Puter's filesystem, AI services, and more.
Here are a few examples of what you can do:
- `ai "write me a story"`
- `txt2img "a blue computer on a cloud" > puter.png`
- `neofetch`
- `echo $(echo "command substitution")`
- `cat example.txt | grep "find me"`
- `cat example.json | jq "name"`
## Quickstart
**Note:** we've released Puter's terminal and shell very recently, so you may
run into some hurdles.
If you encounter any inconvenience we'd greatly appreciate
[an issue report](https://github.com/HeyPuter/terminal/issues/new).
The terminal emulator needs a shell to communicate with.
You can run it with Puter's shell, [phoenix](https://github.com/HeyPuter/phoenix).
1. Clone `phoenix` as a sibling directory to this repo, to get a directory
structure like the following:
```
my-puter-repos/
terminal/
phoenix/
```
2. Ensure you've run `npm install` in both repos
3. Install `dev-runner`
```
npm install -g @heyputer/dev-runner
```
4. While `cd`'d into this repo, run `run-phoenix-http.json5`
```
dev-runner ./run-phoenix-http.json5
```
5. Navigate to [http://127.0.0.1:8082](http://127.0.0.1:8082),
and use the `login` command to access files on puter.com.
**Note:** You will need to ensure the login popup is allowed.
If you choose to allow it _after_ the popup was blocked,
it will break; you need to allow always and then reload.
| ⌨️ Web-based terminal in pure JavaScript | javascript,terminal,terminal-emulator,web-console,web-terminal | 2023-05-28T00:53:36Z | 2024-04-13T03:48:30Z | null | 4 | 4 | 30 | 4 | 12 | 106 | null | AGPL-3.0 | JavaScript |
superagent-ai/superagent-js | main | <div align="center">
# Superagent JavaScript SDK 🥷
### The open framework for building AI Assistants
<p>
[](https://www.npmjs.com/package/superagentai-js)
<a href="https://buildwithfern.com/?utm_source=homanp/suepragent-py/readme">
<img alt="Fern" src="https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen" />
</a><img alt="GitHub Contributors" src="https://img.shields.io/github/contributors/homanp/superagent-py" />
<img alt="GitHub Last Commit" src="https://img.shields.io/github/last-commit/homanp/superagent-py" />
<img alt="" src="https://img.shields.io/github/repo-size/homanp/superagent-py" />
<img alt="GitHub Issues" src="https://img.shields.io/github/issues/homanp/superagent-py" />
<img alt="GitHub Pull Requests" src="https://img.shields.io/github/issues-pr/homanp/superagent-py" />
<img alt="Github License" src="https://img.shields.io/badge/License-MIT-yellow.svg" />
<img alt="Discord" src="https://img.shields.io/discord/1110910277110743103?label=Discord&logo=discord&logoColor=white&style=plastic&color=d7b023)](https://discord.gg/e8j7mgjDUK" />
</p>
</div>
-----
Superagent is an open source framework that enables any developer to integrate production ready AI Assistants into any application in a matter of minutes.
-----
## Installation
Add this dependency to your project's build file:
```bash
npm install superagentai-js
# or
yarn add superagentai-js
```
## Usage
```ts
import { Superagent, SuperAgentClient } from "superagentai-js";
const client = new SuperAgentClient(token="API_TOKEN")
const agent = await client.agent.create({
name: "My Agent",
description: "My Awesome Agent",
isActive: True,
llmModel: "GPT_4_1106_PREVIEW",
promprt: "You are a helpful assistant"
});
output = await client.agent.invoke(agent.data.id, {
input: "Hi there!",
enableStreaming: false,
sessionId: "123",
});
console.log("Received response from superagent", agent.data)
```
## Handling Exceptions
All exceptions thrown by the SDK will sublcass [SuperAgentError](./src/errors/SuperAgentError.ts).
```ts
improt { SuperAgentError } from "superagentai-js";
try {
client.agent.invoke(...)
} catch (err) {
if (err instanceof SuperAgentError) {
console.log(err.statusCode);
console.log(err.message);
}
}
```
## Acknowledgements
A special thanks to the [Fern](https://buildwithfern.com/) team for all support with the Superagent libraries and SDKs ❤️.
## Beta status
This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning the package version to a specific version. This way, you can install the
same version each time without breaking changes unless you are intentionally looking for the latest version.
## Contributing
While we value open-source contributions to this SDK, this library is generated programmatically. Additions made directly to this library would have to be moved
over to our generation code, otherwise they would be overwritten upon the next generated release. Feel free to open a PR as a proof of concept, but know that we
will not be able to merge it as-is. We suggest opening an issue first to discuss with us!
On the other hand, contributions to the README are always very welcome!
| Superagent Javascript SDK | superagent,agent,ai,javascript,llm | 2023-05-19T18:24:33Z | 2024-05-23T06:41:22Z | 2024-05-23T06:41:22Z | 4 | 11 | 191 | 0 | 31 | 84 | null | null | TypeScript |
abinth11/TutorTrek | master | null | This project is a online learning platform that connects teachers and students. Teachers can upload educational videos, and students can access and watch these videos at their own pace. The platform aims to provide a user-friendly and interactive environment for effective teaching and learning | clean-architecture,expressjs,javascript,mongodb,nodejs,reactjs,redux,typescript,axios,redis | 2023-06-06T16:59:07Z | 2023-09-26T18:53:32Z | null | 1 | 80 | 373 | 1 | 25 | 81 | null | MIT | TypeScript |
symfony/stimulus-bundle | 2.x | # StimulusBundle: Symfony integration with Stimulus!
This bundle adds integration between Symfony, Stimulus and Symfony UX:
- A) Twig `stimulus_*` functions & filters to add Stimulus controllers, actions & targets in your templates;
- B) Integration with Symfony UX & AssetMapper;
- C) A helper service to build the Stimulus data attributes and use them in your services.
[Read the documentation][1]
[1]: https://symfony.com/bundles/StimulusBundle/current/index.html
| Integration with your Symfony app & Stimulus! | javascript,symfony,symfony-ux,ux | 2023-05-22T18:11:43Z | 2024-05-03T07:02:49Z | null | 26 | 12 | 75 | 0 | 16 | 74 | null | MIT | PHP |
martinlaxenaire/gpu-curtains | main | # gpu-curtains
<div align="center">
<img src="https://raw.githubusercontent.com/martinlaxenaire/gpu-curtains/main/website/assets/gpu-curtains-logo-1080-720.jpg" width="500" alt="gpu-curtains" />
</div>
[Website](https://martinlaxenaire.github.io/gpu-curtains/) - [Documentation](https://martinlaxenaire.github.io/gpu-curtains/docs/) - [Examples](https://martinlaxenaire.github.io/gpu-curtains/examples/)
---
>
> :warning: WIP
>
---
<p align="center">
<a href="https://npmjs.org/package/gpu-curtains">
<img src="https://img.shields.io/npm/v/gpu-curtains" alt="version" />
</a>
<a href="https://bundlephobia.com/result?p=gpu-curtains">
<img src="https://img.shields.io/bundlephobia/minzip/gpu-curtains" alt="size" />
</a>
</p>
### DOM 2 WebGPU rendering engine
gpu-curtains is a small, lightweight WebGPU rendering engine library.
Although it can theoretically be used as a genuine 3D engine, its main purpose is to turn HTML elements into textured planes, allowing you to animate them via WGSL shaders.
The project was initially conceived as a WebGPU port of [curtains.js](https://github.com/martinlaxenaire/curtainsjs). It turned out to be a complete rewrite of the library instead, but with a very similar API.
## Usage
You can directly download the files and start using the ES6 modules:
#### ES modules
```javascript
import { GPUCurtains } from 'path/to/dist/esm/index.mjs'
window.addEventListener('load', async () => {
// set our main GPUCurtains instance
// it will handle everything we need
// a WebGPU device and a renderer with its scene,
// requestAnimationFrame, resize and scroll events...
const gpuCurtains = new GPUCurtains({
container: '#canvas'
})
// set the GPU device
// note this is asynchronous
await gpuCurtains.setDevice()
// now create some magic!
})
```
You can also use one of your favorite package manager:
#### npm
```
npm i gpu-curtains
```
#### yarn
```
yarn add gpu-curtains
```
Finally, you can load the library from a CDN. You should always target a specific version (append `@x.x.x`) rather than the latest one in order to avoid breaking changes.
```javascript
import { ... } from 'https://esm.run/gpu-curtains'
// or
import { ... } from 'https://cdn.skypack.dev/gpu-curtains'
// or use another cdn...
```
#### UMD files
In a browser, you can use the UMD files located in the `dist` directory:
```html
<script src="path/to/dist/gpu-curtains.umd.min.js"></script>
```
Or use a CDN:
```html
<script src="https://cdn.jsdelivr.net/npm/gpu-curtains"></script>
```
## Documentation and examples
- [API documentation](https://martinlaxenaire.github.io/gpu-curtains/docs/)
- [Official examples](https://martinlaxenaire.github.io/gpu-curtains/examples/)
- [Website](https://martinlaxenaire.github.io/gpu-curtains/)
## Basic example
### HTML
```html
<body>
<!-- div that will hold our WebGPU canvas -->
<div id="canvas"></div>
</body>
```
### CSS
```css
body {
position: relative;
width: 100%;
height: 100%;
margin: 0;
overflow: hidden;
}
#canvas {
/* make the canvas wrapper fits the viewport */
position: fixed;
top: 0;
right: 0;
width: 100%;
height: 100lvh;
}
```
### Javascript
```javascript
import { Curtains, Mesh } from 'gpu-curtains';
window.addEventListener('load', async () => {
// set our main GPUCurtains instance
// it will handle everything we need
// a WebGPU device and a renderer with its scene,
// requestAnimationFrame, resize and scroll events...
const gpuCurtains = new GPUCurtains({
container: '#canvas'
})
// set the GPU device
// note this is asynchronous
await gpuCurtains.setDevice()
// create a cube mesh
const mesh = new Mesh(gpuCurtains, {
geometry: new BoxGeometry(),
})
// this callback is executed
// before the scene actually updates the matrix stack
mesh.onBeforeRender(() => {
// make it rotate
mesh.rotation.x += 0.01
mesh.rotation.y += 0.02
})
})
```
## Limitations
gpu-curtains is mostly made to create quads based on HTML elements, it may lack some common 3D engines features (even tho it is slowly evolving towards a real 3D engine).
If you need a more robust 3D engine that could handle complex geometries or advanced rendering mechanics, then you should probably go with another library like [three.js](https://github.com/mrdoob/three.js) or [Babylon.js](https://github.com/BabylonJS).
## Contributing
Contribution are more than welcome! Please refer to the [contribution guidelines](CONTRIBUTING.md).
## Acknowledgements
Some parts of the code (mostly the math classes) have been ported or adapted from other existing open source libraries like [three.js](https://github.com/mrdoob/three.js) and [glmatrix](https://github.com/toji/gl-matrix).
Some examples are also ported and/or inspired by other online open-source WebGL or WebGPU examples. In any case the source should always be credited in the code. If a credit is missing, feel free to reach out or make a PR.
The [WebGPU samples](https://github.com/webgpu/webgpu-samples), [WebGPU fundamentals](https://webgpufundamentals.org/) and [WebGPU best practices](https://toji.dev/webgpu-best-practices/) were very helpful to help with the basic concepts of WebGPU. If you want to understand a bit more how it's working under the hood, do not hesitate to check those.
A big thanks to the members of the [WebGPU matrix chan](https://matrix.to/#/#WebGPU:matrix.org) that were always super kinds and very helpful as well.
## Changelog and roadmap
- [Releases](https://github.com/martinlaxenaire/gpu-curtains/releases)
- See the [roadmap](ROADMAP.md) for details on the current work in progress and possible improvements.
| gpu-curtains is a WebGPU rendering engine focused on mapping 3d objects to DOM elements; It allows users to synchronize values such as position, sizing, or scale between them. | 3d,canvas,curtains,curtainsjs,dom,html5,javascript,webgpu | 2023-05-26T08:42:59Z | 2024-05-07T18:40:43Z | 2024-05-07T18:40:43Z | 4 | 71 | 501 | 0 | 2 | 68 | null | MIT | TypeScript |
anand346/findissues | main | 
# Welcome to FindIssues ✨👋
**FindIssues** is a dynamic web application that lets you find the most recently created and unassigned Github issues across millions of GitHub repositories. This project helps open-source contributors in making their contributions more easier way.
## Table of Content
- [Get Started](https://github.com/anand346/findissues#get-started)
- [Features 🎯](https://github.com/anand346/findissues#features-)
- [Live Demo 😀](https://github.com/anand346/findissues#live-demo-)
- [Tech Stack ⚙️](https://github.com/anand346/findissues#tech-stack-%EF%B8%8F)
- [Contributing 🚀](https://github.com/anand346/findissues#contributing-)
- [Add Active Repo? 📂](https://github.com/anand346/findissues#add-active-repo-)
- [License 🪪](https://github.com/anand346/findissues#license-)
- [Contact 📧](https://github.com/anand346/findissues#contact-)
## Get Started
To begin go to the web application: [FindIssues](https://www.findissues.me/)
In the web broswer you will select your ideal programming langauage and through that it will showcase the 30 most recently created GitHub issues in that language, which are currently unassigned to any individual.
## Features 🎯
- **Advanced Search**: Utilize the advanced search techniques to filter and discover unassigned GitHub issues.
- **Real-time Data**: Get access to the latest issue information directly from GitHub.
- **User-Friendly Design**: Enjoy an intuitive and visually appealing interface.
## Live Demo 😀
Visit our [**live demo**](https://findissues.vercel.app) to experience FindIssues in action and make searching of unassigned issues more easier.
## Tech Stack ⚙️
  
## Contributing 🚀
We welcome contributions from the community to make FindIssues even better. If you're interested in contributing, please follow our [Contributing Guidelines](CONTRIBUTING.md) to get started.
## Add Active Repo? 📂
We welcome contributions from the community to make FindIssues even better. If you're interested in adding an active repo then go through [these instructions](list-active-repo.md) and refer to [this](https://github.com/anand346/findissues/issues/81) issue.
## License 🪪
Copyright Anand Raj, 2023.
This project is licensed under the [MIT License](https://github.com/anand346/findissues/blob/main/LICENSE).
The MIT License is a permissive open-source license that allows you to use, modify, and distribute this software for any purpose.
## Contact 📧
Got questions or feedback? Reach out to us through [**mail**](mailto:rajanand9039@gmail.com). We'd love to hear from you!
Join the FindIssues community today and start making search of unassigned github issues more easier. 🧑💻✨👫
## ✨ Thanks to our contributors!
<div align="center">
<a href="https://github.com/anand346/findissues/graphs/contributors">
<img src="https://contrib.rocks/image?repo=anand346/findissues" alt="Contributors" />
</a>
</div>
🌟 We value the time and effort you put into contributing, and we look forward to reviewing and merging your contributions.
---
<p align="right">(<a href="#top">Back to top</a>)</p>
| FindIssues aims to provide you access to the most recent created issues on github which is not assigned to anyone yet, with its advance search technique 🧑💻✨. | open-source,open-source-project,hacktoberfest,css,html,javascript,next,nextjs,react,reactjs | 2023-05-26T10:56:37Z | 2024-01-07T12:22:27Z | 2023-09-18T13:41:25Z | 42 | 99 | 144 | 10 | 67 | 63 | null | MIT | JavaScript |
yuangwei/leetcode | main | javascript-leetcode
---
<div align="center">
<a href="https://leetcode.about-blank.io/"><img src="/public/banner.svg" alt="banner" width="100px"/></a>
</div>
Master LeetCode with the Simplicity of JavaScript.
| #(1) | Title | Solution | Difficulty |
| ---| ----- | -------- | ---------- |
| 1 | [Two Sum](https://leetcode.com/problems/two-sum) | [Solution](/pages/solutions/two-sum.mdx) | Easy |
| 🤯 Leetcode solutions. | leetcode,leetcode-solutions,algorithms-and-data-structures,javascript | 2023-05-17T09:17:27Z | 2024-03-26T08:07:09Z | null | 1 | 2 | 186 | 0 | 10 | 62 | null | MIT | MDX |
bl33h/whosbl33h | main | # who's bl33h ?
Welcome to my portfolio repository! This project showcases my skills using React, ESLint, Tailwind, and Vite. It includes a brief introduction about me, my projects, the technologies I've worked with, and my experience. You'll also find a contact form at the bottom and my social media links below it. Feel free to explore and connect with me!
<p align="center">
<br>
<img src="https://i.imgur.com/YjFLrzx.png" alt="wb" width="400">
<br>
</p>
<p align="center" >
<a href="#features">Features</a> •
<a href="#Files">Files</a> •
<a href="#how-to-use">How To Use</a> •
<a href="#packages">Packages</a>
</p>
<p align="center" >
<a href="https://whosbl33h.netlify.app/">Try it out here</a>
</p>
## Features
* Vite
```bash
# Install dependencies
$ npm i
# run the app
$ npm run dev
```
## Files
- src: the file that implements de solution.
- assets: resources that are used in an application.
- components: reusable pieces of code that define the appearance and behavior of a part of the UI.
- pages: the different areas of the portfolio.
- constants: values that cannot be altered by the program during normal execution.
## How To Use
To clone and run this application, you'll need [Git](https://git-scm.com), [Node.js](https://nodejs.org/en) and [Vite](https://vitejs.dev/) installed on your computer. From your command line:
```bash
# Clone this repository
$ git clone https://github.com/bl33h/whosbl33h
# Install dependencies
$ npm i
# Run the app
$ npm run dev
```
## Packages
This software uses the following open source packages:
- [Vite](https://vitejs.dev/)
- [React](https://reactjs.org/)
- [Tailwind](https://tailwindcss.com/)
| This project showcases my skills using React, ESLint, Tailwind, and Vite. It includes a brief introduction about me, my projects, the technologies I've worked with, and my experience. You'll also find a contact form at the bottom and my social media links below it. | eslint,react,tailwind,vite,npm,netlify,emailjs,javascript,portfolio,girlsinstem | 2023-06-04T05:51:01Z | 2024-04-27T18:34:01Z | null | 2 | 7 | 74 | 0 | 40 | 60 | null | null | JavaScript |
abhay-raj19/FitBody | main |
<h1 align="center">🏋🏽FitBody🏋🏽</h1>
<p align="center">
<div align="center">
<img src="https://forthebadge.com/images/badges/built-with-love.svg" />
<img src="https://forthebadge.com/images/badges/uses-brains.svg" />
<img src="https://forthebadge.com/images/badges/powered-by-responsibility.svg" />
<br>
<img src="https://img.shields.io/github/repo-size/abhay-raj19/FitBody?style=for-the-badge" />
<img src="https://img.shields.io/github/issues/abhay-raj19/FitBody?style=for-the-badge" />
<img src="https://img.shields.io/github/issues-closed-raw/abhay-raj19/FitBody?style=for-the-badge" />
<img src="https://img.shields.io/github/license/abhay-raj19/FitBody?style=for-the-badge" />
<img src="https://img.shields.io/github/issues-pr/abhay-raj19/FitBodyF?style=for-the-badge" />
<img src="https://img.shields.io/github/contributors/abhay-raj19/FitBody?style=for-the-badge" />
<img src="https://img.shields.io/github/stars/abhay-raj19/FitBody?style=for-the-badge" />
<img src="https://img.shields.io/github/issues-pr-closed-raw/abhay-raj19/FitBody?style=for-the-badge" />
<img src="https://img.shields.io/github/forks/abhay-raj19/FitBody?style=for-the-badge" />
<img src="https://img.shields.io/github/last-commit/abhay-raj19/FitBody?style=for-the-badge" />
<img src="https://api.visitorbadge.io/api/visitors?path=https%3A%2F%2Fgithub.com%2Fabhay-raj19%2FFitBody&label=visitors&countColor=%2337d67a&style=for-the-badge&labelStyle=upper" />
</div>
<br>
</p>
#
<!-- ## Simple website that will blow your mind and requires many PR to be raised. -->
## 📍Table Of Contents
- [About](#About)
- [Live Demo](#LiveDemo)
- [Issues to be welcomed](#Issuestobewelcomed)
- [Building FitBody](#BuildingFitBody)
- [Note](#NOTE)
- [Features](#Features)
- [Technology Stack](#TechnologyStack)
- [License](#License)
- [Repo Status](#RepoStatus)
- [Our Contributors](#OurContributors)
## 🎯About
FitBody is the growing platform for Gym-enthusiasts and they can choose there respective domains for the pricing category and we are happy to invite you in the gym-community.
## 🖱️Live Demo
Here is the live view of this website. It is hosted on Vercel https://fit-body-delta.vercel.app/
### How to Contribute to this repository
1. Fork the repository (Click the Fork button in the top right of this page,
click your Profile Image)
2. Clone the forked repository to your local machine.
3. Make your branch from test branch.
```markdown
git clone https://github.com/abhay-raj19/FitBody.git
```
3. change the present working directory to
```markdown
cd FitBody
```
5. Make your changes
```markdown
git add .
```
```markdown
git commit -m "Your commit Message"
```
```markdown
git push origin branch-name
```
6. Make a pull request.
7. Do ⭐ the repository.
### 🔩Issues to be welcomed
1. Content Correction.
2. Back pages for the linking the webpages.
3. Navigation of the pages.
4. New cards for Testimonials with Images.
### 📦️Building FitBody
1. Install npm from browser(windows), using ``sudo apt install npm``(linux) in the terminal.
2. In the root directory: `npm install` for downloading all the dependencies needed for the project.
3. Run `npm start` for starting the server (FitBody is currently running on `localhost:3000`)
Happy coding :)
### 🗒️NOTE
- Make Sure you commit your changes in a new branch.
- Make Sure you Give a proper name to your files describing the addition.
- Also Make Sure you comment on your code wherever necessary.
## 💫Features
- Personalized Workout Plans: Provide the option for users to receive personalized workout plans tailored to their fitness goals. Users can input their preferences and goals, and the website generates a customized plan for them.
- Progress Tracking: Enable users to track their fitness progress over time. They can input their measurements, record workout sessions, and monitor their improvements through charts or graphs.
- Nutrition Guidance: Offer nutrition tips and guidance to help users maintain a healthy diet and complement their fitness routines. This can include articles, meal plans, and recipes.
- Community and Social Interaction: Foster a sense of community among gym members through features like forums or social media integration. Users can connect, share their fitness journeys, and support one another.
- Blog and Articles: Publish informative articles and blog posts related to fitness, health, and wellness.
## 💻Technology Stack
## License
Licensed under the MIT License.
## Repo Status
<br><br>
## Join our Discord Community
To get latest updates on the project and to interact with the community. We are happy to help you with your queries.
[](https://discord.gg/Ra8vsr5bPK)
## 🤝Our Contributors
<a href="https://github.com/abhay-raj19/fitbody/graphs/contributors">
<img src="https://contrib.rocks/image?repo=abhay-raj19/fitbody" />
</a>
Thank you to all the amazing contributors who have made this project possible!
Show some ❤️ by starring this repository !
<p align="right">(<a href="#top">⇑</a>)</p>
| Star the Repo⭐. | html,javascript,nodejs,reactjs,website,gssoc-24 | 2023-06-05T18:53:13Z | 2024-05-20T08:04:55Z | null | 43 | 129 | 204 | 89 | 96 | 59 | null | MIT | JavaScript |
codinasion/codinasion | master | <h1 align="center">Codinasion</h1>
<div align="center">
Collaborate, Create, Innovate: Together with Open Source ❤️
[](https://github.com/codinasion/codinasion/blob/master/LICENSE.md "MIT License") [](https://github.com/codinasion/codinasion)
 [](https://github.com/codinasion/codinasion/graphs/contributors) [](https://github.com/codinasion/codinasion/graphs/commit-activity)
<a href="https://vercel.com/?utm_source=codinasion&utm_campaign=oss" target="_blank">
<img src="https://raw.githubusercontent.com/codinasion/codinasion/master/assets/powered-by-vercel.svg" alt="Powered By Vercel" width="170">
</a>
</div>
<br>
<div align="center">
<img src="https://raw.githubusercontent.com/codinasion/codinasion/master/assets/rainbow-hr.png" alt="linha colorida" width="100%" height="70%">
</div>
<br>
Read this `Readme` in another language:
<kbd>[<img title="English" alt="English" src="https://cdn.statically.io/gh/hjnilsson/country-flags/master/svg/us.svg" width="22">](https://github.com/codinasion/codinasion/blob/master/README.md)</kbd> <kbd>[<img title="Português" alt="Português" src="https://cdn.statically.io/gh/hjnilsson/country-flags/master/svg/br.svg" width="22">](https://github.com/codinasion/codinasion/blob/master/translations/README-pt-br.md)</kbd> <kbd>[<img title="French" alt="French" src="https://cdn.statically.io/gh/hjnilsson/country-flags/master/svg/fr.svg" width="22">](https://github.com/codinasion/codinasion/blob/master/translations/README-fr.md)</kbd> <kbd>[<img title="Italian" alt="Italian" src="https://cdn.statically.io/gh/hjnilsson/country-flags/master/svg/it.svg" width="22">](https://github.com/codinasion/codinasion/blob/master/translations/README-it.md)</kbd> <kbd>[<img title="Chinese (Simplified)" alt="Chinese (Simplified)" src="https://cdn.statically.io/gh/hjnilsson/country-flags/master/svg/cn.svg" width="22">](https://github.com/codinasion/codinasion/blob/master/translations/README-cn.md)</kbd> <kbd>[<img title="Русский" alt="Русский" src="https://cdn.statically.io/gh/hjnilsson/country-flags/master/svg/ru.svg" width="22">](https://github.com/codinasion/codinasion/blob/master/translations/README-ru.md)</kbd>
<div align="center">
<img src="https://raw.githubusercontent.com/codinasion/codinasion/master/assets/rainbow-hr.png" alt="rainbow hr" width="100%" height="70%">
</div>
## Contributing
If you're looking for a way to contribute, you can scan through our existing issues for something to work on.
We want to make contributing to this project as easy and transparent as possible, and we are grateful to the community for contributing bug fixes and improvements. Read our [Contributing Guide](https://github.com/codinasion/codinasion/blob/master/CONTRIBUTING.md) on how you can take part in improving Codinasion.
<div align="center">
<img src="https://raw.githubusercontent.com/codinasion/codinasion/master/assets/rainbow-hr.png" alt="rainbow hr" width="100%" height="70%">
</div>
## Join us in discussions
We use GitHub Discussions to talk about all sorts of topics related to documentation and this site. For example: if you'd like help troubleshooting a PR, have a great new idea, or want to share something amazing, join us in the [discussions](https://github.com/orgs/codinasion/discussions).
<div align="center">
<img src="https://raw.githubusercontent.com/codinasion/codinasion/master/assets/rainbow-hr.png" alt="rainbow hr" width="100%" height="70%">
</div>
## Sponsors & Backers
<div align="center">
<img src="https://raw.githubusercontent.com/codinasion/codinasion/master/assets/rainbow-hr.png" alt="rainbow hr" width="100%" height="70%">
</div>
<br>
<table>
<tr>
<td>
<img align="left" src="https://raw.githubusercontent.com/codinasion/codinasion/master/assets/octocat.png" width="190">
<h3>Thanks for contributing :purple_heart:</h3>
<ul>
<li>Thanks for all your contributions and efforts</li>
<li>We thank you for being part of our :sparkles: commUnity :sparkles: !</li>
</ul>
<img width="900" height="0">
</td>
</tr>
</table>
<div align="center">
<img src="https://raw.githubusercontent.com/codinasion/codinasion/master/assets/rainbow-hr.png" alt="rainbow hr" width="100%" height="70%">
</div>
<br/>
<p align="center">
Made with 💖 by <a href="https://github.com/codinasion"><b>Codinasion</b></a>
</p>
<div align="center">
<img src="https://raw.githubusercontent.com/codinasion/codinasion/master/assets/rainbow-hr.png" alt="rainbow hr" width="100%" height="70%">
</div>
| Community Monorepo | monorepo,turborepo,hacktoberfest,hacktoberfest-accepted,hacktoberfest2023,c,c-plus-plus,c-sharp,javascript,python | 2023-05-27T13:13:13Z | 2024-05-15T18:39:55Z | 2024-01-14T08:51:14Z | 161 | 952 | 4,679 | 826 | 172 | 51 | null | MIT | TypeScript |
pekkiriscim/passwords | main | # Passwords
Passwords is an open-source desktop app that simplifies password management, offering a secure and user-friendly experience. Built with Tauri and Next.js.
<img src="screenshots/Dashboard.png" alt="Dashboard" width="100%">
## Table of Contents
- [Features](#features)
- [Used Technologies](#used-technologies)
- [Run Locally](#run-locally)
- [Contribution](#contribution)
- [License](#license)
- [Screenshots](#screenshots)
- [Download App](#download-app)
## Features
- Access your encrypted password file through the user authentication page. Safeguard your passwords with an additional layer of security using user credentials.
- Seamlessly add, edit, and delete passwords within the app.
- Organize your passwords into different types for convenient categorization.
- Utilize pre-designed forms tailored for various password types, ensuring easy and consistent data entry.
- Calculate password strength in real-time, assisting you in creating robust and secure passwords.
- Generate strong and unique passwords based on user preferences and choices. Customize password criteria such as length, character types, and complexity.
- Enable internationalization with the integration of i18next. Reach a wider audience by providing localized language options, enhancing user experience.
- Built with Tauri and Next.js, Passwords combines the power of modern web development and desktop application creation. Leverage the advanced capabilities of Tauri for seamless cross-platform deployment.
- Store your passwords in an encrypted local file, ensuring the safety of your sensitive information. Utilize encryption powered by CryptoJS to maintain the confidentiality of your stored data.
- Enjoy a modern and user-friendly interface designed for efficiency and ease of use. Access various password types and features with a clean and organized layout.
## Used Technologies
- **Tauri**: Empower your app with the capabilities of Tauri, enabling seamless cross-platform deployment and access to native APIs for enhanced user experience.
- **Next.js**: Harness the power of Next.js, leveraging its static site generation (SSG) capabilities to create a user interface.
- **shadcn/ui**: Enhance your app's visual and interactive elements with components from shadcn/ui. These beautifully designed components can be seamlessly integrated into your application, offering accessibility, customizability, and open-source goodness.
- **CryptoJS**: Utilize CryptoJS for strong encryption, ensuring that sensitive information such as passwords is securely stored within the app's encrypted local file.
- **i18next**: Implement internationalization with i18next, enabling users to experience the app in their preferred language, enhancing global accessibility.
- **Lucide React**: Enhance the visual appeal of your app with icons from Lucide React, adding a touch of aesthetic sophistication to the user interface.
- **Tailwind CSS**: Employ Tailwind CSS for efficient styling, enabling rapid development through its utility-first approach and streamlined design workflow.
- **Tauri APIs**: Access native functionalities seamlessly through Tauri APIs, providing your app with the potential to interact with the user's system.
## Run Locally
To get a copy of Passwords up and running on your local machine, follow these steps:
1. **Install Tauri Prerequisites**:
Before you begin, make sure you have the required tools and dependencies installed for Tauri. Follow the [Tauri Prerequisites Guide](https://tauri.app/v1/guides/getting-started/prerequisites) to set up your environment.
2. **Clone the repository**:
```bash
git clone https://github.com/pekkiriscim/passwords.git
```
```bash
cd passwords
```
3. **Install Dependencies**:
Navigate into the project directory and install the required dependencies:
```bash
npm install
```
4. **Run the Development Server**:
Start the app in development mode with the following command:
```bash
npm run tauri dev
```
5. **Build and Launch the Tauri App**:
To build and launch the Tauri app, run the following command:
```bash
npm run tauri build
```
## Contribution
Contributions to Passwords are welcomed and encouraged! If you're interested in improving the app, adding new features, fixing bugs, or enhancing documentation, your contributions are highly valued.
## License
Passwords is open-source software released under the MIT License.
The MIT License (MIT) is a permissive open-source license that allows you to use, modify, and distribute the software in your projects, both commercial and non-commercial, while providing attribution to the original authors.
## Screenshots
<img src="screenshots/Authentication.png" alt="Authentication" width="100%">
<img src="screenshots/Dashboard.png" alt="Dashboard" width="100%">
<img src="screenshots/PasswordDialog.png" alt="PasswordDialog" width="100%">
<img src="screenshots/PasswordGenerator.png" alt="PasswordGenerator" width="100%">
<img src="screenshots/DeletePasswordDialog.png" alt="DeletePasswordDialog" width="100%">
## Download App
Visit the [Releases](https://github.com/pekkiriscim/passwords/releases) page of the GitHub repository to find the latest version of Passwords. Look for the release version that you want to download.
| Easily secure and manage passwords with a desktop app powered by Tauri and Next.js. | desktop,desktop-app,desktop-application,desktop-apps,javascript,nextjs,nextjs13,password,password-generator,password-manager | 2023-06-02T18:19:14Z | 2023-09-05T18:01:17Z | 2023-09-05T18:01:17Z | 1 | 0 | 30 | 0 | 4 | 49 | null | MIT | JavaScript |
AmoabaKelvin/Medium-Anti-Member-Only | main | null | This is a chromium & firefox extension that removes all paywalls from medium article links, preventing you from seeing the annoying member only thingy. | chrome-extension,firefox-extension,javascript | 2023-05-30T23:45:05Z | 2024-03-13T21:41:12Z | 2024-03-13T21:41:12Z | 2 | 6 | 21 | 2 | 3 | 48 | null | MIT | JavaScript |
zeondev/pluto | main | <h1 align="center">Pluto v1.6.2</h1>
<div align="center">
<a href="https://github.com/zeondev/pluto/stargazers"><img src="https://img.shields.io/github/stars/zeondev/pluto?style=for-the-badge" /></a>
<a href="https://github.com/zeondev/pluto/forks"><img src="https://img.shields.io/github/forks/zeondev/pluto?style=for-the-badge&color=orange" /></a>
<a href="https://github.com/zeondev/pluto/pulls"><img src="https://img.shields.io/github/issues-pr/zeondev/pluto?style=for-the-badge" /></a>
<a href="https://github.com/zeondev/pluto/commits"><img src="https://img.shields.io/github/commit-activity/t/zeondev/pluto?style=for-the-badge&color=violet" /></a>
<br>
<br>
<a href="https://discord.gg/axUqK8CN2n"><img src="assets/images/thewebosalliancebanner.png" height="50"></a>
<a href="https://discord.gg/wvd8ChpD8t"><img src="assets/images/zeoncommunitybanner.png" height="50"></a>
<a href="https://zeon.dev"><img src="assets/images/zeonbanner.png" height="50"></a><br/><br/>
<a href="https://pluto-app.zeon.dev/">Try the live demo ↗</a>
</div>
<p align="center">Pluto is a minimal but functional "web OS" that aims to provide a desktop environment-like experience inside of a website.</p>
<picture>
<source media="(prefers-color-scheme: light)" srcset="assets/images/ss_light.png">
<img align="center" src="assets/images/ss_dark.png">
</picture>
## Table of Contents
- [Table of Contents](#table-of-contents)
- [Features](#features)
- [Documentation](#documentation)
- [Contributing](#contributing)
## Features
Pluto has several key features some of which include:
- Clean and minimal UI design, focused on personalization
- Simple file system
- Easy to create your own apps
## Documentation
You can find documentation in the [docs](docs/) folder.
## Contributing
When contributing to Pluto, please consider the following:
- It is recommended to use [VS Code](https://code.visualstudio.com) along with the Live Server and Prettier extensions for the best experience.
- Following these guidelines increases the chance of your pull request being approved.
| Pluto is a minimal and functional Webtop! | customizable,html,interactive,javascript,js,os,project,themes,ui,web | 2023-05-30T00:12:46Z | 2024-04-18T13:53:45Z | null | 9 | 11 | 252 | 2 | 11 | 46 | null | GPL-3.0 | JavaScript |
selenite-cc/selenite-old | main | ## Selenite
The better unblocked games website.
## Deploy to a cloud service
[](https://railway.app/new/template?template=https://github.com/selenite-cc/selenite)
[](https://app.cyclic.sh/api/app/deploy/selenite-cc/selenite)
[](https://app.koyeb.com/deploy?type=git&repository=github.com/selenite-cc/selenite&branch=main&name=selenite)
[](https://render.com/deploy?repo=https://github.com/selenite-cc/selenite)
[](https://replit.com/github/selenite-cc/selenite)
[](https://glitch.com/edit/#!/import/github/selenite-cc/selenite)
[](https://vercel.com/new/clone?repository-url=https://github.com/selenite-cc/selenite)
## Contributors
[](https://github.com/selenite-cc/selenite/graphs/contributors)
## Support
Join our [discord server](https://discord.gg/WDZhkdFyF4) to contact our support team free of charge for any reason 24/7.
| an opensource unblocked games website, dedicated to hosting games and unblocked content. | 3kh0,flash,game,games,proxy,unblocked,unity,webgl,css,html | 2023-05-22T02:06:11Z | 2024-01-23T02:28:49Z | null | 4 | 15 | 388 | 0 | 84 | 46 | null | GPL-3.0 | HTML |
iGaoWei/CoderBooks | master | 程序员编程书籍资源汇总 【CoderBooks】
============================
## 仓库简介
CoderBooks是一个收集计算机领域经典书籍、学习资源的开源项目，供各位同学免费使用，永不收费！作为一名互联网/IT从业人员，经常需要搜索一些书籍、资源，在这个过程中踩过很多坑、浪费过很多时间。为了方便大家，我特意把这些年收集的计算机类书籍资源共享给大家。欢迎大家 `Watch`、`Star`。
- 以下所有编程学习书籍资源，均收集于网络或来自码友投稿，仅供学习交流，欢迎大家积极投稿。
- 涵盖范围包括但不限于：计算机基础、前后端资源等。可以说，你想要的，这里都有！
- 本仓库持续更新中，后续会陆续分享更多资源书籍，强烈建议大家 `Star` 下本仓库，找资源再也不愁 ！
- 更多资源内容可以关注[微信公众号【DreamCoders】](#更多分享)，第一时间获取最新资料。
## 欢迎投稿
欢迎大家共同完善这个项目，让免费资源不再难找！您可以通过以下方式提供： `赠人玫瑰，手有余香`
* 使用 [Issues](https://github.com/iGaoWei/CoderBooks/issues/new) 提交
* 使用 [Pull Request](https://github.com/iGaoWei/CoderBooks/pulls) 提交
收集整理不易，如果觉得对你有对您有帮助，欢迎 `Watch`、`Star`。当然也可以请我喝杯咖啡：
<p align="center"><img src="https://cdn.staticaly.com/gh/iGaoWei/codercdn@master/img/wechat-code.png" width="320" height="320" alt="微信赞赏码" /></p>
## 目录
* 推荐
* [500+程序员超级实用必备效率工具，全部免费分享](https://mp.weixin.qq.com/s?__biz=MzAwODExMTM4MQ==&mid=2649836364&idx=1&sn=5427c3f185afa6e3487da161dfb9153a&chksm=83763f36b401b620eac6075388417491ef41c1ffb15767a5ff94c0af5189b7c090634cdcd804&scene=21#wechat_redirect) :100:
* [100套最新最全大数据可视化炫酷大屏Html5模板](https://mp.weixin.qq.com/s?__biz=MzAwODExMTM4MQ==&mid=2649836159&idx=1&sn=2e4b628d26c16c263a1856636d2c5b59&chksm=83763e05b401b713271f1a3402ed4bec3abddf3f83335da3fdb8e78f450845224fa37ba60b80&scene=21#wechat_redirect) :100:
* [全网最全最多的计算机编程学习资源PDF电子书大合集](https://mp.weixin.qq.com/s?__biz=MzAwODExMTM4MQ==&mid=2649836414&idx=1&sn=54a239fbf90d0a5ebc5dfcfa4ad71ef0&chksm=83763f04b401b612332011fae9c6949bcdc509e5ed6e9cf1a2623412966308f121620e7cee0d&scene=21#wechat_redirect) :100:
* 计算机基础类
* [操作系统](#操作系统)
* [编译原理](#编译原理)
* [计算机网络](#计算机网络)
* [计算机组成原理](#计算机组成原理)
* [设计模式](#设计模式)
* [正则表达式](#正则表达式)
* [WEB服务器](#web服务器)
* [版本控制](#版本控制)
* [Web](#web)
* [编程艺术](#编程艺术)
* [其它](#其它)
* 数据结构算法类
* [数据结构](#数据结构)
* [算法](#算法)
* 数据库类
* [NoSQL](#nosql)
* [PostgreSQL](#postgresql)
* [MySQL](#mysql)
* [大数据](#大数据)
* 面试相关类
* [面试](#面试)
* 综合类
* [前端](#前端)
* [后端](#后端)
* 编程语言相关类
* [Android](#android)
* [APP](#app)
* [AWK](#awk)
* [C/C++](#cc)
* [C#](#c)
* [Clojure](#clojure)
* [CSS/HTML](#csshtml)
* [Dart](#dart)
* [Elixir](#elixir)
* [Erlang](#erlang)
* [Fortran](#fortran)
* [Go](#go)
* [Groovy](#groovy)
* [Haskell](#haskell)
* [iOS](#ios)
* [Java](#java)
* [JavaScript](#javascript)
* [Kotlin](#kotlin)
* [LaTeX](#latex)
* [LISP](#lisp)
* [Lua](#lua)
* [OCaml](#OCaml)
* [Perl](#perl)
* [PHP](#php)
* [Prolog](#prolog)
* [Python](#python)
* [R](#r)
* [Ruby](#ruby)
* [Rust](#rust)
* [Scala](#scala)
* [Shell](#shell)
* [Swift](#swift)
## 操作系统
* [鸟哥的Linux私房菜](http://linux.vbird.org/)
* [开源世界旅行手册](http://i.linuxtoy.org/docs/guide/index.html)
* [操作系统教程.孙钟秀.文字版](https://pan.baidu.com/s/1NyfbnkXv7gIIDGXpBVtrsg?pwd=sc3a)
* [The Linux Command Line](http://billie66.github.io/TLCL/index.html)
* [UNIX TOOLBOX](http://cb.vu/unixtoolbox_zh_CN.xhtml)
* [FreeBSD 使用手册](https://www.freebsd.org/doc/zh_CN/books/handbook/index.html)
* [Linux 命令行(中文版)](http://billie66.github.io/TLCL/book/)
* [Linux 构建指南](http://works.jinbuguo.com/lfs/lfs62/index.html)
* [Linux工具快速教程](https://github.com/me115/linuxtools_rst)
* [Linux Documentation (中文版)](https://www.gitbook.com/book/tinylab/linux-doc/details)
* [嵌入式 Linux 知识库 (eLinux.org 中文版)](https://www.gitbook.com/book/tinylab/elinux/details)
* [理解Linux进程](https://github.com/tobegit3hub/understand_linux_process)
* [命令行的艺术](https://github.com/jlevy/the-art-of-command-line/blob/master/README-zh.md)
* [操作系统思考](https://github.com/wizardforcel/think-os-zh)
* [计算机系统系统架构与操作系统的高度集成](https://pan.baidu.com/s/129ttW5464rlOk7xK3Ke0ow?pwd=49qx)
[返回目录](#目录)
## 编译原理
* [《编译原理》.陈意云.文字版](https://pan.baidu.com/s/1sRMrAO9g1yLH6tJ0sBENag?pwd=06tw)
* [《计算机程序的结构和解释》公开课 翻译项目](https://github.com/DeathKing/Learning-SICP)
* [麻省理工学院公开课：计算机科学及编程导论](http://v.163.com/special/opencourse/bianchengdaolun.html)
[返回目录](#目录)
## 函数式概念
* [傻瓜函数编程](https://github.com/justinyhuang/Functional-Programming-For-The-Rest-of-Us-Cn)
[返回目录](#目录)
## 计算机图形学
* [OpenGL 教程](https://github.com/zilongshanren/opengl-tutorials)
* [《Real-Time Rendering 3rd》提炼总结](https://github.com/QianMo/Real-Time-Rendering-3rd-Summary-Ebook)
[返回目录](#目录)
## WEB服务器
* [Nginx开发从入门到精通](http://tengine.taobao.org/book/index.html) (淘宝团队)
* [Nginx教程从入门到精通](http://www.ttlsa.com/nginx/nginx-stu-pdf/)(PDF版本，运维生存时间出品)
* [OpenResty最佳实践](https://www.gitbook.com/book/moonbingbing/openresty-best-practices/details)
* [Apache 中文手册](http://works.jinbuguo.com/apache/menu22/index.html)
[返回目录](#目录)
## 版本控制
* [Learn Git - complete book in Chinese](https://www.git-tower.com/learn/git/ebook/cn/command-line/)
* [Git Cheat Sheet](https://www.git-tower.com/blog/git-cheat-sheet-cn)
* [Git教程](http://www.liaoxuefeng.com/wiki/0013739516305929606dd18361248578c67b8067c8c017b000)
* [git - 简易指南](http://rogerdudler.github.io/git-guide/index.zh.html)
* [猴子都能懂的GIT入门](http://backlogtool.com/git-guide/cn/)
* [Git 参考手册](http://gitref.justjavac.com)
* [Pro Git](http://git-scm.com/book/zh/v2)
* [Git Magic](http://www-cs-students.stanford.edu/~blynn/gitmagic/intl/zh_cn/)
* [GotGitHub](http://www.worldhello.net/gotgithub/index.html)
* [Git权威指南](http://www.worldhello.net/gotgit/)
* [Git Community Book 中文版](http://gitbook.liuhui998.com/index.html)
* [Mercurial 使用教程](https://www.mercurial-scm.org/wiki/ChineseTutorial)
* [HgInit (中文版)](http://bucunzai.net/hginit/)
* [沉浸式学 Git](http://igit.linuxtoy.org)
* [GitHub秘籍](https://snowdream86.gitbooks.io/github-cheat-sheet/content/zh/index.html)
* [GitHub帮助文档](https://github.com/waylau/github-help)
* [git-flow 备忘清单](http://danielkummer.github.io/git-flow-cheatsheet/index.zh_CN.html)
* [svn 手册](http://svnbook.red-bean.com/nightly/zh/index.html)
* [GitHub漫游指南](https://github.com/phodal/github-roam)
[返回目录](#目录)
## 编辑器
* [exvim--vim 改良成IDE项目](http://exvim.github.io/docs-zh/intro/)
* [Vim中文文档](https://github.com/vimcn/vimcdoc)
* [21天学会Emacs](http://book.emacs-china.org/)
* [一年成为Emacs高手 (像神一样使用编辑器)](https://github.com/redguardtoo/mastering-emacs-in-one-year-guide/blob/master/guide-zh.org)
* [所需即所获：像 IDE 一样使用 vim](https://github.com/yangyangwithgnu/use_vim_as_ide)
* [vim 实操教程](https://github.com/dofy/learn-vim)
* [Atom飞行手册中文版](https://github.com/wizardforcel/atom-flight-manual-zh-cn)
* [Markdown·简单的世界](https://github.com/wizardforcel/markdown-simple-world)
* [一年成为 Emacs 高手](https://github.com/redguardtoo/mastering-emacs-in-one-year-guide/blob/master/guide-zh.org)
* [Emacs 生存指南](http://lifegoo.pluskid.org/upload/blog/152/Survive.in.Emacs.pdf)
* [Atom官方手册](https://atom-china.org/t/atom/62)
[返回目录](#目录)
## NoSQL
* [NoSQL数据库笔谈](http://old.sebug.net/paper/databases/nosql/Nosql.html)
* [Redis 设计与实现](http://redisbook.com/)
* [Redis 命令参考](http://redisdoc.com/)
* [带有详细注释的 Redis 3.0 代码](https://github.com/huangz1990/redis-3.0-annotated)
* [带有详细注释的 Redis 2.6 代码](https://github.com/huangz1990/annotated_redis_source)
* [The Little MongoDB Book](https://github.com/justinyhuang/the-little-mongodb-book-cn/blob/master/mongodb.md)
* [The Little Redis Book](https://github.com/JasonLai256/the-little-redis-book/blob/master/cn/redis.md)
* [Neo4j 简体中文手册 v1.8](http://docs.neo4j.org.cn/)
* [Neo4j .rb 中文資源](http://neo4j.tw/)
* [Disque 使用教程](http://disquebook.com)
* [Apache Spark 设计与实现](https://github.com/JerryLead/SparkInternals/tree/master/markdown)
[返回目录](#目录)
## PostgreSQL
* [PostgreSQL 8.2.3 中文文档](http://works.jinbuguo.com/postgresql/menu823/index.html)
* [PostgreSQL 9.3.1 中文文档](http://www.postgres.cn/docs/9.3/index.html)
* [PostgreSQL 9.5.3 中文文档](http://www.postgres.cn/docs/9.5/index.html)
[返回目录](#目录)
## MySQL
* [MySQL索引背后的数据结构及算法原理](http://blog.codinglabs.org/articles/theory-of-mysql-index.html)
* [21分钟MySQL入门教程](http://www.cnblogs.com/mr-wid/archive/2013/05/09/3068229.html)
[返回目录](#目录)
## 管理和监控
* [ELKstack 中文指南](http://kibana.logstash.es)
* [Mastering Elasticsearch(中文版)](http://udn.yyuap.com/doc/mastering-elasticsearch/)
* [ElasticSearch 权威指南](https://www.gitbook.com/book/fuxiaopang/learnelasticsearch/details)
* [Elasticsearch 权威指南（中文版）](http://es.xiaoleilu.com)
* [Logstash 最佳实践](https://github.com/chenryn/logstash-best-practice-cn)
* [Puppet 2.7 Cookbook 中文版](http://bbs.konotes.org/workdoc/puppet-27/)
[返回目录](#目录)
## 项目相关
* [持续集成（第二版）](http://article.yeeyan.org/view/2251/94882) (译言网)
* [让开发自动化系列专栏](http://www.ibm.com/developerworks/cn/java/j-ap/)
* [追求代码质量](http://www.ibm.com/developerworks/cn/java/j-cq/)
* [selenium 中文文档](https://github.com/fool2fish/selenium-doc)
* [Selenium Webdriver 简易教程](http://it-ebooks.flygon.net/selenium-simple-tutorial/)
* [Joel谈软件](http://local.joelonsoftware.com/wiki/Chinese_\(Simplified\))
* [約耳談軟體(Joel on Software)](http://local.joelonsoftware.com/wiki/%E9%A6%96%E9%A0%81)
* [Gradle 2 用户指南](https://github.com/waylau/Gradle-2-User-Guide)
* [Gradle 中文使用文档](http://yuedu.baidu.com/ebook/f23af265998fcc22bcd10da2)
* [编码规范](https://github.com/ecomfe/spec)
* [开源软件架构](http://www.ituring.com.cn/book/1143)
* [GNU make 指南](http://docs.huihoo.com/gnu/linux/gmake.html)
* [GNU make 中文手册](http://www.yayu.org/book/gnu_make/)
* [The Twelve-Factor App](http://12factor.net/zh_cn/)
[返回目录](#目录)
## 设计模式
* [图说设计模式](https://github.com/me115/design_patterns)
* [史上最全设计模式导学目录](http://blog.csdn.net/lovelion/article/details/17517213)
* [design pattern 包教不包会](https://github.com/AlfredTheBest/Design-Pattern)
* [设计模式 Java 版](https://quanke.gitbooks.io/design-pattern-java/content/)
[返回目录](#目录)
## Web
* [关于浏览器和网络的 20 项须知](http://www.20thingsilearned.com/zh-CN/home)
* [浏览器开发工具的秘密](http://jinlong.github.io/2013/08/29/devtoolsecrets/)
* [Chrome 开发者工具中文手册](https://github.com/CN-Chrome-DevTools/CN-Chrome-DevTools)
* [Chrome扩展开发文档](http://open.chrome.360.cn/extension_dev/overview.html)
* [Grunt中文文档](http://www.gruntjs.net/)
* [gulp中文文档](http://www.gulpjs.com.cn/docs/)
* [Gulp 入门指南](https://github.com/nimojs/gulp-book)
* [移动Web前端知识库](https://github.com/AlloyTeam/Mars)
* [正则表达式30分钟入门教程](http://deerchao.net/tutorials/regex/regex.htm)
* [前端开发体系建设日记](https://github.com/fouber/blog/issues/2)
* [移动前端开发收藏夹](https://github.com/hoosin/mobile-web-favorites)
* [JSON风格指南](https://github.com/darcyliu/google-styleguide/blob/master/JSONStyleGuide.md)
* [HTTP 接口设计指北](https://github.com/bolasblack/http-api-guide)
* [前端资源分享（一）](https://github.com/hacke2/hacke2.github.io/issues/1)
* [前端资源分享（二）](https://github.com/hacke2/hacke2.github.io/issues/3)
* [前端代码规范 及 最佳实践](http://coderlmn.github.io/code-standards/)
* [前端开发者手册](https://www.gitbook.com/book/dwqs/frontenddevhandbook/details)
* [前端工程师手册](https://www.gitbook.com/book/leohxj/front-end-database/details)
* [w3school教程整理](https://github.com/wizardforcel/w3school)
* [Wireshark用户手册](http://man.lupaworld.com/content/network/wireshark/index.html)
* [一站式学习Wireshark](https://community.emc.com/thread/194901)
* [HTTP 下午茶](https://ccbikai.gitbooks.io/http-book/content/)
* [HTTP/2.0 中文翻译](http://yuedu.baidu.com/ebook/478d1a62376baf1ffc4fad99?pn=1)
* [RFC 7540 - HTTP/2 中文翻译版](https://github.com/abbshr/rfc7540-translation-zh_cn)
* [http2讲解](https://www.gitbook.com/book/ye11ow/http2-explained/details)
* [3 Web Designs in 3 Weeks](https://www.gitbook.com/book/juntao/3-web-designs-in-3-weeks/details)
* [站点可靠性工程](https://github.com/hellorocky/Site-Reliability-Engineering)
* [Web安全学习笔记](https://websec.readthedocs.io)
* [Serverless 架构应用开发指南](https://github.com/phodal/serverless)
[返回目录](#目录)
## 大数据
* [大数据/数据挖掘/推荐系统/机器学习相关资源](https://github.com/Flowerowl/Big-Data-Resources)
* [面向程序员的数据挖掘指南](https://github.com/egrcc/guidetodatamining)
* [大型集群上的快速和通用数据处理架构](https://code.csdn.net/CODE_Translation/spark_matei_phd)
* [数据挖掘中经典的算法实现和详细的注释](https://github.com/linyiqun/DataMiningAlgorithm)
* [Spark 编程指南简体中文版](https://aiyanbo.gitbooks.io/spark-programming-guide-zh-cn/content/)
[返回目录](#目录)
## 编程艺术
* [代码整洁之道.(美)马丁.扫描版](https://pan.baidu.com/s/10ipwfaSI70w8Auf4JaisuQ?pwd=d087)
* [程序员编程艺术](https://github.com/julycoding/The-Art-Of-Programming-by-July)
* [计算机程序设计艺术.第一卷](https://pan.baidu.com/s/1RSwa4hD5AsPhSyigfUJ7Rg?pwd=avse)
* [计算机程序设计艺术.第二卷](https://pan.baidu.com/s/1hQ1_VeNioRKaVvHRZKSMzA?pwd=t4ee)
* [计算机程序设计艺术.第三卷](https://pan.baidu.com/s/1CtLKd5o1A6fyu9CpH8BpNA?pwd=6rmw)
* [计算机发展百年趣味史](https://pan.baidu.com/s/1S8lPCgcwJQZVKnZMMRY65Q?pwd=i0ln) (阿里出版)
[返回目录](#目录)
## 数据结构
* [labuladong 的算法小抄](https://github.com/labuladong/fucking-algorithm)
[返回目录](#目录)
## 算法
* [labuladong 的算法小抄](https://github.com/labuladong/fucking-algorithm)
[返回目录](#目录)
## 其它
* [OpenWrt智能、自动、透明翻墙路由器教程](https://www.gitbook.com/book/softwaredownload/openwrt-fanqiang/details)
* [SAN 管理入门系列](https://community.emc.com/docs/DOC-16067)
* [Sketch 中文手册](http://sketchcn.com/sketch-chinese-user-manual.html#introduce)
* [深入理解并行编程](http://ifeve.com/perfbook/)
* [程序员的自我修养](http://www.kancloud.cn/kancloud/a-programmer-prepares)
* [Growth: 全栈增长工程师指南](https://github.com/phodal/growth-ebook)
* [系统重构与迁移指南](https://github.com/phodal/migration)
[返回目录](#目录)
## Android
* [Android Design(中文版)](http://www.apkbus.com/design/index.html)
* Google Material Design 正體中文版 ([译本一](https://wcc723.gitbooks.io/google_design_translate/content/style-icons.html) [译本二](https://github.com/1sters/material_design_zh))
* [Material Design 中文版](http://wiki.jikexueyuan.com/project/material-design/)
* [Google Android官方培训课程中文版](http://hukai.me/android-training-course-in-chinese/index.html)
* [Android学习之路](http://www.stormzhang.com/android/2014/07/07/learn-android-from-rookie/)
* [Android开发技术前线(android-tech-frontier)](https://github.com/bboyfeiyu/android-tech-frontier)
* [Point-of-Android](https://github.com/FX-Max/Point-of-Android) Android 一些重要知识点解析整理
* [Android6.0新特性详解](http://leanote.com/blog/post/561658f938f41126b2000298)
[返回目录](#目录)
## APP
* [Apache Cordova 开发指南](https://github.com/waylau/cordova-dev-guide)
[返回目录](#目录)
## AWK
* [awk程序设计语言](https://github.com/wuzhouhui/awk)
* [awk中文指南](http://awk.readthedocs.org/en/latest/index.html)
* [awk实战指南](https://book.saubcy.com/AwkInAction/)
[返回目录](#目录)
## 前端
* [前端知识体系](http://www.cnblogs.com/sb19871023/p/3894452.html)
* [前端知识结构](https://github.com/JacksonTian/fks)
* [前端知识体系](http://www.cnblogs.com/sb19871023/p/3894452.html)
* [前端书籍](https://github.com/dypsilon/frontend-dev-bookmarks)
* [前端免费书籍大全](https://github.com/vhf/free-programming-books)
* [大前端工具集-聂微东](https://github.com/nieweidong/fetool)
[返回目录](#目录)
## 后端
## C/C++
* [C/C++ 中文参考手册](http://zh.cppreference.com/)
* [C 语言编程透视](https://www.gitbook.com/book/tinylab/cbook/details)
* [C++ 并发编程指南](https://github.com/forhappy/Cplusplus-Concurrency-In-Practice)
* [Linux C编程一站式学习](http://akaedu.github.io/book/)
* [CGDB中文手册](https://github.com/leeyiw/cgdb-manual-in-chinese)
* [100个gdb小技巧](https://github.com/hellogcc/100-gdb-tips/blob/master/src/index.md)
* [100个gcc小技巧](https://github.com/hellogcc/100-gcc-tips/blob/master/src/index.md)
* [ZMQ 指南](https://github.com/anjuke/zguide-cn)
* [How to Think Like a Computer Scientist](http://www.ituring.com.cn/book/1203) (中英文版)
* [跟我一起写 Makefile](https://github.com/seisman/how-to-write-makefile)
* [GNU make 指南](http://docs.huihoo.com/gnu/linux/gmake.html)
* [Google C++ 风格指南](http://zh-google-styleguide.readthedocs.org/en/latest/google-cpp-styleguide/contents/)
* [C/C++ Primer](https://github.com/andycai/cprimer)
* [简单易懂的C魔法](http://www.nowamagic.net/librarys/books/contents/c)
* [C++ FAQ LITE(中文版)](http://www.sunistudio.com/cppfaq/)
* [C++ Primer 5th Answers](https://github.com/Mooophy/Cpp-Primer)
* [C++ 并发编程(基于C++11)](https://www.gitbook.com/book/chenxiaowei/cpp_concurrency_in_action/details)
* [QT 教程](http://www.kuqin.com/qtdocument/tutorial.html)
* [DevBean的《Qt学习之路2》(Qt5)](http://www.devbean.net/category/qt-study-road-2/)
* [中文版《QmlBook》](https://github.com/cwc1987/QmlBook-In-Chinese)
* [C++ Template 进阶指南](https://github.com/wuye9036/CppTemplateTutorial)
* [libuv中文教程](https://github.com/luohaha/Chinese-uvbook)
* [Boost 库中文教程](http://zh.highscore.de/cpp/boost/)
* [笨办法学C](https://github.com/wizardforcel/lcthw-zh)
* [高速上手 C++11/14/17](https://github.com/changkun/modern-cpp-tutorial)
[返回目录](#目录)
## C#
* [Microsoft Docs C# 官方文档](https://docs.microsoft.com/zh-cn/dotnet/csharp/)
* [ASP.NET MVC 5 入门指南](http://www.cnblogs.com/powertoolsteam/p/aspnetmvc5-tutorials-grapecity.html)
* [超全面的 .NET GDI+ 图形图像编程教程](http://www.cnblogs.com/geeksss/p/4162318.html)
* [.NET控件开发基础](https://github.com/JackWangCUMT/customcontrol)
* [.NET开发要点精讲（初稿）](https://github.com/sherlockchou86/-free-ebook-.NET-)
[返回目录](#目录)
## Clojure
* [Clojure入门教程](https://wizardforcel.gitbooks.io/clojure-fpftj/)
[返回目录](#目录)
<h2 id="csshtml">CSS/HTML</h2>
* [学习CSS布局](http://zh.learnlayout.com/)
* [通用 CSS 笔记、建议与指导](https://github.com/chadluo/CSS-Guidelines/blob/master/README.md)
* [CSS参考手册](http://css.doyoe.com/)
* [Emmet 文档](http://yanxyz.github.io/emmet-docs/)
* [前端代码规范](http://alloyteam.github.io/CodeGuide/) (腾讯团队)
* [HTML和CSS编码规范](http://codeguide.bootcss.com/)
* [Sass Guidelines 中文](http://sass-guidelin.es/zh/)
* [CSS3 Tutorial 《CSS3 教程》](https://github.com/waylau/css3-tutorial)
* [MDN HTML 中文文档](https://developer.mozilla.org/zh-CN/docs/Web/HTML)
* [MDN CSS 中文文档](https://developer.mozilla.org/zh-CN/docs/Web/CSS)
[返回目录](#目录)
## Dart
* [Dart 语言导览](http://dart.lidian.info/wiki/Language_Tour)
[返回目录](#目录)
## Elixir
* [Elixir编程入门](https://github.com/straightdave/programming_elixir)
[返回目录](#目录)
## Erlang
* [21天学通Erlang](http://xn--21erlang-p00o82pmp3o.github.io/)
[返回目录](#目录)
## Fortran
* [Fortran77和90/95编程入门](http://micro.ustc.edu.cn/Fortran/ZJDing/)
[返回目录](#目录)
## Go
* [Go编程基础](https://github.com/Unknwon/go-fundamental-programming)
* [Go入门指南](https://github.com/Unknwon/the-way-to-go_ZH_CN)
* [学习Go语言](http://mikespook.com/learning-go/)
* [Go Web 编程](https://github.com/astaxie/build-web-application-with-golang)
* [Go实战开发](https://github.com/astaxie/Go-in-Action)
* [Network programming with Go 中文翻译版本](https://github.com/astaxie/NPWG_zh)
* [Effective Go](http://www.hellogcc.org/effective_go.html)
* [Go 语言标准库](https://github.com/polaris1119/The-Golang-Standard-Library-by-Example)
* [Golang标准库文档](http://godoc.ml/)
* [Revel 框架手册](http://gorevel.cn/docs/manual/index.html)
* [Java程序员的Golang入门指南](http://blog.csdn.net/dc_726/article/details/46565241)
* [Go命令教程](https://github.com/hyper-carrot/go_command_tutorial)
* [Go语言博客实践](https://github.com/achun/Go-Blog-In-Action)
* [Go 官方文档翻译](https://github.com/golang-china/golangdoc.translations)
* [深入解析Go](https://github.com/tiancaiamao/go-internals)
* [Go语言圣经(中文版)](https://bitbucket.org/golang-china/gopl-zh/wiki/Home) ([GitBook](https://www.gitbook.com/book/wizardforcel/gopl-zh/details))
* [golang runtime源码分析](https://github.com/sheepbao/golang_runtime_reading)
* [Go语言实战: 编写可维护Go语言代码建议](https://github.com/llitfkitfk/go-best-practice)
* [Golang 系列教程(译)](https://github.com/Tinywan/golang-tutorial)
* [Go RPC 开发指南](https://github.com/smallnest/go-rpc-programming-guide)[GitBook](https://smallnest.gitbooks.io/go-rpc-programming-guide/)
* [Go语言高级编程](https://books.studygolang.com/advanced-go-programming-book/)
* [Go2编程指南](https://chai2010.cn/go2-book/)
* [Go语言设计模式](https://github.com/senghoo/golang-design-pattern)
* [Go语言四十二章经](https://github.com/ffhelicopter/Go42)
[返回目录](#目录)
## Groovy
* [实战 Groovy 系列](http://www.ibm.com/developerworks/cn/java/j-pg/)
[返回目录](#目录)
## Haskell
* [Real World Haskell 中文版](http://rwh.readthedocs.org/en/latest/)
* [Haskell趣学指南](https://learnyoua.haskell.sg/content/zh-cn/)
[返回目录](#目录)
## iOS
* [iOS开发60分钟入门](https://github.com/qinjx/30min_guides/blob/master/ios.md)
* [iOS7人机界面指南](http://isux.tencent.com/ios-human-interface-guidelines-ui-design-basics-ios7.html)
* [Google Objective-C Style Guide 中文版](http://zh-google-styleguide.readthedocs.org/en/latest/google-objc-styleguide/)
* [iPhone 6 屏幕揭秘](http://wileam.com/iphone-6-screen-cn/)
* [Apple Watch开发初探](http://nilsun.github.io/apple-watch/)
* [马上着手开发 iOS 应用程序](https://developer.apple.com/library/ios/referencelibrary/GettingStarted/RoadMapiOSCh/index.html)
* [网易斯坦福大学公开课：iOS 7应用开发字幕文件](https://github.com/jkyin/Subtitle)
[返回目录](#目录)
## Java
* [Apache Shiro 用户指南](https://github.com/waylau/apache-shiro-1.2.x-reference)
* [Jersey 2.x 用户指南](https://github.com/waylau/Jersey-2.x-User-Guide)
* [Spring Framework 4.x参考文档](https://github.com/waylau/spring-framework-4-reference)
* [Spring Boot参考指南](https://github.com/qibaoguang/Spring-Boot-Reference-Guide)
* [MyBatis中文文档](http://mybatis.org/mybatis-3/zh/index.html)
* [MyBatis Generator 中文文档](http://mbg.cndocs.tk/)
* [用jersey构建REST服务](https://github.com/waylau/RestDemo)
* [Activiti 5.x 用户指南](https://github.com/waylau/activiti-5.x-user-guide)
* [Google Java编程风格指南](https://hawstein.com/2014/01/20/google-java-style/)
* [Netty 4.x 用户指南](https://github.com/waylau/netty-4-user-guide)
* [Netty 实战(精髓)](https://github.com/waylau/essential-netty-in-action)
* [REST 实战](https://github.com/waylau/rest-in-action)
* [Java 编码规范](https://github.com/waylau/java-code-conventions)
* [Apache MINA 2 用户指南](https://github.com/waylau/apache-mina-2.x-user-guide)
* [H2 Database 教程](https://github.com/waylau/h2-database-doc)
* [Java Servlet 3.1 规范](https://github.com/waylau/servlet-3.1-specification)
* [JSSE 参考指南](https://github.com/waylau/jsse-reference-guide)
* [Java开源实现及最佳实践](https://github.com/biezhi/jb)
* [Java 编程要点](https://github.com/waylau/essential-java)
* [Think Java](http://www.ituring.com.cn/minibook/69)
* [Java 8 简明教程](https://github.com/wizardforcel/modern-java-zh)
* [On Java 8 中文版](https://github.com/LingCoder/OnJava8) (翻译中)
* [Effective Java 第3版中文版](https://github.com/sjsdfg/effective-java-3rd-chinese)
[返回目录](#目录)
## JavaScript
* [前端工程师的入门与进阶](https://shenbao.github.io/2017/04/22/justjavac-live/)
* [现代 Javascript 教程](https://zh.javascript.info/)
* [Google JavaScript 代码风格指南](http://bq69.com/blog/articles/script/868/google-javascript-style-guide.html)
* [Google JSON 风格指南](https://github.com/darcyliu/google-styleguide/blob/master/JSONStyleGuide.md)
* [Airbnb JavaScript 规范](https://github.com/adamlu/javascript-style-guide)
* [JavaScript 标准参考教程（alpha）](http://javascript.ruanyifeng.com/)
* [Javascript编程指南](http://pij.robinqu.me/) ([源码](https://github.com/RobinQu/Programing-In-Javascript))
* [javascript 的 12 个怪癖](https://github.com/justjavac/12-javascript-quirks)
* [JavaScript 秘密花园](http://bonsaiden.github.io/JavaScript-Garden/zh/)
* [JavaScript核心概念及实践](http://icodeit.org/jsccp/)
* [《JavaScript 模式》](https://github.com/jayli/javascript-patterns)
* [JavaScript语言精粹](https://github.com/qibaoguang/Study-Step-by-Step/blob/master/%E8%AF%BB%E4%B9%A6%E7%AC%94%E8%AE%B0/javascript_the_good_parts.md)
* [命名函数表达式探秘](http://justjavac.com/named-function-expressions-demystified.html)
* [学用 JavaScript 设计模式](http://www.oschina.net/translate/learning-javascript-design-patterns) (开源中国)
* [深入理解JavaScript系列](http://www.cnblogs.com/TomXu/archive/2011/12/15/2288411.html)
* [ECMAScript 5.1 中文版](http://yanhaijing.com/es5)
* [ECMAScript 6 入门](http://es6.ruanyifeng.com/) (作者：阮一峰)
* [JavaScript Promise迷你书](http://liubin.github.io/promises-book/)
* [You-Dont-Know-JS](https://github.com/getify/You-Dont-Know-JS) (深入JavaScript语言核心机制的系列图书)
* [JavaScript 教程](http://www.liaoxuefeng.com/wiki/001434446689867b27157e896e74d51a89c25cc8b43bdb3000) 廖雪峰
* [MDN JavaScript 中文文档](https://developer.mozilla.org/zh-CN/docs/Web/JavaScript)
* jQuery
* [jQuery 解构](http://www.cn-cuckoo.com/deconstructed/jquery.html)
* [简单易懂的JQuery魔法](http://www.nowamagic.net/librarys/books/contents/jquery)
* [How to write jQuery plugin](http://i5ting.github.io/How-to-write-jQuery-plugin/build/jquery.plugin.html)
* [You Don't Need jQuery](https://github.com/oneuijs/You-Dont-Need-jQuery/blob/master/README.zh-CN.md)
* [如何实现一个类jQuery？](https://github.com/MeCKodo/forchange)
* Node.js
* [Node入门](http://www.nodebeginner.org/index-zh-cn.html)
* [七天学会NodeJS](http://nqdeng.github.io/7-days-nodejs/)
* [Nodejs Wiki Book](https://github.com/nodejs-tw/nodejs-wiki-book) (繁体中文)
* [express.js 中文文档](http://expressjs.jser.us/)
* [koa 中文文档](https://github.com/guo-yu/koa-guide)
* [一起学koa](http://base-n.github.io/koa-generator-examples/)
* [使用 Express + MongoDB 搭建多人博客](https://github.com/nswbmw/N-blog)
* [Express框架](http://javascript.ruanyifeng.com/nodejs/express.html)
* [Node.js 包教不包会](https://github.com/alsotang/node-lessons)
* [Learn You The Node.js For Much Win! (中文版)](https://www.npmjs.com/package/learnyounode-zh-cn)
* [Node debug 三法三例](http://i5ting.github.io/node-debug-tutorial/)
* [nodejs中文文档](https://www.gitbook.com/book/0532/nodejs/details)
* [orm2 中文文档](https://github.com/wizardforcel/orm2-doc-zh-cn)
* [一起学 Node.js](https://github.com/nswbmw/N-blog)
* [Node入门：一本全面的Node.js教程](https://www.nodebeginner.org/index-zh-cn.html)
* [从零开始的Nodejs系列文章](http://blog.fens.me/series-nodejs/)
* [如何正确的学习 Node.js](https://github.com/i5ting/How-to-learn-node-correctly)
* underscore.js
* [Underscore.js中文文档](http://learningcn.com/underscore/)
* backbone.js
* [backbone.js中文文档](http://www.css88.com/doc/backbone/)
* [backbone.js入门教程](http://www.the5fire.com/backbone-js-tutorials-pdf-download.html) (PDF)
* [Backbone.js入门教程第二版](https://github.com/the5fire/backbonejs-learning-note)
* [Developing Backbone.js Applications(中文版)](http://feliving.github.io/developing-backbone-applications/)
* AngularJS
* [AngularJS最佳实践和风格指南](https://github.com/mgechev/angularjs-style-guide/blob/master/README-zh-cn.md)
* [AngularJS中译本](https://github.com/peiransun/angularjs-cn)
* [AngularJS入门教程](https://github.com/zensh/AngularjsTutorial_cn)
* [构建自己的AngularJS](https://github.com/xufei/Make-Your-Own-AngularJS/blob/master/01.md)
* [在Windows环境下用Yeoman构建AngularJS项目](http://www.waylau.com/build-angularjs-app-with-yeoman-in-windows/)
* Zepto.js
* [Zepto.js 中文文档](http://mweb.baidu.com/zeptoapi/)
* Sea.js
* [Hello Sea.js](http://island205.github.io/HelloSea.js/)
* React.js
* [React 学习之道](https://github.com/the-road-to-learn-react/the-road-to-learn-react-chinese)
* [React.js 小书](https://github.com/huzidaha/react-naive-book)
* [React.js 中文文档](https://doc.react-china.org/)
* [React webpack-cookbook](https://github.com/fakefish/react-webpack-cookbook)
* [React 入门教程](http://fraserxu.me/intro-to-react/)
* [React 入门教程](https://hulufei.gitbooks.io/react-tutorial/content/)
* [React Native 中文文档(含最新Android内容)](http://wiki.jikexueyuan.com/project/react-native/)
* [Learn React & Webpack by building the Hacker News front page](https://github.com/theJian/build-a-hn-front-page)
* impress.js
* [impress.js的中文教程](https://github.com/kokdemo/impress.js-tutorial-in-Chinese)
* CoffeeScript
* [CoffeeScript Cookbook](http://island205.com/coffeescript-cookbook.github.com/)
* [The Little Book on CoffeeScript中文版](http://island205.com/tlboc/)
* [CoffeeScript 编码风格指南](https://github.com/geekplux/coffeescript-style-guide)
* TypeScipt
* [TypeScript Handbook](https://zhongsp.gitbooks.io/typescript-handbook/content/)
* ExtJS
* [Ext4.1.0 中文文档](http://extjs-doc-cn.github.io/ext4api/)
* Meteor
* [Discover Meteor](http://zh.discovermeteor.com/)
* [Meteor 中文文档](http://docs.meteorhub.org/#/basic/)
* [Angular-Meteor 中文教程](http://angular.meteorhub.org/)
* VueJS
* [逐行剖析 Vue.js 源码](https://nlrx-wjc.github.io/Learn-Vue-Source-Code/)
* [Chrome扩展及应用开发](http://www.ituring.com.cn/minibook/950)
## Kotlin
* [Kotlin 官方参考文档 中文版](https://hltj.gitbooks.io/kotlin-reference-chinese/content/)
* [Kotlin 中文文档](https://huanglizhuo.gitbooks.io/kotlin-in-chinese/) [GitHub](https://github.com/huanglizhuo/kotlin-in-chinese)
* [Kotlin 参考文档](http://www.liying-cn.net/kotlin/docs/reference/)
* [《Kotlin for android developers》中文版](https://wangjiegulu.gitbooks.io/kotlin-for-android-developers-zh/content/)
[返回目录](#目录)
## LaTeX
* [一份其实很短的 LaTeX 入门文档](http://liam0205.me/2014/09/08/latex-introduction/)
* [一份不太简短的 LATEX 2ε 介绍](http://www.mohu.org/info/lshort-cn.pdf) （PDF版）
[返回目录](#目录)
## LISP
* Common Lisp
* [ANSI Common Lisp 中文翻譯版](http://acl.readthedocs.org/en/latest/)
* [On Lisp 中文翻译版本](http://www.ituring.com.cn/minibook/862)
* Scheme
* [Yet Another Scheme Tutorial Scheme入门教程](http://deathking.github.io/yast-cn/)
* [Scheme语言简明教程](http://songjinghe.github.io/TYS-zh-translation/)
* Racket
* [Racket book](https://github.com/tyrchen/racket-book)
[返回目录](#目录)
## Lua
* [Lua编程入门](https://github.com/andycai/luaprimer)
* [Lua 5.1 参考手册 中文翻译](http://www.codingnow.com/2000/download/lua_manual.html)
* [Lua 5.3 参考手册 中文翻译](http://cloudwu.github.io/lua53doc/)
* [Lua源码欣赏](http://www.codingnow.com/temp/readinglua.pdf)
[返回目录](#目录)
## OCaml
* [Real World OCaml](https://github.com/zforget/translation/tree/master/real_world_ocaml)
[返回目录](#目录)
## Perl
* [Modern Perl 中文版](https://github.com/horus/modern_perl_book)
* [Perl 程序员应该知道的事](http://perl.linuxtoy.org/)
[返回目录](#目录)
## PHP
* [PHP 官方手册](http://php.net/manual/zh/)
* [PHP调试技术手册](http://www.laruence.com/2010/06/21/1608.html)(PDF)
* PHP之道：php-the-right-way ([@wulijun版](http://wulijun.github.io/php-the-right-way/) [PHPHub版](http://laravel-china.github.io/php-the-right-way/))
* [PHP 最佳实践](https://github.com/justjavac/PHP-Best-Practices-zh_CN)
* [PHP 开发者实践](https://ryancao.gitbooks.io/php-developer-prepares/content/)
* [深入理解PHP内核](https://github.com/reeze/tipi)
* [PHP扩展开发及内核应用](http://www.walu.cc/phpbook/)
* [Laravel5.1 中文文档](http://laravel-china.org/docs/5.1)
* [Laravel 5.1 LTS 速查表](https://cs.phphub.org/)
* [Symfony2 Cookbook 中文版](http://wiki.jikexueyuan.com/project/symfony-cookbook/)(版本 2.7.0 LTS)
* [Symfony2中文文档](http://symfony-docs-chs.readthedocs.org/en/latest/) (未译完)
* [YiiBook几本Yii框架的在线教程](http://yiibook.com//doc)
* [深入理解 Yii 2.0](http://www.digpage.com/)
* [Yii 框架中文官网](http://www.yiichina.com/)
* [简单易懂的PHP魔法](http://www.nowamagic.net/librarys/books/contents/php)
* [swoole文档及入门教程](https://github.com/LinkedDestiny/swoole-doc)
* [Composer 中文网](http://www.phpcomposer.com)
* [Slim 中文文档](http://ww1.minimee.org/php/slim)
* [Lumen 中文文档](http://lumen.laravel-china.org/)
* [PHPUnit 中文文档](https://phpunit.de/manual/current/zh_cn/installation.html)
* [PHP-LeetCode](https://github.com/wuqinqiang/leetcode-php)
* [ThinkPHP6完全开发手册](https://www.kancloud.cn/manual/thinkphp6_0)
* [Laravel 10 中文文档](https://learnku.com/docs/laravel/10.x)
[返回目录](#目录)
## Prolog
* [笨办法学Prolog](http://fengdidi.github.io/blog/2011/11/15/qian-yan/)
[返回目录](#目录)
## Python
* [廖雪峰 Python 2.7 中文教程](http://www.liaoxuefeng.com/wiki/001374738125095c955c1e6d8bb493182103fac9270762a000)
* [廖雪峰 Python 3 中文教程](http://www.liaoxuefeng.com/wiki/0014316089557264a6b348958f449949df42a6d3a2e542c000)
* [简明Python教程](http://www.kuqin.com/abyteofpython_cn/)
* [简明 Python 教程(Python 3)](https://legacy.gitbook.com/book/lenkimo/byte-of-python-chinese-edition/details)
* [零基础学 Python 第一版](http://www.kancloud.cn/kancloud/python-basic)
* [零基础学 Python 第二版](http://www.kancloud.cn/kancloud/starter-learning-python)
* [可爱的 Python](http://lovelypython.readthedocs.org/en/latest/)
* [Python 2.7 官方教程中文版](http://www.pythondoc.com/pythontutorial27/index.html)
* [Python 3.3 官方教程中文版](http://www.pythondoc.com/pythontutorial3/index.html)
* [Python Cookbook 中文版](http://www.kancloud.cn/thinkphp/python-cookbook)
* [Python3 Cookbook 中文版](https://github.com/yidao620c/python3-cookbook)
* [深入 Python](http://www.kuqin.com/docs/diveintopythonzh-cn-5.4b/html/toc/)
* [深入 Python 3](http://old.sebug.net/paper/books/dive-into-python3/)
* [PEP8 Python代码风格规范](https://code.google.com/p/zhong-wiki/wiki/PEP8)
* [Google Python 风格指南 中文版](http://zh-google-styleguide.readthedocs.org/en/latest/google-python-styleguide/)
* [Python入门教程](http://liam0205.me/2013/11/02/Python-tutorial-zh_cn/) ([PDF](http://liam0205.me/attachment/Python/The_Python_Tutorial_zh-cn.pdf))
* [笨办法学 Python](http://old.sebug.net/paper/books/LearnPythonTheHardWay/) ([PDF](http://liam0205.me/attachment/Python/PyHardWay/Learn_Python_The_Hard_Way_zh-cn.pdf) [EPUB](https://www.gitbook.com/download/epub/book/wizardforcel/lpthw))
* [Python自然语言处理中文版](http://pan.baidu.com/s/1qW4pvnY)
* [Python 绘图库 matplotlib 官方指南中文翻译](http://liam0205.me/2014/09/11/matplotlib-tutorial-zh-cn/)
* [Scrapy 0.25 文档](http://scrapy-chs.readthedocs.org/zh_CN/latest/)
* [ThinkPython](https://github.com/carfly/thinkpython-cn)
* [ThinkPython 2ed](https://github.com/bingjin/ThinkPython2-CN)
* [Python快速教程](http://www.cnblogs.com/vamei/archive/2012/09/13/2682778.html)
* [Python 正则表达式操作指南](http://wiki.ubuntu.org.cn/Python正则表达式操作指南)
* [python初级教程：入门详解](http://www.crifan.com/files/doc/docbook/python_beginner_tutorial/release/html/python_beginner_tutorial.html)
* [Twisted 与异步编程入门](https://www.gitbook.com/book/likebeta/twisted-intro-cn/details)
* [TextGrocery 中文 API](http://textgrocery.readthedocs.org/zh/latest/index.html)
* [Requests: HTTP for Humans](http://requests-docs-cn.readthedocs.org/zh_CN/latest/)
* [Pillow 中文文档](http://pillow-cn.readthedocs.org/en/latest/#)
* [PyMOTW 中文版](http://pymotwcn.readthedocs.org/en/latest/index.html)
* [Python 官方文档中文版](http://data.digitser.net/zh-CN/python_index.html)
* [Fabric 中文文档](http://fabric-chs.readthedocs.org)
* [Beautiful Soup 4.2.0 中文文档](http://beautifulsoup.readthedocs.org/zh_CN/latest/)
* [Python 中的 Socket 编程](https://legacy.gitbook.com/book/keelii/socket-programming-in-python-cn/details)
* [用Python做科学计算](https://docs.huihoo.com/scipy/scipy-zh-cn/index.html)
* [Sphinx 中文文档](http://www.pythondoc.com/sphinx/index.html)
* [精通 Python 设计模式](https://github.com/cundi/Mastering.Python.Design.Patterns)
* [python 安全编程教程](https://github.com/smartFlash/pySecurity)
* [程序设计思想与方法](https://www.gitbook.com/book/wizardforcel/sjtu-cs902-courseware/details)
* [知乎周刊·编程小白学Python](https://read.douban.com/ebook/16691849/)
* [Scipy 讲义](https://github.com/cloga/scipy-lecture-notes_cn)
* [Python 学习笔记 基础篇](http://www.kuqin.com/docs/pythonbasic.html)
* [Python 学习笔记 模块篇](http://www.kuqin.com/docs/pythonmodule.html)
* [Python 标准库 中文版](http://old.sebug.net/paper/books/python/%E3%80%8APython%E6%A0%87%E5%87%86%E5%BA%93%E3%80%8B%E4%B8%AD%E6%96%87%E7%89%88.pdf)
* [Python进阶](https://www.gitbook.com/book/eastlakeside/interpy-zh/details)
* [Python 核心编程 第二版](https://wizardforcel.gitbooks.io/core-python-2e/content/)
* [Python最佳实践指南](http://pythonguidecn.readthedocs.io/zh/latest/)
* [Python 精要教程](https://www.gitbook.com/book/wizardforcel/python-essential-tutorial/details)
* [Python 量化交易教程](https://www.gitbook.com/book/wizardforcel/python-quant-uqer/details)
* [Python黑魔法手册](https://magic.iswbm.com/preface.html)
* Django
* [Django 1.5 文档中文版](http://django-chinese-docs.readthedocs.org/en/latest/) 正在翻译中
* [Django 2.0 文档中文版](https://docs.djangoproject.com/zh-hans/2.0/)
* [Django 最佳实践](https://github.com/yangyubo/zh-django-best-practices)
* [Django 2.1 搭建个人博客教程](https://www.dusaiphoto.com/article/detail/2/) ( 编写中 )
* [Django搭建简易博客教程](https://www.gitbook.com/book/andrew-liu/django-blog/details)
* [The Django Book 中文版](http://djangobook.py3k.cn/2.0/)
* [Django 设计模式与最佳实践](https://github.com/cundi/Django-Design-Patterns-and-Best-Practices)
* [Django 网站开发 Cookbook](https://github.com/cundi/Web.Development.with.Django.Cookbook)
* [Django Girls 學習指南](https://www.gitbook.com/book/djangogirlstaipei/django-girls-taipei-tutorial/details)
* Flask
* [Flask 文档中文版](http://docs.jinkan.org/docs/flask/)
* [Jinja2 文档中文版](http://docs.jinkan.org/docs/jinja2/)
* [Werkzeug 文档中文版](http://werkzeug-docs-cn.readthedocs.org/zh_CN/latest/)
* [Flask之旅](http://spacewander.github.io/explore-flask-zh/)
* [Flask 扩展文档汇总](https://www.gitbook.com/book/wizardforcel/flask-extension-docs/details)
* [Flask 大型教程](http://www.pythondoc.com/flask-mega-tutorial/index.html)
* [SQLAlchemy 中文文档](http://docs.jinkan.org/docs/flask-sqlalchemy/)
* [Flask 入门教程](https://read.helloflask.com)
* web.py
* [web.py 0.3 新手指南](http://webpy.org/tutorial3.zh-cn)
* [Web.py Cookbook 简体中文版](http://webpy.org/cookbook/index.zh-cn)
* Tornado
* [Introduction to Tornado 中文翻译](http://demo.pythoner.com/itt2zh/index.html)
* [Tornado源码解析](http://www.nowamagic.net/academy/detail/13321002)
* [Tornado 4.3 文档中文版](https://tornado-zh.readthedocs.org/zh/latest/)
[返回目录](#目录)
## R
* [R语言忍者秘笈](https://github.com/yihui/r-ninja)
* [R语言教程](https://www.math.pku.edu.cn/teachers/lidf/docs/Rbook/html/_Rbook/index.html)
[返回目录](#目录)
## Ruby
* [Ruby 风格指南](https://github.com/JuanitoFatas/ruby-style-guide/blob/master/README-zhCN.md)
* [Rails 风格指南](https://github.com/JuanitoFatas/rails-style-guide/blob/master/README-zhCN.md)
* [笨方法學 Ruby](http://lrthw.github.io/)
* [Ruby on Rails 指南](http://guides.ruby-china.org/)
* [Ruby on Rails 實戰聖經](https://ihower.tw/rails4/index.html)
* [Ruby on Rails Tutorial 原书第 3 版](http://railstutorial-china.org/)
* [Rails 实践](http://rails-practice.com/content/index.html)
* [Rails 5 开发进阶(Beta)](https://www.gitbook.com/book/kelby/rails-beginner-s-guide/details)
* [Rails 102](https://www.gitbook.com/book/rocodev/rails-102/details)
* [编写Ruby的C拓展](https://wusuopu.gitbooks.io/write-ruby-extension-with-c/content/)
* [Ruby 源码解读](https://ruby-china.org/topics/22386)
* [Ruby中的元编程](http://deathking.github.io/metaprogramming-in-ruby/)
[返回目录](#目录)
## Rust
* [Rust编程语言 中文翻译](https://kaisery.github.io/trpl-zh-cn/)
* [通过例子学 Rust 中文版](https://rustwiki.org/zh-CN/rust-by-example/)
* [Rust Primer](https://github.com/rustcc/RustPrimer)
[返回目录](#目录)
## Scala
* [Scala课堂](http://twitter.github.io/scala_school/zh_cn/index.html) (Twitter的Scala中文教程)
* [Effective Scala](http://twitter.github.io/effectivescala/index-cn.html)(Twitter的Scala最佳实践的中文翻译)
* [Scala指南](http://zh.scala-tour.com/)
[返回目录](#目录)
## Shell
* [Shell脚本编程30分钟入门](https://github.com/qinjx/30min_guides/blob/master/shell.md)
* [Bash脚本15分钟进阶教程](http://blog.sae.sina.com.cn/archives/3606)
* [Linux工具快速教程](https://github.com/me115/linuxtools_rst)
* [shell十三问](https://github.com/wzb56/13_questions_of_shell)
* [Shell编程范例](https://www.gitbook.com/book/tinylab/shellbook/details)
* [Linux命令搜索引擎](https://wangchujiang.com/linux-command/)
[返回目录](#目录)
## Swift
* [The Swift Programming Language 中文版](http://numbbbbb.github.io/the-swift-programming-language-in-chinese/)
* [Swift 语言指南](http://dev.swiftguide.cn)
* [Stanford 公开课，Developing iOS 8 Apps with Swift 字幕翻译文件](https://github.com/x140yu/Developing_iOS_8_Apps_With_Swift)
* [C4iOS - COSMOS](http://c4ios.swift.gg)
[返回目录](#目录)
## 读书笔记及其它
* [编译原理（紫龙书）中文第2版习题答案](https://github.com/fool2fish/dragon-book-exercise-answers)
* [把《编程珠玑》读薄](http://hawstein.com/2013/08/11/make-thiner-programming-pearls/)
* [Effective C++读书笔记](https://github.com/XiaolongJason/ReadingNote/blob/master/Effective%20C%2B%2B/Effective%20C%2B%2B.md)
* [Golang 学习笔记、Python 学习笔记、C 学习笔记](https://github.com/qyuhen/book) (PDF)
* [Jsoup 学习笔记](https://github.com/code4craft/jsoup-learning)
* [学习笔记: Vim、Python、memcached](https://github.com/lzjun567/note)
* [图灵开放书翻译计划--C++、Python、Java等](http://www.ituring.com.cn/activity/details/2004)
* [蒂姆·奥莱利随笔](http://g.yeeyan.org/books/2095)
* [SICP 解题集](http://sicp.readthedocs.org/en/latest/)
* [精彩博客集合](https://github.com/hacke2/hacke2.github.io/issues/2)
* [中文文案排版指北](https://github.com/sparanoid/chinese-copywriting-guidelines)
* [Standard C 语言标准函数库速查 (Cheat Sheet)](http://ganquan.info/standard-c/)
* [Git Cheatsheet Chs](http://gh.amio.us/git-cheatsheet-chs/)
* [GitBook简明教程](http://www.chengweiyang.cn/gitbook/index.html)
* [制造开源软件](http://producingoss.com/zh/)
* [提问的智慧](http://www.dianbo.org/9238/stone/tiwendezhihui.htm)
* [Markdown 入门参考](https://github.com/LearnShare/Learning-Markdown)
* [AsciiDoc简明指南](https://github.com/stanzgy/wiki/blob/master/markup/asciidoc-guide.asciidoc)
* [背包问题九讲](http://love-oriented.com/pack/)
* [老齐的技术资料](https://github.com/qiwsir/ITArticles)
* [前端技能汇总](https://github.com/JacksonTian/fks)
* [借助开源项目，学习软件开发](https://github.com/zhuangbiaowei/learn-with-open-source)
* [前端工作面试问题](https://github.com/h5bp/Front-end-Developer-Interview-Questions/tree/master/Translations/Chinese)
* [leetcode/lintcode题解/算法学习笔记](https://www.gitbook.com/book/yuanbin/algorithm/details)
* [前端开发笔记本](https://github.com/li-xinyang/FEND_Note)
* [LeetCode题解](https://siddontang.gitbooks.io/leetcode-solution/content/)
* [《不可替代的团队领袖培养计划》](https://leader.js.cool/#/)
[返回目录](#目录)
PS：上面只是列举了一部分的资料，具体可以获取后查看。这些资料来源于网上，这里分享仅用作分享学习，不做任何商业用途。如有侵权，请及时联系我去删除。资源搜集非常不易，并且这些资源都是经过我认真筛选和整理的，质量都是可以保证的，有些是我看过的，有些虽然没看过，但全都是业内公认的经典中的经典，现在全部免费送给大家。希望在座的读者，以后都能成为技术大牛！
<p align="center"><img src="https://img-blog.csdnimg.cn/4fb8abb0b4e24404921e39ae11157946.png" alt="计算机经典电子书大全" /></p>
后续还会有上千本编程开发电子书分享，正在整理中，欢迎持续关注
最近很多小伙伴找我要一些程序员必备资料，于是我翻出了压箱底的宝藏，免费分享给大家！扫描下方二维码免费获取。
更多分享
---------
| 微信进群 | 公众号 | 小程序 |
| :----------------------------------------------------------: | :----------------------------------------------------------: | :----------------------------------------------------------: |
| <img src="https://mp-3e73bec6-149b-4708-9012-341df2257774.cdn.bspapp.com/cloudstorage/f9e15db8-168e-47a4-8ea2-114c8908524b.jpg" width="158" height="158" /> | <img src="https://mp-3e73bec6-149b-4708-9012-341df2257774.cdn.bspapp.com/cloudstorage/f9e15db8-168e-47a4-8ea2-114c8908524b.jpg" width="158" height="158" alt="" /> | <img src="https://mp-3e73bec6-149b-4708-9012-341df2257774.cdn.bspapp.com/cloudstorage/a4004598-c0e3-4fab-a3f6-4ec3d41c174b.jpg" width="158" height="158" alt="小程序"/> |
| DreamCoders | DreamCoders | DreamCoders |
> 欢迎持续关注，会不定期更新～
| 程序员免费编程书籍资源汇总，不定期分享编程开发相关的编程书籍、技术文章、学习资源、实用软件、互联网相关技术等。供各位小伙伴们学习参考，同时也方便自己提升，欢迎 Watch、Star。 | android,books,golang,ios,java,javascript,lua,pdf,php,programming-language | 2023-05-30T00:25:24Z | 2023-06-03T08:43:23Z | null | 1 | 0 | 15 | 0 | 14 | 46 | null | null | null |
dbushell/sveltekit-adapter-deno | main | # sveltekit-adapter-deno
[Adapter](https://kit.svelte.dev/docs/adapters) for [SvelteKit](https://kit.svelte.dev/) apps that generates a standalone [Deno](https://deno.com/runtime) or [Deno Deploy](https://deno.com/deploy) server.
## Usage
Install in your SvelteKit project:
```sh
npm install --save-dev sveltekit-adapter-deno
```
Add the adapter to your [SvelteKit configuration](https://kit.svelte.dev/docs/configuration).
```js
// svelte.config.js
import adapter from 'sveltekit-adapter-deno';
/** @type {import('@sveltejs/kit').Config} */
const config = {
kit: {
adapter: adapter()
}
};
export default config;
```
Build the app for production (`npm run build`).
Serve with Deno from the build directory:
```sh
deno run --allow-env --allow-read --allow-net mod.ts
```
For Deno Deploy set the entry point to `mod.ts`.
See the [GitHub Action workflow](/.github/workflows/ci.yml) for automated deployment.
Using [deployctl](https://deno.com/deploy/docs/deployctl):
```
deployctl deploy --project=demo --import-map=import_map.json mod.ts
```
## Adapter options
See the [TypeScript definition](/index.d.ts) for `AdapterOptions`. You can specify the build output directory and provide additional esbuild options.
## Node and NPM modules
Import Node modules in server routes with the `node:` prefix:
```js
import * as fs from 'node:fs';
import {Buffer} from 'node:buffer';
```
Import NPM modules as if coding for Node:
```js
import slugify from '@sindresorhus/slugify';
console.log(slugify('I ♥ Deno'));
```
## Demo App
This repo publishes a SvelteKit demo app to Deno Deploy at:
[sveltekit-adapter-deno.deno.dev](https://sveltekit-adapter-deno.deno.dev/)
* * *
[MIT License](/LICENSE) | Copyright © 2023 [David Bushell](https://dbushell.com)
| 🦕 SvelteKit Adapter for Deno and Deno Deploy | deno,deno-deploy,javascript,svelte,sveltekit,typescript | 2023-05-25T11:14:27Z | 2024-01-02T10:17:31Z | null | 1 | 0 | 35 | 3 | 1 | 44 | null | MIT | TypeScript |
CanadaHonk/test262.fyi | main | # test262.fyi
Independent daily [test262](https://github.com/tc39/test262) (standard test suite) runner for *many* JS engines (test262.report spiritual successor). WIP.
## Engines
- [X] V8 <small>[site](https://v8.dev)</small> <small>[source](https://chromium.googlesource.com/v8/v8.git)</small>
- [X] SpiderMonkey <small>[site](https://spidermonkey.dev)</small> <small>[source](https://hg.mozilla.org/mozilla-central/file/tip/js)</small>
- [X] JavaScriptCore <small>[source](https://github.com/WebKit/WebKit/tree/main/Source/JavaScriptCore)</small>
- [X] ChakraCore <small>[source](https://github.com/chakra-core/ChakraCore)</small>
- [X] Hermes <small>[site](https://hermesengine.dev)</small> <small>[source](https://github.com/facebook/hermes)</small>
- [X] LibJS <small>[site](https://libjs.dev)</small> <small>[source](https://github.com/SerenityOS/serenity/tree/master/Userland/Libraries/LibJS)</small>
- [X] engine262 <small>[site](https://engine262.js.org)</small> <small>[source](https://github.com/engine262/engine262)</small>
- [X] GraalJS <small>[source](https://github.com/oracle/graaljs)</small>
- [X] QuickJS <small>[site](https://bellard.org/quickjs/)</small> <small>[source](https://github.com/facebook/hermes)</small>
- [X] XS <small>[site](https://www.moddable.com/)</small> <small>[source](https://github.com/Moddable-OpenSource/moddable)</small>
- [X] Rhino <small>[site](https://mozilla.github.io/rhino/)</small> <small>[source](https://github.com/mozilla/rhino)</small>
- [X] Nashorn <small>[site](https://openjdk.org/projects/nashorn/)</small> <small>[source](https://github.com/openjdk/nashorn)</small>
- [X] Boa <small>[source](https://github.com/boa-dev/boa)</small>
- [X] Kiesel <small>[site](https://kiesel.dev)</small> <small>[source](https://codeberg.org/kiesel-js/kiesel)</small>
- [X] porffor <small>[site](https://porffor.goose.icu)</small> <small>[source](https://github.com/CanadaHonk/porffor)</small>
- Request more in GitHub issues!
### Transpilers
- [X] Babel (old Node and Babel + core-js)
- [X] SWC (old Node and SWC + core-js)
- [X] Sucrase (old Node and SWC + core-js)
### Engine variants
- [X] V8 with experimental opts (--harmony etc)
- [X] SM with experimental opts
- [ ] Stable versions of engines
## Features to do
- Preview test262 PRs (changes only)
- Data/graph over time
- Diff individual engines(/runs)
- Lookup JS runtime version -> JS engine version (Node, Deno, Bun, etc)
- Measure times for each test, have "result view" and "time view"
## Local build
> **Note**:
> You need a GitHub API token (PAT) in your env as `GITHUB_TOKEN`
1. Clone repo
2. Run `scripts/downloadOldResults.mjs` and `scripts/extractResults.sh` (downloads results from latest build)
3. `node site/generate.mjs` (might take a minute or two)
4. Start a HTTP server in `site` and open it in your browser
| Daily runner of test262 for many engines | ecmascript,javascript,standards,test262,tc39,tests | 2023-06-02T21:11:35Z | 2024-05-02T00:14:09Z | null | 6 | 17 | 392 | 20 | 7 | 42 | null | MIT | JavaScript |
ikennaezef/beatbox_music_app | master | # BeatBox Music 🎵
### ✨ [Live Demo](https://beatbox-music.vercel.app)
## Overview
BeatBox is a music app where users can listen to music, save music to their accounts and also create awesome playlists.
## Technologies Used
Built on the MERN Stack with `NodeJs` `ReactJs` `Express` `Chakra UI` `Redux Toolkit` and `MongoDB` for Database Management and storage.
## Author
👤 **Ikenna Eze** <br/>
Leave a ⭐️ If you like this project!
- Website: https://ikennaezef.netlify.app
## Screenshot
| Music application built on the MERN stack | chakra-ui,express,mern,nodejs,reactjs,redux-toolkit,fullstack,javascript | 2023-06-08T13:19:22Z | 2023-06-09T11:02:38Z | null | 1 | 0 | 48 | 2 | 3 | 42 | null | null | JavaScript |
akashusr/assignment-solution-batch-2 | master |
[![Youtube][youtube-shield]][youtube-url]
[![Facebook][facebook-shield]][facebook-group-url]
<!-- PROJECT LOGO -->
<br />
<p align="center">
<img src="https://avatars.githubusercontent.com/u/73503432?v=4" alt="Logo" width="80" height="80" />
<h3 align="center "><a href="https://learnwithsumit.com/courses/think-in-a-redux-way/introduction" target="_blank" >THINK IN A REDUX WAY</a></h3>
</p>
<!-- description -->
# Assignment-Solution-Batch-2
This is the assignment solution for the Think in a Redux way course. You can locate the solutions for the assignments using the naming convention "assignment-1" and "assignment-2".
<!-- CONTACT -->
## Contact us
[![Facebook][facebook-shield]][facebook-url]
[![LinkedIn][linkedin-shield]][linkedin-url]
[![Instagram][instagram-shield]][instagram-url]
[![mail][mail-shield]][mail-url]
<!-- MARKDOWN LINKS & IMAGES -->
[youtube-shield]: https://img.shields.io/badge/-Youtube-black.svg?style=flat-square&logo=youtube&color=555&logoColor=white
[youtube-url]: https://youtube.com/LearnwithSumit
[facebook-shield]: https://img.shields.io/badge/-Facebook-black.svg?style=flat-square&logo=facebook&color=555&logoColor=white
[facebook-url]: https://facebook.com/letslearnwithsumit
[facebook-group-url]: https://facebook.com/groups/learnwithsumit
[instagram-shield]: https://img.shields.io/badge/-Instagram-black.svg?style=flat-square&logo=instagram&color=555&logoColor=white
[instagram-url]: https://instagram.com/learnwithsumit
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=flat-square&logo=linkedin&colorB=555
[linkedin-url]: https://linkedin.com/company/learnwithsumit
[thumbnail-shield]: https://i.ibb.co/d6hxnvd/Screenshot-50.png
[mail-shield]: https://img.shields.io/badge/%F0%9F%93%A7%20Email-support%40learnwithsumit.com-lightgray
[mail-url]: mailto:support@learnwithsumit.com
[htmlicon-shield]: https://img.icons8.com/external-flaticons-flat-flat-icons/28/undefined/external-html-computer-programming-flaticons-flat-flat-icons.png
| assignment-solution-batch-2. This is the assignment solution for the Think in a Redux way course. You can locate the solutions for the assignments using the naming convention "assignment-1" and "assignment-2". | css3,html5,reactjs,redux,redux-thunk,redux-toolkit,rtk-query,tailewindcss,javascript | 2023-05-31T20:17:09Z | 2023-06-01T11:06:32Z | null | 1 | 0 | 14 | 0 | 23 | 39 | null | null | JavaScript |
namespacecomm/NSCC-BPIT-Website | master | <div id="top"></div>
<h1 align="center"> NSCC BPIT WEBSITE </h1>
<!-- ---------------------------------------------------------------------------------------------------------------------- -->
<div align="center">
</div>
<!-- ---------------------------------------------------------------------------------------------------------------------- -->
<p align="center">
<strong> A beginner-friendly project to help you in open source contributions. </strong>
<br>
<br />
<strong> <a href="https://www.nsccbpit.tech/">Visit the Official Website » </strong></a>
<br />
<a href="https://github.com/NSCC-BPIT/NSCC-BPIT-Website/issues/new?assignees=&labels=bug%2CPriority-High%2Cwant+fix%2CReview+Required&template=bug_report.yml&title=%5BBug%5D%3A+">Report Bug</a>
·
<a href="https://github.com/NSCC-BPIT/NSCC-BPIT-Website/issues/new?assignees=&labels=documentation%2Cenhancement%2Cgood+first+issue&template=doc_report.yml&title=%5BDoc%5D%3A+">Documentation Request</a>
.
<a href="https://github.com/NSCC-BPIT/NSCC-BPIT-Website/issues/new?assignees=&labels=feature%2CReview+Required&template=feature_request.yml&title=%5BFeature%5D%3A+">Feature Request</a>
</p>
<!-- ---------------------------------------------------------------------------------------------------------------------- -->
<!-- TABLE OF CONTENTS -->
### 📌Table of Contents :
- [What is Open Source?](#What-is-Open-Source?)
- [Open Source programs this repo has been part of](#Open-Source-programs-this-repo-has-been-part-of)
- [Overview of Project](#Overview-of-Project)
- [Tech Stacks used](#Tech-Stacks-used)
- [Key Features](#Key-Features)
- [Screenshots of Website](#Screenshots-of-Websites)
- [Contribution Guidelines](#Contribution-Guidelines)
- [Usage](#Usage)
- [Contributors](#Contributors)
- [Github Beginner Guide](#Github-Beginner-Guide)
- [Feedback](#Feedback)
<p align="right">(<a href="#Bottom">Bottom</a>)</p>
<br>
<!-- ------------------------------------------------------------------------------------------------------------------------------------------------------------- -->
## What is Open Source?
<p align="center"> The open source community provides a great opportunity for aspiring programmers to distinguish themselves; and by contributing to various projects, developers can improve their skills and get inspiration and support from like-minded people. When you contribute to something you already know and love, it can have so much more meaning, because you know how the tool is used and the good it does for you. Being part of an open source community opens you up to a broader range of people to interact with.
Read more about it <a href="https://www.digitalocean.com/community/tutorial_series/an-introduction-to-open-source"> here. </a>
</p>
<p align="right">(<a href="#top">back to top</a>)</p>
<!-- -------------------------------------------------------------------------------------------------------------------------------------------------- -->
## Open Source programs this repo has been part of
<a href="https://github.com/NSCC-BPIT/NSCC-BPIT-Website"><img src="https://badges.frapsoft.com/os/v2/open-source.svg?v=103"></a>
<div align="center">
<img src="https://miro.medium.com/v2/resize:fit:1400/0*McOGR_vW3LivYNor.png" width="500px">
</div>
<div align="center">
<a href="https://hacktoberfest.com/">HACTOBERFEST 2023</a>
</div>
<br>
<br>
<p align="right">(<a href="#top">back to top</a>)</p>
<!-- .............................................................................................................................................-->
<!-- ABOUT THE PROJECT -->
## Overview of Project
<p align="center"> The goal of this project is to help beginners with their contributions to Open Source. We aim to achieve this collaboratively, so feel free to contribute in any way you want, just make sure to follow the contribution guidelines.
</p>
<!-- ............................................................................................................................................. -->
### Tech Stacks used
<!-- -------------------------------------------------------------------------------------------------------------------------------------------------- -->
<!-- ------------------------------------------------------------------------------------------------------------------------------------------------------------- -->
### Screenshots of Website
# 
# 
# 
# 
# 
# 
# 
# 
<p align="right">(<a href="#top">back to top</a>)</p>
<!-- ------------------------------------------------------------------------------------------------------------------------------------------------------------- -->
## Contribution Guidelines
<a href="https://github.com/NSCC-BPIT/NSCC-BPIT-Website"><img src="https://img.shields.io/static/v1.svg?label=Contributions&message=Welcome&color=royalblue"></a>
<a href="https://github.com/NSCC-BPIT/NSCC-BPIT-Website"><img src="https://img.shields.io/github/contributors/NSCC-BPIT/NSCC-BPIT-Website?color=royalblue&style=flat-square"></a>
<a href="https://github.com/NSCC-BPIT/NSCC-BPIT-Website"><img src="https://img.shields.io/badge/Maintained%3F-yes-brightgreen.svg?color=royalblue&style=flat-square"></a>
#### 🔑Guidelines
Here are some set of guidelines to follow while contributing to `NSCC_BPIT_WEBSITE` :
```
1. Welcome to this repository, if you are here as an open-source program participant/contributor.
2. Participants/contributors have to **comment** on issues they would like to work on, and mentors or the PA will assign you.
3. Issues will be assigned on a **first-come, first-serve basis.**
4. Participants/contributors can also **open their issues**, but it needs to be verified and labelled by a mentor. We respect all your contributions, whether
it is an Issue or a Pull Request.
5. When you raise an issue, make sure you get it assigned to you before you start working on that project.
6. Each participant/contributor will be **assigned 1 issue (max)** at a time to work.
7. Don't create issues that are **already listed**.
8. Please don't pick up an issue already assigned to someone else. Work on the issues after it gets **assigned to you**.
9. Create your file in an appropriate folder with appropriate name and extension.
10. Pull requests will be merged after being **reviewed** by maintainers.
11. We all are here to learn. You are allowed to make mistakes. That's how you learn, right!.
```
### How to Contribute:
- Before Contribute Please read [CONTRIBUTING.md](https://github.com/NSCC-BPIT/NSCC-BPIT-Website/blob/master/CONTRIBUTING.md) and [CODE_OF_CONDUCT.md](https://github.com/NSCC-BPIT/NSCC-BPIT-Website/blob/master/CODE_OF_CONDUCT.md)
- Fork the repo to your Github.<br/>
- Clone the Forked Repository to your local machine.
```
git clone https://github.com/<username>/NSCC-BPIT-Website.
```
- Change the directory to NSCC-BPIT-Website.
```bash
cd NSCC-BPIT-Website
```
- Add remote to the Original Repository.
```
git remote add upstream https://github.com/NSCC-BPIT/NSCC-BPIT-Website
```
- Check the remotes for this repository.
```
git remote -v
```
- Always take a pull from the upstream repository to your master branch to keep it at par with the main project(updated repository).
```
git pull upstream main
```
- Create a new branch.
```
git checkout -b <your_branch_name>
```
- Perform your desired changes to the code base.
- Track your changes:heavy_check_mark: .
```
git add .
```
- Commit your changes .
```
git commit -m "Relevant message"
```
- Push the committed changes in your feature branch to your remote repo.
```
git push -u origin <your_branch_name>
```
- To create a pull request, click on `compare and pull requests`. Please ensure you compare your feature branch to the desired branch of the repository you are supposed to make a PR to.
- Add appropriate title and description to your pull request explaining your changes and efforts done.
- Click on `Create Pull Request`.
- Voila! You have made a PR to this repo. Sit back patiently and relax while your PR is reviewed
<p align="right">(<a href="#top">back to top</a>)</p>
<!-- ------------------------------------------------------------------------------------------------------------------------------------------------------------- -->
### Install dependencies
```
cd NSCC-BPIT-Website
npm install
npm start
```
<p align="right">(<a href="#top">back to top</a>)</p>
<!-- ------------------------------------------------------------------------------------------------------------------------------------------------------------- -->
## Contributors
<div align="center">
<a href="https://github.com/NSCC-BPIT/NSCC-BPIT-Website"><img src="https://forthebadge.com/images/badges/built-by-developers.svg" ></a>
<a href="https://github.com/NSCC-BPIT/NSCC-BPIT-Website"><img src="https://forthebadge.com/images/badges/built-with-love.svg" ></a>
</div>
<br>
<div>
<h1 align="center">
<b>Thanks to these amazing people
<h1>
<a href="https://github.com/NSCC-BPIT/NSCC-BPIT-Website/contributors">
<img src="https://contrib.rocks/image?repo=NSCC-BPIT/NSCC-BPIT-Website&&max=817" />
</a>
</div>
<p align="right">(<a href="#top">back to top</a>)</p>
<!-- ------------------------------------------------------------------------------------------------------------------------------------------------------------------ -->
## Github Beginner Guide
#### Are you a beginner in using Github?
You can refer to the following articles on the basics of Git and Github and also contact me, in case you are stuck:
- [Forking a Repo](https://help.github.com/en/github/getting-started-with-github/fork-a-repo)
- [Cloning a Repo](https://help.github.com/en/desktop/contributing-to-projects/creating-an-issue-or-pull-request)
- [How to create a Pull Request](https://opensource.com/article/19/7/create-pull-request-github)
- [Getting started with Git and GitHub](https://towardsdatascience.com/getting-started-with-git-and-github-6fcd0f2d4ac6)
- [Learn GitHub from Scratch](https://lab.github.com/githubtraining/introduction-to-github)
<p align="right">(<a href="#top">back to top</a>)</p>
<!-- ------------------------------------------------------------------------------------------------------------------------------------------------------------------ -->
## Feedback
If you have any feedback or suggestions please reach out to maintainers.
* [Manan khandelwal](https://github.com/mnnkhndlwl)
* [Pradeepto Sarkar](https://github.com/pradeeptosarkar)
Or you can create a <a href="https://github.com/NSCC-BPIT/NSCC-BPIT-Website/issues/new?assignees=&labels=feature%2CReview+Required&template=feature_request.yml&title=%5BFeature%5D%3A+">issue</a> and mention there , which features can make this Project more good.
<!-- ------------------------------------------------------------------------------------------------------------------------------------------------------------------ -->
<br>
<div align="center">
<h3>Show some ❤️ by starring this awesome repository!</h3>
</div>
### [](https://git.io/typing-svg)
<div id="Bottom"></div>
| Official website of NSCC BPIT. Note: Production is deployed from a private repository not this one. But can be viewed using the official link below | javascript,reactjs,styled-components,tailwindcss,threejs,hacktoberfest-accepted,hacktoberfest,css,html,hacktoberfest2023 | 2023-05-20T15:11:45Z | 2024-05-18T08:15:08Z | null | 80 | 307 | 818 | 3 | 83 | 39 | null | MIT | JavaScript |
I2Djs/pdf-frame | main | <p align="center">
<img src="https://github.com/I2Djs/pdf-frame/blob/main/assets/pdf-frame.svg?raw=true" width=500>
</p>
<h3 align="center">
[www.pdf-frame.org](https://www.pdf-frame.org)
</h3>
# pdf-frame
| Package | version |
| --- | --- |
| [pdf-frame-vue](https://github.com/I2Djs/pdf-frame/tree/main/packages/pdf-frame-vue) | [](https://www.npmjs.com/package/@i2d/pdf-frame-vue) |
| [pdf-frame-nuxt](https://github.com/I2Djs/pdf-frame/tree/main/packages/pdf-frame-nuxt) | [](https://www.npmjs.com/package/@i2d/nuxt-pdf-frame) |
## Introduction
Pdf-frame is a JavaScript web framework for client-side PDF/Canvas rendering. With its declarative HTML syntax and semantics, it offers an easy and efficient way to define PDF/Canvas graphical content. It follows syntax similar to SVG's and provides component support for popular frameworks like Vue, nuxt, and React(work in progress). Powered by [i2djs](https://github.com/I2Djs/I2Djs), PDF-frame presently supports rendering outputs as PDF and Canvas formats.
## Features
* **Declarative Syntax:** Easily define PDF/Canvas graphical content using a clear and declarative syntax.
* **SVG-like Syntax and Semantics:** Adopts the familiar SVG tag and attribute syntax for defining geometrical shapes.
* **Consistent Rendering:** Provides the same syntax and semantics for rendering both PDF and Canvas outputs.
* **Auto Pagination:** Content overflow is taken care by the engine by spawning new pages, ensuring the document's integrity and readability.
* **Multi-page Support:** Create multi-page PDF documents seamlessly.
* **Animations & Events:** Easy way to define the animations and events on elements in canvas context.
* Framework component support: Vue, nuxt.
## Blogs:
* [Creating visually rich PDFs with PDF-Frame-Vue](https://nswamy14.hashnode.dev/creating-visually-rich-pdfs-with-pdf-frame-vue)
* [Simplifying PDF Rendering in Vue with PDF-Frame-Vue](https://nswamy14.hashnode.dev/pdf-rendering-made-easy-with-pdf-frame-vue)
### Canvas Template
```html
<pdfFrame type="canvas" width="595" height="841">
<i-g :transform="{ translate: [100, 200], scale: [2, 3], rotate: [ 45, 0, 0] }">
<i-text :x="30" :y="60" :text="'Page 1 Title'" :width="530" :style="{font: '25px Arial', align: 'center'}"></i-text>
<i-rect :x="30" :y="100" :width="535" :height="700" :style="{ fillStyle:'#f0f0f0' }"></i-rect>
<i-image src="src/assets/i2d-frame.svg" :width="200" :x="175" :y="100"></i-image>
</i-g>
</pdfFrame>
```
### PDF Basic Template
```html
<pdfFrame type="pdf" width="595" height="841">
<i-g :transform="{ translate: [100, 200], scale: [2, 3], rotate: [ 45, 0, 0] }">
<i-text :x="30" :y="60" :text="'Page 1 Title'" :width="530" :style="{font: '25px Arial', align: 'center'}"></i-text>
<i-rect :x="30" :y="100" :width="535" :height="700" :style="{ fillStyle:'#f0f0f0' }"></i-rect>
<i-image src="src/assets/i2d-frame.svg" :width="200" :x="175" :y="100"></i-image>
</i-g>
</pdfFrame>
```
### Multi-Page PDF Template
```html
<pdfFrame type="pdf" width="595" height="841">
<!-- Page Templates -->
<i-page-template id="temp-1">
<i-rect :x="0" :y="0" :width="595" :height="841" :style="{ fillStyle:'#ffffff' }"></i-rect>
<i-text :x="30" :y="30" :text="'Header Text'" :width="530" :style="{font: '15px Arial'}"></i-text>
<i-text :x="30" :y="810" :text="'Footer Text'" :width="530" :style="{font: '15px Arial'}"></i-text>
</i-page-template>
<!-- Page 1 -->
<i-page p-template="temp-1">
<i-g :transform="{ translate: [100, 200], scale: [2, 3], rotate: [ 45, 0, 0] }">
<i-text :x="30" :y="60" :text="'Page 1 Title'" :width="530" :style="{font: '25px Arial', align: 'center'}"></i-text>
<i-rect :x="30" :y="100" :width="535" :height="700" :style="{ fillStyle:'#f0f0f0' }"></i-rect>
</i-g>
</i-page>
<!-- Page 2 -->
<i-page p-template="temp-1">
<i-text :x="30" :y="60" :text="'Page 2 Title'" :width="530" :style="{font: '25px Arial', align: 'center'}"></i-text>
<i-image src="src/assets/i2d-frame.svg" :width="200" :x="175" :y="100"></i-image>
</i-page>
</pdfFrame>
```
## Contributing
Contributions are welcome! If you would like to contribute to pdf-frame, please follow the guidelines in CONTRIBUTING.md.
## License
This project is licensed under the MIT License. See the [LICENSE](https://raw.githubusercontent.com/I2Djs/pdf-frame/main/LICENSE) file for more details.
## Contact
For any inquiries or support, please contact `narayanaswamy14@gmail.com`.
| pdf-frame is a web framework designed specifically for handling PDF and Canvas graphics requirements. It provides component support for popular frameworks like Vue, Nuxt and React. With its declarative HTML syntax and semantics, it offers a straightforward way to define PDF/Canvas graphical content efficiently. | pdf,vuejs,canvas,nuxtjs,animation,data-visualization,javascript,nuxtjs-template,pdf-generator,visualizations | 2023-05-30T17:17:01Z | 2024-05-01T05:03:44Z | 2024-04-05T19:00:07Z | 1 | 10 | 194 | 1 | 5 | 39 | null | MIT | Vue |
Parana-Games/tinymo | main | null | Programmatic interface for DynamoDB (TypeScript) | aws,aws-lambda,aws-sdk,dynamodb,javascript,node,nodejs,npm-package,tiny,typescript | 2023-06-08T22:29:36Z | 2024-01-03T11:00:46Z | null | 3 | 0 | 28 | 0 | 2 | 36 | null | Apache-2.0 | TypeScript |
Hanieh-Sadeghi/Draw-Verse | Hanieh | <h1>Art Canvas </h1>
<p>
the implemented digital painting is built using
HTML, CSS, and JavaScript. In this painting, you will be able to utilize
various tools such as a brush, eraser, color picker, and brush width adjustment.
Additionally, you can save color settings and also save the image of your artwork.
This code draws colored lines on an HTML5 canvas using mouse events and form controls in JavaScript.
</p>
<p>
<img src="./img/img1.png" width="350" height="200" />
<img src="./img/img2.png" width="350" height="200" />
</p>
<h2>Features</h2>
<ul>
<li>
<p>
<strong>Eraser :</strong> If you want to delete a line or make corrections, the eraser functionality enables you to remove specific parts of the drawing. You can use it to erase lines or areas that need to be modified.
</p>
</li>
<li>
<p>
<strong>Color selection:</strong> You can choose your desired color for the drawing tool. This feature allows you to use different colors in your artwork and precisely select the preferred color.
</p>
</li>
<li>
<p>
<strong>Brush width :</strong> In this digital painting, you can adjust the width of the brush. This feature enables you to create lines of different thicknesses, adding more variety and detail to your artwork.
</p>
</li>
<li>
<p>
<strong>Save color settings :</strong> A feature that allows you to save 5 color histories and use them.
</p>
</li>
<li>
<p>
<strong>Clear the entire canvas:</strong>This option allows you to remove all the content on the canvas, including lines, drawings, and colors, effectively resetting the canvas for a fresh start.
</p>
</li>
</ul>
<h2>Installation</h2>
<p>To use this Art Canvas, follow the instructions below:</p>
<ol>
<li>
<p>Clone the repository:</p>
<pre><code> https://github.com/Hanieh-Sadeghi/Draw-Verse
</code></pre>
</li>
<li><p>Open the project folder in your preferred code editor.</p></li>
<li>
<p>
Launch the application by opening the
<code>index.html</code> file in a web browser.
</p>
</li>
</ol>
<h2>Technologies Used</h2>
<p>
The following technologies and libraries were used to develop this Art Canvas:
</p>
<ul>
<li>
<strong>HTML</strong>: The standard markup language for creating the
structure and elements of web pages.
</li>
<li>
<strong>CSS</strong>: The style sheet language used for designing the
visual presentation of web pages.
</li>
<li>
<strong>JavaScript</strong>: The programming language that enables
dynamic behavior and interactivity in web applications.
</li>
</ul>
| In summary, the implemented digital painting is built using HTML, CSS, and JavaScript. In this painting, you will be able to utilize various tools such as a brush, eraser, color picker, and brush width adjustment. | css,html5,javascript | 2023-05-29T08:54:40Z | 2023-06-04T10:16:32Z | null | 2 | 6 | 56 | 1 | 1 | 31 | null | null | JavaScript |
nickorzha/threejs-room-planner | main | null | React.js + Three.js 3d room planner | javascript,threejs,reactjs,floorplan,floorplanning | 2023-05-29T15:59:40Z | 2023-03-04T14:55:44Z | null | 1 | 0 | 13 | 5 | 3 | 30 | null | null | HTML |
fityannugroho/idn-area-data | main | <h1 align="">Indonesian Area Data (<i>Data Wilayah Indonesia</i>)</h1>
Provides the administrative areas data of Indonesia (province, regency, district, village, and island) based on the latest official sources.
[](https://www.npmjs.com/package/idn-area-data)
[](https://www.npmjs.com/package/idn-area-data)
[](LICENSE)
[](https://packagephobia.com/result?p=idn-area-data)
## Prerequisite
- [Node.js](https://nodejs.org) (version 18 or higher)
- [npm 9](https://www.npmjs.com) or [yarn](https://yarnpkg.com)
## Upgrading
If you are upgrading from version 2 to version 3, please read the [upgrade guide](docs/upgrading/upgrade-to-v3.md).
## Installation
```bash
npm install --save idn-area-data
```
Use this for **yarn** user :
```bash
yarn add idn-area-data
```
## Usage
Import the package into your project as shown below.
> [!NOTE]
> The following code examples use [top level await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await#top_level_await) to run the asynchronous function. You also can use [IIFE](https://developer.mozilla.org/en-US/docs/Glossary/IIFE), [`.then()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise/then), or run it inside anonther `async` function instead.
### ESM
Import specific function only :
```js
import { getProvinces } from 'idn-area-data';
const provinces = await getProvinces();
```
Import the entire module :
```js
import * as IdnArea from 'idn-area-data';
const provinces = await IdnArea.getProvinces();
```
### CommonJS
Since version 3.0.0, **idn-area-data** is published as ECMAScript Module (ESM). So that, for CommonJS user, you need to import it using [dynamic import](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/import) like this :
```js
const { getProvinces } = await import('idn-area-data');
const provinces = await getProvinces();
```
Then, you can get the data you need using these methods below.
## Methods
### `getProvinces()`
Asynchronous function to get all provinces data.
```js
import { getProvinces } from 'idn-area-data';
const provinces = await getProvinces();
console.log(provinces);
/*
[
{
code: '11',
name: 'ACEH',
},
...
]
*/
```
### `getRegencies(?options)`
Asynchronous function to get all regencies data
```js
import { getRegencies } from 'idn-area-data';
const regencies = await getRegencies();
console.log(regencies);
/*
[
{
code: '11.01',
name: 'KABUPATEN ACEH SELATAN',
province_code: '11',
},
...
]
*/
```
If **`options.transform`** argument is `true`, the property naming will be changed from `snake_case` into **`camelCase`**.
```js
const regencies = await getRegencies({ transform: true });
/*
[
{
code: '11.01',
name: 'KABUPATEN ACEH SELATAN',
provinceCode: '11',
},
...
]
*/
```
### `getDistricts(?options)`
Asynchronous function to get all districts data.
```js
import { getDistricts } from 'idn-area-data';
const districts = await getDistricts();
console.log(districts);
/*
[
{
code: '11.01.01',
name: 'Bakongan',
regency_code: '11.01',
},
...
]
*/
```
If **`options.transform`** argument is `true`, the property naming will be changed from `snake_case` into **`camelCase`**.
```js
const districts = await getDistricts({ transform: true });
/*
[
{
code: '11.01.01',
name: 'Bakongan',
regencyCode: '11.01',
},
...
]
*/
```
### `getVillages(?options)`
Asynchronous function to get all villages data.
```js
import { getVillages } from 'idn-area-data';
const villages = await getVillages();
console.log(villages);
/*
[
{
code: '11.01.01.2001',
district_code: '11.01.01',
name: 'Keude Bakongan',
},
...
]
*/
```
If **`options.transform`** argument is `true`, the property naming will be changed from `snake_case` into **`camelCase`**.
```js
const villages = await getVillages({ transform: true });
/*
[
{
code: '11.01.01.2001',
districtCode: '11.01.01',
name: 'Keude Bakongan',
},
...
]
*/
```
### `getIslands(?options)`
Asynchronous function to get all islands data.
```js
import { getIslands } from 'idn-area-data';
const islands = await getIslands();
console.log(islands);
/*
[
{
code: '11.01.40001',
coordinate: '03°19'03.44" N 097°07'41.73" E',
name: 'Pulau Batukapal',
is_outermost_small: '0',
is_populated: '0',
regency_code: '11.01',
},
...
]
*/
```
If **`options.transform`** argument is `true`, the property naming will be changed from `snake_case` into **`camelCase`** and the data type will be converted (for `boolean` and `number`).
> [!IMPORTANT]
> The `regencyCode` will be **`null`** if the island doesn't belong to any regency and the `transform` option is enabled.
```js
const islands = await getIslands({ transform: true });
/*
[
{
code: '11.01.40001',
coordinate: '03°19'03.44" N 097°07'41.73" E',
name: 'Pulau Batukapal',
isOutermostSmall: false,
isPopulated: false,
regencyCode: '11.01', <-- It will be `null` if the island doesn't belong to any regency
},
...
]
*/
```
### `getData(area, ?options)`
If you need to **customize the attribute names or values of the data** yourself, you can use this asyncronous function and provide the data transformer configuration in `options.transform`.
To customize the attribute names, define the pair between the old attribute and the new attribute in `options.transform.headers`. The old attributes is equals to the CSV headers of each [data](#data).
To customize the attribute values, set the value transformer functions in `options.transform.values`.
See the example below :
```ts
// .ts
import { getData } from 'idn-area-data';
// Define the custom type of the data
type Provinsi = {
kode: number;
nama: string;
};
// Get the data
const data = await getData<Provinsi>('provinces', {
transform: {
headers: {
code: 'kode',
name: 'nama',
},
values: {
code: (value) => parseInt(value),
},
},
});
console.log(data);
/*
[
{
kode: 11,
nama: 'ACEH',
},
...
]
*/
```
```js
// .js
import { getData } from 'idn-area-data';
const data = await getData('provinces', {
transform: {
headers: {
code: 'kode',
name: 'nama',
},
values: {
code: (value) => parseInt(value),
},
},
});
```
## Try it now
You can try to run this package in the code playground :
[](https://codesandbox.io/p/sandbox/idn-area-data-rkievt)
## Motivation
This package is a solution that addresses the limitations of other existing packages, repositories, or sources that provides Indonesian area data. Here's why it's the perfect choice for developers :
1. Up-to-date and Government-Sourced Data
This package ensures that you have access to the most current Indonesian area data. We rely on official government sources, guaranteeing that the information provided is reliable and up-to-date.
1. Seamless Database Integration
This package offers data in a format that seamlessly integrates with various databases. Unlike other sources that provide data solely in SQL query or JSON, this package store the data sources in CSV and use JavaScript to parse it into an array. You can easily insert the data into any database by using database integration tools like [Prisma](https://www.prisma.io), [Sequelize](https://sequelize.org), [node-postgres](https://node-postgres.com), [mongodb](https://github.com/mongodb/node-mongodb-native), etc. This approach ensures compatibility with a wide range of databases.
1. Easy Integration and Minimum Package Size
You just need to install this package as a dependency into your project, just like any other library or module. This package has minimal dependencies on other packages, with the majority of its size being attributed to the data source itself.
## Data
The data we used is based on official data from the government and stored in separated CSV files by the levels in [`data`](data) directory.
> You can see the list of official sources we refer to [here](docs/references.md).
## Problem Reporting
We have different channels for each problem, please use them by following these conditions :
### Reporting a Bug
To report a bug, please open a new issue following the guide [here](CONTRIBUTING.md#submitting-an-issue).
### Requesting a New Feature
If you have a new feature in mind, please open a new issue following the guide [here](CONTRIBUTING.md#submitting-an-issue).
### Asking a Question
If you have a question, you can search for answers in the GitHub Discussions Q&A category [here](https://github.com/fityannugroho/idn-area-data/discussions/categories/q-a). If you don't find a relevant discussion already, you can open a new discussion.
## License
- This package and repository are licensed under the [MIT License](LICENSE).
- All data that included in this package and repository are made available under the [Open Database License](data/LICENSE.md).
These licenses apply to the current and previous versions, and apply to future versions until changed.
## Support This Project
**Give a ⭐️** if this project helped you!
Also please consider supporting this project by **becoming a sponsor**. Your donation will help us to maintain and develop this project and provide you with better support.
| Provides the administrative areas data of Indonesia based on the latest official sources 🇮🇩 | idn-area,data,data-sources,indonesia,javascript,wilayah-indonesia,island,pulau,wilayah,open-data | 2023-06-05T03:34:24Z | 2024-05-09T07:32:21Z | 2024-05-07T07:37:54Z | 1 | 154 | 250 | 0 | 4 | 30 | null | MIT | TypeScript |
Alok-2002/Quizzify | main | # Quiz Web App
This repository contains a Quiz Web App built using HTML, CSS, JavaScript, and the Open Trivia Database. The app allows users to test their knowledge by answering quiz questions from various categories.
## Features
- User-friendly interface for a seamless quiz-taking experience.
- Randomly generated questions from the Open Trivia Database API.
- Multiple-choice questions with instant feedback on answer selection.
- Scoring system to track and display the user's progress.
- Different categories of quizzes to choose from.
## Technologies Used
- HTML: Used to structure the web pages and content.
- CSS: Used for styling and enhancing the visual appearance of the app.
- JavaScript: Implemented the logic and interactivity of the quiz app.
- Open Trivia Database API: Used to fetch quiz questions and categories.
## Getting Started
To get started with the Quiz Web App, follow these steps:
1. Clone the repository:
```
git clone https://github.com/Alok-2002/Quiz_Web_App_Using_HTML_CSS_And_Javascript
```
2. Open the project folder:
```
cd Quiz_Web_App_Using_HTML_CSS_And_Javascript
```
3. Launch the app by opening the `index.html` file in your preferred web browser.
## Usage
1. Select a category for the quiz from the available options.
2. Click the "Start Quiz" button to begin the quiz.
3. Read each question carefully and select the answer you think is correct.
4. Instant feedback will be provided after each answer.
5. Continue answering questions until you reach the end of the quiz.
6. At the end of the quiz, you will be presented with your score and the option to restart or choose a different category.
## Customization
If you wish to customize the app, you can modify the following files:
- `index.html`: Edit the HTML structure of the app and update the UI elements.
- `app.css`: Modify the CSS styles to change the visual appearance.
- `game.js`: Update the JavaScript logic and functionality according to your requirements.
- `game.html`: Edit the HTML structure of the app and update the UI elements.
- `game.css`: Modify the CSS styles to change the visual appearance.
- `end.js`: Update the JavaScript logic and functionality according to your requirements.
- `end.html`: Edit the HTML structure of the app and update the UI elements.
- `highscores.css`: Modify the CSS styles to change the visual appearance.
- `highscores.js`: Update the JavaScript logic and functionality according to your requirements.
- `highscores.html`: Edit the HTML structure of the app and update the UI elements.
## Contributions
Contributions to this Quiz Web App are welcome! If you have any improvements or feature suggestions, feel free to open an issue or submit a pull request. Please make sure to follow the existing code style and guidelines.
## License
This project is licensed under the [MIT License](LICENSE). Feel free to use and modify the code according to the terms of this license.
## Acknowledgements
- The Quiz Web App utilizes the [Open Trivia Database API](https://opentdb.com) for fetching quiz questions.
- Special thanks to the developers and contributors of the libraries and frameworks used in this project.
---
Enjoy using the Quiz Web App! Test your knowledge, challenge your friends, and have fun!
| This repository contains a Quiz Web App built using HTML, CSS, JavaScript, and the Open Trivia Database. The app allows users to test their knowledge by answering quiz questions from various categories. | alok-2002,api,api-integration,back-end-development,css,front-end-development,html,javascript,open-source,open-trivia-database | 2023-05-18T20:31:13Z | 2023-09-04T16:18:11Z | null | 1 | 0 | 25 | 0 | 15 | 29 | null | MIT | HTML |
duolicious/duolicious-frontend | main | # Duolicious Frontend
There's screenshots of the app at https://github.com/duolicious.
## Contributing
There's three ways you can contribute:
1. Tell your friends about Duolicious and share on social media! This is the best way to make it grow.
2. Donate on Ko-fi: https://ko-fi.com/duolicious
3. Raise a pull request. Developer instructions can be found at [DEVELOPER.md](DEVELOPER.md).
| The frontend of the Duolicious dating app | dating,expo,javascript,react-native | 2023-05-27T00:01:14Z | 2024-05-21T21:28:45Z | null | 4 | 178 | 178 | 35 | 11 | 28 | null | AGPL-3.0 | TypeScript |
sksabbirhossain/megamart-ecommerce | main | # Megamart E-commerce Website
Welcome to my React Redux eCommerce website! This project is a full-stack e-commerce solution built with React, Redux, Redux-toolkit and various other technologies. Whether you're a developer looking to contribute, a business owner interested in my platform, or just a curious user, this README will guide you through the essential details of my project.
## Table of Contents
- [Features](#features)
- [Technologies Used](#technologies-used)
- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#license)
## Features
My React Redux megamart eCommerce website features:
- **Product Catalog:** Browse and search for products across various categories.
- **User Authentication:** Register, login, and manage your user profile.
- **Shopping Cart:** Add and remove items from your cart, update quantities, and proceed to checkout.
- **Order Management:** View and manage your order history.
- **Admin Panel:** An admin interface for managing products, categories, and orders.
- **Responsive Design:** A mobile-friendly user interface for a seamless shopping experience on all devices.
- **Payment Integration:** Secure payment processing to complete orders.
## Technologies Used
- **React:** A popular JavaScript library for building user interfaces.
- **Redux:** A state management library for predictable application state.
- **React Router:** For handling navigation within the application. this react router i use (react-router-dom) v6.
- **Node.js:** A JavaScript runtime for building the server-side of the application.
- **Express.js:** A web application framework for building RESTful APIs.
- **Mongoose:** Mongoose is an Object Data Modeling (ODM) library for MongoDB.
- **Stripe:** Payment processing integration for secure transactions.
- **Tailwindcss:** For styling the user interface.
## Installation
To get started with my React Redux eCommerce website, follow these steps:
1. Clone this repository to your local machine using Git.
```bash
git clone https://github.com/sksabbirhossain/megamart-ecommerce.git
```
2. Change to the project directory.
```bash
cd megamart-ecommerce
```
3. Install server dependencies. (recommended use yarn)
```bash
yarn install
```
Or,
```bash
npm install
```
4. Create a `.env` file or rename `.env.dev` to `.env` and add your own configuration based on the provided `.env.dev` file.
5. Start the development server using this command.
```bash
yarn start
```
Or
```bash
npm start
```
6. Access the application in your web browser at `http://localhost:3000`.
## Usage
- Visit the deployed website or run the development server (as described in the installation instructions) to access the application.
- Register an account or log in to start shopping.
- Explore the product catalog, add items to your cart, and complete orders.
If you are an admin, access the admin panel to manage products, categories, and orders.
1. Go to this URL and login as a admin
```bash
http://localhost:3000/admin
```
2. Login your admin account using this information.
```bash
email: admin@gmail.com
password: 1111
```
If your are successfully login as a admin then you can manage everything.
## Contributing
If you have any suggestions on what to improve this website, please make a issue share your ideas and create your pull request.
## License
This project is licensed under the [MIT License](LICENSE.md). Feel free to use, modify, and distribute it as per the terms of the license.
Enjoy your shopping experience with my MegaMart E-commerce website! If you have any questions or encounter any issues, please create a issue or [contact me](https://www.linkedin.com/in/sk-sabbir-hossain/).
## server side code is here.
```bash
https://github.com/sksabbirhossain/megamart-ecommerce-server.git
```
| This is a React and redux e-commerce website with admin dashboard. this a mobile responsive e-commerce website. anyone can contribute in this project. | e-commerce,e-commerce-project,javascript,react,react-hooks,react-router,react-router-dom,react-website,redux-toolkit,web-application | 2023-05-31T12:09:02Z | 2023-12-03T05:24:47Z | 2023-09-21T16:04:13Z | 3 | 4 | 110 | 1 | 16 | 28 | null | MIT | JavaScript |
jankozik/book_purchase | main | # BookTown
BookTown is a fully functional website for purchasing books. It was created using HTML, CSS, Bootstrap, and vanila JavaScript. Users can browse through a variety of books, add them to their cart, and checkout securely. The website also includes a search function and user account management.
## The technologies used in the project:
- HTML
- CSS
- Bootstrap
- JavaScript
## The project includes the following features:
- User authentication and authorization
- Shopping cart
- Order placement
- Payment integration
## Installation
To run the BookTown Project locally, follow these steps:
- Clone the repository
- Open the index.html file in Home-Page folder in your preferred browser
- Enjoy browsing and purchasing books!
## Contributing
We welcome contributions from anyone interested in improving the BookTown! To contribute, please fork the repository and submit a pull request with your changes.
`This project is developed for educational purposes and is free to use and modify.`
| A complete book purchase website made using HTML/CSS/JavaScript | bootstrap,css,html,html-css-javascript,javascript,website | 2023-05-25T09:48:21Z | 2023-04-10T17:22:02Z | null | 1 | 0 | 65 | 0 | 0 | 27 | null | null | HTML |
Podginator/TickGPTick | main | # TickGPTick
This year I found out I had ADHD. In an attempt to address some of the symptoms I've started to experiment with different tools and methodologies.
One thing that came up a lot was breaking tasks down into smaller tasks. For instance, going to the gym would be made up of changing into gym clothes, putting your gym bag by the door. This 'atomicising' of your todo list is supposed to help keep people with ADHD motivated to complete a task.
But I've always lacked the creativity for this. I've always had an incredibly difficult time breaking down tasks into incredibly small tasks. So I turned to ChatGPT. And it was good at it. Not perfect, but much better than me, and a much better starting point that I could provide.
And as the lazy man I've always been, I figured, why not complicate it and try to build it directly into TickTick.
I run this locally on a Raspberry Pi, and it polls every second for changes. It then does two things.
## Expand
By adding a tag like expand-5 TickGPTick calls ChatGPT. It returns a list of 5 broken down tasks. It uses the description field for additional context when creating them. The gif below demonstrates this functionality.
## AI Descriptions.
If you type ai{{a prompt}} into the description field, in the background the OpenAI API will be called. It will Replace the content in the description field with AI Generated Content.
# ToDo:
* Error handling, any at all.
# .env
The following environment variables must be set in order for this application to work
## OPENAI_API_KEY
Your Open AI API Key.
## TICKUSERNAME
Your Tick Tick Username
## TICKPASSWORD
Your Tick Tick Password
| TickGPTick Integration | ai,chatgpt,javascript,llm,openai,openai-api,ticktick,ticktick-api,todo-list,chatgpt-api | 2023-06-08T21:56:23Z | 2023-09-17T21:44:59Z | null | 1 | 0 | 12 | 0 | 1 | 25 | null | null | JavaScript |
seo-asif/Rock-Paper-Scissors | main | # Rock-Paper-Scissors
This is a simple implementation of the classic Rock Paper Scissors game using HTML, CSS, and JavaScript. The game allows Human player and Bot player to compete against each other by selecting one of the three options: Rock, Paper, or Scissors. The winner is determined based on the standard rules of the game.
#Demo<br>
You can try out the game by visiting the following link: [Rock Paper Scissors Game Demo](https://rock-pap.vercel.app/)<br><br>
<br><br>#Features<br>
Human player and Bot player can compete against each other.
Real-time updates and feedback on the game result.
Clear and intuitive user interface.
Option to restart the game after each round.<br>
<br>#Technologies Used<br>
HTML<br>
CSS<br>
JavaScript<br><br>
<br>#Getting Started<br>
To run the game locally on your machine, follow these steps:<br>
<br>#Clone the repository:<br>
shell
Copy code
git clone https://github.com/seo-asif/rock-paper-scissors.git
<br>#Navigate to the project directory:<br>
shell
Copy code
cd rock-paper-scissors
Open the index.html file in your preferred web browser.
<br>#Usage<br>
Player 1 and Bot should each select one of the three options (Rock, Paper, or Scissors) by clicking on the corresponding buttons.
Once both players have made their choices, the result will be displayed on the screen.
To play again, click on the "Again Play" button.
<br>#Contributing<br>
Contributions to the project are welcome! If you find any issues or have suggestions for improvements, please open an issue or submit a pull request.
<br>#License<br>
This project is licensed under the MIT License. You are free to use, modify, and distribute the code as per the terms of the license.
<br>#Acknowledgments<br>
The game logic and rules are based on the traditional Rock Paper Scissors game.
The CSS styling is inspired by modern web design trends.
<br><br>Contact<br>
If you have any questions or feedback, feel free to contact the project maintainer at asif064@gmail.com.
| Rock Paper Scissors is a beautiful child game which I recreated with my JavaScript knowledge | html-css-javascript,javascript | 2023-06-03T18:48:04Z | 2023-06-04T04:38:57Z | null | 1 | 0 | 10 | 0 | 3 | 25 | null | null | JavaScript |
grauJavier/capstone-project | main | <a name="readme-top"></a>
<!-- TABLE OF CONTENTS -->
# Capstone Project - Joshua Redman World Tour 2023
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Usage](#usage)
- [Deployment](#deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show Your Support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)
<!-- PROJECT DESCRIPTION -->
# 📖 Joshua Redman World Tour 2023 <a name="about-project"></a>
The Joshua Redman World Tour 2023 project showcases the upcoming world tour of renowned jazz saxophonist Joshua Redman. This website provides information about the tour, including tour dates, venues, and ticket information.
## 🛠 Built With <a name="built-with"></a>
### Tech Stack <a name="tech-stack"></a>
<details>
<summary>Version Control System</summary>
<ul>
<li><a href="https://git-scm.com/">Git</a></li>
</ul>
</details>
<details>
<summary>Repository Hosting Service</summary>
<ul>
<li><a href="https://github.com/">GitHub</a></li>
</ul>
</details>
<details>
<summary>Programming Languages</summary>
<ul>
<li><a href="https://en.wikipedia.org/wiki/HTML">HTML</a></li>
<li><a href="https://en.wikipedia.org/wiki/CSS">CSS</a></li>
<li><a href="https://en.wikipedia.org/wiki/Git">Git BASH</a></li>
</ul>
</details>
<!-- FEATURES -->
### Key Features <a name="key-features"></a>
- **Clean and Modern Design:** The website features a visually appealing and contemporary design, providing an engaging user experience.
- **Responsive Layout:** The website is responsive and adapts seamlessly to different screen sizes and devices, ensuring optimal viewing across desktop, tablet, and mobile.
- **Easy Navigation:** The site offers intuitive and user-friendly navigation, making it effortless for visitors to explore different sections and find tour-related information.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- Live Demo -->
# 🚀 Live Demo <a name="live-demo"></a>
To preview a live demo [Click here!](https://graujavier.github.io/capstone-project/)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- GETTING STARTED -->
## 💻 Getting Started <a name="getting-started"></a>
To get a local copy up and running, follow these steps.
### Prerequisites
To run this project you need:
- Any Web Browser that supports HTML & CSS such as [Brave](https://brave.com/).
- Any IDE and Code Editor such as [Visual Studio](https://visualstudio.microsoft.com/).
- If you want to clone this project, please install [Git BASH](https://git-scm.com/).
### Setup
Clone this repository to your desired folder with git:
`git clone https://github.com/grauJavier/capstone-project.git`
### Install
No installation is required.
### Usage
Open the `index.html` file with your Code Editor if you want to add new desired text.
### Run tests
No run test is available.
### Deployment
Deployment link: https://graujavier.github.io/capstone-project/
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- AUTHORS -->
## 👥 Authors <a name="authors"></a>
👤 **Javier Grau**
- GitHub: [@grauJavier](https://github.com/grauJavier)
- Twitter: [@jgrauchile](https://twitter.com/jgrauchile)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/javiergrau)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- FUTURE FEATURES -->
## 🔭 Future Features <a name="future-features"></a>
- [ ] **Much more interesting content**
- [ ] **Professional embellishment with CSS and JavaScript**
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- CONTRIBUTING -->
## 🤝 Contributing <a name="contributing"></a>
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/grauJavier/hello-microverse/issues).
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- SUPPORT -->
## ⭐️ Show your support <a name="support"></a>
If you like this project gift us with a nice comment!
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- ACKNOWLEDGEMENTS -->
## 🙏 Acknowledgments <a name="acknowledgements"></a>
Original design idea by [Cindy Shin in Behance](https://www.behance.net/adagio07).
Used under the [Creative Commons license of the design](https://creativecommons.org/licenses/by-nc/4.0/).
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- LICENSE -->
## 📝 License <a name="license"></a>
This project is [MIT](./MIT.md) licensed.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
| The Joshua Redman World Tour 2023 project showcases the upcoming world tour of renowned jazz saxophonist Joshua Redman. This website provides information about the tour, including tour dates, venues, and ticket information. | css,html,javascript | 2023-05-20T17:15:44Z | 2023-05-25T18:43:31Z | null | 1 | 2 | 10 | 1 | 0 | 25 | null | null | HTML |
jankozik/ffmpeg-concat | main | null | Concats a list of videos together using ffmpeg with sexy OpenGL transitions. | ffmpeg,fluent-ffmpeg,opengl,transition,javascript | 2023-05-27T06:50:05Z | 2023-07-14T10:32:16Z | null | 1 | 2 | 86 | 0 | 0 | 25 | null | null | JavaScript |
canopas/web-developer-roadmap-2023 | main | <h1 align="center">Web Developer Roadmap 2023</h1>
Web Developer Roadmap 2023 is a learning path to understand web development, including frontend, backend, and cloud(AWS).
## How to Learn Web Development?
Web development can be divided into four different parts,
1. Database
2. Backend
3. Frontend
4. Cloud(server)
## Guidelines
- Before starting any practical it's important to conduct research and learn the necessary concepts.
- As you progress through the practical exercises, make sure to apply the new knowledge you've gained in subsequent exercises.
- Follow the `best practices` and `coding standards` of particular languages for implementation.
# Table of contents
- [Useful references](https://github.com/canopas/web-developer-roadmap-2023#useful-references)
- [Basic commands and Version Control](https://github.com/canopas/web-developer-roadmap-2023#basic-commands-and-version-control)
- [Practical 1 - Basic commands](https://github.com/canopas/web-developer-roadmap-2023#practical-1)
- [HTML/CSS](https://github.com/canopas/web-developer-roadmap-2023#htmlcss)
- [Practical 2 - Static UI](https://github.com/canopas/web-developer-roadmap-2023#practical-2)
- [Practical 3 - Responsive UI](https://github.com/canopas/web-developer-roadmap-2023#practical-3)
- [Practical 4 - Tailwind CSS](https://github.com/canopas/web-developer-roadmap-2023#practical-4)
- [Practical 5 - Animations](https://github.com/canopas/web-developer-roadmap-2023#practical-5)
- [Docker](https://github.com/canopas/web-developer-roadmap-2023#docker)
- [Practical 6 - Docker commands](https://github.com/canopas/web-developer-roadmap-2023#practical-6)
- [Database](https://github.com/canopas/web-developer-roadmap-2023#database)
- [Practical 7 - Mysql](https://github.com/canopas/web-developer-roadmap-2023#practical-7)
- [Practical 8 - MongoDB](https://github.com/canopas/web-developer-roadmap-2023#practical-8)
- [PHP](https://github.com/canopas/web-developer-roadmap-2023#php)
- [Practical 9 - Calculator](https://github.com/canopas/web-developer-roadmap-2023#practical-9)
- [Practical 10 - Blog application](https://github.com/canopas/web-developer-roadmap-2023#practical-10)
- [Javascript](https://github.com/canopas/web-developer-roadmap-2023#javascript)
- [Practical 11 - Random Quote Generator](https://github.com/canopas/web-developer-roadmap-2023#practical-11)
- [Practical 12 - Interactive Form Validation](https://github.com/canopas/web-developer-roadmap-2023#practical-12)
- [Typescript](https://github.com/canopas/web-developer-roadmap-2023#typescript)
- [Practical 13 - BMI Calculator](https://github.com/canopas/web-developer-roadmap-2023#practical-13)
- [Practical 14 - File Uploader](https://github.com/canopas/web-developer-roadmap-2023#practical-14)
- [NodeJS](https://github.com/canopas/web-developer-roadmap-2023#nodejs)
- [Practical 15 - Real-time group chat application](https://github.com/canopas/web-developer-roadmap-2023#practical-15)
- [Practical 16 - E-commerce Auth APIs](https://github.com/canopas/web-developer-roadmap-2023#practical-16)
- [Practical 17 - E-commerce Product APIs](https://github.com/canopas/web-developer-roadmap-2023#practical-17)
- [VueJS](https://github.com/canopas/web-developer-roadmap-2023#vuejs)
- [Practical 18 - E-commerce Admin panel](https://github.com/canopas/web-developer-roadmap-2023#practical-18)
- [Practical 19 - E-commerce Website](https://github.com/canopas/web-developer-roadmap-2023#practical-19)
- [Golang](https://github.com/canopas/web-developer-roadmap-2023#golang)
- [Practical 20 - Music APP Auth and Admin APIs](https://github.com/canopas/web-developer-roadmap-2023#practical-20)
- [Practical 21 - Music APP User apis](https://github.com/canopas/web-developer-roadmap-2023#practical-21)
- [Practical 22 - Unit tests and Documentation](https://github.com/canopas/web-developer-roadmap-2023#practical-22)
- [ReactJS](https://github.com/canopas/web-developer-roadmap-2023#reactjs)
- [Practical 23 - Music APP Admin panel](https://github.com/canopas/web-developer-roadmap-2023#practical-23)
- [Practical 24 - Music App Website](https://github.com/canopas/web-developer-roadmap-2023#practical-24)
# Useful references
These references provide basic knowledge, that is necessary before diving into web development and serve as starting points for beginners. If you have prior knowledge and experience in web development, feel free to skip this section.
- [Command line interface - CLI](https://ubuntu.com/tutorials/command-line-for-beginners#4-creating-folders-and-files)
- [Version control system - VCS](https://about.gitlab.com/topics/version-control/) and [Git](https://about.gitlab.com/topics/version-control/what-is-git-version-control/)
- [Backend vs Frontend](https://www.geeksforgeeks.org/frontend-vs-backend/)
- [Document object model - DOM](https://developer.mozilla.org/en-US/docs/Web/API/Document_Object_Model/Introduction)
- [REST APIs](https://blog.postman.com/rest-api-examples/)
- [JSON](https://developer.mozilla.org/en-US/docs/Learn/JavaScript/Objects/JSON)
- [Coding standards](https://www.geeksforgeeks.org/coding-standards-and-guidelines/)
- [Docker](https://www.ibm.com/topics/docker)
- [Cloud](https://www.cloudflare.com/en-gb/learning/cloud/what-is-the-cloud/) and [AWS](https://www.guru99.com/what-is-aws.html)
# Basic commands and Version Control
## Practical 1
Perform the following commands on the terminal and write them down for review,
- Basic commands
- List all files with details in the directory
- Give only read permission to any file
- Give all read and write permissions to any file
- Get the IP address of your own pc
- Observe disk space usage
- View previously executed commands history
- Linux command to install/uninstall PHP
- Linux command to start/stop mysql service
- Write and save any file from terminal
- Version Control
- Add files to git
- Check git remotes
- Fetch remote branches
- Delete branch
- Check the git status of the repository
- Commit new/updated files into a git repository
- Push in a git repository
- Pull new changes from the repository
- Checkout new branch
- Merge branch into another
- See commit history
- Rebase and Squash
- Write a command to clone [this](https://github.com/canopas/web-developer-roadmap-2023) repo
# HTML/CSS
## Practical 2
- Static UI
- Create an HTML project and design a static UI given in [reference](https://github.com/canopas/web-developer-roadmap-2023/blob/main/images/static-new.png).
- Use modern CSS properties like flex or grid to create UI.
## Practical 3
- Responsive UI
- Create an HTML project and design [this](https://www.w3schools.com/w3css/tryw3css_templates_food_blog.htm) UI.
- UI should be responsive for mobile and desktop devices.
- Use modern CSS properties like flex or grid to create UI.
## Practical 4
- Tailwind css
- Configure tailwindcss in the project.
- Create [given](https://github.com/canopas/web-developer-roadmap-2023/blob/main/images/swiper.gif) responsive UI using swiper and tailwindcss.
- UI should be responsive till 4k devices.
## Practical 5
- Animations
- CSS Hover Effects:
- Implement creative hover effects on given elements.
- **Button:** Change background and text color on hover
- **Link:** Add underline floating from left to right on hover
- **Image:** Rotate the left image on hover
- Utilize CSS transitions, transforms, or animations to add interactive and visually appealing effects when the user hovers over the elements.
- CSS Text Effects:
- Implement various text effects using CSS animations or transitions.
- Examples include text color changes, text rotations, text scaling, or text fading.
- Play around with different timing functions and animation properties to create visually appealing text effects.
- Loading Spinner:
- Create the spinner given in the [link](https://github.com/canopas/web-developer-roadmap-2023/blob/main/images/spinner.gif)
- Use keyframe animations or CSS transforms to create an effect.
- Customize the spinner's appearance and experiment with different animation properties to achieve the desired effect.
- Bounce up and down the circle by clicking on the button
- Utilize CSS transitions, transforms, or animations to add interactive and visually appealing effects when the user hovers over the elements.
- Customize the circle's appearance and experiment with different animation properties to achieve the desired effect.
# Docker
## Practical 6
Perform following commands
- Pull the latest mysql and nginx image
- List the docker images
- List the docker volumes
- Run the nginx container on 8000 port
- Run mysql container on 3307 port with volume
- List the currently running containers
- List the file with its details inside the nginx container
- Stop nginx container
- Remove nginx container and image
- Show logs of the docker container
- Show the latest 100 logs of the docker container
- Setup docker swarm
- Create a docker container with the help of the docker service
# Database
## Practical 7
- Perform the following queries in **MySQL**
- Create a table named `students` with fields id, first_name, last_name, standard, percentage, interest, etc… and insert data into it
- Create table `student_attendances` with fields id, student_id, created_at, presence/absence fields and insert data into it
- Create a table named `teachers` with fields id, first_name, last_name, subject, interests, etc… and insert data into it
- Create table `teachers_attendances` with fields id, teacher_id, created_at, presence/absence fields and insert data into it
- Find the student's presence/absence on a particular day
- Find the total absence/presence of every student
- Find absent students with a percentage lower than 70.
- Find a student who has the highest presence
- Get all student's and teacher's first_name, last_name, full_name, interest, standard, subject and total absence.
## Practical 8
- Perform following queries in **MongoDB** (Can use [MongoDBPlayground](https://mongoplayground.net/) to peform queries)
- Create a collection named `students` with fields id, first_name, last_name, standard, percentage, interest, etc… and insert data into it
- Create table `student_attendances` with fields id, student_id, created_at, presence/absence fields and insert data into it
- Find students with a percentage lower than 70 and an interest in sports.
- Find the total attadence of students who have not interest in sport but interest in reading.
- Count the total students with a percentage above 80
# PHP
## Practical 9
- Simple calculator
- Create a calculator that can perform basic arithmetic operations like addition, subtraction, multiplication, and division
- Add two input fields that allow only numeric values
- Show error if the value is not numeric
- Add buttons for arithmetic operations like addition, subtraction, multiplication, and division
- Add submit button and print the result in the label
## Practical 10
- Blog application
- It should have two roles
1. Admin
2. User
- Implement Register and login/logout functionality for admin
- Create add/edit/delete posts for admin. It should not be accessible by users.
- post fields - title, description, created_at, author, category, image
- Allow admin to disable/enable users to see posts.
- User can only view the post in descending order.
# JavaScript
## Practical 11
- Random Quote Generator
- Use [random quotes API](https://api.whatdoestrumpthink.com/api/v1/quotes/random) and get random quotes.
- Display random technical quotes each time when the user refreshes the page or clicks a button.
## Practical 12
- Interactive Form Validation
- Create a form containing fields like name, email, phone, and password with a placeholder.
- Implement form validation using JavaScript.
- Validate input fields for required values, email formats, password strength, and other criteria. - Display error messages for invalid inputs in red color.
- If all validations pass, submit button click should insert the data into the table (without refreshing the page - Use AJAX) and show a popup with a success message
# TypeScript
## Practical 13
- BMI Calculator
- Build a BMI (Body Mass Index) calculator that takes a person's weight and height as input and calculates their BMI.
- Add appropriate validations for input fields.
- Use TypeScript to define the data types for the inputs and outputs and provide a meaningful interpretation of the result.
## Practical 14
- File Uploader
- Implement a file uploader that allows users to upload files to a server.
- Allow only `pdf` and `doc` files.
- Max filesize should be `10kb`.
- Display progress indicators during the upload process.
- Show the `File uploaded successfully` message after the upload
# NodeJS
## Practical 15
- Real-time group chat application
- Build a real-time group chat application using Node.js, Javascript, and a library like Socket.IO.
- Allow users to join chat rooms, send messages, and receive messages in real time.
## Practical 16
- E-commerce App authorization and admin APIs
- **Implementation specifications:** `express.js`, `typescript`, and `sequelize` with PostgreSQL
- Review [Ecommerce App](https://github.com/canopas/web-developer-roadmap-2023/blob/main/ecommerce_web_app.md) requirements.
- Create the following REST APIs
- Admin SignUp/SignIn
- User SignUp/SignIn - Send mail to the users after signUP from API only
- Admin APIs - Only authenticated admins can access these APIs
- Create/Update/Delete categories
- Create/Update/Delete subcategories
- Create/Update/Delete products
## Practical 17
- Ecommerce App user apis (continue Practical 16)
- **Implementation specifications:** `express.js`, `typescript`, and `sequelize` with PostgreSQL
- Create the following User REST APIs - Only authenticated users can access these APIs
- FindAll/FindOne categories, subcategories, products
- Get products of a given category/subcategory
- Search product from given string with name, price
- Favourite/Unfavorite products
- Send feedback mail to the admin.
# VueJS
## Practical 18
- E-commerce Admin panel
- **Implementation specifications:** `tailwind`, `vite`, `vuex or pinia
- Review [Ecommerce App](https://github.com/canopas/web-developer-roadmap-2023/blob/main/ecommerce_web_app.md) requirements.
- Can use readymade templates.
- Use [nodeJS](https://github.com/canopas/web-developer-roadmap-2023#7-nodejs) APIs to handle the data
- Create registration/Login forms with all validations.
- Admin should be able to create, update, delete, and view categories, subcategories, and products.
- Admin should be able to see all users.
- Implement logout functionality.
## Practical 19
- E-commerce website
- **Implementation specifications:** `tailwind`, `vite`, `vuex or pinia`
- Create a website where users can see a list of products.
- User should be able to filter products by categories and subcategories.
- Create registration/Login forms with all validations.
- LoggedIn users can favorite/unfavourite products.
- Implement logout functionality.
# Golang
## Practical 20
- Music APP authorization and admin APIs
- **Implementation specifications:** `JWT` for authentication, `sqlx or gorm`, `gin`
- Review [Music APP](https://github.com/canopas/web-developer-roadmap-2023/blob/main/music_app.md) requirements
- Use concepts of golang like go modules, generics, concurrency, etc…
- Create the following REST APIs
- Admin Register/Login
- User Register/Login
- Admin APIs - Only authenticated admins can access these APIs
- Create/Read/Update/Delete artist
- Create/Read/Update/Delete album
- Create/Read/Update/Delete track
- Create/Read/Update/Delete playlist
- Add/Remove tracks to/from the album
- Add/Remove tracks to/from the playlist
- Get all users
## Practical 21
- Music APP user apis (continue Practical 20)
- **Implementation specifications:** `JWT` for authentication, `sqlx or gorm`, `gin`
- Create the following User REST APIs - Only authenticated users can access these APIs
- Fetch all albums
- Fetch all tracks
- Fetch all tracks by album Id
- Fetch all playlists
- Get the playlist and its tracks by playlist id
- Favourite/unfavourite tracks
- Retrieve favorite/unfavourite tracks of own
## Practical 22
- Unit tests and Documentation (continue Practical 21)
- Write a test for all errors and successful response
- Write unit test for the following APIs from [Music APP](https://github.com/canopas/web-developer-roadmap-2023/blob/main/music_app.md)
- Create playlist
- Delete track
- Get the playlist and its tracks by playlist id
- Favourite/unfavourite tracks
- Write API documentation for the given APIs.
- Should contain the following fields
- Method
- Endpoint
- Path params/Query params
- Description
- Header
- Request
- Response
# ReactJS
## Practical 23
- Music App Admin panel
- **Implementation specifications:** `tailwind`, `vite`, and `typescript`
- Review [Music APP](https://github.com/canopas/web-developer-roadmap-2023/blob/main/music_app.md) requirements
- Can use readymade templates
- Use [Golang](https://github.com/canopas/web-developer-roadmap-2023#9-golang) APIs to handle the data
- Create an admin panel that will cover all the admin APIs.
## Practical 24
- Music App Website
- **Implementation specifications:** `tailwind`, `vite`, and `typescript`
- Create a web app that will cover all User APIs.
- Can refer [spotify](https://open.spotify.com/) UI.
- Allow users to favorite/unfavourite tracks if they have logged-in otherwise redirect to the login page on click on favorite/unfavourite
| Web Developer Roadmap 2023 is a path to understand web development including frontend, backend and cloud. | backend,backend-development,database,developer-roadmap,development-roadmap,frontend-development,golang,html,javascript,php | 2023-05-30T04:37:47Z | 2024-02-21T12:09:44Z | null | 4 | 3 | 11 | 0 | 3 | 24 | null | MIT | null |
ferlyafriliyan/ferlyafriliyan.github.io | main | - *Hasil Website* :
- **https://ferlyafriliyan.github.io/**
| Personal Portfolio | bash,css,golang,html,html-css-javascript,javascript,shell | 2023-05-24T12:30:53Z | 2023-09-09T02:06:43Z | null | 0 | 0 | 236 | 0 | 0 | 23 | null | null | HTML |
crutchcorn/the-fun-framework | main | <div align="center">
<h1>The Fun Framework</h1>
<a href="https://joypixels.com/profiles/emoji/playground-slide">
<img
height="80"
width="80"
alt="playground slide"
src="./other/slide.png"
/>
</a>
<p>An experimental homegrown JS framework.</p>
</div>
<div align="center">
[](https://github.com/crutchcorn/the-fun-framework/actions/workflows/build.yml?query=branch%3Amain)
[](https://github.com/crutchcorn/the-fun-framework/actions/workflows/test.yml?query=branch%3Amain)
[](https://npm.im/the-fun-framework)
[](https://unpkg.com/browse/the-fun-framework@latest/dist/the-fun-framework.cjs)
[](./LICENSE.md)
</div>
The goals of this project are:
- HTML-first templating
- No VDOM
- Implicit re-renders (instead of calling an update function manually, "mutate")
## Installation
```shell
npm install the-fun-framework
```
## Usage
```html
<!-- index.html -->
<!-- You can have multiple islands in one HTML file -->
<div data-island-comp="App">
<p>{{message}}</p>
</div>
```
```typescript
// index.ts
import { createState, registerComponent, render } from "the-fun-framework";
function App() {
return {
message: "Hello, world",
};
}
// Register with the same name as `data-island-comp`
App.selector = "App";
registerComponent(App);
render();
```
### Conditional Display
```html
<!-- index.html -->
<div data-island-comp="Counter">
<button data-on-click="updateCount()">Count</button>
<p>Count: {{count.value}}</p>
<p data-if="count.value % 2 === 0">{{count.value}} is even</p>
</div>
```
```typescript
// index.ts
import { createState, registerComponent, render } from "the-fun-framework";
function Counter() {
let count = createState(0);
function updateCount() {
count.value++;
}
return {
count,
updateCount,
};
}
// Register with the same name as `data-island-comp`
Counter.selector = "Counter";
registerComponent(Counter);
render();
```
### Loop Display
```html
<!-- index.html -->
<div data-island-comp="People">
<h1>Names</h1>
<ul>
<li data-for="item of list.value" data-key="item.key">{{item.name}}</li>
</ul>
<button data-on-click="addPerson()">Add person</button>
</div>
```
```typescript
// index.ts
function People() {
const list = createState([
{
name: "Corbin",
key: "corbin",
},
{
name: "Ade",
key: "ade",
},
]);
let personCount = 0;
function addPerson() {
const newList = [...list.value];
++personCount;
newList.push({
name: `Person ${personCount}`,
key: `person_${personCount}`,
});
list.value = newList;
}
return {
list,
addPerson,
};
}
People.selector = "People";
registerComponent(People);
render();
```
| 🛝 An experimental homegrown JS framework. | alpinejs,framework,javascript,solidjs,vue | 2023-06-04T12:49:15Z | 2023-07-20T06:32:28Z | null | 1 | 1 | 34 | 1 | 2 | 23 | null | MIT | TypeScript |
nitotm/efficient-language-detector-js | main | # Efficient Language Detector
<div align="center">
[](https://www.apache.org/licenses/LICENSE-2.0)
[](#languages)
</div>
Efficient language detector (*Nito-ELD* or *ELD*) is a fast and accurate language detector, is one of the fastest non compiled detectors, while its accuracy is within the range of the heaviest and slowest detectors.
It's 100% Javascript (vanilla), easy installation and no dependencies.
ELD is also available in [Python](https://github.com/nitotm/efficient-language-detector-py) and [PHP](https://github.com/nitotm/efficient-language-detector).
1. [Install](#install)
2. [How to use](#how-to-use)
3. [Benchmarks](#benchmarks)
4. [Languages](#languages)
## Install
- For *Node.js*
```bash
$ npm install eld
```
- For Web, just download or clone the files
`git clone https://github.com/nitotm/efficient-language-detector-js`
## How to use?
### Load ELD
- At Node.js REPL
```javascript
const { eld } = await import('eld')
```
- At Node.js
```javascript
import { eld } from 'eld' // use .mjs extension for version <18
```
- At the Web Browser
```html
<script type="module" charset="utf-8">
import { eld } from './src/languageDetector.js' // Update path.
/* code */
</script>
```
- To load the minified version, which is not a module
```html
<script src="minified/eld.M60.min.js" charset="utf-8"></script>
```
### Usage
`detect()` expects a UTF-8 string, and returns an object, with a 'language' variable, with a ISO 639-1 code or empty string
```javascript
console.log( eld.detect('Hola, cómo te llamas?') )
// { language: 'es', getScores(): {'es': 0.5, 'et': 0.2}, isReliable(): true }
// returns { language: string, getScores(): Object, isReliable(): boolean }
console.log( eld.detect('Hola, cómo te llamas?').language )
// 'es'
```
- To reduce the languages to be detected, there are 2 options, they only need to be executed once. (Check available [languages](#languages) below)
```javascript
let langSubset = ['en', 'es', 'fr', 'it', 'nl', 'de']
// Option 1
// Setting dynamicLangSubset(), detect() executes normally but finally filters the excluded languages
eld.dynamicLangSubset(langSubset) // Returns an Object with the validated languages of the subset
// to remove the subset
eld.dynamicLangSubset(false)
// Option 2
// The optimal way to regularly use the same subset, is using saveSubset() to download a new database
eld.saveSubset(langSubset) // ONLY for the Web Browser, and not included at minified files
// We can load any Ngrams database saved at src/ngrams/, including subsets. Returns true if success
await eld.loadNgrams('ngramsL60.js') // eld.loadNgrams('file').then((loaded) => { if (loaded) { } })
// To modify the preloaded database, edit the filename loadNgrams('filename') at languageDetector.js
```
- Also, we can get the current status of eld: languages, database type and subset
```javascript
console.log( eld.info() )
```
## Benchmarks
I compared *ELD* with a different variety of detectors, since the interesting part is the algorithm.
| URL | Version | Language |
|:----------------------------------------------------------|:--------------|:-------------|
| https://github.com/nitotm/efficient-language-detector-js/ | 0.9.0 | Javascript |
| https://github.com/nitotm/efficient-language-detector/ | 1.0.0 | PHP |
| https://github.com/pemistahl/lingua-py | 1.3.2 | Python |
| https://github.com/CLD2Owners/cld2 | Aug 21, 2015 | C++ |
| https://github.com/google/cld3 | Aug 28, 2020 | C++ |
| https://github.com/wooorm/franc | 6.1.0 | Javascript |
Benchmarks: **Tweets**: *760KB*, short sentences of 140 chars max.; **Big test**: *10MB*, sentences in all 60 languages supported; **Sentences**: *8MB*, this is the *Lingua* sentences test, minus unsupported languages.
Short sentences is what *ELD* and most detectors focus on, as very short text is unreliable, but I included the *Lingua* **Word pairs** *1.5MB*, and **Single words** *880KB* tests to see how they all compare beyond their reliable limits.
These are the results, first, accuracy and then execution time.
<!-- Accuracy table
| | Tweets | Big test | Sentences | Word pairs | Single words |
|:--------------------|:------------:|:------------:|:------------:|:------------:|:------------:|
| **Nito-ELD** | 99.3% | 99.4% | 98.8% | 87.6% | 73.3% |
| **Nito-ELD-L** | 99.4% | 99.4% | 98.7% | 89.4% | 76.1% |
| **Nito-ELD-xs** | 99.2% | 99.4% | 98.4% | 84.4% | 66.8% |
| **Lingua** | 98.8% | 99.1% | 98.6% | 93.1% | 80.0% |
| **CLD2** | 93.8% | 97.2% | 97.2% | 87.7% | 69.6% |
| **Lingua low** | 96.0% | 97.2% | 96.3% | 83.7% | 68.0% |
| **CLD3** | 92.2% | 95.8% | 94.7% | 69.0% | 51.5% |
| **franc** | 89.8% | 92.0% | 90.5% | 65.9% | 52.9% |
-->
<img alt="accuracy table" width="800" src="https://raw.githubusercontent.com/nitotm/efficient-language-detector-js/main/misc/table_accuracy_js.svg">
<!--- Time table
| | Tweets | Big test | Sentences | Word pairs | Single words |
|:--------------------|:------------:|:------------:|:------------:|:------------:|:------------:|
| **Nito-ELD-js** | 0.58" | 5.1" | 4.3" | 1.2" | 0.73" |
| **Nito-ELD-L-js** | 0.59" | 5.2" | 4.5" | 1.2" | 0.77" |
| **Nito-ELD-XS-js** | 0.5" | 4.6" | 4" | 1.1" | 0.71" |
| **Lingua** | 4790" | 24000" | 18700" | 8450" | 6700" |
| **CLD2** | 0.35" | 2" | 1.7" | 0.98" | 0.8" |
| **Lingua low** | 64" | 370" | 308" | 108" | 85" |
| **CLD3** | 3.9" | 29" | 26" | 12" | 11" |
| **franc** | 1.2" | 8" | 7.8" | 2.8" | 2" |
| **Nito-ELD-php** | 0.31" | 2.5" | 2.2" | 0.66" | 0.48" |
-->
<img alt="time table" width="800" src="https://raw.githubusercontent.com/nitotm/efficient-language-detector-js/main/misc/table_time_js.svg">
<sup style="color:#08e">1.</sup> <sup style="color:#777">Lingua could have a small advantage as it participates with 54 languages, 6 less.</sup>
<sup style="color:#08e">2.</sup> <sup style="color:#777">CLD2 and CLD3, return a list of languages, the ones not included in this test where discarded, but usually they return one language, I believe they have a disadvantage.
Also, I confirm the results of CLD2 for short text are correct, contrary to the test on the *Lingua* page, they did not use the parameter "bestEffort = True", their benchmark for CLD2 is unfair.
*Lingua* is the average accuracy winner, but at what cost, the same test that in *ELD* or *CLD2* is below 6 seconds, in Lingua takes more than 5 hours! It acts like a brute-force software.
Also, its lead comes from single and pair words, which are unreliable regardless.
I added *ELD-L* for comparison, which has a 2.3x bigger database, but only increases execution time marginally, a testament to the efficiency of the algorithm. *ELD-L* is not the main database as it does not improve language detection in sentences.
For a client side solution, I included an all-in-one detector+Ngrams minified file, of the standard version (M), and XS which still performs great for sentences.
The XS version only weights 865kb, when gzipped it's only 245kb. The standard version is 486kb gzipped.
Here is the average, per benchmark, of Tweets, Big test & Sentences.
<!--- Sentences average
| | Time | Accuracy |
|:--------------------|:------------:|:------------:|
| **Nito-ELD-js** | 3.32" | 99.16% |
| **Nito-ELD-php** | 1.65" | 99.16% |
| **Lingua** | 15800" | 98.84% |
| **CLD2** | 1.35" | 96.08% |
| **Lingua low** | 247" | 96.51% |
| **CLD3** | 19.6" | 94.19% |
| **franc** | 5.7" | 90.79% |
-->
## Languages
These are the *ISO 639-1 codes* of the 60 supported languages for *Nito-ELD* v1
> 'am', 'ar', 'az', 'be', 'bg', 'bn', 'ca', 'cs', 'da', 'de', 'el', 'en', 'es', 'et', 'eu', 'fa', 'fi', 'fr', 'gu', 'he', 'hi', 'hr', 'hu', 'hy', 'is', 'it', 'ja', 'ka', 'kn', 'ko', 'ku', 'lo', 'lt', 'lv', 'ml', 'mr', 'ms', 'nl', 'no', 'or', 'pa', 'pl', 'pt', 'ro', 'ru', 'sk', 'sl', 'sq', 'sr', 'sv', 'ta', 'te', 'th', 'tl', 'tr', 'uk', 'ur', 'vi', 'yo', 'zh'
Full name languages:
> Amharic, Arabic, Azerbaijani (Latin), Belarusian, Bulgarian, Bengali, Catalan, Czech, Danish, German, Greek, English, Spanish, Estonian, Basque, Persian, Finnish, French, Gujarati, Hebrew, Hindi, Croatian, Hungarian, Armenian, Icelandic, Italian, Japanese, Georgian, Kannada, Korean, Kurdish (Arabic), Lao, Lithuanian, Latvian, Malayalam, Marathi, Malay (Latin), Dutch, Norwegian, Oriya, Punjabi, Polish, Portuguese, Romanian, Russian, Slovak, Slovene, Albanian, Serbian (Cyrillic), Swedish, Tamil, Telugu, Thai, Tagalog, Turkish, Ukrainian, Urdu, Vietnamese, Yoruba, Chinese
## Future improvements
- Train from bigger datasets, and more languages.
- The tokenizer could separate characters from languages that have their own alphabet, potentially improving accuracy and reducing the N-grams database. Retraining and testing is needed.
**Donate / Hire**
If you wish to Donate for open source improvements, Hire me for private modifications / upgrades, or to Contact me, use the following link: https://linktr.ee/nitotm | Fast and accurate natural language detection. Detector written in Javascript. Nito-ELD, ELD. | javascript,language,language-detection,language-detector,language-identification,natural-language,natural-language-processing,nlp,nodejs | 2023-05-27T17:30:09Z | 2023-10-03T22:06:45Z | null | 1 | 1 | 13 | 0 | 2 | 21 | null | Apache-2.0 | JavaScript |
codenze/bard-api-node | main | # Bard-API-Node (Updated for Gemini API)
## Description
**bard-api-node** is a Node.js library for interacting with Bard, an AI Chatbot developed by Google. Bard is based on Google's Large language model (LLM), LaMDA, which is designed to generate human-like text and images in response to prompts. This updated version of the library is aligned with the launch of Gemini API, the successor to Bard, and integrates with the official Google API services.
## What is Bard (Gemini)?
Bard, now known as Gemini, is an AI Chatbot developed by Google, based on Google’s Large language model (LLM), LaMDA. Similar to how ChatGPT is based on GPT, Gemini utilizes neural networks to mimic the underlying architecture of the brain in the form of a computer. Gemini is conversational and allows users to write a prompt and receive human-like text and images generated by artificial intelligence.
## Getting Started with BardAPI
To begin using BardAPI in your project, follow these steps:
### Installation
To use the Bard-API-Node library in your project, you can install it via npm directly:
```
npm install bard-api-node
```
or can install it via npm from Github:
```
npm install git+https://github.com/codenze/bard-api-node.git
```
### Obtaining API Key
To get started with the Bard API, you need to obtain an API key from the Google AI Studio. Follow the steps below to acquire your API key:
1. **Sign in to Google Account**:
- Make sure you are signed in to your Google account.
2. **Create a New Project**:
- Visit [Google Cloud Console](https://console.cloud.google.com/projectcreate).
- Enter a project name of your choice.
- Click on "Create" to create the project.
- <img width="854" alt="Screenshot 2024-03-01 at 10 15 19 PM" src="https://github.com/codenze/bard-api-node/assets/125561714/e35f763b-0447-4c82-aacd-1cc38518890c">
3. **Visit Google Ai Studio for API Key**:
- After creating the project, navigate to [API Key creation page](https://aistudio.google.com/app/apikey).
- <img width="854" alt="Screenshot 2024-03-01 at 10 16 25 PM" src="https://github.com/codenze/bard-api-node/assets/125561714/311e3c4e-c1a7-4b47-9a27-0ac85cc6fda9">
- Click on "Create API key".
- Choose the project you just created from the dropdown menu labeled "Search Google Cloud projects".
- <img width="854" alt="Screenshot 2024-03-01 at 10 17 05 PM" src="https://github.com/codenze/bard-api-node/assets/125561714/272ab018-80f8-4e40-9dac-e7417360e780">
- Click on "Create API key in exsisting project".
- Copy the API key.
- <img width="854" alt="Screenshot 2024-03-01 at 10 17 27 PM" src="https://github.com/codenze/bard-api-node/assets/125561714/70549631-ecbb-46f1-8546-76d51cba0dab">
5. **Paste API Key into Code**:
- Paste the API key into your code to initialize the BardAPI object.
### Usage
```javascript
javascript const { BardAPI } = require('bard-api-node');
async function testAssistant() {
try { // Initialize BardAPI object const bard = new BardAPI();
// Set API key
const apiKey = 'YOUR_API_KEY'; // Replace 'YOUR_API_KEY' with the obtained API key
// Initialize chat with API key
await bard.initilizeChat(apiKey);
// Send a query to Bard
const response = await bard.getBardResponse("Greetings! What can you do for me?");
console.log(response);
} catch (error) {
console.error('Error:', error);
}
}
testAssistant();
```
Make sure to replace `YOUR_API_KEY` with the actual API key obtained from Google AI Studio.
## Advanced Settings
### Content Generation Settings
The `setResponseGenerationConfig()` method allows you to customize the generation configuration for generating responses. This method enables you to fine-tune parameters related to the content generation process.
#### Usage
```javascript
const bard = new BardAPI();
const generationConfig = {
temperature: 0.7,
topK: 5,
topP: 0.9,
maxOutputTokens: 1024,
};
bard.setResponseGenerationConfig(generationConfig);
```
In the above example, we set a custom generation configuration with specific values for temperature, top-K sampling, top-p sampling, and maximum output tokens.
### Safety Settings
The `setSafetySettings()` method allows you to configure safety settings to filter out sensitive or harmful content from the generated responses. This method enables you to specify thresholds for different categories of harmful content.
#### Usage
```javascript
const bard = new BardAPI();
const safetySettings = [
{
category: HarmCategory.HARM_CATEGORY_HARASSMENT,
threshold: HarmBlockThreshold.BLOCK_STRICT,
},
{
category: HarmCategory.HARM_CATEGORY_HATE_SPEECH,
threshold: HarmBlockThreshold.BLOCK_LOW,
},
// Add more security settings as needed
];
bard.setSafetySettings(safetySettings);
```
In the above example, we set custom safety settings to filter out harassment with a strict threshold and hate speech with a low threshold. You can customize these settings based on your application's requirements.
## Acknowledgements
This Node.js library for interacting with the Bard chat assistant is powered by the official Google AI Studio API and utilizes the `@google/generative-ai` npm library. The integration with Google's Gemini AI and the use of the `@google/generative-ai` library serve as the foundation for this implementation.
I extend my gratitude to the Google AI team for providing access to their advanced AI capabilities and for the comprehensive documentation that facilitated the development of this library.
## Feedback
I welcome any feedback, bug reports, or problems you may encounter while using this library. If you have any issues or suggestions, please don't hesitate to reach out. You can send your reports to [de.inzimam@gmail.com](mailto:de.inzimam@gmail.com).
Thank you for your support and feedback!
## License
This project is licensed under the [MIT License](LICENSE).
If you find this project helpful in your own work, I would appreciate a star or acknowledgment in your projects.
| bard-api-node is a Node.js library for interacting with Bard, an AI Chatbot developed by Google. Bard is based on Google's Large language model (LLM), LaMDA, which is designed to generate human-like text and images in response to prompts. | ai,api,bard,bard-ai,bard-api,chatbot,google,javascript,lamda,llm | 2023-05-19T21:36:52Z | 2024-04-29T14:12:27Z | null | 3 | 4 | 22 | 1 | 9 | 21 | null | NOASSERTION | JavaScript |
woodendoors7/DiscordFriendInvites | main | [<img src="https://cdn.discordapp.com/attachments/1113574795540430969/1113577994804547654/invites.png" href="https://www.youtube.com/watch?v=qIU5jx4gup8">](https://www.youtube.com/watch?v=qIU5jx4gup8)
# Create a Discord Friend Invite link | DiscordFriendInvites
### A simple tool for generating Discord friend invite links that allows you to send friend requests via a link.
<hr></hr>
<img src="https://cdn.discordapp.com/attachments/1113574795540430969/1113587461365448704/newimage.png" alt="a discord friend invite">
<b>Discord Friend Invite links, a relic of the past that Discord didn't remove. How do you generate a friend invite?</b>
<br>
The code automatically generates a link that lasts for 168 hours and has the limit of 5 uses, afterwards using the link 1 use, it becomes expired. The cool thing is, you don't even need to accept the person's friend request, upon clicking the link, the user is automatically added as a friend without you confirming.
This is a feature of Discord, and in fact, as far as I know it's [still in Discord's code.](https://github.com/doggybootsy/hidden-disc-docs/blob/main/snippets/createFriendInvite.js)
As to my knowledge, you cannot change the use or time limit on the invites, nor you can delete individual invites, only all invites at once.
<hr></hr>
### How to use:
1. Open https://discord.com/
2. Wait until Discord is **fully** loaded
3. Copy this code:
```js
/*DiscordFriendInvites 1.0.0 by woodendoors7 */ var outputCreate,selectInvite,token,div,closeBtn,offsetLeft,offsetTop,html='\n <div id="mainWindow">\n <div id="header">DiscordFriendInvites<br>by woodendoors7<div id="closeBtn" class="closeButton-30b1gR" aria-label="Dismiss" role="button" tabindex="0"><svg aria-hidden="true" role="img" class="closeIcon-3eoP1e" width="18" height="18" viewBox="0 0 24 24"><path fill="currentColor" d="M18.4 4L12 10.4L5.6 4L4 5.6L10.4 12L4 18.4L5.6 20L12 13.6L18.4 20L20 18.4L13.6 12L20 5.6L18.4 4Z"></path></svg></div></div>\n <div class="dividing">\n <p class="sectionTitle">\n Create Invite\n </p>\n <button class="fieldButton-14lHvK button-ejjZWC lookFilled-1H2Jvj colorPrimary-2-Lusz sizeSmall-3R2P2p grow-2T4nbg" id="runCreate">Do It</button>\n </div>\n \n <div class="dividing">\n <p class="sectionTitle">\n View Invite\n </p>\n <select name="Select Invite" id="selectInvite">\n \n </select>\n \n <button class="sectionButton fieldButton-14lHvK button-ejjZWC lookFilled-1H2Jvj colorPrimary-2-Lusz sizeSmall-3R2P2p grow-2T4nbg" id="runInfo">View Info</button>\n </div>\n <div onClick="this.select();" disabled type="text" class="textOutput inputDefault-Ciwd-S input-3O04eu" id="outputCreate"><b style="margin-top: 8px;display: block;">Welcome!</b></div>\n <button style="margin-left: 32%; margin-top: 10px;" class="sectionButton fieldButton-14lHvK button-ejjZWC lookFilled-1H2Jvj colorPrimary-2-Lusz sizeSmall-3R2P2p grow-2T4nbg" id="runDelete">Delete All Invites</button>\n <a href="https://github.com/woodendoors7/DiscordFriendInvites"><img style="margin-top: 10px; width: 250px;" src="https://cdn.discordapp.com/attachments/1113574795540430969/1113574807611650128/pleasestar.png"></a>\n </div>',css='#mainWindow {\n position: absolute;\n z-index: 9;\n background-color: #2F3136;\n border: 1px solid #3f4147;\n color: white;\n text-align: center;\n height: 280px;\n width: 400px;\n font-family: "Century Gothic", CenturyGothic, Geneva, AppleGothic, sans-serif;\n z-index: 1000;\n border-radius: 12px;\n }\n \n #header {\n padding: 10px;\n cursor: move;\n z-index: 10;\n background-color: #5865F2;\n color: #ffe8e9;\n user-select: none;\n font-weight: bold;\n border-top-left-radius:12px;\n border-top-right-radius: 12px;\n\n }\n \n .dividing {\n background-color: #2F3136;\n width: 100%;\n height: 50px;\n text-align: left;\n vertical-align: middle;\n white-space: nowrap;\n line-height: 50px;\n }\n \n .sectionTitle {\n vertical-align: middle;\n margin: 0px;\n font-size: 18px;\n margin-left: 15px;\n }\n \n .sectionButton {\n vertical-align: middle;\n }\n \n .dividing * {\n display: inline;\n }\n \n .textOutput {\n max-width: 93%;\n min-height: 16px;\n cursor: text;\n margin-left: 10px;\n user-select: all;\n padding: 3px;\n text-align: center;\n margin-left: 10px;\n }';async function inject(){var e=document.createElement("div");e.innerHTML=html,e.innerHTML+=`\n\n<style>${css}</style>`,document.body.appendChild(e),(div=document.getElementById("mainWindow")).style.top="100px",div.style.left="100px",window.addEventListener("mousemove",divMove,!0),document.getElementById("header").addEventListener("mousedown",mouseDown,!1),window.addEventListener("mouseup",mouseUp,!1),document.getElementById("runCreate").addEventListener("click",createElement),document.getElementById("runInfo").addEventListener("click",checkTheInfo),document.getElementById("runDelete").addEventListener("click",deleteInvites),closeBtn=document.getElementById("closeBtn"),outputCreate=document.getElementById("outputCreate"),selectInvite=document.getElementById("selectInvite"),expireAfterCreate=document.getElementById("expireAfterCreate"),maxUsesCreate=document.getElementById("maxUsesCreate"),closeBtn.addEventListener("click",uninject),token=await getToken(),outputCreate.innerHTML='<b style="margin-top: 8px;display: block;">Welcome!</b>',fetchInvites(!1)}async function createElement(){outputCreate.innerHTML='<b style="margin-top: 8px;display: block;">Loading . . .</b>';let e=await fetch("https://discord.com/api/v9/users/@me/invites",{credentials:"include",headers:{"User-Agent":"Mozilla/5.0 (Windows NT 10.0; rv:103.0) Gecko/20100101 Firefox/103.0",Accept:"*/*","Accept-Language":"en,sk;q=0.8,cs;q=0.5,en-US;q=0.3","Content-Type":"application/json",Authorization:token,"X-Discord-Locale":"en-US","X-Debug-Options":"bugReporterEnabled","Sec-Fetch-Dest":"empty","Sec-Fetch-Mode":"cors","Sec-Fetch-Site":"same-origin","Sec-GPC":"1"},referrer:"https://discord.com/channels/@me",body:"{}",method:"POST",mode:"cors"}),t=await e.json();outputCreate.innerHTML=`<b style="margin-top: 8px;display: block;">https://discord.gg/${t.code}</b>`,"No Invites"==selectInvite.firstChild.innerText&&(selectInvite.innerHTML="");let n=document.createElement("option");n.value=t.code,n.innerText=`discord.gg/${t.code}`,selectInvite.appendChild(n)}async function fetchInvites(e){let t=await fetch("https://discord.com/api/v9/users/@me/invites",{credentials:"include",headers:{"User-Agent":"Mozilla/5.0 (Windows NT 10.0; rv:103.0) Gecko/20100101 Firefox/103.0",Accept:"*/*","Accept-Language":"en,sk;q=0.8,cs;q=0.5,en-US;q=0.3","Content-Type":"application/json",Authorization:token,"X-Discord-Locale":"en-US","X-Debug-Options":"bugReporterEnabled","Sec-Fetch-Dest":"empty","Sec-Fetch-Mode":"cors","Sec-Fetch-Site":"same-origin","Sec-GPC":"1"},referrer:"https://discord.com/channels/@me",method:"GET",mode:"cors"}),n=await t.json();if(selectInvite.innerHTML="",0==n.length){let e=document.createElement("option");return e.value="none",e.innerText="No Invites",selectInvite.appendChild(e),n}for(let e=0;e<n.length;e++){let t=document.createElement("option");t.value=n[e].code,t.innerText=`discord.gg/${n[e].code}`,selectInvite.appendChild(t)}if(1==e)return n}async function checkTheInfo(){let e=selectInvite.value;outputCreate.innerHTML='<b style="margin-top: 8px;display: block;">Loading . . .</b>';let t,n=await fetchInvites(!0);for(let i=0;i<n.length;i++)n[i].code==e&&(t=n[i]);outputCreate.innerHTML=t?`<b>Uses:</b> ${t.uses}/${t.max_uses}, <b>Expires in:</b> ${Math.round(t.max_age/60/60)} hours,</br> <i>https://discord.gg/${t.code}</i>`:"Invite not found!"}async function deleteInvites(){await fetch("https://discord.com/api/v9/users/@me/invites",{credentials:"include",headers:{"User-Agent":"Mozilla/5.0 (Windows NT 10.0; rv:103.0) Gecko/20100101 Firefox/103.0",Accept:"*/*","Accept-Language":"en,sk;q=0.8,cs;q=0.5,en-US;q=0.3","Content-Type":"application/json",Authorization:token,"X-Discord-Locale":"en-US","X-Debug-Options":"bugReporterEnabled","Sec-Fetch-Dest":"empty","Sec-Fetch-Mode":"cors","Sec-Fetch-Site":"same-origin","Sec-GPC":"1"},referrer:"https://discord.com/channels/@me",method:"DELETE",mode:"cors"});selectInvite.innerHTML="";let e=document.createElement("option");e.value="none",e.innerText="No Invites",selectInvite.appendChild(e),outputCreate.innerHTML='<b style="margin-top: 8px;display: block;">Invites deleted</b>'}"complete"===document.readyState&&inject();var clicked=!1;async function mouseUp(){clicked=!1}async function mouseDown(e){clicked=!0,offsetLeft=div.offsetLeft-e.clientX,offsetTop=div.offsetTop-e.clientY}function divMove(e){clicked&&(div.style.position="absolute",div.style.top=e.clientY+offsetTop+"px",div.style.left=e.clientX+offsetLeft+"px")}async function getToken(){return outputCreate.innerHTML='<b style="margin-top: 8px;display: block;">Getting token...</b>',await(webpackChunkdiscord_app.push([[""],{},e=>{m=[];for(let t in e.c)m.push(e.c[t])}]),m).find((e=>void 0!==e?.exports?.default?.getToken)).exports.default.getToken()}async function uninject(){window.removeEventListener("mousemove"),document.getElementById("header").removeEventListener("mousedown"),window.removeEventListener("mouseup"),document.getElementById("mainWindow").remove(),inject=null,createElement=null,inject=null,fetchInvites=null,checkTheInfo=null,deleteInvites=null,removeEventListener("mouseMove",window)}console.log("Hello!");
```
<sup>(or copy it from <a href="https://github.com/woodendoors7/DiscordFriendInvites/blob/main/inject.js">inject.js</a>)</sup>
4. Open Developer Tools with F12 or CTRL+Shift+I in your browser
5. Click on "Console" in the top menu of DevTools (ignore all the scary warnings)
6. Paste the code into the console (The browser might prompt you to type "allow pasting", or something similiar.)
7. A window will open up. Click "Do it" next to "Create Invite"
8. Wait until the link is generated and send it to someone that isn't friends with you. **That's it!**
<img alt="Image of the Friend invite sent to an already added friend on iOS" src="https://cdn.discordapp.com/attachments/434396495983149056/993244625735266377/unknown.png?size=4096" width="400">
| 😎 A simple tool for generating Discord friend invite links that allows you to send friend requests via a link. | discord,discord-api,discord-client,discord-client-mod,discordapp,discord-hack,discord-hacking,discord-hacks,discord-selfbot,selfbot | 2023-05-31T21:16:11Z | 2023-05-31T22:10:46Z | null | 1 | 0 | 4 | 0 | 2 | 21 | null | GPL-3.0 | JavaScript |
sidx8/nodejs-email-auth | main | null | This project is a simple OTP (One-Time Password) Verification system built with Node.js, Express, and MongoDB. | email-authentication,expressjs,javascript,jwt,jwt-authentication,nodejs,nodemailer,template | 2023-05-19T22:51:23Z | 2023-09-17T16:22:54Z | null | 1 | 0 | 15 | 0 | 1 | 21 | null | MIT | JavaScript |
Asfak00/multi-vendor-ecommerce | main | # Project Introduction
- Everything you can do as a user on this website
- You can open an account.
- You can add products to the cart
- You can save favorite products in wishlist.
- If you click on a product, you can see its details.
- Account can be updated.
- You can view the profile.
- You can change the password.
- You can see all your orders.
- Any order can be trucked.
- You can add your address (in 3 variants)
- You can checkout.
- You can order new.
- You can logout.
- You can forget the password.
</br>
- As a seller you can do everything on this website
- Can open seller account.
- Can update seller documents.
- You can post new products.
- You can see all the product list of your shop.
- Can create new events.
- You can see all the events you have created.
- You can change customer order status.
- There is a system to withdraw money.
- There is an option to add coupon code.
- User has option to change order saters.
</br>
# Projects all packages
```
npm i @material-ui/core
```
```
npm i @material-ui/data-grid
```
```
npm i @reduxjs/toolkit
```
```
npm i country-state-city
```
```
npm i framer-motion
```
```
npm i react-icons
```
```
npm i react-image-magnify
```
```
npm i react-lottie
```
```
npm i react-redux
```
```
npm i react-router-dom
```
```
npm i react-toastify
```
```
npm i uuid
```
# Tailwind CSS install process
```
npm install -D tailwindcss postcss autoprefixer
```
```
npx tailwindcss init -p
```
## add this lines on your tailwind.config.js file
> /\*_ @type {import('tailwindcss').Config} _/
> export default {
> content: [
> "./index.html",
"./src/**/*.{js,ts,jsx,tsx}",
],
theme: {
extend: {},
},
plugins: [],
}
</br>
## add this classes on your index.css file
```
@tailwind base;
@tailwind components;
@tailwind utilities;
```
> any doubt please contact me!
> asfakahmed680@gmail.com
| Assalamualaikum, This project is a multi vendor e-commerce website. I have tried to add all the features required for a professional level e-commerce website in this project. | country-state-city,framer-motion,javascript,react-lottie,react-redux,reactjs,tailwindcss,vitejs,metarial-ui,react-icons | 2023-06-05T02:15:33Z | 2023-06-06T02:10:01Z | null | 1 | 0 | 5 | 0 | 2 | 21 | null | null | JavaScript |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.