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 |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Zy8712/frontend-mentor-challenges-react | main | # frontend-mentor-challenges-react
Separate repository for the react versions of my work from Frontend Mentor.
See full list of attempts and completed Frontend Mentor challenges here: https://github.com/Zy8712/frontend-mentor-challenges/blob/main/README.md
| Separate repository for the react versions of my work from Frontend Mentor. | css,css3,hmtl5,html,html-css-javascript,javascript,javascript-framework,react,reactjs,tailwind-css | 2023-08-14T21:06:54Z | 2023-10-08T01:18:18Z | null | 1 | 0 | 27 | 0 | 0 | 2 | null | null | JavaScript |
Alexandrbig1/restaurant-Chicago | main | # Building Responsive Webdesign animated with HTML/CSS/SASS - project for restaurant "Chicago"
<img align="right" src="https://media.giphy.com/media/du3J3cXyzhj75IOgvA/giphy.gif" width="100"/>
## Project Specifications:
I have just finished Building Responsive Web-design animated with HTML/CSS/SASS - freelance project for restaurant "Chicago".
- Pretty nice and simple landing page for restaurant with nice animation added with SASS;
- HTML/CSS/SASS (responsive web design for desktop/tablets and mobile versions);
- Main menu is hidden, you can open the menu when pressed an burger icon with nicely smooth animation;
- There is a image card when you hovering you can see what the product is and the price as well as added button for order it;
- Project wireframe was build on Figma.
### Languages and Tools:
<div align="center">
<a href="https://en.wikipedia.org/wiki/HTML5" target="_blank"><img style="margin: 10px" src="https://profilinator.rishav.dev/skills-assets/html5-original-wordmark.svg" alt="HTML5" height="50" /></a>
<a href="https://www.w3schools.com/css/" target="_blank"><img style="margin: 10px" src="https://profilinator.rishav.dev/skills-assets/css3-original-wordmark.svg" alt="CSS3" height="50" /></a>
<a href="https://www.javascript.com/" target="_blank"><img style="margin: 10px" src="https://profilinator.rishav.dev/skills-assets/javascript-original.svg" alt="JavaScript" height="50" /></a>
<a href="https://sass-lang.com" target="_blank" rel="noreferrer"> <img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/sass/sass-original.svg" alt="sass" width="40" height="40"/> </a>
<a href="https://www.figma.com/" target="_blank" rel="noreferrer"> <img src="https://www.vectorlogo.zone/logos/figma/figma-icon.svg" alt="figma" width="40" height="40"/> </a>
<a href="https://git-scm.com/" target="_blank" rel="noreferrer"> <img src="https://www.vectorlogo.zone/logos/git-scm/git-scm-icon.svg" alt="git" width="40" height="40"/> </a>
</div>
### Connect with me:
<div align="center">
<a href="https://linkedin.com/in/alex-smagin29" target="_blank">
<img src=https://img.shields.io/badge/linkedin-%231E77B5.svg?&style=for-the-badge&logo=linkedin&logoColor=white alt=linkedin style="margin-bottom: 5px;" />
</a>
<a href="https://github.com/alexandrbig1" target="_blank">
<img src=https://img.shields.io/badge/github-%2324292e.svg?&style=for-the-badge&logo=github&logoColor=white alt=github style="margin-bottom: 5px;" />
</a>
<a href="https://stackoverflow.com/users/22484161/alex-smagin" target="_blank">
<img src=https://img.shields.io/badge/stackoverflow-%23F28032.svg?&style=for-the-badge&logo=stackoverflow&logoColor=white alt=stackoverflow style="margin-bottom: 5px;" />
</a>
<a href="https://dribbble.com/Alexandrbig1" target="_blank">
<img src=https://img.shields.io/badge/dribbble-%23E45285.svg?&style=for-the-badge&logo=dribbble&logoColor=white alt=dribbble style="margin-bottom: 5px;" />
</a>
<a href="https://www.behance.net/a1126" target="_blank">
<img src=https://img.shields.io/badge/behance-%23191919.svg?&style=for-the-badge&logo=behance&logoColor=white alt=behance style="margin-bottom: 5px;" />
</a>
</div>
| Responsive landing page (restaurant "Chicago") | css3,frontend,html-css-javascript,html5,javascript,sass,webdevelopment | 2023-09-09T15:51:26Z | 2023-09-30T16:33:40Z | null | 1 | 0 | 5 | 0 | 0 | 2 | null | null | CSS |
MohamedNoordin/YT-Commentator-Name | main | # YT-Commentator-Name
Introducing the remarkable YT Commentator Name extension, a groundbreaking tool designed to enhance the user experience for screen reader users on YouTube. This cutting-edge extension revolutionizes accessibility by seamlessly displaying commentator names alongside user IDs, just as YouTube used to before. With its elegant design and intuitive functionality (nonsense), the YT Commentator Name extension takes accessibility to new heights. But that's not all! This extraordinary extension goes above and beyond by incorporating accessible tags and symbols, allowing you to effortlessly differentiate between various comment types. Channel owner comments are distinguished by the majestic crown (👑) emoji, adding a touch of regality to their words. And when it comes to super thanks comments, they are elevated with the uplifting raising hands (🙌) emoji, signifying the gratitude and appreciation bestowed by fellow users. With the YT Commentator Name extension, accessibility becomes a captivating and immersive experience. Embrace the power of inclusivity and embark on a journey where accessibility meets elegance. Elevate your YouTube interactions today with this remarkable extension, and discover a world where every voice is heard and celebrated.
Do you think it's exaggerated? Yes, I see it too!
# How to use
This extension is not currently uploaded to the Chrome Web Store, so you have to enable developer mode to be able to use it.
```
git clone https://github.com/MohamedNoordin/YT-Commentator-Name.git
```
Or, download a recent release of this repo and unzip it.
- Open the extensions page from the Chrome toolbar, or simply, write chrome://extensions in the address bar of any tab.
- Toggle the "Developer mode" button at top-right on.
- Click on "Load unpacked"
- Find your way to and select the cloned repo YT-Commentator-Name directory.
Voilà! You now have the YT-Commentator-Name extension running up.
# Testing
- Open up [YouTube](https://www.youtube.com)
- Choose a video
- Scroll down to comments
- You can see commentator names shine next to user IDs
- You can now identify channel owner comments from normal and super thanks comments.
# How to contribute
Contributions are welcome. To contribute, please fork the repository and create a pull request.
| A tool designed to enhance the screen reader user experience on YouTube by seamlessly displaying commentator names alongside IDs. | chrome,chrome-extensions,comments,javascript,youtube | 2023-09-08T19:08:34Z | 2023-09-27T20:35:47Z | 2023-09-08T20:15:36Z | 1 | 0 | 7 | 0 | 0 | 2 | null | GPL-3.0 | JavaScript |
AB-DALRAHM-AN/Portfolio | main | # Hi This is my Portfolio | null | css,html,javascript | 2023-08-25T08:42:20Z | 2024-03-22T11:42:11Z | null | 1 | 2 | 35 | 0 | 0 | 2 | null | null | HTML |
BaseMax/ImageProcessingTSAPI | main | # Image Processing API with Face Detection and Emotion Analysis
This is a TypeScript-based RESTful API for image processing that includes features like face detection and emotion analysis. Users can register, login, generate API keys, upload images, and receive information about detected faces with their corresponding emotional states (e.g., happy, normal, angry, not happy).
## Prerequisites
Before you begin, ensure you have met the following requirements:
- Node.js and npm installed on your system.
- Git for cloning the repository.
## Demo
### Face datection:
### APIs
Register:
Login:
## Getting Started
Clone the repository:
```bash
git clone https://github.com/BaseMax/ImageProcessingTSAPI.git
cd ImageProcessingTSAPI
```
Install dependencies:
```bash
npm install
```
Run app:
```bash
npm run start:dev
```
## Configuration
Create a `.env` file in the project root and set the following environment variables:
```env
PORT=3000 # Port for the Express server
MONGODB_URI= # MongoDB connection string
JWT_SECRET_KEY= # Secret for JWT token generation
```
## Usage
**User Authentication**
Use the following endpoints for user registration and login:
- POST /api/auth/register for user registration.
- POST /api/auth/login for user login.
Authentication is required for the API key generation and image upload endpoints.
**API Key Generation**
After successful login, you can generate an API key by making a POST request to:
- POST /api/auth/generateApiKey
The generated API key should be included in the headers of image upload requests for authentication.
**Image Upload and Processing**
Upload an image and get face detection and emotion analysis results by making a POST request to:
- POST /api/upload/image
Include the API key in the headers to authenticate the request.
The API will return information about detected faces and their emotional states.
## Endpoints
**User Authentication:**
- POST /api/auth/register - Register a new user.
- POST /api/auth/login - User login.
**API Key Generation:**
- POST /api/auth/generateApiKey - Generate an API key for an authenticated user.
**Image Processing:**
- POST /api/face/detect - Upload an image for face detection and emotion analysis.
## Example
### Face Detection
The Image Processing API uses the face-api.js library for face detection. This library is a powerful tool for face detection and facial landmark recognition. Below, we'll provide more details and examples on how to use it.
### Face Detection Process
Uploading an Image: To detect faces in an image, you first need to upload an image to the API using the /api/upload/image endpoint.
Authentication: Ensure you include the API key in the headers of your request to authenticate.
Image Processing: The API will process the uploaded image and perform face detection using face-api.js.
Response: You will receive a JSON response containing information about the detected faces, including their positions and emotions.
Here's an example of the response you can expect from the API after uploading an image:
```json
{
"faces": [
{
"position": {
"top": 120,
"left": 280,
"width": 150,
"height": 150
},
"emotions": {
"happy": 0.75,
"normal": 0.2,
"angry": 0.05,
"not_happy": 0.0
}
},
{
"position": {
"top": 200,
"left": 450,
"width": 130,
"height": 130
},
"emotions": {
"happy": 0.6,
"normal": 0.35,
"angry": 0.03,
"not_happy": 0.02
}
}
]
}
```
## Example Usage
Here's an example of how to make a POST request to the API to upload an image and receive face detection results using a JavaScript fetch:
```javascript
const apiUrl = 'http://your-api-url/api/face/detect';
// Replace 'your-api-key' with a valid API key.
const apiKey = 'your-api-key';
// Create a FormData object to send the image.
const formData = new FormData();
formData.append('image', imageFile);
fetch(apiUrl, {
method: 'POST',
headers: {
'Authorization': `Bearer ${apiKey}`,
},
body: formData,
})
.then(response => response.json())
.then(data => {
// Process the data, which contains face detection results.
console.log(data.faces);
})
.catch(error => {
console.error('Error:', error);
});
```
## Contributing
Contributions are welcome! Please follow the Contributing Guidelines for this project.
## License
This project is licensed under the GPL-3.0 License - see the LICENSE file for details.
Copyright 2023, Max Base
| This is a TypeScript-based RESTful API for image processing that includes features like face detection and emotion analysis. Users can register, login, generate API keys, upload images, and receive information about detected faces with their corresponding emotional states (e.g., happy, normal, angry, not happy). | express,express-javascript,express-typescript,expressjs,expressts,javascript,js,ts,typescript | 2023-09-08T16:04:05Z | 2024-03-29T10:24:35Z | null | 1 | 4 | 79 | 0 | 0 | 2 | null | GPL-3.0 | TypeScript |
Foufou-exe/duckdns | main | # DuckDNS - Modernisation of the site
[](https://deepscan.io/dashboard#view=project&tid=22793&pid=26090&bid=825585)
This project aims to modernise the DuckDNS site.
## Description
The DuckDNS site is a platform for managing dynamic domain names. The aim of this project is to modernise the site's user interface using the latest web technologies.
## Features
- Modern, user-friendly interface
- Simplified management of dynamic domain names
- Integration with other services and tools
- Responsive design
- API for developers based on REST
- Panel for administrators and moderators
## Installation
Clone this repository on your local machine.
#### Frontend
1. Go to `web` folder.
2. Run `npm install` to install the dependencies.
3. Run `npm run dev` to launch the site.
#### Backend
1. Go to `api` folder.
2. Run `npm install` to install the dependencies.
3. Run `npm start` to launch the API.
__IMPORTANT: The backend must be launched before the frontend.__
#### Docker
1. Go to the root folder.
2. Run `docker build -t duckdns:latest .` to build image docker.
3. Run `docker run --name web-site-duckdns -d -p 8080:80 duckdns:latest` to launch the site.
Example: `http://localhost:8080/`
## Contribution
@Foufou-exe | @IzumiTV
## License
This project is licensed under the MIT license. Please see the `LICENSE` file for more information.
| Redesign of the DuckDNS website | css,duckdns,expressjs,html,javascript,vue,vue3,website | 2023-09-11T20:28:06Z | 2024-04-10T19:32:24Z | 2023-12-11T23:44:14Z | 3 | 23 | 13 | 0 | 0 | 2 | null | Apache-2.0 | Vue |
adamcegielka/website-html-css-js-adam-cegielka | main | # Adam Cegiełka - Portfolio Website
[](https://app.netlify.com/sites/adamcegielka/deploys)
Welcome to my repository containing my interactive portfolio. This is the place where I showcase my skills, projects and achievements using HTML, CSS and JavaScript.
## Description
My portfolio is an interactive website that serves as a showcase for my skills and work. I use HTML to structure the site, CSS for aesthetic styling and JavaScript to add interactivity such as animations or dynamic effects.
## Preview
You can see my portfolio in action at the link below:
[adamcegielka.pl](https://adamcegielka.pl/)
## Structure of the repository
- `index.html`: The main HTML file containing the structure of the portfolio website.
- `css`: Directory containing the page styles and layout.
- `js`: Directory containing the interactive elements of the page
- `icons/`: Directory containing the icons used in the portfolio.
- `images/`: Directory containing the images used in the portfolio.
- `video/`: Directory containing the films used in the portfolio.
- `tips/`: Directory with useful information.
- `tests/`: Website testing at Playwright.
## Technologies
- HTML
- CSS
- Bootstrap
- JavaScript (including jQuery library)
## Contact
If you have any questions or would like to contact me, you can email me at adamcegielka@proton.me
| My Portfolio | css,html,html-css-javascript,javascript,js,bootstrap,playwright-typescript,tests | 2023-08-31T17:53:28Z | 2024-04-13T09:05:11Z | null | 1 | 0 | 231 | 0 | 0 | 2 | null | null | HTML |
dumanimedia/calculator-app | mucho | null | Calculator App - Front-end Calculator challenge. | css,frontend-mentor,html,javascript,scss,web-design | 2023-08-25T01:02:29Z | 2023-08-25T01:00:42Z | null | 1 | 0 | 1 | 0 | 0 | 2 | null | null | CSS |
josafaverissimo/atacadao-portal273 | main | # Portal Interno - Atacadão Maceió Petropólis 273
Venho aprendendo muito sobre desenvolvimento de software e ainda mais sobre php. Então decidi aplicar isso no mundo real.
Criei esse portal para uma filial do Atacadão e uma das versões desse sistema já está em produção!
Eu estava aprendendo muito e praticando pouco. Estava sentindo que o que eu praticava não estava me levando ao limite. Então, eu decidi recriar o portal que já era utilizado por um que atendesse ou superasse as expectativas dos usuários para um portal interno.
Durante o desenvolvimento, me senti realmente testado e muito feliz no processo. Fiquei tão empolgado ao ponto de passar várias madrugadas programando esse portal. Foi uma ótima forma de praticar alguns design patterns e padrões de arquitetura como o MVC.
Eu comecei do zero, literalmente do zero. Implementei as minhas próprias rotas, para entender como funciona e como ajuda a centralizar as requisições à aplicação em um frontController, além de aprender como os middleswares e métodos http funcionam; Montei toda a arquitetura MVC do projeto, os controllers, models e orms, um próprio renderizador das views com o output buffer do php (parte que achei muito massa); Cheguei até a implementar meu próprio socket http.
Foi uma prática excessiva de orientação a objetos: encapsulamento, herança, sobreposição de métodos, interfaces, classes abstratas, classes anônimas, namespaces, autoload, etc. Também, entendi: algumas preocupações de segurança da aplicação; e o composer para gerenciar as dependências da aplicação.
O projeto está longe de acabar, anotei todas as ideias que surgiam em cards no trello e em blocos de anotações no oneNote, são muitas ideias para incrementar no sistema. Estou estudando desenvolvimento mobile com react native, mas pretendo me especializar na plataforma Android. Em breve, irei refazer um sistema similiar como aplicativo para praticar.
Quem quiser trocar alguma ideia comigo, bater um papo ou ajuda em algum projeto, pode me chamar no <a href="https://www.linkedin.com/in/josafaverissimo/">linkedin</a>, ou por email: josafaverissimo98@gmail.com
## Configurando o projeto
Basta somente inserir no servidor apache. A estrutura do banco de dados está no arquivo sql/0.0.0.sql.
Para saber como inserir os dados e realizar o deploy no servidor da filial entre em contato comigo.
| Sistema de portal interno para uma filial do atacadão | javascript,php8,atacadao | 2023-08-26T02:53:30Z | 2024-04-13T14:32:03Z | null | 1 | 1 | 236 | 0 | 1 | 2 | null | null | PHP |
YerrouHamza/MealEase-Vue | main | # Vue 3 + Vite
This template should help get you started developing with Vue 3 in Vite. The template uses Vue 3 `<script setup>` SFCs, check out the [script setup docs](https://v3.vuejs.org/api/sfc-script-setup.html#sfc-script-setup) to learn more.
## Recommended IDE Setup
- [VS Code](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur) + [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin).
| MealEase: A Vue 3-powered meal recipe app integrated with Flowbit, utilizing the MealDB API. Quickly search for recipes by meal or ingredient, access detailed instructions | css,flowbite,html,javascript,js,scss,skeleton,vue3,vuejs | 2023-08-27T15:44:01Z | 2024-04-21T16:10:51Z | null | 1 | 0 | 55 | 0 | 0 | 2 | null | null | Vue |
luksi02/MERN_Image_Generator | main | null | My clone of DALL-E, using MERN stack and OpenAI's DALL-E API. | dall-e,express,javascript,mern-stack,mongodb,nodejs,react,tailwindcss | 2023-08-10T15:58:51Z | 2023-08-27T21:47:25Z | null | 1 | 1 | 27 | 0 | 1 | 2 | null | null | JavaScript |
sivo91/AJAX-Programming | master | # AJAX Programming / JavaScript
## Introduction
Welcome to the AJAX Programming in JavaScript repository! This project is a comprehensive collection of examples and practical implementations showcasing AJAX (Asynchronous JavaScript and XML) techniques in JavaScript.
## About AJAX
AJAX allows web applications to send and retrieve data from a server asynchronously without interfering with the display and behavior of the existing page. By leveraging AJAX, developers can create more dynamic, responsive, and user-friendly web applications.
## Project Contents
This repository is organized into several sections, each focusing on different aspects of AJAX in JavaScript:
- **Basic AJAX Examples**: Fundamental examples demonstrating the core concepts and syntax of AJAX.
- **Form Handling**: Implementations showing how to efficiently handle form submissions.
- **Data Manipulation**: Advanced projects focusing on manipulating and presenting data dynamically using AJAX calls.
## Getting Started
To explore and test these examples, follow these steps:
1. **Clone the Repository**
3. **Browse Through the Examples**
Each folder contains separate examples or projects with its own specific README for detailed instructions.
## Prerequisites
- Basic understanding of HTML, CSS, and JavaScript.
- A modern browser with JavaScript support.
- A text editor or IDE for code editing purposes.
## Technologies
- JavaScript
- HTML5
- CSS3
## Contribution
Your contributions are always welcome! If you'd like to contribute, please follow these steps:
1. Fork the repository.
2. Create a new branch: `git checkout -b feature-branch-name`.
3. Commit your changes: `git commit -am 'Add some feature'`.
4. Push to the branch: `git push origin feature-branch-name`.
5. Submit a pull request.
## Feedback and Contact
For feedback, suggestions, or queries, feel free to [open an issue](https://github.com/your-username/ajax-programming-js/issues) on GitHub or contact me directly on p.sivak91@gmail.com
## Enjoy your coding journey! 🌟👨💻🚀
--------------------------------------------------------------------
## Open Source
This project is open-source and available under the MIT License. We encourage contributions and adaptations of this work.
## License
Copyright (c) last update[2023] [Peter Sivak]
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.
---
| College of San Mateo | ajax,javascript | 2023-08-23T23:28:36Z | 2024-05-06T17:42:09Z | null | 1 | 0 | 136 | 0 | 0 | 2 | null | null | HTML |
nishant05gaurav/Hackerrank_Problem_Solutions | main | # Hackerrank Problem Solutions
This repository contains solutions to the **Hackerrank** platform problems in various languages
- [C Languages](https://github.com/nishant05gaurav/Hackerrank_Problem_Solutions/tree/main/C-Language)
- [C++ Languages](https://github.com/nishant05gaurav/Hackerrank_Problem_Solutions/tree/main/CPP)
| Hackerrank problem solutions! | c-language,cpp,hackerrank,hackerrank-solutions,java,javascript,mysql,python | 2023-08-31T02:25:44Z | 2024-05-22T15:34:18Z | null | 1 | 0 | 89 | 0 | 0 | 2 | null | null | C |
LakshayD02/Captcha-Verification | main | # Captcha-Verification-Form
Captcha Verification Form made using HTML, CSS and JavaScript
Deployed Link - https://captchaverify-lakshay.netlify.app
| Captcha Verification Form made using HTML, CSS and JavaScript | css,css-grid,css3,html,html5,javascript,swal,font-awesome,cdn | 2023-08-20T12:12:16Z | 2023-08-20T12:15:22Z | null | 1 | 0 | 3 | 0 | 0 | 2 | null | null | CSS |
melvintivane/portfolio-website | main | # Portfolio Website
A portfolio website built with the React framework along with HTML and CSS. The website showcases my skills, projects, and experiences in a visually appealing and user-friendly manner.
## Overview
This portfolio website was created to highlight my professional achievements, showcase projects, and share information about my experience. The interface is designed to be intuitive and engaging, allowing visitors to easily explore my work.
## Demo
//
## Technologies
- React
- HTML
- CSS
- EmailJS
## Installation
Follow these steps to run the project locally:
1. Clone this repository: `git clone https://github.com/melvintivane/portfolio-website.git`
2. Navigate to the project directory: `cd portfolio-website`
3. Install dependencies: `npm install`
4. Start the development server: `npm run dev`
## Usage
Navigate through the site to explore different sections like skills, projects, and experiences. Click on the navigation links to smoothly scroll between sections. Feel free to get in touch using the contact information provided in the contact section.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for more details.
| A portfolio website built with React framework along with HTML and CSS. The website showcases my skills, projects, and experiences in a visually appealing and user-friendly manner. | css,html5,javascript,reactjs,emailjs | 2023-08-24T19:10:07Z | 2023-10-07T15:41:22Z | null | 1 | 0 | 59 | 0 | 0 | 2 | null | MIT | JavaScript |
zhorabay/Leaderboard | dev | <a name="readme-top"></a>
<div align="center">
<h3><b>Leaderboard</b></h3>
</div>
# 📗 Table of Contents <!-- omit in toc -->
- [🛠 Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Key Features ](#key-features-)
- [Prerequisites](#prerequisites)
- [🚀 Live Demo](#live-demo)
- [👥 Authors ](#-authors-)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [📝 License ](#-license-)
**[The leaderboard website]** displays scores submitted by different players. It also allows you to submit your score. All data is preserved thanks to the external Leaderboard API service.<br />
## 🛠 Built With <a name="built-with"></a>
### Tech Stack <a name="tech-stack"></a>
- HTML
- CSS
- JAVASCRIPT (ES6)
- WEBPACK
### Key Features <a name="key-features"></a>
- **[Enter name and score]**
- **[Click submit to store name and score]**
- **[Click refresh button to view the score list]**
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 🚀 Live Demo <a name="live-demo"></a>
- [Live Demo link](https://zhorabay.github.io/Leaderboard/dist/)
- ## 💻 Getting Started <a name="getting-started"></a>
To get a local copy up and running, follow these steps.
### Prerequisites
- Browser
- Node
- Code Editor
In order to run this project you need:
To get a local copy up and running follow these simple example steps.
- Choose a directory
- Open a Terminal
- write: git clone git@github.com:zhorabay/Leaderboard.git
- get into to directory "Leaderboard"
- write: npm install
- then write: npm start
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 👥 Authors <a name="authors"></a>
👤 **Assem Zhorabay**
- GitHub: [@zhorabay](https://github.com/zhorabay)
- LinkedIn: [@zhorabay](https://www.linkedin.com/mwlite/in/zhorabay)
- Twitter: [@zhorabay](https://twitter.com/AssemZhorabay)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 🔭 Future Features <a name="future-features"></a>
- [ ] **[Sort the data]**
- [ ] **[Give video background]**
<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/zhorabay/Leaderboard/issues/4)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## ⭐️ Show your support <a name="support"></a>
If you like this project, please, feel free to give a star the repository and share it with others who might benefit from it.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 🙏 Acknowledgments <a name="acknowledgements"></a>
I would like to thank the Microverse team and Code reviewers who helped me create this project and my husband and daughter for their tremendous support. Also, I would like to express my sincere gratitude to [Lucas Erkana](https://github.com/Lucas-Erkana) and [Raphael Miyoyo](https://github.com/rmiyoyo) for their valuable assistance in solving a problem in the JavaScript leaderboard app. Their expertise and guidance were instrumental in finding a solution.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 📝 License <a name="license"></a>
This project is [MIT](./LICENSE) licensed.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
| The leaderboard website displays scores submitted by different players. It also allows you to submit your score. All data is preserved thanks to the external Leaderboard API service. | api,es6,html-css,javascript,webpack | 2023-08-28T15:05:21Z | 2023-09-22T09:11:05Z | null | 1 | 3 | 33 | 2 | 0 | 2 | null | MIT | JavaScript |
jordanpapaditsas/xceptional-tactics | main | # Xceptional-Tactics
## Description
Xceptional Tactics is an interactive web-based Tic Tac Toe game built using HTML, CSS, and JavaScript. This project showcases Module design pattern and Factory functions, for better code's structure and maintainability through Encapsulation.
## Live Preview
**https://jordanpapaditsas.github.io/xceptional-tactics/**
## Features
- **Player Turn Display**: Keep track of the game progress with a clear indication of the current player's turn. The app shows the name of the active player.
- **Dynamic Game Board**: The game board dynamically updates as players make their moves, providing a visual representation of the game's progression.
- **Reset All and Try Again**: Contains a "Reset All" button for starting all over fresh. At the end of each round the "Try again" button appears that provides another chance to play the game.
- **Module and Factory Design Patterns**: The JavaScript logic behind Xceptional Tactics is implemented using Module and Factory design patterns, ensuring clean and maintainable code. This design pattern choice provides code organization and code reusability.
## Getting Started
Follow these steps to get the web application up and running on your local machine:
1. Clone this repository: `git clone https://github.com/your-username/xceptional-tactics.git`
2. Open the `index.html` file in your preferred web browser.
3. Explore the mechanism of the application.
4. Customize the content to fit your application's needs.
## Contributing
All contributions are accepted! If you'd like to contribute, please follow these steps:
1. Fork this repository to your GitHub account.
2. Create a new branch for your feature or bug fix: `git checkout -b feature/your-feature-name`
3. Make your changes and commit them with descriptive commit messages.
4. Push your changes to your forked repository.
5. Create a pull request to the `main` branch of this repository, describing your changes.
## License
This project is licensed under the [MIT License](LICENSE).
| A modern web application, showcasing the ageless Egyptian game Tic-Tac-Toe, made by JavaScript, HTML and CSS. | dom-manipulation,dynamic-programming,javascript,responsive-web-design,css3,html5,factory-pattern,module | 2023-08-22T18:08:47Z | 2023-09-18T19:49:52Z | null | 1 | 0 | 20 | 0 | 0 | 2 | null | MIT | JavaScript |
SuryaPratap2542/Plan-Maker | main |
# React Tours App
## Description
The React Tours App is a web application built using React that displays a list of tour destinations. Users can remove tours they are not interested in and refresh the list.
## Features
- View a list of tour destinations
- Remove tours from the list
- Refresh the list of tours
## Preview
<img width="786" alt="image" src="https://github.com/SuryaPratap2542/Plan-Maker/assets/89827931/20745e6d-70f5-467b-8def-5d93aeb54d0b">
## Technologies Used
- React
- CSS
- Data from JSON
## Installation
1. Clone the repository:
```sh
git clone https://github.com/your-username/react-tours-app.git
```
2. Navigate to the project directory:
```sh
cd react-tours-app
```
3. Install dependencies:
```sh
npm install
```
4. Start the development server:
```sh
npm start
```
5. Open your web browser and navigate to [http://localhost:3000](http://localhost:3000) to view the app.
## Usage
1. Browse the list of tour destinations.
2. Click the "Not Interested" button to remove a tour from the list.
3. If all tours are removed, click the "Refresh" button to restore the original list.
## Data Source
Tour data is sourced from the `data.js` file. Modify this file to add or update tour information.
## Contributing
Contributions are welcome! If you find any issues or would like to enhance the app, feel free to submit a pull request.
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
---
Designed and developed by [Surya Pratap Singh](https://github.com/SuryaPratap2542)
```
| The React Tours App is a web application built using React that displays a list of tour destinations. Users can remove tours they are not interested in and refresh the list. | css,dom,html,json,plan,reactjs,travel,javascript | 2023-08-26T06:45:40Z | 2023-08-26T06:52:54Z | null | 1 | 0 | 2 | 0 | 0 | 2 | null | null | JavaScript |
panahi-projects/tic-toc-toe | main | # Welcome to Tic Tac Toe
This is a simple implementation of the classic game, written in pure JavaScript, HTML, and CSS. It's a fun project that I've created during my leisure time, and I hope you enjoy playing it.
Currently, the game supports 2-player mode, where two players can take turns placing their marks on a 3x3, 6x6 grid or more. The first player to get three in a row (horizontally, vertically, or diagonally) wins the game. If all squares are filled and no player has won, then the game ends in a draw.
In the future, I plan to implement 1-player mode, where the computer will play against the human player. This will add an extra level of challenge and fun to the game.
To play, simply click on a square to place your mark (X or O).
I hope you have fun playing Tic Tac Toe! Let me know if you encounter any issues or have suggestions for improvements.
### Demo
### Getting Started
1. Clone the repository: git clone https://github.com/panahi-projects/tic-toc-toe.git
2. Navigate to the project directory: `cd tic-toc-toe`
3. Install the packages: `npm install`
4. Run the application: `npm run dev` or `npm start`
5. Open your browser and navigate to http://localhost:3000 to see the application in action.
#### Node version
This project has been started with Node v18.16.1
#### Acknowledgments
Many thanks to the creators of Express.js and Node.js for making such amazing tools available to the developer community.
| TIC TAC TOE game, a project as a hobby by vanilla Javascript | arcade-game,game,javascript,tic-tac-toe-game,typescript | 2023-08-18T13:33:49Z | 2023-10-11T07:40:02Z | null | 1 | 0 | 12 | 3 | 0 | 2 | null | null | TypeScript |
nathancaleb/caleb_tools | main | **<h1 align="center">Caleb Tools</h1>**
---
**<h2>SOBRE</h2>**
Projeto construído com intuito de estudo prático de HTLM/CSS/JS.
<a name="sumario"></a>
|**<h4>SUMARIO</h4>**|
|--------------------|
| _[1 - ESCOPO](#escopo)_ |
| _[2 - DETALHES](#detalhes)_ |
| _[3 - FERRAMENTAS](#ferramentas)_ |
| _[4 - SOBRE FERRAMENTAS](#sobre_ferramentas)_ |
| _[5 - TECNOLOGIAS](#tecnologias)_ |
| _[6 - CONTATO](#contato)_ |
<a id="escopo"></a>
> **_ESCOPO_**
Uma aplicação com diversas ferramentas que podem auxiliar no dia-a-dia dependendo da necessidade.
[Topo](#sumario)
<a id="detalhes"></a>
> **_DETALHES_**
A aplicação possui um menu lateral, onde cada botão representa uma ferramenta e uma tela principal logo ao centro onde as ferramentas iram funcionar. Junto ao menu lateral, foram criados caixas de texto com um nome descritivo de cada aplicação, as caixas são apresentadas quando o usuário passa com o mouse por cima do botão da aplicação.
[Topo](#sumario)
<a id="ferramentas"></a>
> **_FERRAMENTAS_**
- _[CALCULADORA](#calculadora)_
- _[CALENDÁRIO](#calendario)_
- _[PALAVRAS](#palavras)_
- _[SORTEIO DE NÚMEROS](#sorteio)_
- _[CONVERSOR DE TEMPERATURA](#temperatura)_
- _[PX TO REM](#pxtorem)_
- _[DADOS](#dados)_
- _[JOGO DA VELHA](#jogodavelha)_
- _[JOGO DA FORCA](#jogodaforca)_
[Topo](#sumario)
_________________________________
<a id="sobre_ferramentas"></a>
> **_SOBRE AS FERRAMENTAS_**
<a id="calculadora"></a>
<b>[ _CALCULADORA_ ]</b>
_* Tech: HTML, CSS, JavaScript;_
_* Utilidade: Realizar contas básicas de matemática;_
_DETALHES: A calculadora realiza operações de adição(+), subtração(-), multiplicação (*), divisão(/) e calcula porcentagem de um valor sobre o outro, é possível negativar os números e definir casas decimais, limpeza dos dados e cancelamento de operação._
_FUNCIONAMENTO: Basicamente a calculadora trabalha com quatro variáveis, sendo o primeiro número (n1) a operação matemática desejada (operação) o segundo número (n2) e o número resultado (result)._
_No fluxo, a aplicação solicita o primeiro número, o mesmo para de concatenar os valores inseridos após o usuário clicar no símbolo operador desejado, feito isso, a aplicação solicita o segundo número e da mesma maneira, para de concatenar os valores inseridos até que o botão de "igual" será clicado, apresentando o valor final._
_É possível continuar a operação a partir do resultado da última equação, pois, após a operação realizada o resultado é atribuído ao primeiro valor. As operações podem ser realizadas sem que o usuário precise ficar clicando no botão de "igual", após inserir o primeiro valor, operação desejada e segundo valor, caso ele clique em um outro operador, a primeira operação será realizada, resultado atribuído ao primeiro número e a operação desejada irá continuar sendo executada a partir dali._
_Para no caso do usuário não informar os valores, sempre que clicar num operador ou no botão de resultado, os números receberam o valor 0.(Ex: Usuário clicar em (+) e depois em igual (=), a calculadora irar realizar a operação 0 + 0)._
_Todos os valores da operação, são inseridos como STRING (números, operadores) e depois que a toda operação é definida (N1 (operador) N2) eles são validados e então convertidos para realização da operação matemática e depois o resultado é convertido novamente para STRING. Para criar e manipular os números (negativo, decimal, primeiro numero está definido, qual operador será utilizado, etc), usamos variáveis booleano, que são validadas por funções._
_* Construção e Estilização: Aplicação construída apenas com caracteres (sem imagens) e estilizada com CSS bruto._
<a id="calendario"></a>
<b>[ _CALENDARIO_ ]</b>
_* Tech: HTML, CSS, JavaScript;_
_* Utilidade: Calendário interativo para consulta de datas;_
_DETALHES E ESTRUTURA: O calendário apresenta a hora atual(atualiza conforme os segundos passam), a data de hoje por extenso(ex: domingo, 1 de janeiro de 2023) e logo abaixo o calendário do mês atual, informando como uma espécie de título o mês e o ano atual, abaixo uma legenda para os dias da semana(Ex: DOM, SEG) e os dias do mês conforme cada dia da semana e abaixo, botões que levam para uma espécie de seleção de mês e ano, tornando a navegação mais dinâmica e rápida._
_CONSTRUÇÃO: Utilizando a instância Date, crio variável para o mês atual(mês/ano) e o último dia do mês atual. Com o último dia do mês, utilizo uma estrutura de repetição onde é atribuído dentro de um array um objeto com o dia, dia da semana e mês. Para os meses que não iniciam no domingo(primeiro dia da semana), usamos uma nova estrutura de repetição, onde colhemos os dias do mês passado até chegar no domingo, o intuito é não deixar espaços em branco no calendário, o mesmo processo é feito no final do calendário, onde preenchemos com dias do mês seguinte até o dia sábado._
_Após colher as informações, inicia uma função que irá mostrar os dados na tela. É criado um Array com os nomes dos meses e atrelados cada uma com seu valor correspondente na instância Date. Imprime nome do mês e ano atual como titulo, depois, utilizando estrutura de repetição, retiro os dados do Array preenchidos anteriormente e atribuímos cada dia em um novo Array referente a semana que ele pertence, iniciando sempre com os dias do mês anterior, em seguida com os dias do mês atual e depois com os dias do mês seguinte._
_Após imprimir o calendário, inicia a função de seleção de dia, onde é possível clicar no dia desejado e o mesmo fica selecionado em tela. Tal função foi implementada para futuras utilidades._
_FUNCIONAMENTO: Para navegar de mês em mês, foram implementados nas laterais do título do mês, botões com setas, cada um indicando para o lado que está, onde o da esquerda vai para o mês anterior e o da direita, para o próximo mês. Cada um executa uma função onde iniciamos uma função de limpeza de tela, variáveis e validadores, reduzimos ou incrementamos um do valor do mês, dependendo do botão clicado e logo é executado a função de colher dados e de impressão em tela, assim gerando o calendário de outro mês._
_Para a apresentação da hora, existe uma função com uma nova instância Date, onde é atrelada a variáveis de hora, minuto e segundo, em seguida é realizado o incremento do zero a esquerda, para números menores que 10 e assim o valor é impresso em tela. A função está configurada para executar de 1 em 1 segundo, assim funcionando como um relógio. Para a data em extenso utilizamos o mesmo do título do calendário utilizando também outro Array com o nome dos dias da semana._
_BOTÃO DEFINIR MÊS: Inicialmente, ao clicar, ele remove a visibilidade de todos os itens do calendário, e ativa a visibilidade de uma nova janela, onde é apresentando como titulo o ano selecionado(no caso inicialmente, o ano atual) e em botões as iniciais de cada mês, onde o mês selecionado(no caso inicialmente, o mês atual) vai estar com uma cor diferente indicando estar selecionado. Estes botões com os meses são pré criados no HTML e cada um possui uma função de click, passando o valor correspondente ao mês, ao clicar no mesmo, ele executa a função de limpeza, subtrai o valor do mês atual pelo mês escolhido(Vice-versa, depende qual possui maior valor) e esse valor é atrelado a variável com a instância Date, em seguida, executa função para pegar os dados e depois de impressão de dados, removendo a visibilidade deste menu de meses e reativando a visibilidade dos itens de calendário, assim apresentando o mês selecionado. É possível alterar o ano, clicando no título com o ano._
_BOTÃO DEFINIR ANO: Funciona como o menu de opções de meses, mas este apresenta anos. Neste menu são apresentados os anos em botões, em destaque, sempre em um período de 10 anos(EX: 2020 a 2029, 2000 a 2009), apresentado também, antes do período destaque, o último ano da última década e após o período destaque, o primeiro ano da próxima década. Assim como no menu de meses, executa função de limpeza, atrela o valor desejado a instância DATE, colhe os dados, imprime, desabilita visualização do menu, reabilita do calendário. No título deste menu, é apresentado o período destaque, e através das setas podemos navegar pelas décadas._
_SOBRE LIMITE DO CALENDÁRIO: O calendário, regredindo os meses, funciona até janeiro de 1970 conforme informado na documentação da instância Date. Ao tentar passar o limite, um alerta em tela é apresentado, informando sobre o limite._
_* Construção e Estilização: Arquivo SVG para botões (seta), estilização com CSS bruto e criação de elementos com JavaScript._
<a id="palavras"></a>
<b>[ _PALAVRAS_ ]</b>
_* Tech: HTML, CSS, JavaScript;_
_* Utilidade: Manipulação de letras, palavras e textos, podendo alterando maiúscula/minúscula, ordem alfabÉtica e contador de caracteres ;_
_A aplicação inicialmente possui uma grande caixa de texto (textArea), onde acontece toda a interação com as letras e palavras, e no topo, um menu com botões relacionado aos tipos de interações. Clicando no botão, as opções de interação iram aparecer abaixo da caixa de texto, de acordo com sua função._
_As aplicações estão escondidas através de CSS, utilizando a propriedade ```display: none;``` ao clicar no botão, a aplicação desejada fica visivel por ```display: flex;```_
<b>MAIÚSCULO E MINÚSCULO</b>
_Na ferramenta MAIÚSCULO/MINÚSCULO é possivel manipular letras, palavras e textos através das opções disponiveis. Com o texto inserido na caixa de texto e a opção desejada selecionada, basta clicar no botão << TRANSFORMAR >> e o proprio texto digitado na caixa de texto será transformado._
_MAIÚSCULO: Esta opção transforma todo o texto em maiúsculo._
_MINÚSCULO: Esta opção transforma todo o texto em minúsculo._
_AUTERNADO: Esta opção transforma o texto alternando cada letra entre maiúscula e minúscula_
_INVERTER TEXTO: Esta opção transforma o texto colocando o mesmo de trás para frente_
_PRIMEIRA LETRA PALAVRA: Esta opção tranforma o texto colocando a primeira letra de cada letra em maiúscula e o restante de cada palavra em minúscula_
<b>ORDEM ALFABÉTICA</b>
_Na Ferramenta ORDDEM ALFABÉTICA é possivel ordernar as palavras através das opções disponiveis_
_TIPO DE ORDENAÇÃO: Esta opção define se a ordem alfabética seguira o fluxo normal ou de traz pra frente (de A ao Z ou de Z ao A)_
_SEPARAR POR: Esta opção define qual tipo de caractere será usado para separar as palavras, sendo estes << Quebra de linha>>, << Espaço >>, << Vírgula >>, << Ponto e Vírgula >> e << ponto >>_
_RETORNAR POR: Esta opção define qual tipo de caractere será usado para separar as palavras quando retornamos o resultado da ordenação, sendo estes << Quebra de linha>>, << Espaço >>, << Vírgula >>, << Ponto e Vírgula >> e << ponto >>_
_REMOVER DUPLICADOS: Esta opção define se a aplicação irá remover os valores repitidos ou se seram ordenados também_
<b>CONTADOR DE CARACTERES</b>
_Na ferramenta CONTADOR DE CARACTERES a aplicação ira contabilizar os caracteres, palavras e linhas que são inseridos na caixa de texto, em tempo real._
_* Construção e Estilização: Estilização com CSS bruto._
<a id="sorteio"></a>
<b>[ _SORTEIO DE NÚMEROS_ ]</b>
_* Tech: HTML, CSS, JavaScript;_
_* Utilidade: Sortear um ou mais números no intervalo desejado;_
_DETALHES: O usuário determina a quantidade de números e o intervalo de números que ele deseja, o resultado do sorteio é apresentado na tela com a identificação de qual o sorteio é aquele. O usuário pode realizar novos sorteios, com outra quantidade e intervalo conforme desejar, que serão também apresentados logo acima dos sorteios anteriores._
_ESTRUTURA: Em questão de estrutura, a aplicação é dividida em duas seções, onde na primeira existem 1 caixa de texto para definir a quantidade de números que serão sorteados e outras duas onde o usuário irá definir o intervalo de números a ser sorteado, logo abaixo um botão que irá disparar o sorteio. A segunda seção será onde os resultados serão exibidos, cada sorteio será exibido em uma caixa, com um cor destaque, com os números sorteados em destaque e logo abaixo qual o número daquele sorteio realizado._
_FUNCIONAMENTO: No primeiro momento a aplicação verifica se os números digitados são de fato números e caso não seja(letras, caracteres especiais, etc.), um alerta é enviado, solicitando preencher os campos corretamente, em seguida, a aplicação verifica se o intervalo de números está correto, em ordem crescente, caso contrario outro alerta é disparado._
_A aplicação vai pegar os números do intervalo e jogar cada valor a uma posição de um Array, em seguida, a aplicação executara um comando de número randômico conforme o intervalo numérico, o número escolhido será removido do Array de números a serem sorteados e dependendo da quantidade de números a ser sorteado que o usuário determinou, ele irá atribuir o número a uma variável única ou o valor será adicionado a um array que recebera a quantidade de números a mais a serem sorteados e o processo repete._
_Todos os valores definidos, o resultado é passado a uma função, que irá verificar se um sorteio foi feito antes, caso não, ele cria elementos HTML na seção de resultados, caso já feito, ele vai pegar o último resultado impresso e irá imprimir acima do último resultado._
_* Construção e Estilização: Aplicação estilizada com CSS bruto e criação de elementos com JavaScript._
<a id="temperatura"></a>
<b>[ _CONVERSOR DE TEMPERATURA_ ]</b>
_* Tech: HTML, CSS, JavaScript;_
_* Utilidade: Conversor de formatos de temperatura;_
_DETALHES: O usuário informa o valor da temperatura, o formato da temperatura (Celsius, Fahrenheit ou Kelvin) inicial e a que ele deseja converter para e aplicação apresenta a temperatura._
_ESTRUTURA: Em questão de estrutura, a aplicação está centralizada em tela, possui um caixa de texto do tipo número, onde recebe o valor da temperatura pelo usuário e ao lado uma caixa onde o valor convertido será apresentado, abaixo das caixas, dois menus fechados de seleção, um ao lado do outro, quando clicado, irá apresentar os formatos de temperaturas disponíveis para seleção, ambos os menus são exatamente iguais._
_MENU SELECT: Referente aos menus de seleção, foram baseados no elemento HTML < select >, porém, com intuito de customizar o menu, deixando com o estilo da aplicação, o menu foi construído através do elemento lista, botões do tipo Radio e texto atrelado a cada botão Radio. O script houve o elemento pai e assim que clicado, o elemento do tipo lista contendo os botões Radio irão aparecer, dependendo de qual opção clicada, o Radio será definido e o elemento pai irá receber o texto da opção selecionada._
_FUNCIONAMENTO: O usuário deve digitar a temperatura e definir o formato inicial e o para qual será convertido, a aplicação só ira apresentar o resultado assim que todos esses requisitos forem preenchidos. Cada um dos elementos(Caixa de texto da temperatura e todos os botões Radio com os formatos de temperatura), recebem um escutador de eventos (caixa de texto - keyup / menu radio - change), que ao ser executados, ele executa as funções que irão executar a aplicação._
_A primeira função checa o valor digitado, converte ele de texto para número e se o valor é valido, verifica qual opção do menu de formatos foi selecionado. A segunda função faz as verificações condicionais conforme as opções selecionadas, conforme os mesmos as operações matemáticas são realizadas. Caso o usuário selecione opções de formato iguais, a aplicação envia um alerta solicitando a troca de uma das opções. Após as operações serem realizadas, a aplicação pega o resultado e atribui como texto na caixa de resultado._
_* Construção e Estilização: Aplicação estilizada com CSS bruto e criação de elementos com JavaScript._
<a id="pxtorem"></a>
<b>[ _PX TO REM_ ]</b>
_* Tech: HTML, CSS, JavaScript;_
_* Utilidade: Conversor de formatos de tamanho para CSS;_
_DETALHES: O usuário poderá converter valores em PX(pixel) para REM(root em) e vice-versa._
_ESTRUTURA: Em questão de estrutura, a aplicação está centralizada em tela, possui um caixa de texto do tipo número, onde recebe o valor que o usuário deseja converter e ao lado uma caixa onde o valor convertido será apresentado, abaixo das caixas, duas caixas apresentando o tipo de formato inicial e final com suas respectivas siglas e entre as caixas, um botão que inverte a posição dos formatos._
_FUNCIONAMENTO: O usuário deve digitar o valor inicial a ser convertido. A caixa de texto possui um escutador de evento e assim que o usuário começa a digitar a aplicação já dispara a função que irá realizar a conversão. A aplicação já inicia com os valores de formato já pré-definidos, sendo o formato inicial PX e o formato final REM. Caso o usuário clique no botão de troca de formato, a aplicação irá trocar as siglas e os valores das caixas de apresentação e em seguida executar a função de conversão._
_A função de conversão transforma o valor em valor com casas decimais, faz a verificação de condicional e executa a operação matemática conforme escolhido pelo usuário, o valor final recebe 3 casas decimais e é impresso na caixa de resultado._
_* Construção e Estilização: Botão criado com uma imagem SVG, aplicação estilizada com CSS bruto e criação de elementos com JavaScript._
<a id="dados"></a>
<b>[ _DADOS_ ]</b>
_* Tech: HTML, CSS, JavaScript, Krita;_
_* Utilidade: Simulação de dados D6 e D20;_
_DETALHES: O usuário poderá escolher qual tipo de dado (D6 ou D20) deseja utilizar e ao clicar no mesmo, o resultado é apresentado tanto no desenho do dado, quanto no campo lateral._
_ESTRUTURA: Em questão de estrutura, a aplicação está dividida em 3 seções. Na seção do top, dois botões, um para cada dado ser selecionado, enquanto abaixo, duas seções dividem a tela, sendo a primeira, onde a figura dos dados são apresentados, quanto a outra metade, apresenta o histórico das jogadas de dados que já aconteceram, com o número sorteado, a rodada e o tipo de dado usado._
_FUNCIONAMENTO: Inicialmente é apresentado apenas os dois botões no topo referentes aos Dados de 6 lados e de 20 lados respectivamente, o usuário clica no botão do dado desejado e uma função é disparada, enviando junto o tipo de dado que foi clicado. A função começa resetando todas as variáveis e valores (função executada neste ponto para limpeza de futuros dados atribuídos) e após atribui estilo ao botão selecionado, em seguida ele executa a função de criação do dado em tela, a função recebe o tipo de dado, cria um elemento HTML do tipo IMG e atribui a imagem JPG do dado, assim o apresentando na tela, antes de finalizar a função, uma variável para validação se o dado está criado recebe valor TRUE._
_Com o Dado em tela, uma validação condicional referente ao dado estar criado é executada, adicionando um escutador de evento CLICK no dado com função para rodar o dado e outra para apresentar o resultado._
_A função de rodar o dado executa recebendo o tipo do dado, inicialmente ele faz o sorteio do número referente ao dado escolhido, em seguida executa uma função que através do tipo do dado e do número sorteado, vai realizar verificações condicionais e pegar a imagem correspondente aquele lado do dado sorteado (cada lado de ambos os dados estão em imagens (png ou jpg) dentro das pastas de assets referente a aplicação), o endereço da imagem será retornado a uma variável e depois atribuída ao Elemento HTML de imagem do Dado para ser alterado._
_A função de apresentação é executada recebendo o resultado e o tipo de dado, um contador de vezes que os dados são rolados é incrementado, elementos HTML são criados para o painel de resultados, e os valores (Número sorteado, vez que o dado foi rolado e o tipo de dado usado naquela vez) são apresentados em tela. A cada vez que o dado for rolado, independente se o tipo for alterado, o histórico continuara se formando de maneira contínua._
_* Construção e Estilização: Imagens dos lados dos dados (D6 e D20) foram criados por min através do programa de criação e edição de imagens gratuito open source Krita, aplicação estilizada com CSS bruto e criação de elementos com JavaScript._
<a id="jogodavelha"></a>
<b>[ _JOGO DA VELHA_ ]</b>
_* Tech: HTML, CSS, JavaScript;_
_* Utilidade: Jogar Jogo da Velha;_
_DETALHES: O usuário poderá escolher qual simbolo irá jogar (X ou O) e após clicar em algum espaço do tabuleiro, o jogo ira iniciar, baseado nas regras do jogo da velha clássico._
_ESTRUTURA: Em questão de estrutura, a aplicação está dividida em 2 seções. Na primeira seção, temos a caixa de ambos os jogadores, cada um com seu símbolo pré-definido, e logo abaixo uma caixa com o placar de vitórias respectivamente, caso o jogador clique no símbolo irá aparecer uma caixa apresentando os dois símbolos para que o jogador possa escolher com qual vai jogar. Na seção abaixo, esta disponível o tabuleiro do jogo, criado por meio de tabelas e tomando forma por meio de css._
_FUNCIONAMENTO: Referente ao menu de escolha de símbolo, ao clicar em um dos símbolos (player 1 ou player 2), será executada uma função que recebera qual player está sendo selecionado, a função faz uma verificação condicional verificando se o jogo já começou, caso negativo, o mini menu será apresentado por meio de atributos de CSS, caso o jogo já tenha começado, o aplicativo irá apresentar um alerta, informando que não é possível trocar o símbolo. Com o menu aberto, é apresentado duas caixas, cada uma com um símbolo (X ou O) e clicando em um dos dois, a aplicação executara uma função de mudança de símbolo, a função recebe o tipo de símbolo clicado, e por meio de verificação condicional, faz as alterações de imagem e atribui os novos valores a variáveis de verificação, em seguida, o menu é fechado por meio de atributos css._
_Ao clicar em um dos quadros do tabuleiro é disparada a função de play passando qual caixa foi clicada, sendo a primeira caixa do topo a esquerda e a última de baixo a direita, A função inicialmente verifica se o jogo já começou e caso não tenha, ele irá pegar 1 Array com 3 Arrays dentro que simularão nosso tabuleiro (cada um com 3 casas, no final, simulando uma matriz 3x3) e irá preencher com valores de 10 a 18, pois os valores de cada casa não podem ser iguais e diferente de 1 a 9. Após preencher a matriz, a variável de game iniciado recebe True. Após declarado o início do game uma verificação condicional irá verificar se a casa clicada esta vazia, caso espaço esteja preenchido ele irá imitir um alerta, caso não, o jogo segue, adicionando a um array o número do espaço clicado para que nas próximas jogadas, ele não possa ser clicado mais e em seguida, preenche o tabuleiro com o símbolo referente ao jogador da vez, feito isso, a aplicação executa uma função que irá checar a última jogada concluiu com um vencedor._
_A função de rodar o dado executa recebendo o tipo do dado, inicialmente ele faz o sorteio do número referente ao dado escolhido, em seguida executa uma função que através do tipo do dado e do número sorteado, vai realizar verificações condicionais e pegar a imagem correspondente aquele lado do dado sorteado (cada lado de ambos os dados estão em imagens (png ou jpg) dentro das pastas de assets referente a aplicação), o endereço da imagem será retornado a uma variável e depois atribuída ao Elemento HTML de imagem do Dado para ser alterado._
_A função que irá verificar o vencedor, recebe qual espaço foi clicado e o jogador da vez, primeiramente ela incrementa uma variável que verifica o número de turnos jogados, esta variável ira determinar se ouve um empate, em seguida executa uma verificação condicional relacionando o espaço clicado e atribuindo o número do player(player "1" ou player "2") ao espaço referente na Matriz 3x3 (3 Arrays de 3 espaços) e em seguida, outra verificação condicional verificando se as posições do array possuem os mesmo valores (as posições definidas, são referentes as linhas, colunas e diagonal que dão vitória ao jogador segundo as regras do jogo da velha clássico), caso nenhuma atenda, o jogo continua aguardando próxima escolha do próximo jogador, caso o total de jogadas for igual a 9 e nenhum dos requisitos de vitória não tiverem sido atendidos, o jogo declara empate e caso haja um vencedor é executado uma função de vencedor, passado o número do jogador vencedor._
_A função de vencedor irá incrementar na pontuação do jogador e apresentar em tela o valor adicionado, a função irá criar um modal em tela, informando o vencedor e após feito isso é executada uma função que irá adicionar um escutador de evento do tipo CLICK ao modal, clicando no mesmo, ele executar uma função de limpeza, essa função ira resetar os valores iniciais de cada variável, remover os símbolos dos tabuleiros e remover o modal criado, mantendo apenas a variável de pontuação dos jogadores. O mesmo esquema do modal é feito para caso o jogo seja empatado._
_Voltando no caso de não houver vencedor ou empate ainda, a função de checar vitoria é encerrada, e executada uma verificação condicional para trocar os jogadores, uma função que ira troca o estilo da caixa do jogador, indicando que ele será o próximo a jogar e assim o jogo continuará._
_* Construção e Estilização: Simbolos X e O são imagens SVG, aplicação estilizada com CSS bruto e criação de elementos com JavaScript._
<a id="jogodaforca"></a>
<b>[ _JOGO DA FORCA_ ]</b>
_* Tech: HTML, CSS, JavaScript, Krita;_
_* Utilidade: Jogar Jogo da Forca;_
_DETALHES: O usuário irá inserir uma palavra secreta, após outro jogador tera que adivinhar as palavras antes que o boneco desenhado representado em imagem seja enforcado._
_ESTRUTURA: Em questão de estrutura, a aplicação no primeiro momento apresenta uma caixa de texto padrão PASSWORD com um botão para iniciar o jogo, após iniciado, a aplicação é dividida em 3 seções, a primeira apresenta a imagem da forca, que é atualizada toda vez que o jogador erra, abaixo a seção da palavra secreta, onde foi criado uma caixa por letra com a borda inferior para indicar cada espaço de letra e por fim uma seção para o teclado virtual, onde é apresentado um botão por letra do alfabeto, seguindo o padrão QWERTY dos teclados físicos. Ao final do jogo é apresentado um modal com texto de vitória ou derrota dependendo do resultado._
_FUNCIONAMENTO: Ao iniciar a aplicação, o usuário deve digitar a palavra que deseja se adivinhada e ao clicar em START é executada uma função, A função primeiramente faz uma verificação condicional referente a palavra secreta digitada, caso a palavra tenha não tenham apenas letras do alfabeto (caso números, caracteres especiais, etc.) a aplicação retorna um alerta, solicitando digitar novamente, caso positivo, a caixa de texto é ocultada e as seções com o desenho da forca, as letras ocultas e o teclado virtual são revelados, em seguida, a palavra digitada e o número de caracteres da palavra são atribuídos ambos em variáveis e por meio de um FOR a aplicação cria elementos HTML para cada letra preenchendo com *(Asterisco). Uma verificação condicional verifica se o jogo já foi inicializado alguma vez, e caso negativo, a aplicação ira adicionar escutador de eventos nas teclas do teclado virtual, que ao clicados, valores de conteúdo da tecla e a própria tecla, são armazenados em variáveis e as mesmas passadas em uma função que irá checar a letra clicada. Uma função é executada antes, onde a aplicação adiciona escuta de evento no documento, referente a teclado, que ira se comportar da mesma maneira das teclas do teclado virtual, desde que essas teclas sejam das letras do alfabeto, caso contrario um alerta é enviado._
_A função, irá verificar se a letra já foi escolhida anteriormente, por meio de um Array que recebera todas as letras escolhidas, certas e erradas, caso negativo, a variável que determina se o jogo já foi jogado alguma vez recebe verdadeiro (essa variável vai impedir que a aplicação adiciona mais de um escutador de eventos nas teclas) e após, irá executar três funções em sequência._
_A primeira função irá verificar se a letra escolhida está correta, primeiro ele dividi a palavra secreta em um Array e depois verifica se a letra escolhida esta dentro do Array de letras, caso positivo, ele substitui o asterisco dentro do Elemento HTML das letras secretas pela letra escolhida, caso contrario será adicionado ao contador de erros mais um e a medida que o valor deste contador vai aumentando, uma verificação condicional vai alterando as imagens da forca até chegar na imagem final. No final de ambas condicionais, a função retorna verdadeiro caso a letra esteja correta e falso caso a letra esteja errada, atribuindo a uma variável que será passada na próxima função._
_A segunda função irá trocar a cor da tecla escolhida no teclado virtual com intuito de relembrar acertos e erros ao jogador. A função recebe a tecla clicada e o retorno da última função dizendo se acertou ou errou, caso positivo a função trocara o fundo da tecla para azul, caso errado, troca a cor de fundo da tecla para vermelho._
_A terceira função irá checar se o jogador venceu, a aplicação executa uma verificação condicional, caso o contador de acertos for igual ao contador total de letras, ele terá vencido, caso o contador de erros seja igual a 8, o jogador perdeu. Ambas as condições abrem um modal apresentando a mensagem de vitória ou derrota, uma imagem final é apresentada e o modal possui um botão com uma função de reset, que irá redefinir o valor das variáveis, voltar a imagem da forca inicial, resetar os estilos das teclas clicadas, remover as letras secretas e por fim, remover a visibilidade das três seções de game e reabilitando a visibilidade da caixa de texto, assim, reiniciando o jogo._
_* Construção e Estilização: Imagens do boneco e da forca foram criadas por min através do programa de criação e edição de imagens gratuito open source Krita, aplicação estilizada com CSS bruto e criação de elementos com JavaScript._
[Ferramentas](#ferramentas) - [Topo](#sumario)
---
<a id="tecnologias"></a>
**<h2>TECNOLOGIAS</h2>**
<img src="./.github/html5_svg.svg"> HTML
<img src="./.github/css_svg.svg"> CSS
<img src="./.github/js_svg.svg"> JavaScript
<img src="./.github/krita_svg.svg"> Krita
[Topo](#sumario)
---
**<h2>PROJETO</h2>**
[Clique aqui para acessar o projeto;](https://nathancaleb.github.io/caleb_tools/)
---
<a id="contato"></a>
**<h2>CONTATO</h2>**
E-mail: nathancalebss@gmail.com
[Topo](#sumario) | Aplicação que reúne diversas ferramentas | css,html,javascript | 2023-08-31T15:55:57Z | 2023-10-20T06:46:28Z | null | 1 | 0 | 57 | 0 | 0 | 2 | null | null | JavaScript |
Odisseu93/top-commerce | main | # Top Commerce
## About / Sobre
Personal project of a fictitious E-commerce,
with the goal of studying the architecture, creation, and maintenance of a full-stack application (backend and frontend, database, etc.).
*Projeto pessoal de um Ecommerce fictício,
com o objetivo de estudar a arquitetura, criação e manunteção de uma aplicação full stack (backend e frontend, banco de dados, ETC).*
## Tech stack / lista de tecnologias
As suas principais tecnologias, são:
- [Docker](https://docs.docker.com/)
---
### Frontend
- [React.js](https://react.dev/)
- [TypeScript](https://www.typescriptlang.org/)
- [Styled Components](https://styled-components.com/)
- [Vite.Js](https://vitejs.dev/)
---
### Backend
- [Express.Js](https://expressjs.com/pt-br/)
- [Node.Js](https://nodejs.org/en)
- [Sequilize - ORM](https://sequelize.org/docs/v6/getting-started/)
---
### Database / Banco de daddos
- [MySQL 8.1](https://dev.mysql.com/)
## Run locally / Rodar localmente
### 1 - Clone
```bash
git clone https://github.com/Odisseu93/top-commerce
```
```bash
cd top-commerce
```
### 2 - Run Docker compose / execute o Docker compose
```bash
docker compose up -d # in the root directory of the project / na pasta raiz
```
### 3 - Install the project dependencies locally / Instale as dependecias do projeto localmente
```diff
- Do not skip this step / Não pule esta esta etapa
```
<br>
**Front-end**
```bash
cd app/front-end # in the root directory of the project / na pasta raiz
```
```bash
yarn install
```
**Back-end**
```bash
cd app/back-end # in the root directory of the project / na pasta raiz
```
```bash
yarn install
```
### 4 - Locahost
After starting the server, access the port in your browser:
Depois de iniciar o servidor, acesse a porta no seu navegador:
**Swagger**
```bash
localhost:8080/docs/api/
```
**Front-end**
```bash
localhost:3000
```
**Database** `PORT: 3308`
### Filestruct / Estrutura de arquivos
**For illustration purposes only, be guided by the files and folder present in this repository / Meramente ilustrativo se guie pelo arquivos e pasta presente neste repositório**
<details>
<summary>Back-end</summary>
```
.
├── Dockerfile
├── nodemon.json
├── package.json
├── src
│ ├── controllers
│ │ ├── ProductCategoryController.ts
│ │ ├── ProductController.ts
│ │ └── ProductFilterController.ts
│ ├── db
│ │ └── mysql
│ │ └── index.ts
│ ├── docs
│ │ └── swagger.json
│ ├── helpers
│ │ └── ProductCategory
│ │ ├── Validate.ts
│ │ └── registeredProducts.ts
│ ├── models
│ │ ├── Product.ts
│ │ └── ProductCategory.ts
│ ├── routes
│ │ ├── ProductCategoryRoutes.ts
│ │ ├── ProductFiltersRoutes.ts
│ │ ├── ProductRoutes.ts
│ │ └── docsRoutes.ts
│ ├── server.ts
│ └── types
│ ├── TypedRequestBody.ts
│ ├── TypedRequestQuery.ts
│ ├── TypedResponseJson.ts
│ ├── controllers
│ │ ├── Product
│ │ │ ├── RequestCreateType.ts
│ │ │ ├── RequestUpdateType.ts
│ │ │ └── index.ts
│ │ └── ProductFilter
│ │ ├── ProductFilterPriceInBetweenRequestType.ts
│ │ ├── ProductFilterRequestType.ts
│ │ └── index.ts
│ └── models
│ ├── ProductCategory
│ │ └── index.ts
│ └── Products
│ └── index.ts
├── tsconfig.json
└── yarn.lock
```
</details>
<details>
<summary>Font-end</summary>
```
.
├── Dockerfile
├── README.md
├── index.html
├── package.json
├── public
│ └── vite.svg
├── src
│ ├── App.css
│ ├── App.tsx
│ ├── assets
│ │ └── react.svg
│ ├── index.css
│ ├── main.tsx
│ └── vite-env.d.ts
├── tsconfig.json
├── tsconfig.node.json
├── vite.config.ts
└── yarn.lock
```
</details>
## Developer / Desenvolvedor
<div align="center">
<img src="https://user-images.githubusercontent.com/76600539/235897309-88ab21df-d0be-4905-829c-36ab68ebc2e8.png" alt="developer: Ulisses Silvério" width="200px" align="center"/>
</div>
<br>
<div align="center" margin="50px">
<a href="https://linktr.ee/ulissessilverio" align="center">
<img src="https://img.shields.io/badge/linktree-1de9b6?style=for-the-badge&logo=linktree&logoColor=white" alt="linktree shild" />
</a>
</div>
| Ecommerce fictício dockerizado, criado como Node.js, Express, React.js e mysql | docker,docker-compose,javascript,js,mysql,mysql-database,mysql2,nodejs,react,reactjs | 2023-08-15T16:32:39Z | 2023-09-10T23:42:22Z | null | 1 | 0 | 77 | 0 | 0 | 2 | null | null | TypeScript |
PrinceGehlot24/fliptile-puzzle | main |
# FlipTile Puzzle Project
Created a memory-boosting ReactJS game with Zustand for streamlined state control and Material-UI for a sleek interface. Challenge your memory by flipping two matching tiles to keep them face-up; otherwise, they'll flip back. It's a fun and engaging memory game.
## Features
- ReactJS-powered memory game.
- Zustand for efficient state management.
- Material-UI for polished frontend.
- Match pairs of tiles for memory improvement."
## Demo
Play and experience the game by clicking on the link below.
[FlipTile-Puzzle (Live)](https://princegehlot24.github.io/fliptile-puzzle/)
## Run Locally
Clone the project
```bash
git clone https://github.com/PrinceGehlot24/fliptile-puzzle.git
```
Go to the project directory
```bash
cd my-project
```
Install dependencies
```bash
npm install
```
Start the server
```bash
npm start
```
## Tech Stack
ReactJs , Zustand , MUI , Sass .
## Screenshots
## Level - 1
<img width="865" alt="fliptile-1" src="https://github.com/PrinceGehlot24/fliptile-puzzle/assets/108737973/177a859c-372b-49d6-8057-08048e0a64a2">
## Level - 2
<img width="865" alt="filptile-2" src="https://github.com/PrinceGehlot24/fliptile-puzzle/assets/108737973/bee2ad4b-c201-4ec6-afb6-a151b89abc56">
| ReactJS puzzle game with tile-flipping challenges and multiple levels. Flip two tiles at a time, matching current same-file occurrences for victory. | mui,puzzlegame,reactjs,vanila-javascript,zustand,javascript,sass | 2023-08-31T20:13:43Z | 2023-09-05T14:38:20Z | null | 1 | 0 | 5 | 0 | 0 | 2 | null | null | JavaScript |
SuryaPratap2542/Weather-React-App | main | # Weather React Web App
A simple React web app that allows users to check the weather for a specific city.
## Table of Contents
- [Features](#features)
- [Installation](#installation)
- [Usage](#usage)
- [API Key](#api-key)
- [Technologies Used](#technologies-used)
- [Contributing](#contributing)
- [License](#license)
## Features
- Enter the name of a city to get its current weather information.
- Displays temperature, humidity, wind speed, and weather icon.
- Dynamic weather icon changes based on the weather conditions.
## Installation
1. Clone this repository to your local machine.
2. Navigate to the project directory: `cd weather-react-app`
3. Install dependencies: `npm install`
## Usage
1. Get your API key from [OpenWeatherMap](https://openweathermap.org/api) and replace `'YOUR_API_KEY'` in `WheatherApp.js` with your actual API key.
2. Run the app: `npm start`
3. Open your browser and go to `http://localhost:3000`
## API Key
This project uses the OpenWeatherMap API to fetch weather data. You'll need to sign up for a free API key on their website and replace `'YOUR_API_KEY'` in the code with your actual API key.
## Technologies Used
- React
- CSS
- Fetch API
## Contributing
Contributions are welcome! If you find any issues or have suggestions, feel free to open an issue or a pull request.
## License
This project is licensed under the [MIT License](LICENSE).
| A simple React web app that allows users to check the weather for a specific city. | api,apikey,css,fetch-api,html,javascript,openweathermap-api,react,weather | 2023-08-22T17:24:09Z | 2023-08-22T17:27:30Z | null | 1 | 0 | 2 | 0 | 0 | 2 | null | null | JavaScript |
Ali-Sdg90/Todo-App-Firebase | main | <h1>Todo-App-Firebase🗂</h1>
<p><img src="Assets/readme-img.png" alt="Todo-App-img" /></p>
<h2>Introduction</h2>
<p>
Welcome to the Todo App with Firebase repository! In this project, I've
created a JavaScript-based Todo app that showcases the integration of
Firebase for backend services. This app allows users to manage their todos,
leveraging Firebase to store and retrieve data.
</p>
<p>
The code in this repository has been developed professionally and is
organized into two main sections within the <code>public</code> folder:
</p>
<ol>
<li>
<strong>Todo Files</strong>: Contains the core files for the Todo app.
</li>
<li>
<strong>Work-w-firebase</strong>: Includes base files that demonstrate
how to interact with Firebase to send and retrieve data using both the
traditional and snapshot methods.
</li>
</ol>
<h2>Getting Started</h2>
<p>To run the code locally on your machine, follow these steps:</p>
<ol>
<li><p>Clone or download this repository to your local system.</p></li>
<li>
<p>
Open a terminal in the repository's folder and run the following
command:
</p>
<pre><code>firebase serve</code></pre>
</li>
<li>
<p>
Open your web browser and navigate to
<a href="http://localhost:5000/" target="_new"
>http://localhost:5000/</a
>
to access the running code.
</p>
</li>
</ol>
<p>
Alternatively, you can also experience the live demo of the app at
<a href="https://ali-sdg9093-todo-app.web.app/" target="_new"
>https://ali-sdg9093-todo-app.web.app/</a
>.
</p>
<h2>Features</h2>
<p>This Todo app offers the following features:</p>
<ul>
<li>
<p>
<strong>Add Tasks</strong>: You can add tasks by typing into the
input field and clicking the "Add" button.
</p>
</li>
<li>
<p>
<strong>Filter Tasks</strong>: Tasks can be filtered by clicking the
"All," "Active," or "Completed" buttons.
</p>
</li>
<li>
<p>
<strong>Clear Tasks</strong>: Easily clear all tasks by clicking the
"Clear" button.
</p>
</li>
<li>
<p>
<strong>Persistence</strong>: Tasks are saved to Firebase, ensuring
they persist even after the browser is closed or refreshed.
</p>
</li>
</ul>
<h2>Code Structure</h2>
<p>
The code is well-organized and utilizes various variables to interact with
the HTML elements and Firebase:
</p>
<ul>
<li>
<p>
<code>addBtn</code>, <code>todoCounter</code>,
<code>pendingFilter</code>,
<code>clearAll</code>, <code>todoInput</code>,
<code>todoList</code> are used to select
different parts of the HTML for manipulation.
</p>
</li>
<li>
<p>
An array named <code>todoSaves</code> is employed to store tasks,
while another array, <code>filteredTodoSaves</code>, is used to
store filtered tasks. The
<code>filterTodoSavesFunc()</code> function filters tasks based on
the filter mode (<code>all</code>, <code>active</code>, or
<code>completed</code>). The
<code>updateHTML(addNewTodo)</code> function refreshes the DOM to
display the list of tasks.
</p>
</li>
</ul>
<h2>Steps</h2>
<table>
<thead>
<tr>
<th>Steps</th>
<th>Github</th>
<th>JSFiddle</th>
<th>Live Demo</th>
<th>Showcase Video</th>
</tr>
</thead>
<tbody>
<tr>
<td>Step 3 (base file)</td>
<td><a href="https://github.com/Ali-Sdg90/Todo-App/tree/2471d1bfbd34de78b451684a90d3c6db4ac20350" target="_new">Link</a></td>
<td><a href="https://jsfiddle.net/Ali_Sdg90/v60okbum/" target="_new">Link</a></td>
<td>---</td>
<td>Coming soon...</td>
</tr>
<tr>
<td>Step 4 (todo btns + SCSS)</td>
<td><a href="https://github.com/Ali-Sdg90/Todo-App" target="_new">Link</a></td>
<td><a href="https://jsfiddle.net/Ali_Sdg90/k4Lwxare/" target="_new">Link</a></td>
<td>---</td>
<td>Coming soon...</td>
</tr>
<tr>
<td>Step 5 (knockout.js)</td>
<td><a href="https://github.com/Ali-Sdg90/Todo-App-KnockoutJS" target="_new">Link</a></td>
<td><a href="https://jsfiddle.net/Ali_Sdg90/v7nac15g/4/" target="_new">Link</a></td>
<td><a href="https://ali-sdg90.github.io/Todo-App-KnockoutJS/">Link</a></td>
<td>Coming soon...</td>
</tr>
<tr>
<td>Step 6 (localStorage)</td>
<td><a href="https://github.com/Ali-Sdg90/Todo-App" target="_new">Link</a></td>
<td><a href="https://jsfiddle.net/Ali_Sdg90/tz105ux4/1/" target="_new">Link</a></td>
<td><a href="https://ali-sdg90.github.io/Todo-App/">Link</a></td>
<td>Coming soon...</td>
</tr>
<tr>
<td>Step 6 (Firebase)</td>
<td><a href="https://github.com/Ali-Sdg90/Todo-App-Firebase" target="_new">Link</a></td>
<td><a href="https://jsfiddle.net/Ali_Sdg90/bfLrwtxg/2/" target="_new">Link</a></td>
<td><a href="https://ali-sdg9093-todo-app.web.app/">Link</a></td>
<td>Coming soon...</td>
</tr>
</tbody>
</table>
<p>Enjoy using the app❤️</p>
| Todo App with Firebase backend for CS_Internship | firebase,firebase-database,javascript,todo-app,css | 2023-08-26T16:30:50Z | 2023-10-27T15:40:25Z | null | 1 | 0 | 24 | 0 | 0 | 2 | null | MIT | JavaScript |
CoderMungan/React-Product-Api | main | # React-Product-Api
React ile fetch api kullanarak ürünleri listeleme.
Search olarak istenilen value'ya ulaşma.
Dipnot: Acemilik Projelerinden (Old!)
| from beginner projects! (Old) | bootstrap,css,html,javascript,js,react,reactjs | 2023-08-14T11:21:07Z | 2023-08-15T19:49:58Z | null | 1 | 0 | 6 | 0 | 0 | 2 | null | null | JavaScript |
mastrmind-dev/electron-screen-recorder | main | # electron-screen-recorder
creating an open source screen recorder with advanced features like pausing and resuming, specially with unlimited recording time. This is open source and free project. There are bunch of free screen recorders with limited features. Some of them have limited time duration to record, some of them have limited features like they only allow us to "start recording" and "stop recording" but no "pause recording" and "resume recording". To all those all those issues, this simple project will be an answer.
# prerequisites
1. node.js (version = above 16.15.0)
# how to setup
1. clone the repo
2. npm install or yarn install
3. npm start or yarn start
| creating an open source screen recorder with advanced features like pausing and resuming, specially with unlimited recording time | beginner-friendly,electron-app,hacktoberfest,hacktoberfest-2023,hacktoberfest-accepted,javascript,free,open-source | 2023-08-25T18:20:44Z | 2023-10-21T11:07:57Z | 2023-09-29T10:12:36Z | 2 | 3 | 21 | 8 | 5 | 2 | null | null | JavaScript |
nuejs/nue | master | packages/nuekit/README.md | The Content First Web Framework | javascript,content,css3,javascript-framework | 2023-09-13T00:18:50Z | 2024-05-08T08:53:42Z | 2024-03-20T09:29:36Z | 26 | 83 | 329 | 38 | 169 | 5,850 | null | MIT | JavaScript |
raidendotai/openv0 | main |
# openv0
project website - [openv0.com](https://openv0.com)
**openv0** is a generative UI component framework
It allows you to AI generate and iterate on UI components, with live preview.
- **openv0** makes use of open source component libraries and icons to build a library of assets for the generative pipeline.
- **openv0** is highly modular, and structured for elaborate generative processes
- Component generation is a multipass pipeline - where every pass is a fully independent plugin
(say hi [@n_raidenai](https://twitter.com/n_raidenai) 👋)
---
# Currently Supported
* Frontend frameworks
* React
* Next.js
* Svelte
* UI libraries
* NextUI
* Flowbite
* Shadcn
* Icons libraries
* Lucide
The latest **openv0** update makes it easier to integrate new frameworks, libraries and plugins.
Docs & guides on how to do so will be soon posted.
Next updates :
- public explore+share web app on [openv0.com](https://openv0.com) *(you can use the openv0 share API already)*
- multimodal `UIray` vision model *(more details soon)*
- better validation passes, more integrations & plugins
---
# Demos
## Current version
https://github.com/raidendotai/openv0/assets/127366981/a249cf0d-ae44-4155-a5c1-fc2528bf05b5
## Previous version
[openv0_demo.webm](https://github.com/raidendotai/openv0/assets/127366981/53b14c27-22ec-40a3-a431-539daf197f49)
---
# Install
* Open your terminal and run
```sh
npx openv0@latest
```
It will download openv0, configure it based on your choices & install dependencies. Then :
* Start the local server + webapp
* start server `cd server && node api.js`
* start webapp `cd webapp && npm run dev`
* Open you web browser, go to `http://localhost:5173/`
That is all. Have fun 🎉
---
**Alternatively** - you can also clone this repo and install manually
To do so :
* Clone repo, run `npm i` in `server/`
* Unzip `server/library/icons/lucide/vectordb/index.zip` into that same folder
* Configure your OpenAI key in `server/.env`
* Web apps starter templates are in `webapps-starters/`
* run `npm i` in the web app starter of your choice
* make sure that `WEBAPP_ROOT` variable `server/.env` matches your webapp folder path
* Start the server with `node api.js` and the web app with `npm run dev`
---
# Try openv0
You can try openv0 (using React as a framework) with minimal configuration below
### Replit
[](https://replit.com/@n-raidenai/openv0-react)
### StackBlitz
[](https://stackblitz.com/~/github.com/raidendotai/openv0/pull/9)
---
# How It Works
### Multipass Workflow
A simple explanation is the following image
### Codebase
Youtube video by user [@elie2222](https://www.youtube.com/@elie2222) explains parts of the previous openv0 code base
[](https://www.youtube.com/watch?v=fAEH2ZBO6BA)
| AI generated UI components | ai,generative,javascript,react,tailwind,typescript,ui | 2023-09-19T16:12:31Z | 2023-10-25T18:45:11Z | null | 6 | 8 | 14 | 30 | 254 | 3,189 | null | MIT | TypeScript |
OpenSignLabs/OpenSign | staging | <h1 align="center"><a href='https://www.opensignlabs.com'><img src=https://github.com/OpenSignLabs/OpenSign/assets/5486116/e518cc9c-5de3-47da-950b-f93336b9f14e></a>
</h1><div align="center">
[The free and open source alternative to DocuSign](https://www.opensignlabs.com)
[](http://isitmaintained.com/project/opensignlabs/opensign "Average time to resolve an issue")
[](#contributors)
<a href="https://www.opensignlabs.com/">Website</a>
<span> • </span>
<a href="https://www.opensignlabs.com">Docs</a>
<span> • </span>
<a href="https://www.opensignlabs.com/blog">Blog</a>
<span> • </span>
<a href="https://discord.com/invite/xe9TDuyAyj">Discord</a>
<span> • </span>
<a href="https://twitter.com/opensignlabs">Twitter</a>
<span> • </span>
<a href="https://www.linkedin.com/company/opensign%E2%84%A2/about/">LinkedIn</a>
## The open-source document e-signing solution
---
</div>
### Table of Contents
1. [Introduction](#introduction)
2. [Features](#features)
3. [Installation](#installation)
4. [Usage](#usage)
5. [Contribution Guidelines](#contribution-guidelines)
6. [License](#license)
7. [Acknowledgments](#acknowledgments)
---
Please star ⭐ the repo to support us! 😀
### Introduction
Welcome to OpenSign, the premier open source docusign alternative - document e-signing solution designed to provide a secure, reliable and free alternative to commercial esign platforms like DocuSign, PandaDoc, SignNow, Adobe Sign, Smartwaiver, SignRequest, HelloSign & Zoho sign. Our mission is to democratize the e-signing process, making it accessible and straightforward for everyone.
---
### Features
- **Secure PDF E-Signing:** With the help of robust encryption algorithms, OpenSign™ ensures maximum security, privacy & compatibility.
- **Annotate Documents:** OpenSign™ allows you to annotate PDF documents with an advanced signing pad that allows hand drawn signatures, uploaded images, typed signatures & saved signatures for the simplest signing experience ever.
- **User-Friendly Interface:** OpenSign™ was built while keeping Intuitive design in mind for ease of use. Features like "Sign yourself", "Templates", "One click signatures" and "OpenSign™ Drive" makes it stand out of the crowd and even makes it better than a lot of so-called industry leaders.
- **Multi-signer Support:** OpenSign's ability to invite multiple signers for signing along with the ability to invite witnesses & being able to enforce signing in a sequence makes it the only open source solution that is fully loaded and allows it to compete head-to-head with established players in e-signature space.
- **Email Unique Code(OTP) verification support for guest signers:** With OpenSign™, your documents are fully secure even when being signed by guest users. Guest signers can only sign the document after entering a unique code sent to their email address.
- **"Expiring Docs" & "Rejection":** You can set documents to expire after certain number of days after which nobody will be able to sign. Not just this, OpenSign™ also allows signers to reject signing a document.
- **Beautiful email templates:** All document signing invitations, completion notifications & reminders are formatted using great looking email templates.
- **PDF Template Creation:** OpenSign™ allows you to create and store PDF document templates for repeated use thereby saving you a lot of time & collect e-signatures seamlessly.
- **OpenSign™ Drive:** It is a centralised secure vault for your digital documents that makes storing, signing, organizing, sharing & achieving your docs a breeze.
- **Audit Trails & completion certificate:** Being a security focused solution, OpenSign™ makes it a top priority to save detailed logs for tracking document activities along with time-stamps, IP addresses, email IDs & phone numbers. A completion certificate is generated as soon as document is completed which contains all the document related logs for added safety.
- **API Support:** OpenSign™ API allows seamless integration into existing systems and software. You can generate an API key from the app and refer the [docs](https://docs.opensignlabs.com) to start integrating it in your existing applications.
- **Integrations:** Seamless integrations with various Cloud storage systems, CRMs & enterprise platforms is available. We also have a Zapier integration that allows you to integrate it with virtually any application.
<img src=https://github.com/OpenSignLabs/OpenSign/assets/5486116/b37ff443-7099-4273-9aeb-21c46d7154cf height='200'>
<img src=https://github.com/OpenSignLabs/OpenSign/assets/5486116/86db91b7-6c2f-4885-a33c-58f4fd35ec89 height='200'>
<img src=https://github.com/OpenSignLabs/OpenSign/assets/5486116/56835efd-c40e-42de-a206-20202c293876 height='200'>
---
### Installation
Please refer to the [Installation Guide](INSTALLATION.md) for detailed instructions on how to install OpenSign on your system.
---
### Usage
For comprehensive guidelines on how to use OpenSign™, please consult our [User Manual](USAGE.md).
---
### Contribution Guidelines
We welcome contributions from the open-source community. For more information on how to contribute, please read our [Contribution Guidelines](CONTRIBUTING.md).
---
### License
OpenSign is licensed under the AGPL License. For more details, see the [LICENSE](LICENSE) file.
---
### Acknowledgments
We would like to thank all our contributors and users for their support and feedback. Special thanks to [OpenSignLabs](https://github.com/OpenSignLabs) for spearheading this initiative.
---
## Contributors
<!-- 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://aleksandarjakovljevic.com/"><img src="https://avatars.githubusercontent.com/u/2115393?v=4?s=100" width="100px;" alt="Aleksandar Jakovljevic"/><br /><sub><b>Aleksandar Jakovljevic</b></sub></a><br /><a href="#code-ajakov" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/BuilderPrid"><img src="https://avatars.githubusercontent.com/u/106882895?v=4?s=100" width="100px;" alt="Priyanshu Dwivedi"/><br /><sub><b>Priyanshu Dwivedi</b></sub></a><br /><a href="#code-BuilderPrid" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/Tashuuuu"><img src="https://avatars.githubusercontent.com/u/85075827?v=4?s=100" width="100px;" alt="Akriti Sengar"/><br /><sub><b>Akriti Sengar</b></sub></a><br /><a href="#code-Tashuuuu" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/parthrc"><img src="https://avatars.githubusercontent.com/u/101104958?v=4?s=100" width="100px;" alt="Parth Chawande"/><br /><sub><b>Parth Chawande</b></sub></a><br /><a href="#code-parthrc" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/Rishabh-git10"><img src="https://avatars.githubusercontent.com/u/107680241?v=4?s=100" width="100px;" alt="Rishabh Dewangan"/><br /><sub><b>Rishabh Dewangan</b></sub></a><br /><a href="#code-Rishabh-git10" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/LemonDrop847"><img src="https://avatars.githubusercontent.com/u/106615670?v=4?s=100" width="100px;" alt="Nitin Mishra"/><br /><sub><b>Nitin Mishra</b></sub></a><br /><a href="#code-LemonDrop847" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="http://jobinselvanose.com"><img src="https://avatars.githubusercontent.com/u/63976083?v=4?s=100" width="100px;" alt="Jobin Selvanose"/><br /><sub><b>Jobin Selvanose</b></sub></a><br /><a href="#doc-Jobin-S" title="Documentation">📖</a></td>
</tr>
<tr>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/HansF"><img src="https://avatars.githubusercontent.com/u/1503?v=4?s=100" width="100px;" alt="Hans Fraiponts"/><br /><sub><b>Hans Fraiponts</b></sub></a><br /><a href="#doc-HansF" title="Documentation">📖</a></td>
<td align="center" valign="top" width="14.28%"><a href="http://linktr.ee/monilprajapati"><img src="https://avatars.githubusercontent.com/u/99136041?v=4?s=100" width="100px;" alt="Monil Prajapati"/><br /><sub><b>Monil Prajapati</b></sub></a><br /><a href="#code-Monilprajapati" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://emm-dev0.github.io/portfolio/"><img src="https://avatars.githubusercontent.com/u/97445413?v=4?s=100" width="100px;" alt="Edogbanya Emmanuel"/><br /><sub><b>Edogbanya Emmanuel</b></sub></a><br /><a href="#bug-Emm-dev0" title="Bug reports">🐛</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/pranav514"><img src="https://avatars.githubusercontent.com/u/76992202?v=4?s=100" width="100px;" alt="pranav514"/><br /><sub><b>pranav514</b></sub></a><br /><a href="#code-pranav514" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/arianxq"><img src="https://avatars.githubusercontent.com/u/122199576?v=4?s=100" width="100px;" alt="Aria"/><br /><sub><b>Aria</b></sub></a><br /><a href="#code-arianxq" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/SoumyadiptoPal"><img src="https://avatars.githubusercontent.com/u/119007659?v=4?s=100" width="100px;" alt="Soumyadipto Pal"/><br /><sub><b>Soumyadipto Pal</b></sub></a><br /><a href="#code-SoumyadiptoPal" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/AndreyCurious"><img src="https://avatars.githubusercontent.com/u/105622604?v=4?s=100" width="100px;" alt="Andrey Didenko"/><br /><sub><b>Andrey Didenko</b></sub></a><br /><a href="#code-AndreyCurious" title="Code">💻</a></td>
</tr>
<tr>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/VishakhaSainani"><img src="https://avatars.githubusercontent.com/u/113436770?v=4?s=100" width="100px;" alt="VishakhaSainani"/><br /><sub><b>VishakhaSainani</b></sub></a><br /><a href="#code-VishakhaSainani" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/andrew-opensignlabs"><img src="https://avatars.githubusercontent.com/u/148278535?v=4?s=100" width="100px;" alt="Andrew"/><br /><sub><b>Andrew</b></sub></a><br /><a href="#code-andrew-opensignlabs" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/rishabjasrotia"><img src="https://avatars.githubusercontent.com/u/33950743?v=4?s=100" width="100px;" alt="Rishab"/><br /><sub><b>Rishab</b></sub></a><br /><a href="#code-rishabjasrotia" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://session.it"><img src="https://avatars.githubusercontent.com/u/327285?v=4?s=100" width="100px;" alt="Maurizio Pillitu"/><br /><sub><b>Maurizio Pillitu</b></sub></a><br /><a href="#bug-maoo" title="Bug reports">🐛</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://luisparra.dev"><img src="https://avatars.githubusercontent.com/u/16653744?v=4?s=100" width="100px;" alt="Luis Parra"/><br /><sub><b>Luis Parra</b></sub></a><br /><a href="#a11y-lsprr" title="Accessibility">️️️️♿️</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/Govinda04"><img src="https://avatars.githubusercontent.com/u/50038172?v=4?s=100" width="100px;" alt="Govinda Kocharekar"/><br /><sub><b>Govinda Kocharekar</b></sub></a><br /><a href="#code-Govinda04" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://bilal.cc"><img src="https://avatars.githubusercontent.com/u/55330484?v=4?s=100" width="100px;" alt="Bilal Ahmad Bhat"/><br /><sub><b>Bilal Ahmad Bhat</b></sub></a><br /><a href="#code-crediblebilal" title="Code">💻</a></td>
</tr>
<tr>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/VikramNagwal"><img src="https://avatars.githubusercontent.com/u/123088024?v=4?s=100" width="100px;" alt="Vikram"/><br /><sub><b>Vikram</b></sub></a><br /><a href="#code-VikramNagwal" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/ugoconsonni"><img src="https://avatars.githubusercontent.com/u/13661702?v=4?s=100" width="100px;" alt="ugoconsonni"/><br /><sub><b>ugoconsonni</b></sub></a><br /><a href="#code-ugoconsonni" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/daniel-mutwiri"><img src="https://avatars.githubusercontent.com/u/8936960?v=4?s=100" width="100px;" alt="Daniel Mutwiri"/><br /><sub><b>Daniel Mutwiri</b></sub></a><br /><a href="#code-daniel-mutwiri" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/Zathiel"><img src="https://avatars.githubusercontent.com/u/26553418?v=4?s=100" width="100px;" alt="Zathiel"/><br /><sub><b>Zathiel</b></sub></a><br /><a href="#code-Zathiel" title="Code">💻</a></td>
</tr>
</tbody>
</table>
<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->
<!-- ALL-CONTRIBUTORS-LIST:END -->
| 🔥 The free & Open Source DocuSign alternative | hacktoberfest,javascript,reactjs,mongodb,nodejs,open-source,digital-signature,e-signature,electronic-signature,esign | 2023-10-02T15:53:30Z | 2024-05-23T12:47:00Z | 2024-05-23T12:47:00Z | 26 | 677 | 1,558 | 20 | 182 | 2,599 | null | AGPL-3.0 | JavaScript |
ollama/ollama-js | main | # Ollama JavaScript Library
The Ollama JavaScript library provides the easiest way to integrate your JavaScript project with [Ollama](https://github.com/jmorganca/ollama).
## Getting Started
```
npm i ollama
```
## Usage
```javascript
import ollama from 'ollama'
const response = await ollama.chat({
model: 'llama2',
messages: [{ role: 'user', content: 'Why is the sky blue?' }],
})
console.log(response.message.content)
```
### Browser Usage
To use the library without node, import the browser module.
```javascript
import ollama from 'ollama/browser'
```
## Streaming responses
Response streaming can be enabled by setting `stream: true`, modifying function calls to return an `AsyncGenerator` where each part is an object in the stream.
```javascript
import ollama from 'ollama'
const message = { role: 'user', content: 'Why is the sky blue?' }
const response = await ollama.chat({ model: 'llama2', messages: [message], stream: true })
for await (const part of response) {
process.stdout.write(part.message.content)
}
```
## Create
```javascript
import ollama from 'ollama'
const modelfile = `
FROM llama2
SYSTEM "You are mario from super mario bros."
`
await ollama.create({ model: 'example', modelfile: modelfile })
```
## API
The Ollama JavaScript library's API is designed around the [Ollama REST API](https://github.com/jmorganca/ollama/blob/main/docs/api.md)
### chat
```javascript
ollama.chat(request)
```
- `request` `<Object>`: The request object containing chat parameters.
- `model` `<string>` The name of the model to use for the chat.
- `messages` `<Message[]>`: Array of message objects representing the chat history.
- `role` `<string>`: The role of the message sender ('user', 'system', or 'assistant').
- `content` `<string>`: The content of the message.
- `images` `<Uint8Array[] | string[]>`: (Optional) Images to be included in the message, either as Uint8Array or base64 encoded strings.
- `format` `<string>`: (Optional) Set the expected format of the response (`json`).
- `stream` `<boolean>`: (Optional) When true an `AsyncGenerator` is returned.
- `keep_alive` `<string | number>`: (Optional) How long to keep the model loaded.
- `options` `<Options>`: (Optional) Options to configure the runtime.
- Returns: `<ChatResponse>`
### generate
```javascript
ollama.generate(request)
```
- `request` `<Object>`: The request object containing generate parameters.
- `model` `<string>` The name of the model to use for the chat.
- `prompt` `<string>`: The prompt to send to the model.
- `system` `<string>`: (Optional) Override the model system prompt.
- `template` `<string>`: (Optional) Override the model template.
- `raw` `<boolean>`: (Optional) Bypass the prompt template and pass the prompt directly to the model.
- `images` `<Uint8Array[] | string[]>`: (Optional) Images to be included, either as Uint8Array or base64 encoded strings.
- `format` `<string>`: (Optional) Set the expected format of the response (`json`).
- `stream` `<boolean>`: (Optional) When true an `AsyncGenerator` is returned.
- `keep_alive` `<string | number>`: (Optional) How long to keep the model loaded.
- `options` `<Options>`: (Optional) Options to configure the runtime.
- Returns: `<GenerateResponse>`
### pull
```javascript
ollama.pull(request)
```
- `request` `<Object>`: The request object containing pull parameters.
- `model` `<string>` The name of the model to pull.
- `insecure` `<boolean>`: (Optional) Pull from servers whose identity cannot be verified.
- `stream` `<boolean>`: (Optional) When true an `AsyncGenerator` is returned.
- Returns: `<ProgressResponse>`
### push
```javascript
ollama.push(request)
```
- `request` `<Object>`: The request object containing push parameters.
- `model` `<string>` The name of the model to push.
- `insecure` `<boolean>`: (Optional) Push to servers whose identity cannot be verified.
- `stream` `<boolean>`: (Optional) When true an `AsyncGenerator` is returned.
- Returns: `<ProgressResponse>`
### create
```javascript
ollama.create(request)
```
- `request` `<Object>`: The request object containing create parameters.
- `model` `<string>` The name of the model to create.
- `path` `<string>`: (Optional) The path to the Modelfile of the model to create.
- `modelfile` `<string>`: (Optional) The content of the Modelfile to create.
- `stream` `<boolean>`: (Optional) When true an `AsyncGenerator` is returned.
- Returns: `<ProgressResponse>`
### delete
```javascript
ollama.delete(request)
```
- `request` `<Object>`: The request object containing delete parameters.
- `model` `<string>` The name of the model to delete.
- Returns: `<StatusResponse>`
### copy
```javascript
ollama.copy(request)
```
- `request` `<Object>`: The request object containing copy parameters.
- `source` `<string>` The name of the model to copy from.
- `destination` `<string>` The name of the model to copy to.
- Returns: `<StatusResponse>`
### list
```javascript
ollama.list()
```
- Returns: `<ListResponse>`
### show
```javascript
ollama.show(request)
```
- `request` `<Object>`: The request object containing show parameters.
- `model` `<string>` The name of the model to show.
- `system` `<string>`: (Optional) Override the model system prompt returned.
- `template` `<string>`: (Optional) Override the model template returned.
- `options` `<Options>`: (Optional) Options to configure the runtime.
- Returns: `<ShowResponse>`
### embeddings
```javascript
ollama.embeddings(request)
```
- `request` `<Object>`: The request object containing embedding parameters.
- `model` `<string>` The name of the model used to generate the embeddings.
- `prompt` `<string>`: The prompt used to generate the embedding.
- `keep_alive` `<string | number>`: (Optional) How long to keep the model loaded.
- `options` `<Options>`: (Optional) Options to configure the runtime.
- Returns: `<EmbeddingsResponse>`
## Custom client
A custom client can be created with the following fields:
- `host` `<string>`: (Optional) The Ollama host address. Default: `"http://127.0.0.1:11434"`.
- `fetch` `<Object>`: (Optional) The fetch library used to make requests to the Ollama host.
```javascript
import { Ollama } from 'ollama'
const ollama = new Ollama({ host: 'http://localhost:11434' })
const response = await ollama.chat({
model: 'llama2',
messages: [{ role: 'user', content: 'Why is the sky blue?' }],
})
```
## Building
To build the project files run:
```sh
npm run build
```
| Ollama JavaScript library | javascript,js,ollama | 2023-09-13T22:58:51Z | 2024-05-10T21:59:45Z | 2024-05-10T21:33:38Z | 12 | 44 | 129 | 19 | 88 | 1,328 | null | MIT | TypeScript |
mkkellogg/GaussianSplats3D | main | # 3D Gaussian splatting for Three.js
Three.js-based implemetation of a renderer for [3D Gaussian Splatting for Real-Time Radiance Field Rendering](https://repo-sam.inria.fr/fungraph/3d-gaussian-splatting/), a technique for generating 3D scenes from 2D images. Their project is CUDA-based and needs to run natively on your machine, but I wanted to build a viewer that was accessible via the web.
The 3D scenes are stored in a format similar to point clouds and can be viewed, navigated, and interacted with in real-time. This renderer will work with the `.ply` files generated by the INRIA project, standard `.splat` files, or my own custom `.ksplat` files, which are a trimmed-down and compressed version of the original `.ply` files.
When I started, web-based viewers were already available -- A WebGL-based viewer from [antimatter15](https://github.com/antimatter15/splat) and a WebGPU viewer from [cvlab-epfl](https://github.com/cvlab-epfl/gaussian-splatting-web) -- However no Three.js version existed. I used those versions as a starting point for my initial implementation, but as of now this project contains all my own code.
<br>
<br>
## Highlights
- Rendering is done entirely through Three.js
- Code is organized into modern ES modules
- Built-in viewer is self-contained so very little code is necessary to load and view a scene
- Viewer can import `.ply` files, `.splat` files, or my custom compressed `.ksplat` files
- Users can convert `.ply` or `.splat` files to the `.ksplat` file format
- Allows a Three.js scene or object group to be rendered along with the splats
- Built-in WebXR support
- Supports 1st and 2nd degree spherical harmonics for view-dependent effects
- Focus on optimization:
- Splats culled prior to sorting & rendering using a custom octree
- WASM splat sort: Implemented in C++ using WASM SIMD instructions
- Partially GPU accelerated splat sort: Uses transform feedback to pre-calculate splat distances
## Known issues
- Splat sort runs on the CPU – would be great to figure out a GPU-based approach
- Artifacts are visible when you move or rotate too fast (due to CPU-based splat sort)
- Sub-optimal performance on mobile devices
- Custom `.ksplat` file format still needs work, especially around compression
- The default, integer based splat sort does not work well for larger scenes. In that case a value of `false` for the `integerBasedSort` viewer parameter can force a slower, floating-point based sort
## Future work
This is still very much a work in progress! There are several things that still need to be done:
- Improve the method by which splat data is stored in textures
- Continue optimizing CPU-based splat sort - maybe try an incremental sort of some kind?
- Add editing mode, allowing users to modify scene and export changes
- Support very large scenes
## Online demo
[https://projects.markkellogg.org/threejs/demo_gaussian_splats_3d.php](https://projects.markkellogg.org/threejs/demo_gaussian_splats_3d.php)
## Controls
Mouse
- Left click to set the focal point
- Left click and drag to orbit around the focal point
- Right click and drag to pan the camera and focal point
Keyboard
- `C` Toggles the mesh cursor, showing the intersection point of a mouse-projected ray and the splat mesh
- `I` Toggles an info panel that displays debugging info:
- Camera position
- Camera focal point/look-at point
- Camera up vector
- Mesh cursor position
- Current FPS
- Renderer window size
- Ratio of rendered splats to total splats
- Last splat sort duration
- `U` Toggles a debug object that shows the orientation of the camera controls. It includes a green arrow representing the camera's orbital axis and a white square representing the plane at which the camera's elevation angle is 0.
- `Left arrow` Rotate the camera's up vector counter-clockwise
- `Right arrow` Rotate the camera's up vector clockwise
- `P` Toggle point-cloud mode, where each splat is rendered as a filled circle
- `=` Increase splat scale
- `-` Decrease splat scale
- `O` Toggle orthographic mode
<br>
## Building from source and running locally
Navigate to the code directory and run
```
npm install
```
Next run the build. For Linux & Mac OS systems run:
```
npm run build
```
For Windows I have added a Windows-compatible version of the build command:
```
npm run build-windows
```
To view the demo scenes locally run
```
npm run demo
```
The demo will be accessible locally at [http://127.0.0.1:8080/index.html](http://127.0.0.1:8080/index.html). You will need to download the data for the demo scenes and extract them into
```
<code directory>/build/demo/assets/data
```
The demo scene data is available here: [https://projects.markkellogg.org/downloads/gaussian_splat_data.zip](https://projects.markkellogg.org/downloads/gaussian_splat_data.zip)
<br>
<br>
## Installing as an NPM package
If you don't want to build the library from source, it is also available as an NPM package. The NPM package does not come with the source code or demos that are available in the source repository. To install, run the following command:
```
npm install @mkkellogg/gaussian-splats-3d
```
<br>
## Basic Usage
To run the built-in viewer:
```javascript
import * as GaussianSplats3D from '@mkkellogg/gaussian-splats-3d';
const viewer = new GaussianSplats3D.Viewer({
'cameraUp': [0, -1, -0.6],
'initialCameraPosition': [-1, -4, 6],
'initialCameraLookAt': [0, 4, 0]
});
viewer.addSplatScene('<path to .ply, .ksplat, or .splat file>', {
'splatAlphaRemovalThreshold': 5,
'showLoadingUI': true,
'position': [0, 1, 0],
'rotation': [0, 0, 0, 1],
'scale': [1.5, 1.5, 1.5]
})
.then(() => {
viewer.start();
});
```
Viewer parameters
<br>
| Parameter | Purpose
| --- | ---
| `cameraUp` | The natural 'up' vector for viewing the scene (only has an effect when used with orbit controls and when the viewer uses its own camera). Serves as the axis around which the camera will orbit, and is used to determine the scene's orientation relative to the camera.
| `initialCameraPosition` | The camera's initial position (only used when the viewer uses its own camera).
| `initialCameraLookAt` | The initial focal point of the camera and center of the camera's orbit (only used when the viewer uses its own camera).
<br>
Parameters for `addSplatScene()`
<br>
| Parameter | Purpose
| --- | ---
| `splatAlphaRemovalThreshold` | Tells `addSplatScene()` to ignore any splats with an alpha less than the specified value (valid range: 0 - 255). Defaults to `1`.
| `showLoadingUI` | Displays a loading spinner and/or loading progress bar while the scene is loading. Defaults to `true`.
| `position` | Position of the scene, acts as an offset from its default position. Defaults to `[0, 0, 0]`.
| `rotation` | Rotation of the scene represented as a quaternion, defaults to `[0, 0, 0, 1]` (identity quaternion).
| `scale` | Scene's scale, defaults to `[1, 1, 1]`.
| `streamView` | Stream the scene's splat data and allow the scene to be rendered and viewed as the splats are loaded. Option is only valid for `addSplatScene()`, and not for `addSplatScenes()`.
<br>
`Viewer` can also load multiple scenes simultaneously with the `addSplatScenes()` function:
```javascript
import * as GaussianSplats3D from '@mkkellogg/gaussian-splats-3d';
viewer.addSplatScenes([{
'path': '<path to first .ply, .ksplat, or .splat file>',
'splatAlphaRemovalThreshold': 20
},
{
'path': '<path to second .ply, .ksplat, or .splat file>',
'rotation': [-0.14724434, -0.0761755, 0.1410657, 0.976020],
'scale': [1.5, 1.5, 1.5],
'position': [-3, -2, -3.2]
}
])
.then(() => {
viewer.start();
});
```
The `addSplatScene()` and `addSplatScenes()` methods will accept the original `.ply` files, standard `.splat` files, and my custom `.ksplat` files.
<br>
### Integrating THREE.js scenes
You can integrate your own Three.js scene into the viewer if you want rendering to be handled for you. Just pass a Three.js scene object as the `threeScene` parameter to the constructor:
```javascript
import * as GaussianSplats3D from '@mkkellogg/gaussian-splats-3d';
import * as THREE from 'three';
const threeScene = new THREE.Scene();
const boxColor = 0xBBBBBB;
const boxGeometry = new THREE.BoxGeometry(2, 2, 2);
const boxMesh = new THREE.Mesh(boxGeometry, new THREE.MeshBasicMaterial({'color': boxColor}));
boxMesh.position.set(3, 2, 2);
threeScene.add(boxMesh);
const viewer = new GaussianSplats3D.Viewer({
'threeScene': threeScene,
});
viewer.addSplatScene('<path to .ply, .ksplat, or .splat file>')
.then(() => {
viewer.start();
});
```
Currently this will only work for objects that write to the depth buffer (e.g. standard opaque objects). Supporting transparent objects will be more challenging :)
<br>
A "drop-in" mode for the viewer is also supported. The `DropInViewer` class encapsulates `Viewer` and can be added to a Three.js scene like any other renderable:
```javascript
import * as GaussianSplats3D from '@mkkellogg/gaussian-splats-3d';
import * as THREE from 'three';
const threeScene = new THREE.Scene();
const viewer = new GaussianSplats3D.DropInViewer({
'gpuAcceleratedSort': true
});
viewer.addSplatScenes([{
'path': '<path to .ply, .ksplat, or .splat file>'
'splatAlphaRemovalThreshold': 5
},
{
'path': '<path to .ply, .ksplat, or .splat file>',
'rotation': [0, -0.857, -0.514495, 6.123233995736766e-17],
'scale': [1.5, 1.5, 1.5],
'position': [0, -2, -1.2]
}
]);
threeScene.add(viewer);
```
<br>
### Advanced options
The viewer allows for various levels of customization via constructor parameters. You can control when its `update()` and `render()` methods are called by passing `false` for the `selfDrivenMode` parameter and then calling those methods whenever/wherever you decide is appropriate. You can also use your own camera controls, as well as an your own instance of a Three.js `Renderer` or `Camera` The sample below shows all of these options:
```javascript
import * as GaussianSplats3D from '@mkkellogg/gaussian-splats-3d';
import * as THREE from 'three';
const renderWidth = 800;
const renderHeight = 600;
const rootElement = document.createElement('div');
rootElement.style.width = renderWidth + 'px';
rootElement.style.height = renderHeight + 'px';
document.body.appendChild(rootElement);
const renderer = new THREE.WebGLRenderer({
antialias: false
});
renderer.setSize(renderWidth, renderHeight);
rootElement.appendChild(renderer.domElement);
const camera = new THREE.PerspectiveCamera(65, renderWidth / renderHeight, 0.1, 500);
camera.position.copy(new THREE.Vector3().fromArray([-1, -4, 6]));
camera.up = new THREE.Vector3().fromArray([0, -1, -0.6]).normalize();
camera.lookAt(new THREE.Vector3().fromArray([0, 4, -0]));
const viewer = new GaussianSplats3D.Viewer({
'selfDrivenMode': false,
'renderer': renderer,
'camera': camera,
'useBuiltInControls': false,
'ignoreDevicePixelRatio': false,
'gpuAcceleratedSort': true,
'halfPrecisionCovariancesOnGPU': true,
'sharedMemoryForWorkers': true,
'integerBasedSort': true,
'dynamicScene': false,
'webXRMode': GaussianSplats3D.WebXRMode.None,
'renderMode': GaussianSplats3D.RenderMode.OnChange,
'sceneRevealMode': GaussianSplats3D.SceneRevealMode.Instant,
'antialiased': false,
'focalAdjustment': 1.0,
'logLevel': GaussianSplats3D.LogLevel.None,
'sphericalHarmonicsDegree': 0
});
viewer.addSplatScene('<path to .ply, .ksplat, or .splat file>')
.then(() => {
requestAnimationFrame(update);
});
```
Since `selfDrivenMode` is false, it is up to the developer to call the `update()` and `render()` methods on the `Viewer` class:
```javascript
function update() {
requestAnimationFrame(update);
viewer.update();
viewer.render();
}
```
Advanced `Viewer` parameters
<br>
| Parameter | Purpose
| --- | ---
| `selfDrivenMode` | If `false`, tells the viewer that you will manually call its `update()` and `render()` methods. Defaults to `true`.
| `useBuiltInControls` | Tells the viewer to use its own camera controls. Defaults to `true`.
| `renderer` | Pass an instance of a Three.js `Renderer` to the viewer, otherwise it will create its own. Defaults to `undefined`.
| `camera` | Pass an instance of a Three.js `Camera` to the viewer, otherwise it will create its own. Defaults to `undefined`.
| `ignoreDevicePixelRatio` | Tells the viewer to pretend the device pixel ratio is 1, which can boost performance on devices where it is larger, at a small cost to visual quality. Defaults to `false`.
| `gpuAcceleratedSort` | Tells the viewer to use a partially GPU-accelerated approach to sorting splats. Currently this means pre-computation of splat distances from the camera is performed on the GPU. It is recommended that this only be set to `true` when `sharedMemoryForWorkers` is also `true`. Defaults to `false` on mobile devices, `true` otherwise.
| `halfPrecisionCovariancesOnGPU` | Tells the viewer to use 16-bit floating point values when storing splat covariance data in textures, instead of 32-bit. Defaults to `false`.
| `sharedMemoryForWorkers` | Tells the viewer to use shared memory via a `SharedArrayBuffer` to transfer data to and from the sorting web worker. If set to `false`, it is recommended that `gpuAcceleratedSort` be set to `false` as well. Defaults to `true`.
| `integerBasedSort` | Tells the sorting web worker to use the integer versions of relevant data to compute the distance of splats from the camera. Since integer arithmetic is faster than floating point, this reduces sort time. However it can result in integer overflows in larger scenes so it should only be used for small scenes. Defaults to `true`.
| `dynamicScene` | Tells the viewer to not make any optimizations that depend on the scene being static. Additionally all splat data retrieved from the viewer's splat mesh will not have their respective scene transform applied to them by default.
| `webXRMode` | Tells the viewer whether or not to enable built-in Web VR or Web AR. Valid values are defined in the `WebXRMode` enum: `None`, `VR`, and `AR`. Defaults to `None`.
| `renderMode` | Controls when the viewer renders the scene. Valid values are defined in the `RenderMode` enum: `Always`, `OnChange`, and `Never`. Defaults to `Always`.
| `sceneRevealMode` | Controls the fade-in effect used when the scene is loaded. Valid values are defined in the `SceneRevealMode` enum: `Default`, `Gradual`, and `Instant`. `Default` results in a nice, slow fade-in effect for progressively loaded scenes, and a fast fade-in for non progressively loaded scenes. `Gradual` will force a slow fade-in for all scenes. `Instant` will force all loaded scene data to be immediately visible.
| `antialiased` | When true, will perform additional steps during rendering to address artifacts caused by the rendering of gaussians at substantially different resolutions than that at which they were rendered during training. This will only work correctly for models that were trained using a process that utilizes this compensation calculation. For more details: https://github.com/nerfstudio-project/gsplat/pull/117, https://github.com/graphdeco-inria/gaussian-splatting/issues/294#issuecomment-1772688093
| `focalAdjustment` | Hacky, non-scientific parameter for tweaking focal length related calculations. For scenes with very small gaussians & small details, increasing this value can help improve visual quality. Default value is 1.0.
| `logLevel` | Verbosity of the console logging. Defaults to `GaussianSplats3D.LogLevel.None`.
| `sphericalHarmonicsDegree` | Degree of spherical harmonics to utilize in rendering splats (assuming the data is present in the splat scene). Valid values are 0, 1, or 2. Default value is 0.
<br>
### Creating KSPLAT files
To convert a `.ply` or `.splat` file into the stripped-down and compressed `.ksplat` format, there are several options. The easiest method is to use the UI in the main demo page at [http://127.0.0.1:8080/index.html](http://127.0.0.1:8080/index.html). If you want to run the conversion programatically, run the following in a browser:
```javascript
import * as GaussianSplats3D from '@mkkellogg/gaussian-splats-3d';
const compressionLevel = 1;
const splatAlphaRemovalThreshold = 5; // out of 255
const sphericalHarmonicsDegree = 1;
GaussianSplats3D.PlyLoader.loadFromURL('<path to .ply or .splat file>',
compressionLevel,
splatAlphaRemovalThreshold,
sphericalHarmonicsDegree)
.then((splatBuffer) => {
GaussianSplats3D.KSplatLoader.downloadFile(splatBuffer, 'converted_file.ksplat');
});
```
Both of the above methods will prompt your browser to automatically start downloading the converted `.ksplat` file.
The third option is to use the included nodejs script:
```
node util/create-ksplat.js [path to .PLY or .SPLAT] [output file] [compression level = 0] [alpha removal threshold = 1]
```
Currently supported values for `compressionLevel` are `0`, `1`, or `2`. `0` means no compression and `1` means compression of scale, rotation, position, and spherical harmonics coefficient values from 32-bit to 16-bit. `2` is similar to `1` except spherical harmonics coefficients are compressed to 8-bit.
<br>
### CORS issues and SharedArrayBuffer
By default, the `Viewer` class uses shared memory (via a typed array backed by a `SharedArrayBufffer`) to communicate with the web worker that sorts the splats. This mechanism presents a potential security issue that is outlined here: https://web.dev/articles/cross-origin-isolation-guide. Shared memory can be disabled by passing `false` for the `sharedMemoryForWorkers` parameter to the constructor for `Viewer`, but if you want to leave it enabled, a couple of extra CORS HTTP headers need to be present in the response from the server that is sent when loading the application. Without those headers set, you might see an error like the following in the debug console:
```
"DOMException: Failed to execute 'postMessage' on 'DedicatedWorkerGlobalScope': SharedArrayBuffer transfer requires self.crossOriginIsolated."
```
For the local demo I created a simple HTTP server (util/server.js) that sets those headers:
```
response.setHeader("Cross-Origin-Opener-Policy", "same-origin");
response.setHeader("Cross-Origin-Embedder-Policy", "require-corp");
```
#### CORS with Apache
For Apache, you can edit the `.htaccess` file to allow CORS by adding the lines:
```
Header add Cross-Origin-Opener-Policy "same-origin"
Header add Cross-Origin-Embedder-Policy "require-corp"
```
Additionally you may need to require a secure connection to your server by redirecting all access via `http://` to `https://`. In Apache this can be done by updating the `.htaccess` file with the following lines:
```
RewriteEngine On
RewriteCond %{HTTPS} off
RewriteRule (.*) https://%{HTTP_HOST}%{REQUEST_URI} [R,L]
```
#### CORS with Vite
For Vite, one popular option is to install the [vite-plugin-cross-origin-isolation](https://github.com/chaosprint/vite-plugin-cross-origin-isolation) plugin via `npm` and then add the following to your `vite.config.js` file.
```javascript
import { defineConfig } from "vite";
export default defineConfig({
plugins: [
{
name: "configure-response-headers",
configureServer: (server) => {
server.middlewares.use((_req, res, next) => {
res.setHeader("Cross-Origin-Embedder-Policy", "require-corp");
res.setHeader("Cross-Origin-Opener-Policy", "same-origin");
next();
});
},
},
],
});
```
There are other ways to configure Vite to handle this referenced in issue [#41](https://github.com/mkkellogg/GaussianSplats3D/issues/41).
| Three.js-based implementation of 3D Gaussian splatting | gaussian-splatting,three-js,webgl,threejs,3d-gaussian-splatting,javascript | 2023-09-26T01:15:29Z | 2024-05-09T03:47:45Z | 2024-05-09T03:47:45Z | 1 | 89 | 467 | 27 | 117 | 996 | null | MIT | JavaScript |
webcrumbs-community/webcrumbs | main | <p align="center"><b>
We are working on a major overhaul of the repository, <br/>so we are currently NOT accepting contributions, but this will change soon 👀 </br>Star the repository and sign up at <a href="https://webcrumbs.org">webcrumbs.org</a> to be notified when we launch!
</b></p>
<br/><br/>
<p align="center">
<img
src="https://github.com/webcrumbs-community/webcrumbs/blob/main/src/assets/logo.svg#gh-light-mode-only"
alt="WebCrumbs logo"
width="255px"
/>
<img
src="https://github.com/webcrumbs-community/webcrumbs/blob/main/src/assets/dark/logo.svg#gh-dark-mode-only"
alt="WebCrumbs logo"
width="255px"
/>
</p>
<br/>
<p align="center">
<img
src="https://github.com/webcrumbs-community/webcrumbs/blob/main/src/assets/main-intro.svg#gh-light-mode-only"
alt="The next revolution in collaborative web development"
width="588px"
/>
<img
src="https://github.com/webcrumbs-community/webcrumbs/blob/main/src/assets/dark/main-intro.svg#gh-dark-mode-only"
alt="The next revolution in collaborative web development"
width="588px"
/>
</p>
</br>
<p align="center">
<a href="https://www.webcrumbs.org/">
<img
src="https://github.com/webcrumbs-community/webcrumbs/blob/main/src/assets/cta-news.svg"
alt="Sign our newsletter"
height="50px"
/>
</a>
<a href="https://discord.gg/ZCj5hFv8xV">
<img
src="https://github.com/webcrumbs-community/webcrumbs/blob/main/src/assets/cta-discord.svg"
alt="Join our discord"
height="50px"
/>
</a>
</p>
<br/><br/>
<br/><br/>
<p align="center">
<img
src="https://github.com/webcrumbs-community/webcrumbs/blob/main/src/assets/title-intro.svg#gh-light-mode-only"
alt="An introduction"
height="24px"
/>
<img
src="https://github.com/webcrumbs-community/webcrumbs/blob/main/src/assets/dark/title-intro.svg#gh-dark-mode-only"
alt="An introduction"
height="24px"
/>
</p>
<br/>
<img
src="https://github.com/webcrumbs-community/webcrumbs/blob/main/src/assets/subtitle-vision.svg#gh-light-mode-only"
alt="Vision"
height="12px"
/>
<img
src="https://github.com/webcrumbs-community/webcrumbs/blob/main/src/assets/dark/subtitle-vision.svg#gh-dark-mode-only"
alt="Vision"
height="12px"
/>
WebCrumbs aspires to be an industry-standard solution for modern web development, creating the first open ecosystem of plugins for the JavaScript community. Whether you're a developer or not, you'll find it easy to create, manage, and extend your modern websites with our intuitive admin panel and a rich ecosystem of and plugins developed by the community.
<p align="center">
<img
src="https://github.com/webcrumbs-community/webcrumbs/blob/main/src/assets/graph-position.svg#gh-light-mode-only"
alt="We're open source, easy and modern"
width="360px"
/>
<img
src="https://github.com/webcrumbs-community/webcrumbs/blob/main/src/assets/dark/graph-position.svg#gh-dark-mode-only"
alt="We're open source, easy and modern"
width="360px"
/>
</p>
**Your Support Matters**
If you find value in what WebCrumbs aims to achieve, consider starring ⭐️ us on GitHub. Your endorsement is crucial in helping us refine our product and grow our community. [Star WebCrumbs on GitHub](#top).
<br/>
<p align="center">
<a href="#top">
<img
src="https://github.com/webcrumbs-community/webcrumbs/blob/main/src/assets/cta-star.png"
alt="Star our repository"
height="50px"
/>
</a>
</p>
<br/>
<p align="center">
<img
src="https://github.com/webcrumbs-community/webcrumbs/blob/main/src/assets/icons.svg#gh-light-mode-only"
alt="Code, love, star"
height="24px"
/>
<img
src="https://github.com/webcrumbs-community/webcrumbs/blob/main/src/assets/dark/icons.svg#gh-dark-mode-only"
alt="Code, love, star"
height="24px"
/>
</p>
<p align="center">
<img
src="https://github.com/webcrumbs-community/webcrumbs/blob/main/src/assets/title-participate.svg#gh-light-mode-only"
alt="Get involved"
height="24px"
/>
<img
src="https://github.com/webcrumbs-community/webcrumbs/blob/main/src/assets/dark/title-participate.svg#gh-dark-mode-only"
alt="Get involved"
height="24px"
/>
</p>
<br/>
</p>
<br/>
<img
src="https://github.com/webcrumbs-community/webcrumbs/blob/main/src/assets/subtitle-spread.svg#gh-light-mode-only"
alt="Help us grow"
height="12px"
/>
<img
src="https://github.com/webcrumbs-community/webcrumbs/blob/main/src/assets/dark/subtitle-spread.svg#gh-dark-mode-only"
alt="Help us grow"
height="12px"
/>
- **Star the repository:** If you haven’t yet (yes, you!), please [give us a star](#top). It’s “free,99” and means a lot to us. Your support helps increase our visibility and keeps us motivated.
- **Share with friends:** We are not looking for numbers, we want passionate, creative minds to join our mission. So only share with the kind of brilliant developers we know you are.
- **Write about us:** If you believe in what WebCrumbs is building, share it with your network and help us grow the community. Write about us on your favorite blog, such as DEV.to, medium, substack, and others.
- **Join our discord community:** It’s where the sync chats happen. Join our discord community through [this link](https://discord.gg/ZCj5hFv8xV).
- **Share your opinion:** we want to make sure we’re building what people want, and guess what, you’re the people! Every opinion counts and I’m excited to hear from you. [Share your opinion](mailto:community@webcrumbs.org).
<br/>
<p align="center">
<a href="https://www.facebook.com/sharer/sharer.php?u=https%3A//github.com/webcrumbs-community/webcrumbs">
<img
src="https://github.com/webcrumbs-community/webcrumbs/blob/main/src/assets/cta-facebook.svg"
alt="Share on Facebook"
height="40px"
/>
</a>
<a href="https://twitter.com/intent/tweet?text=Just%20starred%20this%20Open%20Source%20repo%20that%20is%20the%20WordPress%20for%20React%20developers.%20Check%20it%20out%20https%3A//github.com/webcrumbs-community/webcrumbs">
<img
src="https://github.com/webcrumbs-community/webcrumbs/blob/main/src/assets/cta-x.svg"
alt="Share on X"
height="40px"
/>
</a>
<a href="https://www.linkedin.com/shareArticle?mini=true&url=https%3A//github.com/webcrumbs-community/webcrumbs">
<img
src="https://github.com/webcrumbs-community/webcrumbs/blob/main/src/assets/cta-linkedin.svg"
alt="Share on Linkedin"
height="40px"
/>
</a>
<a href="https://www.reddit.com/submit?url=https%3A//github.com/webcrumbs-community/webcrumbs&title=Create%20and%20modify%20React%20websites%20and%20applications%20with%20a%20no-code%20interface%20and%20powerful%20plugins,%20enriched%20by%20the%20community.%20%F0%9F%8C%9F%20Star%20to%20support%20our%20work!">
<img
src="https://github.com/webcrumbs-community/webcrumbs/blob/main/src/assets/cta-reddit.svg"
alt="Share on Reddit"
height="40px"
/>
</a>
<a href="https://news.ycombinator.com/submitlink?u=https%3A//github.com/webcrumbs-community/webcrumbs&t=Create%20and%20modify%20React%20websites%20and%20applications%20with%20a%20no-code%20interface%20and%20powerful%20plugins,%20enriched%20by%20the%20community.">
<img
src="https://github.com/webcrumbs-community/webcrumbs/blob/main/src/assets/cta-hackernews.svg"
alt="Share on HackerNews"
height="40px"
/>
</a>
<a href="https://t.me/share/url?url=https%3A//github.com/webcrumbs-community/webcrumbs&text=Just%20starred%20this%20Open%20Source%20repo%20that%20is%20the%20WordPress%20for%20React%20developers.%20Check%20it%20out%20https%3A//github.com/webcrumbs-community/webcrumbs">
<img
src="https://github.com/webcrumbs-community/webcrumbs/blob/main/src/assets/cta-telegram.svg"
alt="Send on Telegram"
height="40px"
/>
</a>
<a href="https://api.whatsapp.com/send?text=Just%20starred%20this%20repo%20and%20it%20sounds%20promising.%20It's%20WordPress%20for%20React.%20Check%20it%20here%3A%20https%3A%2F%2Fgithub.com%2Fwebcrumbs-community%2Fwebcrumbs">
<img
src="https://github.com/webcrumbs-community/webcrumbs/blob/main/src/assets/cta-whatsapp.svg"
alt="Send on WhatsApp"
height="40px"
/>
</a>
<a href="https://pinterest.com/pin/create/button/?url=https%3A//github.com/webcrumbs-community/webcrumbs&media=https%3A//github.com/webcrumbs-community/webcrumbs/blob/main/src/img/meme.png">
<img
src="https://github.com/webcrumbs-community/webcrumbs/blob/main/src/assets/cta-pinterest.svg"
alt="Pin on Pinterest"
height="40px"
/>
</a>
</p>
<br/><br/>
<p align="center">
<img
src="https://github.com/webcrumbs-community/webcrumbs/blob/main/src/assets/title-members.svg#gh-light-mode-only"
alt="People making WebCrumbs"
height="30px"
/>
<img
src="https://github.com/webcrumbs-community/webcrumbs/blob/main/src/assets/dark/title-members.svg#gh-dark-mode-only"
alt="People making WebCrumbs"
height="30px"
/>
</p>
<br/>
<img
src="https://github.com/webcrumbs-community/webcrumbs/blob/main/src/assets/subtitle-stargazers.svg#gh-light-mode-only"
alt="We are now"
height="12px"
/>
<img
src="https://github.com/webcrumbs-community/webcrumbs/blob/main/src/assets/dark/subtitle-stargazers.svg#gh-dark-mode-only"
alt="We are now"
height="12px"
/>
<p align="center">
<a href="#top">
<img
src="https://img.shields.io/github/stars/webcrumbs-community/webcrumbs?style=social"
alt="Stars"
height="36px"
/>
</a>
</p>
<br/>
<img
src="https://github.com/webcrumbs-community/webcrumbs/blob/main/src/assets/subtitle-contributors.svg#gh-light-mode-only"
alt="With amazing contributors"
height="12px"
/>
<img
src="https://github.com/webcrumbs-community/webcrumbs/blob/main/src/assets/dark/subtitle-contributors.svg#gh-dark-mode-only"
alt="With amazing contributors"
height="12px"
/>
<p align="center">
<img
src="https://github.com/webcrumbs-community/webcrumbs/blob/main/CONTRIBUTORS.svg"
alt="Contributors"
/>
</p>
<br/>
<img
src="https://github.com/webcrumbs-community/webcrumbs/blob/main/src/assets/subtitle-countries.svg#gh-light-mode-only"
alt="And people around all over the world"
height="12px"
/>
<img
src="https://github.com/webcrumbs-community/webcrumbs/blob/main/src/assets/dark/subtitle-countries.svg#gh-dark-mode-only"
alt="And people around all over the world"
height="12px"
/>
<p align="center">
<img
src="https://github.com/webcrumbs-community/webcrumbs/blob/main/aux/countries/COUNTRIES.svg"
alt="Countries"
/>
</p>
<br/>
<img
src="https://github.com/webcrumbs-community/webcrumbs/blob/main/src/assets/subtitle-growth.svg#gh-light-mode-only"
alt="We are growing fast!"
height="12px"
/>
<img
src="https://github.com/webcrumbs-community/webcrumbs/blob/main/src/assets/dark/subtitle-growth.svg#gh-dark-mode-only"
alt="We are growing fast!"
height="12px"
/>
<p align="center">
<a href="https://star-history.com/#webcrumbs-community/webcrumbs&Timeline">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=webcrumbs-community/webcrumbs&type=Timeline&theme=dark" />
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=webcrumbs-community/webcrumbs&type=Timeline" />
<img alt="Growth" src="https://api.star-history.com/svg?repos=webcrumbs-community/webcrumbs&type=Timeline" />
</picture>
</a>
</p>
<br/><br/>
This project operates under the MIT License and is a community-driven endeavor.
**Credits**
Spearheaded and maintained by [WebCrumbs Community](https://github.com/webcrumbs-community).
| Create and modify Node.js websites and applications with an admin interface and powerful themes and plugins, enriched by the community. 🌟 Star to support our work! | admin-panel,open-source,react,web-development,microfrontend,community,javascript,nodejs,reactjs | 2023-09-13T12:33:12Z | 2024-05-14T11:48:32Z | null | 24 | 113 | 679 | 0 | 70 | 714 | null | MIT | TypeScript |
Teamlinker/Teamlinker | main | <p align="center">
<a href="https://team-linker.com">
<img width="200" src="img/logo.png">
</a>
</p>
<h3 align="center">
Team Collaboration Solution For Enterprise Users
</h3>
<h4 align="center">
Team collaboration has never been easier
</h4>
English | [简体中文](./README-ZH-CN.md)
## 📝 Introduction
Teamlinker is a team collaboration platform that integrates multi-functional modules,such as contact, task management, meeting, IM,Wiki and file management.
The platform solves the problem of efficient collaboration within the team and avoids the problem of companies using multiple tools to handle project progress, communication with colleagues and client meetings separately. Compared with traditional tools, Teamlinker not only provides basic and comprehensive collaborative office needs, but also has extremely low cost.
Teamlinker is developed based on the TeamOS system. It is a web operating system that allows users to process different tasks in parallel, similar to operating systems such as Win and Mac. It mainly contains six functional modules: project, wiki, calendar, meeting, chat and network disk. These functions are seamlessly integrated to make team collaboration smoother.
## 📋 Official website
https://team-linker.com
## 📋 Documentation
https://team-linker.com/doc/en/
## 🕐︎ Features
* Completely developed using TypeScript, using Node.js on the backend and Vue3 on the frontend.
* Created a Web OS system from scratch, realizing functions such as desktop management, multi-window, multi-tasking, file drag-and-drop, upload and download.
* Use WebRtc to realize multi-person video and voice transmission, including member invitation, screen sharing, virtual background, video blur and other functions. At the same time, conference administrator control and in-meeting chat functions are implemented.
* A block editor is developed based on HTMLElement's contentEditable, which supports free typesetting, color and font adjustment, link and picture insertion, as well as attachment addition and shortcuts.
* The project management module supports common project management functions such as custom work item types, workflows, fields, Kanban and Gantt chart management. It is completely developed using pure JavaScript and can be extracted as a separate module for use.
* The calendar part implements multi-calendar management, multi-time zone switching, free switching of day, week and month view status, supports all-day and repeated calendar events, and uses RabbitMQ to implement calendar event reminder functions.
* The IM function uses Socket.IO to realize @ everyone or specific members in the message group, message collection and search, and also includes functions such as fast video conferencing.
* The upcoming AI function uses NLP technology and the Transformers framework to create a personal work assistant to provide you with personalized services.
## 📲 Core Architecture
<p>
<img src="img/core.png">
</p>
## 🔐 Installation
[Installation tutorial](./INSTALL.md)
## 💻 Local Deployment
[Local Deployment](./DEV-README.md)
## 📱 Online demo
project
document
calendar
Meeting
chat
File management
system
## 🎬 Author
Ansun [[ website ](https://team-linker.com) | [ github ](https://github.com/sx1989827)]
## 📺 Tips
1. Only allowed to be used for personal study, graduation projects, teaching cases, public welfare undertakings, and commercial use;
2. If copyright information must be retained for commercial use, please abide by it consciously;
3. It is prohibited to sell the code and resources of this open source in any form or under any name, otherwise the infringer will be responsible for any consequences;
4. The source code of this version is all open source; including front-end and back-end, without any encryption;
5. For commercial use, please carefully review the code and vulnerabilities. It must not be used for commercial applications outside the scope of permission in any country. You will be responsible for any consequences;
## 🔓 License
[ISC](./LICENSE)
## ⚡ Technology Exchange
[Discord](https://discord.gg/X8t4d7JqgX) | Teamlinker is a team collaboration platform that integrates multi-functional modules. Users can process tasks in parallel, including six functional modules: project, wiki, calendar, meeting, chat and network disk, achieving seamless integration and improving team collaboration efficiency. | arco-design,artificial-intelligence,calendar,chat,confluence,cooperation,documentation,javascript,mediasoup,meeting | 2023-10-08T01:33:27Z | 2024-01-17T05:41:54Z | null | 2 | 0 | 11 | 7 | 31 | 519 | null | GPL-3.0 | TypeScript |
QuiiBz/sherif | main | <p align="center">
<picture>
<img alt="" height="200px" src="https://github.com/QuiiBz/sherif/blob/main/assets/logo.png" />
</picture>
<br />
<b>Sherif</b>: Opinionated, zero-config linter for JavaScript monorepos
</p>
---
## About
Sherif is an opinionated, zero-config linter for JavaScript monorepos. It runs fast in any monorepo and enforces rules to provide a better, standardized DX.
## Features
- ✨ **PNPM, NPM, Yarn...**: sherif works with all package managers
- 🔎 **Zero-config**: it just works and prevents regressions
- ⚡ **Fast**: doesn't need `node_modules` installed, written in 🦀 Rust
## Installation
Run `sherif` in the root of your monorepo to list the found issues. Any error will cause Sherif to exit with a code 1:
```bash
# PNPM
pnpm dlx sherif@latest
# NPM
npx sherif@latest
```
We recommend running Sherif in your CI once [all errors are fixed](#autofix). Run it by **specifying a version instead of latest**. This is useful to prevent regressions (e.g. when adding a library to a package but forgetting to update the version in other packages of the monorepo).
<details>
<summary>GitHub Actions example</summary>
```yaml
name: Sherif
on:
pull_request:
jobs:
check:
name: Run Sherif
runs-on: ubuntu-22.04
steps:
- name: Checkout
uses: actions/checkout@v4
- uses: actions/setup-node@v3
with:
node-version: 20
- run: npx sherif@0.8.4
```
</details>
## Autofix
Most issues can be automatically fixed by using the `--fix` flag. Note that autofix is disabled in CI environments (when `$CI` is set):
```bash
sherif --fix
```
## Rules
You can ignore a specific rule by using `--ignore-rule <name>` (or `-r <name>`):
```bash
# Ignore both rules
sherif -r packages-without-package-json -r root-package-manager-field
```
You can ignore all issues in a package by using `--ignore-package <pathOrName>` (or `-p <pathOrName>`):
```bash
# Ignore all issues in the `@repo/tools` package
sherif -p @repo/tools
# Ignore all issues for packages inside `./integrations/*`
sherif -p "./integrations/*"
```
> **Note**
> Sherif doesn't have many rules for now, but will likely have more in the future (along with more features).
#### `empty-dependencies` ❌
`package.json` files should not have empty dependencies fields.
#### `multiple-dependency-versions` ❌
A given dependency should use the same version across the monorepo.
You can ignore this rule for a dependency if you expect to have multiple versions by using `--ignore-dependency <name>` (or `-i <name>`):
```bash
# Ignore dependencies that are expected to have multiple versions
sherif -i react -i @types/node
```
#### `non-existant-packages` ⚠️
All paths defined in the workspace (the root `package.json`' `workspaces` field or `pnpm-workspace.yaml`) should match at least one package.
#### `packages-without-package-json` ⚠️
All packages matching the workspace (the root `package.json`' `workspaces` field or `pnpm-workspace.yaml`) should have a `package.json` file.
#### `root-package-dependencies` ⚠️
The root `package.json` is private, so making a distinction between `dependencies` and `devDependencies` is useless - only use `devDependencies`.
#### `root-package-manager-field` ❌
The root `package.json` should specify the package manager and version to use. Useful for tools like corepack.
#### `root-package-private-field` ❌
The root `package.json` should be private to prevent accidentaly publishing it to a registry.
#### `types-in-dependencies` ❌
Private packages shouldn't have `@types/*` in `dependencies`, since they don't need it at runtime. Move them to `devDependencies`.
## Credits
- [dedubcheck](https://github.com/innovatrics/dedubcheck) that given me the idea for Sherif
- [Manypkg](https://github.com/Thinkmill/manypkg) for some of their rules
- [This article](https://blog.orhun.dev/packaging-rust-for-npm/) for the Rust releases on NPM
## Sponsors
## License
[MIT](./LICENSE)
| Opinionated, zero-config linter for JavaScript monorepos | cli,javascript,linter,monorepo | 2023-09-17T14:11:52Z | 2024-04-13T13:39:29Z | 2024-04-13T13:39:29Z | 2 | 40 | 60 | 5 | 6 | 407 | null | MIT | Rust |
laurentpayot/verticalize | main | # <sub><img src="verticalize.svg" alt="triple chevron down" width="48" height="48"></sub> Verticalize
A pipe-like function to verticalize your JavaScript code
<!-- [](https://bundlephobia.com/package/verticalize) -->
[](https://github.com/laurentpayot/verticalize/blob/main/package.json#L56)
[](https://github.com/laurentpayot/verticalize/blob/main/index.d.ts)
[](https://www.npmjs.com/package/verticalize)
[](https://github.com/laurentpayot/verticalize/blob/main/LICENSE)
## Gist
The following example code is a bit hard to read:
```js
const { status } = await send(capitalize(greeting) + "!")
console.log(status)
```
Make it less nested, more *vertical*, by using the `V` "pipe":
```js
V( greeting, // initial value ➡ "hi"
V (capitalize), // custom function call ➡ "Hi"
V .concat("!"), // String method `concat` call ➡ "Hi!"
V (send), // custom async function call ➡ Promise { <pending> }
V .status, // automatic promise chaining + getting property ➡ Promise { 200 }
V (console.log), // automatic promise chaining + global function call ➡ logs 200
)
```
If your IDE or a tool like Prettier automatically formats the code for you, it may result in the following syntax (still working):
```js
V(greeting,
V(capitalize),
V.concat("!"),
V(send),
V.status,
V(console.log),
)
```
Verticalize’s `V` function is around 200 bytes minified and compressed, and has no dependencies. It won’t bloat your web app.
## NodeJS
### Installation
```bash
npm install verticalize
```
### Import
```js
import { V } from 'verticalize'
```
## Browser
Verticalize uses [ES modules](https://jakearchibald.com/2017/es-modules-in-browsers/), [widely supported](https://caniuse.com/es6-module) in browsers nowadays. Import the `V` function from the `verticalize.min.js` file. This file can be located in a CDN (example below) or copied in any directory of your website (for better performance and to be GDPR compliant, since you don’t have to connect to a third party server).
```html
<script type="module">
import { V } from 'https://cdn.jsdelivr.net/npm/verticalize@0.1.3/verticalize.min.js'
</script>
```
## `V` function usage
The gist example above covers pretty much everything. Just call the `V` function with the initial *value* as the first argument, followed by the other arguments wrapped by another `V` at the beginning of the line to get a nice <sub><img src="verticalize.svg" alt="triple chevron down" width="18" height="18"></sub> syntax. All these `V`-prefixed lines will then act like a pipeline, the output of a pipe being the input of the following pipe. Pipes can use unary functions, methods and properties, but not values (except for the initial value).
### Unary functions
A unary function is a function that takes only one argument. You can use an anonymous ("arrow") function to turn a multi-argument function into a unary one.
```js
V( 1.9, // initial value
V (Math.round), // unary function
V (n => Math.pow(n, 3)), // binary function turned into unary
) // returns 8
```
### Methods and properties
To call a method or to get a property of the previous pipe output (or of the initial value), you can use an anonymous function like `count => count.add(1)`, but for convenience Verticalize allows you to use a direct dot syntax.
```js
V( [1, 2, 3], // initial Array value
V .concat([4, 5, 6]), // calling the Array method `concat()` (returning an Array)
V .length, // getting the Array property `length`
) // returns 6
```
### Promises
When the previous pipe output (or the initial value) is a promise, the next pipe will automatically chain it so you don’t have to write many `.then()` yourself.
```js
const greeting =
await
V( Promise.resolve("Hello"),
V .toUpperCase(),
V .concat("!!!"),
)
```
is the same as
```js
const greeting =
await Promise.resolve("Hello")
.then(s => s.toUpperCase())
.then(s => s.concat("!!!"))
```
## Note
A TC39 proposal for the pipe operator `|>` [was created in 2015](https://github.com/tc39/proposal-pipeline-operator/blob/main/HISTORY.md) and is currently in stage 2. It may or may not be included in the official JavaScript specs in a few years. If so, then it will take a few more years to be adopted by all the major browsers and runtimes. But you can use Verticalize *right now* and enjoy its unique dot syntax and automatic promise chaining features :wink:
## License
[MIT](https://github.com/laurentpayot/verticalize/blob/main/LICENSE)
## Stargazers :heart:
[](https://github.com/laurentpayot/verticalize/stargazers)
| A pipe-like function to verticalize your JavaScript code | javascript,operator,pipe,pipeline,light,lightweight,promises,code,syntax | 2023-09-20T10:05:47Z | 2024-04-03T08:41:58Z | 2023-09-28T08:08:18Z | 1 | 0 | 49 | 0 | 4 | 302 | null | MIT | JavaScript |
e2b-dev/e2b-cookbook | main | # ✴️ E2B Cookbook
Example code and guides for building with [E2B's Code Interpreter SDK](https://github.com/e2b-dev/code-interpreter).
## Examples
**Hello World guide**
- [TypeScript](https://github.com/e2b-dev/e2b-cookbook/tree/main/examples/hello-world-js)
- [Python](https://github.com/e2b-dev/e2b-cookbook/tree/main/examples/hello-world-python)
**Example use cases**
- [Upload dataset and analyze it with Llama 3](https://github.com/e2b-dev/e2b-cookbook/tree/main/examples/upload-dataset-code-interpreter)
- [Scrape Airbnb and analyze data with Firecrawl](https://github.com/e2b-dev/e2b-cookbook/tree/main/examples/scrape-and-analyze-airbnb-data-with-firecrawl)
**LLM providers**
- OpenAI
- [GPT-4o with code interpreter and reasoning on image date](https://github.com/e2b-dev/e2b-cookbook/blob/main/examples/gpt-4o-code-interpreter/gpt_4o.ipynb)
- Anthropic
- Claude 3 Opus with code intepreter
- [Python](https://github.com/e2b-dev/e2b-cookbook/tree/main/examples/claude-code-interpreter-python)
- [JavaScript/TypeScript](https://github.com/e2b-dev/e2b-cookbook/tree/main/examples/claude-code-interpreter-js)
- MetaAI
- 🦙 Llama 3 with code interpreter
- [Python](https://github.com/e2b-dev/e2b-cookbook/tree/main/examples/llama-3-code-interpreter-python)
- [JavaScript/TypeScript](https://github.com/e2b-dev/e2b-cookbook/tree/main/examples/llama-3-code-interpreter-js)
**AI frameworks integrations**
- 🦜⛓️ LangChain
- [LangChain with Code Interpreter](https://github.com/e2b-dev/e2b-cookbook/tree/main/examples/langchain-python)
- 🦜🕸️ LangGraph
- [LangGraph with code interpreter](https://github.com/e2b-dev/e2b-cookbook/tree/main/examples/langgraph-python)
- Autogen
- [Autogen with secure sandboxed for code interpreting](https://github.com/e2b-dev/e2b-cookbook/tree/main/examples/e2b_autogen)
- ▲ Vercel's AI SDK Next.js
- [Next.js + AI SDK + Code Interpreter](https://github.com/e2b-dev/e2b-cookbook/tree/main/examples/nextjs-code-interpreter)
## Getting started with E2B
### 1. Get API key
[Sign up](https://e2b.dev/docs/sign-in?view=sign-up) and [get your E2B API key](https://e2b.dev/docs/getting-started/api-key).
### 2. Install code interpreter SDK
We have built a [dedicated SDK](https://github.com/e2b-dev/code-interpreter) for adding code interpreting to your AI apps.
### 3. Check out Hello World example
Check out the [TypeScript](https://github.com/e2b-dev/e2b-cookbook/tree/main/examples/hello-world-js) and [Python](https://github.com/e2b-dev/e2b-cookbook/tree/main/examples/hello-world-python) hello world examples.
### 4. Explore documentation
Visit our docs at [e2b.dev/docs](https://e2b.dev/docs).
| Examples and guides for using the E2B API | cookbook,e2b,guides,javascript,openai,python,python3,sdk,typescript,example | 2023-09-27T11:02:43Z | 2024-05-21T10:53:23Z | null | 8 | 21 | 263 | 1 | 43 | 279 | null | null | TypeScript |
ShellWen/v8_killer | master | <!-- Improved compatibility of back to top link: See: https://github.com/othneildrew/Best-README-Template/pull/73 -->
<a name="readme-top"></a>
<!--
*** Thanks for checking out the Best-README-Template. If you have a suggestion
*** that would make this better, please fork the repo and create a pull request
*** or simply open an issue with the tag "enhancement".
*** Don't forget to give the project a star!
*** Thanks again! Now go create something AMAZING! :D
-->
<!-- PROJECT SHIELDS -->
<!--
*** I'm using markdown "reference style" links for readability.
*** Reference links are enclosed in brackets [ ] instead of parentheses ( ).
*** See the bottom of this document for the declaration of the reference variables
*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.
*** https://www.markdownguide.org/basic-syntax/#reference-style-links
-->
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
[![LinkedIn][linkedin-shield]][linkedin-url]
[](https://ko-fi.com/O5O4RNVHA)
<!-- PROJECT LOGO -->
<br />
<div align="center">
<h3 align="center">V8 Killer</h3>
<p align="center">
A <strong>powerful</strong> and highly <strong>customizable</strong> <strong>universal</strong> V8 virtual machine injector.
<br />
<a href="https://shellwen.github.io/v8_killer/"><strong>Explore the docs »</strong></a>
<br />
<br />
<a href="https://github.com/ShellWen/v8_killer/issues">Report Bug</a>
·
<a href="https://github.com/ShellWen/v8_killer/issues">Request Feature</a>
</p>
</div>
<!-- DOCUMENTATIONS -->
## Documentations
Documentations are available under [GitHub Pages](https://shellwen.github.io/v8_killer/).
<!-- ABOUT THE PROJECT -->
## About The Project
This project began with an initial idea: injecting scripts into Electron applications. There are traditionally two main approaches for accomplishing this.
- Modifying resource files, such as .js or .asar files. However, this approach is highly invasive and cannot pass integrity checks in some software.
- Opening a debugging port (`--inspect` or `--inspect-brk`) and injecting scripts using a debugger. However, some software may inspect this parameter or outright block it.
This project takes a different approach by hooking into the compilation functions of the V8 engine, directly modifying the source code passed to the V8 compiler. This allows scripts to be injected into the V8 engine without altering any local files or opening any debugging ports. Through testing, it has been confirmed that this method can be used with any software/framework built on the V8 engine, including but not limited to Node.js, Electron, and Deno.
Currently, this project has been tested exclusively on Linux and Windows. In theory, with minor modifications, it should be possible to run it on macOS. However, this is not currently part of our development roadmap.
This project is divided into two parts: `core` and `launcher`. The `core` constitutes the central component and represents the actual injected payload. The `launcher` is responsible for loading the payload, which is the `core`, into the target program.
On Linux, loading the payload can be accomplished simply using `LD_PRELOAD`. However, on Windows, this might require additional work, and this is where the purpose of the launcher comes into play.
So far, we support the following targets:
| Target | Supported | Note |
|----------|-----------|------------------------------------------------------------------------------------------------------------|
| Node.js | Yes | |
| Electron | Yes | |
| CEF | Untested | |
| Deno | No | Deno remove exports from V8. In future versions, we will introduce pattern matching to address this issue. |
Pattern matching is on the way. [#12](https://github.com/ShellWen/v8_killer/issues/12)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- GETTING STARTED -->
## Getting Started
This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.
<!-- LICENSE -->
## License
Distributed under the MIT License. See `LICENSE` for more information.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- CONTACT -->
## Contact
ShellWen - [@realShellWen](https://twitter.com/realShellWen) - me@shellwen.com
Project Link: [https://github.com/ShellWen/v8_killer](https://github.com/ShellWen/v8_killer)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- MARKDOWN LINKS & IMAGES -->
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
[contributors-shield]: https://img.shields.io/github/contributors/ShellWen/v8_killer.svg?style=for-the-badge
[contributors-url]: https://github.com/ShellWen/v8_killer/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/ShellWen/v8_killer.svg?style=for-the-badge
[forks-url]: https://github.com/ShellWen/v8_killer/network/members
[stars-shield]: https://img.shields.io/github/stars/ShellWen/v8_killer.svg?style=for-the-badge
[stars-url]: https://github.com/ShellWen/v8_killer/stargazers
[issues-shield]: https://img.shields.io/github/issues/ShellWen/v8_killer.svg?style=for-the-badge
[issues-url]: https://github.com/ShellWen/v8_killer/issues
[license-shield]: https://img.shields.io/github/license/ShellWen/v8_killer.svg?style=for-the-badge
[license-url]: https://github.com/ShellWen/v8_killer/blob/master/LICENSE
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
[linkedin-url]: https://linkedin.com/in/ShellWen
[rust-badge]: https://img.shields.io/badge/Rust-000000?style=for-the-badge&logo=rust&logoColor=white
[rust-url]: https://www.rust-lang.org/
[v8-badge]: https://img.shields.io/badge/V8-4B8BF5?style=for-the-badge&logo=v8&logoColor=white
[v8-url]: https://v8.dev/
| A powerful and highly customizable universal V8 virtual machine injector. | javascript,native,nodejs,rust,v8,chromium,electron | 2023-09-24T16:47:36Z | 2024-04-08T20:48:36Z | null | 3 | 8 | 48 | 0 | 27 | 275 | null | MIT | Rust |
instant-dev/instant | main | <div align="center">
<h1>instant.dev <img alt="npm" src="https://img.shields.io/npm/v/instant.dev?label="></h1>
<img src="/_assets/instant.png" height="128">
<h3>
<a href="https://github.com/instant-dev/orm">@instant.dev/orm</a> <img alt="npm" src="https://img.shields.io/npm/v/@instant.dev/orm?label="> <img alt="build status" src="https://app.travis-ci.com/instant-dev/orm.svg?branch=main">
</h3>
<h3>
<a href="https://github.com/instant-dev/api">@instant.dev/api</a> <img alt="npm" src="https://img.shields.io/npm/v/@instant.dev/api?label="> <img alt="build status" src="https://app.travis-ci.com/instant-dev/api.svg?branch=main">
</h3>
<hr>
</div>
## JavaScript + Postgres API Framework with ORM, Migrations and Vectors
[**`instant.dev`**](https://instant.dev) provides a fast, reliable and
battle-tested ORM and migration management system for Postgres 13+ built in
JavaScript. For those familiar with Ruby on Rails, instant.dev adds
functionality similar to ActiveRecord to the Node.js, Deno and Bun ecosystems.
We have been using it since 2016 in production at
[Autocode](https://autocode.com) where it has managed over 1 billion records in
a 4TB AWS Aurora Postgres instance.
With `instant.dev` you can:
- Add the [Instant ORM](https://github.com/instant-dev/orm) and migrations to
your existing JavaScript or TypeScript project
- Scaffold new Postgres-backed API projects from scratch using
[Instant API](https://github.com/instant-dev/api)
- Generate new migrations, models and endpoints
- Migrate remote databases and deploy in a single step
- Connect to any PostgreSQL host: AWS RDS, Railway, Vercel Postgres, Neon,
Supabase
- Instantly deploy to [Vercel](https://vercel.com)
Are you interested in connecting? [Join us on Discord](https://discord.gg/puVYgA7ZMh) or follow us on
X, [@instantdevs](https://x.com/instantdevs).
<div align="center">
<img src="/_assets/instant-demo.gif"><br>
</div>
## Features
- [**CRUD operations**](#crud-operations)
- Create, Read, Update and Destroy records easily
- [**Vector fields**](#vector-fields)
- Build AI-integrated applications and add search by easily creating, updating and
querying against vectorized representations of your data
- [**Query composition**](#query-composition)
- Build complex SELECT and UPDATE queries with many layers of nested joins and
conditional statements
- [**Transactions**](#transactions)
- Ensure data consistency within logical transaction blocks that can be rolled
back to prevent writing orphaned data
- [**Input validation**](#input-validation)
- Synchronously validate object fields to ensure the right data is stored
- [**Relationship verification**](#relationship-verification)
- Asynchronously validate relationships between one or more fields and
external resources before saving
- [**Calculated and hidden fields**](#calculated-and-hidden-fields)
- Automatically populate object fields based on existing data
- [**Lifecycle callbacks**](#lifecycle-callbacks)
- Execute custom logic beforeSave(), afterSave(), beforeDestroy() and
afterDestroy() to perform necessary build and teardown steps inside of
transactions
- [**Migrations**](#migrations)
- Manage local database state via the filesystem to make branched git
development a breeze
- [**Seeding**](#seeding)
- Provide custom JSON files so that all developers can share the same test
data across development, testing and staging environments
- [**Code generation**](#code-generation)
- Automatically generate models, migrations and endpoints for your project
## Table of Contents
1. [Installation and Usage](#installation-and-usage)
2. [Getting Started](#getting-started)
3. [Using the `instant` CLI](#using-the-instant-cli)
4. [Using the Instant ORM](#using-the-instant-orm)
5. [Feature breakdown](#feature-breakdown)
6. [Kits](#kits)
1. [Kit: auth](#kit-auth)
1. [Kit: auth on Autocode](#kit-auth-on-autocode)
2. [Kit: auth on Vercel](#kit-auth-on-vercel)
7. [Acknowledgements](#acknowledgements)
## Installation and Usage
```shell
npm i instant.dev -g
cd ~/projects/my-awesome-project
instant init
```
That's it! The command line tool will walk you through the process of
initializing your `instant.dev` project. It will;
- Automatically detect whether this is a new project or an existing one
- Scaffold a new [Vercel](https://vercel.com) or [Autocode](https://autocode.com)
project, if necessary
- Ask for your local database credentials
- Initialize necessary files in the `_instant/` directory of your project
- Create an initial migration
To install the basic `auth` kit which comes with a `User` and `AccessToken`
model and associated user registration and login endpoints, use:
```shell
instant kit auth
```
You can read more in [Kit: auth](#kit-auth)
## Using the `instant` CLI
You can look up documentation for the `instant` command line utility at any
point by running `instant` or `instant help`. The most commonly used methods
are:
- `instant g:model` to create a new model
- `instant g:relationship` to create one-to-one or one-to-many relationships
between models
- `instant g:endpoint` to automatically scaffold Vercel or Autocode endpoints,
if applicable
- `instant db:migrate` to run migrations
- `instant db:rollback` to rollback migrations
- `instant db:rollbackSync` to rollback to last synchronized (filesystem x
database) migration
- `instant db:bootstrap` to reset your database, run migrations, and seed data
- `instant db:add` to add remote databases (AWS RDS, Railway, Vercel Postgres,
Neon, Supabase)
- `instant serve` to run your server using Vercel, Autocode or the command
specified in `package.json["scripts"]["start"]`
- `instant sql` is a shortcut to `psql` into any of your databases
- `instant deploy` to run outstanding migrations and deploy to Vercel or
Autocode
## Using the Instant ORM
Full documentation for the ORM can be found in the
[@instant.dev/orm](https://github.com/instant-dev/orm) repository. Here's
a quick overview of using the ORM:
Importing with CommonJS:
```javascript
const InstantORM = require('@instant.dev/orm');
const Instant = new InstantORM();
```
Importing with ESM:
```javascript
import InstantORM from '@instant.dev/orm';
const Instant = new InstantORM();
```
Using the ORM:
```javascript
// Connect to your database
// Defaults to using instant/db.json[process.env.NODE_ENV || 'development']
await Instant.connect();
// Get the user model: can also use 'user', 'users' to same effect
const User = Instant.Model('User');
// Create a user
let user = await User.create({username: 'Billy'});
// log user JSON
// {id: 1, username: 'Billy', created_at: '...', updated_at: '...'}
console.log(user.toJSON());
// Create multiple models at once
const UserFactory = Instant.ModelFactory('User');
let createdUsers = await UserFactory.create([
{username: 'Sharon'},
{username: 'William'},
{username: 'Jill'}
]);
// Retrieves users with username containing the string 'ill'
let users = await User.query()
.where({username__icontains: 'ill'})
.orderBy('username', 'ASC')
.select();
// [{username: 'Billy'}, {username: 'Jill'}, {username: 'William'}]
console.log(users.toJSON());
users[0].set('username', 'Silly Billy');
await users[0].save();
// [{username: 'Silly Billy'}, {username: 'Jill'}, {username: 'William'}]
console.log(users.toJSON());
```
## Feature breakdown
### CRUD operations
```javascript
const User = Instant.Model('User');
/* Create */
let user = await User.create({
email: 'keith@instant.dev',
username: 'keith'
});
// Can also use new keyword to create, must save after
user = new User({
email: 'keith@instant.dev',
username: 'keith'
});
await user.save();
/* Read */
user = await User.find(1); // uses id
user = await User.findBy('email', 'keith@instant.dev');
user = await User.query()
.where({email: 'keith@instant.dev'})
.first();
let users = await User.query()
.where({email: 'keith@instant.dev'})
.select();
/* Update */
user.set('username', 'keith_h');
await user.save();
// Update by reading from data
user.read({username: 'keith_h'});
await user.save();
// Update or Create By
user = await User.updateOrCreateBy(
'username',
{username: 'keith', email: 'keith+new@instant.dev'}
);
// Update query: this will bypass validations and verifications
users = await User.query()
.where({username: 'keith_h'})
.update({username: 'keith'});
/* Destroy */
await user.destroy();
await user.destroyCascade(); // destroy model + children (useful for foreign keys)
/* ModelArray methods */
users.setAll('username', 'instant');
users.readAll({username: 'instant'});
await users.saveAll();
await users.destroyAll();
await users.destroyCascade();
```
### Vector fields
`instant.dev` comes with built-in support for [pgvector](https://github.com/pgvector/pgvector) and the
`vector` field type. For full instructions on using vectors please check out the
[Instant ORM: Vector fields](https://github.com/instant-dev/orm#vector-fields) documentation.
Set a vector engine via a plugin (OpenAI is the default):
File `_instant/plugins/000_set_vector_engine.mjs`:
```javascript
import OpenAI from 'openai';
const openai = new OpenAI({apiKey: process.env.OPENAI_API_KEY});
export const plugin = async (Instant) => {
Instant.Vectors.setEngine(async (values) => {
const embedding = await openai.embeddings.create({
model: 'text-embedding-ada-002',
input: values
});
return embedding.data.map(entry => entry.embedding);
});
};
```
Explain how we want to automatically store vector fields:
File: `_instant/models/blog_post.mjs`
```javascript
import InstantORM from '@instant.dev/orm';
class BlogPost extends InstantORM.Core.Model {
static tableName = 'blog_posts';
}
// Stores the `title` and `content` fields together as a vector
// in the `content_embedding` vector field
BlogPost.vectorizes(
'content_embedding',
(title, content) => `Title: ${title}\n\nBody: ${content}`
);
// optional, just prevents .toJSON() printing the entire array
BlogPost.hides('content_embedding');
export default BlogPost;
```
And query our vector fields:
```javascript
const blogPost = await BlogPost.create({title: `My first post`, content: `some content`});
const vector = blogPost.get('content_embedding'); // length 1,536 array
// Find the top 10 blog posts matching "blog posts about dogs"
// Automatically converts query to a vector
let searchBlogPosts = await BlogPost.query()
.search('content_embedding', 'blog posts about dogs')
.limit(10)
.select();
```
You can read more on vector queries at
[Composer#search](https://github.com/instant-dev/orm#composersearch) and [Composer#similarity](https://github.com/instant-dev/orm#composersimilarity).
### Query composition
```javascript
const User = Instant.Model('User');
// Basic querying
let users = await User.query()
.where({id__in: [7, 8, 9]})
.orderBy('username', 'ASC')
.limit(2)
.select();
// Query with OR by sending in a list of where objects
users = await User.query()
.where( // Can pass in arguments or an array
{id__in: [7, 8, 9]},
{username__istartswith: 'Rom'}
)
.select();
// evaluate custom values with SQL commands
// in this case, get users where their username matches the first part of their
// email address
users = await User.query()
.where({
username: email => `SPLIT_PART(${email}, '@', 1)`
})
.select();
// Joins
users = await User.query()
.join('posts', {title__icontains: 'hello'}) // JOIN ON
.where({
username: 'fred',
posts__like_count__gt: 5 // query joined table
})
.select();
users.forEach(user => {
let posts = user.joined('posts');
console.log(posts.toJSON()); // log all posts
});
// Deeply-nested joins:
// only get users who have followers that have posts with images from imgur
users = await User.query()
.join('followers__posts__images')
.where({followers__posts__images__url__contains: 'imgur.com'})
.select();
// Access user[0].followers[0].posts[0].images[0] with...
users[0].joined('followers')[0].joined('posts')[0].joined('images')[0];
// Queries are immutable and composable
// Each command creates a new query object from the previous one
let query = User.query();
let query2 = query.where({username__istartswith: 'Rom'});
let query3 = query2.orderBy('username', 'ASC');
let allUsers = await query.select();
let romUsers = await query2.select();
let orderedUsers = await query3.select();
// You can also just query raw SQL!
await Instant.database().query(`SELECT * FROM users`);
```
### Transactions
```javascript
const User = Instant.Model('User');
const Account = Instant.Model('Account');
const txn = Instant.database().createTransaction();
const user = await User.create({email: 'keith@instant.dev'}, txn);
const account = await Account.create({user_id: user.get('id')}, txn);
await txn.commit(); // commit queries to database
// OR...
await txn.rollback(); // if anything went wrong, rollback nullifies the queries
// Can pass transactions to the following Class methods
await Model.find(id, txn);
await Model.findBy(field, value, txn);
await Model.create(data, txn);
await Model.update(id, data, txn);
await Model.updateOrCreateBy(field, data, txn);
await Model.query().count(txn);
await Model.query().first(txn);
await Model.query().select(txn);
await Model.query().update(fields, txn);
// Instance methods
await model.save(txn);
await model.destroy(txn);
await model.destroyCascade(txn);
// Instance Array methods
await modelArray.saveAll(txn);
await modelArray.destroyAll(txn);
await modelArray.destroyCascade(txn);
```
### Input validation
File: `_instant/models/user.mjs`
```javascript
import InstantORM from '@instant.dev/orm';
class User extends InstantORM.Core.Model {
static tableName = 'users';
}
// Validates email and password before .save()
User.validates(
'email',
'must be valid',
v => v && (v + '').match(/.+@.+\.\w+/i)
);
User.validates(
'password',
'must be at least 5 characters in length',
v => v && v.length >= 5
);
export default User;
```
Now validations can be used;
```javascript
const User = Instant.Model('User');
try {
await User.create({email: 'invalid'});
} catch (e) {
// Will catch a validation error
console.log(e.details);
/*
{
"email": ["must be valid"],
"password": ["must be at least 5 characters in length"]
}
*/
}
```
### Relationship verification
File: `_instant/models/user.mjs`
```javascript
import InstantORM from '@instant.dev/orm';
class User extends InstantORM.Core.Model {
static tableName = 'users';
}
// Before saving to the database, asynchronously compare fields to each other
User.verifies(
'phone_number',
'must correspond to country and be valid',
async (phone_number, country) => {
let phoneResult = await someAsyncPhoneValidationAPI(phone_number);
return (phoneResult.valid === true && phoneResult.country === country);
}
);
export default User;
```
Now verifications can be used;
```javascript
const User = Instant.Model('User');
try {
await User.create({phone_number: '+1-416-555-1234', country: 'SE'});
} catch (e) {
// Will catch a validation error
console.log(e.details);
/*
{
"phone_number": ["must correspond to country and be valid"],
}
*/
}
```
### Calculated and hidden fields
File: `_instant/models/user.mjs`
```javascript
import InstantORM from '@instant.dev/orm';
class User extends InstantORM.Core.Model {
static tableName = 'users';
}
User.calculates(
'formatted_name',
(first_name, last_name) => `${first_name} ${last_name}`
);
User.hides('last_name');
export default User;
```
```javascript
const User = Instant.Model('User');
let user = await User.create({first_name: 'Steven', last_name: 'Nevets'});
let name = user.get('formatted_name') // Steven Nevets
let json = user.toJSON();
/*
Last name is hidden from .hides()
{
first_name: 'Steven',
formatted_name: 'Steven Nevets'
}
*/
```
### Lifecycle callbacks
File: `_instant/models/user.mjs`
```javascript
import InstantORM from '@instant.dev/orm';
class User extends InstantORM.Core.Model {
static tableName = 'users';
async beforeSave (txn) {
const NameBan = this.getModel('NameBan');
const nameBans = NameBan.query()
.where({username: this.get('username')})
.limit(1)
.select(txn);
if (nameBans.length) {
throw new Error(`Username "${this.get('username')}" is not allowed`);
}
}
async afterSave (txn) {
// Create an account after the user id is set
// But only when first creating the user
if (this.isCreating()) {
const Account = this.getModel('Account');
await Account.create({user_id: this.get('id')}, txn);
}
}
async beforeDestroy (txn) { /* before we destroy */ }
async afterDestroy (txn) { /* after we destroy */ }
}
export default User;
```
### Migrations
```shell
instant g:migration
```
Can be used to generate migrations like:
```json
{
"id": 20230921192702,
"name": "create_users",
"up": [
[
"createTable",
"users",
[
{
"name": "email",
"type": "string",
"properties": {
"nullable": false,
"unique": true
}
},
{
"name": "password",
"type": "string",
"properties": {
"nullable": false
}
}
]
]
],
"down": [
[
"dropTable",
"users"
]
]
}
```
### Seeding
Reset your database and seed values from `_instant/seed.json`;
```shell
instant db:bootstrap
```
`seed.json` is an Array of seeds. Anything in the same object is seeded
simultaneously and there are no guarantees on order. Otherwise, the seeds are
run in the order provided by the Array.
```json
[
{
"User": [
{"email": "keith@instant.dev"}
]
},
{
"User": [{"email": "scott@instant.dev"}],
"Post": [{"title": "Post by Keith", "user_id": 1}]
}
]
```
### Code Generation
Five types of code generation are supported:
- **Kits**: Generated from `src/kits`, add in complete models,
migrations and automatically adds dependencies
- `instant kit [kitName]`
- **Models**: Generates a new model and associated migration
- `instant g:endpoint`
- **Migrations**: Generates a new migration
- `instant g:migration`
- **Relationships**: Generates a new migration that connect models in a
one-to-one or many-to-many orientation
- `instant g:relationship`
- **Endpoints**: Generates CRUD endpoints for a model from `src/endpoint`
- `instant g:endpoint`
## Kits
Kits provide an easy way to add complex functionality to your `instant.dev` apps
without having to write code from scratch. Currently kits support development
using [Autocode](https://autocode.com/) and [Vercel](https://vercel.com/).
Note that the [Autocode CLI](https://github.com/acode/cli) comes packaged with
its own HTTP wrapper, where `lib .fn.name` will call `/fn/name` on the service
with a POST request. The `-a` option is shorthand for providing an
`Authorization: Bearer` header.
### Kit: auth
```shell
instant kit auth
```
Creates a `User` and `AccessToken` model, as well as corresponding
endpoints.
#### Kit: auth on Autocode
##### POST `users/create`
```shell
lib .users.create \
--email keith@instant.dev \
--password mypass \
--repeat_password=mypass
```
```json
{
"id": 1,
"email": "keith@instant.dev",
"created_at": "2023-09-18T22:46:44.866Z",
"updated_at": "2023-09-18T22:46:44.940Z"
}
```
##### POST `auth`
```shell
lib .auth \
--username keith@instant.dev \
--password=mypass \
--grant_type=password
```
```json
{
"key": "secret_development_XXX",
"ip_address": "::ffff:127.0.0.1",
"user_agent": "curl/7.79.1",
"expires_at": "2023-10-18T22:53:36.967Z",
"is_valid": true,
"created_at": "2023-09-18T22:53:36.967Z",
"updated_at": "2023-09-18T22:53:36.967Z",
}
```
##### GET `users/me`
```shell
lib .users.me -a secret_development_XXX
```
```json
{
"id": 1,
"email": "keith@instant.dev",
"created_at": "2023-09-18T22:46:44.866Z",
"updated_at": "2023-09-18T22:46:44.940Z"
}
```
##### GET `users`
```shell
lib .users -a secret_development_XXX
```
```json
[
{
"id": 1,
"email": "keith@instant.dev",
"created_at": "2023-09-18T22:46:44.866Z",
"updated_at": "2023-09-18T22:46:44.940Z"
}
]
```
#### Kit: auth on Vercel
##### POST `api/users`
```shell
curl localhost:3000/api/users --data \
"email=keith@instant.dev&password=mypass&repeat_password=mypass"
```
```json
{
"id": 1,
"email": "keith@instant.dev",
"created_at": "2023-09-18T22:46:44.866Z",
"updated_at": "2023-09-18T22:46:44.940Z"
}
```
##### POST `api/auth`
```shell
curl localhost:3000/api/auth --data \
"username=keith@instant.dev&password=mypass&grant_type=password"
```
```json
{
"key": "secret_development_XXX",
"ip_address": "::ffff:127.0.0.1",
"user_agent": "curl/7.79.1",
"expires_at": "2023-10-18T22:53:36.967Z",
"is_valid": true,
"created_at": "2023-09-18T22:53:36.967Z",
"updated_at": "2023-09-18T22:53:36.967Z",
}
```
##### GET `api/users/me`
```shell
curl localhost:3000/api/users/me \
-H "Authorization: Bearer secret_development_XXX"
```
```json
{
"id": 1,
"email": "keith@instant.dev",
"created_at": "2023-09-18T22:46:44.866Z",
"updated_at": "2023-09-18T22:46:44.940Z"
}
```
##### GET `api/users`
```shell
curl localhost:3000/api/users \
-H "Authorization: Bearer secret_development_XXX"
```
```json
[
{
"id": 1,
"email": "keith@instant.dev",
"created_at": "2023-09-18T22:46:44.866Z",
"updated_at": "2023-09-18T22:46:44.940Z"
}
]
```
# Acknowledgements
Special thank you to [Scott Gamble](https://x.com/threesided) who helps run all of the front-of-house work for instant.dev 💜!
| Destination | Link |
| ----------- | ---- |
| Home | [instant.dev](https://instant.dev) |
| GitHub | [github.com/instant-dev](https://github.com/instant-dev) |
| Discord | [discord.gg/puVYgA7ZMh](https://discord.gg/puVYgA7ZMh) |
| X / instant.dev | [x.com/instantdevs](https://x.com/instantdevs) |
| X / Keith Horwood | [x.com/keithwhor](https://x.com/keithwhor) |
| X / Scott Gamble | [x.com/threesided](https://x.com/threesided) |
| JavaScript API framework with ORM, migrations and vectors | bun,nodejs,orm,postgres,postgresql,javascript,deno,migrations,api | 2023-09-15T00:15:07Z | 2024-05-06T05:29:32Z | null | 1 | 0 | 243 | 0 | 5 | 261 | null | MIT | JavaScript |
panoratech/Panora | main | <div align="center">
<h1> Panora </h1>
<p> Open-Source Unified API </p>
</div>
<div align="center">
</br>
<img alt="Discord" src="https://img.shields.io/discord/1038131193067077642"></img>
<img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/panoratech/panora?logo=github"> </img>
<img alt="GitHub License" src="https://img.shields.io/github/license/panoratech/Panora"></img>
<img alt="X (formerly Twitter) Follow" src="https://img.shields.io/twitter/follow/panoradotdev"></img>
<img src="https://snyk.io/test/github/panoratech/Panora/badge.svg" alt="Known Vulnerabilities"></img>
</br>
<p>
<a href="https://panora.dev">Website 🌎</a> - <a href="https://docs.panora.dev">Documentation 📖</a> - <a href="https://status.panora.dev">Status 🟢</a>
</p>
</div>
### Have you met anyone who loves developing integrations? *No.* That’s why we designed an easy developer experience that you’ll enjoy
- **Simple developer experience:** easy to self-host, uses industry-standard data models, and is extensible
- **Builder-friendly terms:** Panora is open-source, and offers generous tips for contributors
### More than a devtool: Panora helps you put your product at the core of your customer's daily workflows
Your customers expect all of their tools to work well together. Panora avoids your team spending hundreds of hours building and maintaining integrations instead of your core product.
# ✨ Core Features
| |
|---------------------------|
| **Magic Links:** Let your users grant you access to their data. Without writing code. |
| **Custom Fields:** Reflect in Panora the specific data points that matter to your users |
| **Passthrough Requests:** Interact with other software platforms in their native format. |
| **Webhooks:** Listen to one webhook to receive normalized data from various software platforms |
# ✨ Integrations Catalog
Panora supports integration with the following objects across multiple platforms:
### CRM
| | Contacts | Deals | Notes | Engagements | Tasks | Users | Companies |
|-----------------------------------------------|:--------:|:-----:|:-----:|:-----------:|:-----:|:-----:|:---------:|
| Hubspot | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | |
| Pipedrive | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | |
| Zoho CRM | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | |
| Zendesk Sell | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | |
| Attio | ✔️ | | | | | | ✔️ |
### Ticketing
| | Tickets | Comments | Users | Contacts | Accounts | Tags | Teams | Collections |
|-------------|:----------:|:-------:|:-------:|:------------:|:-------:|:-------:|:------:|:-------------:|
| Zendesk | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | |
| Front | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | |
| Jira | ✔ | ✔ | ✔ | | | ✔ | ✔ | ✔ |
| Gorgias | ✔ | ✔ | ✔ | ✔ | | ✔ | ✔ | |
Your favourite software is missing? [Ask the community to build a connector!](https://github.com/panoratech/Panora/issues/new)
# 🕹️ Try the Open-Source version
- Prerequisite: You should have Git and Docker installed
1. Get the code
```
git clone https://github.com/panoratech/Panora.git
```
2. Go to Panora folder
```
cd Panora && cp .env.example .env
```
3. Start
```
docker compose up
```
Visit our [Quickstart Guide](https://docs.panora.dev/quick-start) to start adding integrations to your product
# 🤔 Questions? Ask the core team
<a href="https://cal.com/rflih/30?utm_source=github&utm_campaign=readme"><img alt="Book us with Cal.com" src="https://cal.com/book-with-cal-dark.svg" /></a>
# 🚀 Contributors
<a href="https://github.com/panoratech/Panora/graphs/contributors">
<img src="https://contrib.rocks/image?repo=panoratech/Panora" />
</a>
Want to contribute? Visit our [guide](https://docs.panora.dev/open-source/contributors#setup-your-environnement) or check our detailed integrations guide [here.](https://github.com/panoratech/Panora/blob/main/INTEGRATIONS.md)
Our [guidelines.](https://github.com/panoratech/Panora/blob/main/CONTRIBUTING.md)
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=3be49a98-8805-45ca-bd15-99f5321ec235" />
| An API to add an integration catalog to your SaaS product in minutes | Fully Open-Source. 100% TypeScript, extensible and developer-first | api,crm,javascript,monorepo,nestjs,postgresql,prisma,react,typescript,unified-api | 2023-09-23T21:33:39Z | 2024-05-23T11:56:57Z | 2024-05-02T00:36:34Z | 7 | 319 | 1,332 | 29 | 26 | 259 | null | Apache-2.0 | TypeScript |
DogeNetwork/v4 | main | # Doge Unblocker V4
Doge Unblocker is a lightning-fast web proxy designed for performance and stealth. We are **by far** the best proxy, offering speeds and features unbeatable by any other proxies.
## Key Features:
- Advanced Tab Cloaking
- Advanced About:Blank Cloaking
- Hiding site from browser history
- Clickoff Cloaking
- Automatic URL Cloaking
- Customizable/Personalization features
- Access settings easily (right-click)
- Inspect Element
- URL Bar
- Extremely clean UI
- Powerful & fast web proxy
- A large selection of Apps & Games
- Many more
## Current Developers:
- [Derpman](https://github.com/DerpmanDev)
- [KDust7](https://github.com/KDust7)
## Deployment
[](https://railway.app/template/h7StcI?referralCode=u82tqg)
<a href="https://render.com/deploy?repo=https://github.com/dogenetwork/doge-unblocker">
<img src="https://raw.githubusercontent.com/BinBashBanana/deploy-buttons/main/buttons/remade/render.svg"></img></a>
<a href="https://app.cyclic.sh/api/app/deploy/dogenetwork/v4">
<img src="https://camo.githubusercontent.com/607221ca4be547dd929fca7c997a93dfaf1f7b06a1baacaf25b44cf5405c9f91/68747470733a2f2f62696e6261736862616e616e612e6769746875622e696f2f6465706c6f792d627574746f6e732f627574746f6e732f72656d6164652f6379636c69632e737667"></img></a>
[](https://vercel.com/new/clone?repositoryurl=https://github.com/dogenetwork/v4)
[](https://app.koyeb.com/deploy?type=git&repository=github.com/dogenetwork/v4)
### Discord
[](https://discord.gg/sWPHCdxCPU)
| Doge Unblocker is the #1 site unblocker, by far the best in speed and customization. (Please star this repo if you fork) | bypass,css,dockerfile,free,games,hacks,html,javascript,nodejs,proxy | 2023-09-21T01:05:49Z | 2024-05-20T01:10:29Z | null | 5 | 15 | 117 | 4 | 1,918 | 249 | null | GPL-3.0 | JavaScript |
instant-dev/api | main | # Instant API
# Build type-safe web APIs with JavaScript, instantly
## Spec generation and LLM streaming
**Instant API** is a framework for building APIs with JavaScript that implements
**type-safety at the HTTP interface**. By doing so, it eliminates the need for
schema validation libraries entirely. Simply write a JSDoc-compliant comment
block for a function that represents your API endpoint and stop worrying about
validation, sanitization and testing for user input. The OpenAPI specification
for your API is then automatically generated in both JSON and YAML at
`localhost:8000/.well-known/openapi.json` and
`localhost:8000/.well-known/openapi.yaml`, respectively.
Additionally, Instant API comes a number of features optimized for integrations
with LLMs and chat bots:
- First class support for Server-Sent Events using `text/event-stream` makes streaming LLM responses easy
- [LLM function calling](https://openai.com/blog/function-calling-and-other-api-updates) can be integrated
easily via JSON schema output at `localhost:8000/.well-known/schema.json`
- Experimental auto-generation of `localhost:8000/.well-known/ai-plugin.json`
- The ability to instantly return `200 OK` responses and execute in the background for Slack, Discord webhooks
You will find Instant API is a very full-featured framework despite being an
early release. It has been in development for six years as the engine behind the
[Autocode](https://autocode.com) serverless platform where it has horizontally scaled
to handle over 100M API requests per day.
## Quick example: Standard API
Here's an example API endpoint built with Instant API. It would be available
at the URL `example.com/v1/weather/current` via HTTP GET. It has length
restrictions on `location`, range restrictions on `coords.lat` and `coords.lng`,
and `tags` is an array of string. The `@returns` definitions ensure that the API
contract with the user is upheld: if the wrong data is returned an error will be
thrown.
File: `/functions/v1/weather/current.mjs`
```javascript
/**
* Retrieve the weather for a specific location
* @param {?string{1..64}} location Search by location
* @param {?object} coords Provide specific latitude and longitude
* @param {number{-90,90}} coords.lat Latitude
* @param {number{-180,180}} coords.lng Longitude
* @param {string[]} tags Nearby locations to include
* @returns {object} weather Your weather result
* @returns {number} weather.temperature Current tmperature of the location
* @returns {string} weather.unit Fahrenheit or Celsius
*/
export async function GET (location = null, coords = null, tags = []) {
if (!location && !coords) {
// Prefixing an error message with a "###:" between 400 and 404
// automatically creates the correct client error:
// BadRequestError, UnauthorizedError, PaymentRequiredError,
// ForbiddenError, NotFoundError
// Otherwise, will throw a RuntimeError with code 420
throw new Error(`400: Must provide either location or coords`);
} else if (location && coords) {
throw new Error(`400: Can not provide both location and coords`);
}
// Fetch your own API data
await getSomeWeatherDataFor(location, coords, tags);
// mock a response
return {
temperature: 89.2
units: `°F`
};
}
```
## Quick example: LLM Streaming
LLM streaming is simple. It relies on a special `context` object and defining
`@stream` parameters to create a `text/event-stream` response. You can think
of `@stream` as similar to `@returns`, where you're specifying the schema
for the output to the user. If this contract is broken, your API will throw an
error. In order to send a stream to the user, we add a special `context` object
to the API footprint as the last parameter and use an exposed `context.stream()`
method.
File: `/functions/v1/ai-helper.mjs`
```javascript
import OpenAI from 'openai';
const openai = new OpenAI(process.env.OPENAI_API_KEY);
/**
* Streams results for our lovable assistant
* @param {string} query The question for our assistant
* @stream {object} chunk
* @stream {string} chunk.id
* @stream {string} chunk.object
* @stream {integer} chunk.created
* @stream {string} chunk.model
* @stream {object[]} chunk.choices
* @stream {integer} chunk.choices[].index
* @stream {object} chunk.choices[].delta
* @stream {?string} chunk.choices[].delta.role
* @stream {?string} chunk.choices[].delta.content
* @returns {object} message
* @returns {string} message.content
*/
export async function GET (query, context) {
const completion = await openai.chat.completions.create({
messages: [
{role: `system`, content: `You are a lovable, cute assistant that uses too many emojis.`},
{role: `user`, content: query}
],
model: `gpt-3.5-turbo`,
stream: true
});
const messages = [];
for await (const chunk of completion) {
// Stream our response as text/event-stream when ?_stream parameter added
context.stream('chunk', chunk); // chunk has the schema provided above
messages.push(chunk?.choices?.[0]?.delta?.content || '');
}
return {content: messages.join('')};
};
```
By default, this method will return something like;
```json
{
"content": "Hey there! 💁♀️ I'm doing great, thank you! 💖✨ How about you? 😊🌈"
}
```
However, if you append `?_stream` to query parameters or `{"_stream": true}` to
body parameters, it will turn into a `text/event-stream` with your `context.stream()`
events sandwiched between a `@begin` and `@response` event. The `@response` event
will be an object containing the details of what the HTTP response would have contained
had the API call been made normally.
```shell
id: 2023-10-25T04:29:59.115000000Z/2e7c7860-4a66-4824-98fa-a7cf71946f19
event: @begin
data: "2023-10-25T04:29:59.115Z"
[... more events ...]
event: chunk
data: {"id":"chatcmpl-8DPoluIgN4TDIuE1usFOKTLPiIUbQ","object":"chat.completion.chunk","created":1698208199,"model":"gpt-3.5-turbo-0613","choices":[{"index":0,"delta":{"content":" 💯"},"finish_reason":null}]}
[... more events ...]
event: @response
data: {"statusCode":200,"headers":{"X-Execution-Uuid":"2e7c7860-4a66-4824-98fa-a7cf71946f19","X-Instant-Api":"true","Access-Control-Allow-Origin":"*","Access-Control-Allow-Methods":"GET, POST, OPTIONS, HEAD, PUT, DELETE","Access-Control-Allow-Headers":"","Access-Control-Expose-Headers":"x-execution-uuid, x-instant-api, access-control-allow-origin, access-control-allow-methods, access-control-allow-headers, x-execution-uuid","Content-Type":"application/json"},"body":"{\"content\":\"Hey there! 🌞 I'm feeling 💯 today! Full of energy and ready to help you out. How about you? How are you doing? 🌈😊\"}"}
```
## Table of Contents
1. [Getting Started](#getting-started)
1. [Quickstart](#quickstart)
1. [Custom installation](#custom-installation)
1. [Endpoints and Type Safety](#endpoints-and-type-safety)
1. [Creating Endpoints](#creating-endpoints)
1. [Responding to HTTP methods](#responding-to-http-methods)
1. [Endpoint lifecycle](#endpoint-lifecycle)
1. [Typing your endpoint](#typing-your-endpoint)
1. [Undocumented parameters](#undocumented-parameters)
1. [Required parameters](#required-parameters)
1. [Optional parameters](#optional-parameters)
1. [`context` object](#context-object)
1. [API endpoints: `functions/` directory](#api-endpoints-functions-directory)
1. [Index routing with `index.mjs`](#index-routing-with-indexmjs)
1. [Subdirectory routing with `404.mjs`](#subdirectory-routing-with-404mjs)
1. [Static files: `www/` directory](#static-files-www-directory)
1. [Index routing with `index.html`](#index-routing-with-indexhtml)
1. [Subdirectory routing with `404.html`](#subdirectory-routing-with-404html)
1. [Type Safety](#type-safety)
1. [Supported types](#supported-types)
1. [Type coercion](#type-coercion)
1. [Combining types](#combining-types)
1. [Enums and restricting to specific values](#enums-and-restricting-to-specific-values)
1. [Sizes (lengths)](#sizes-lengths)
1. [Ranges](#ranges)
1. [Arrays](#arrays)
1. [Object schemas](#object-schemas)
1. [Parameter validation](#parameter-validation)
1. [Query and Body parsing with `application/x-www-form-urlencoded`](#query-and-body-parsing-with-applicationx-www-form-urlencoded)
1. [Query vs. Body parameters](#query-vs-body-parameters)
1. [CORS (Cross-Origin Resource Sharing)](#cors-cross-origin-resource-sharing)
1. [Returning responses](#returning-responses)
1. [`@returns` type safety](#returns-type-safety)
1. [Error responses](#error-responses)
1. [Custom HTTP responses](#custom-http-responses)
1. [Returning files with Buffer responses](#returning-files-with-buffer-responses)
1. [Streaming responses](#streaming-responses)
1. [Debug responses](#debug-responses)
1. [Throwing errors](#throwing-errors)
1. [OpenAPI Specification Generation](#openapi-specification-generation)
1. [OpenAPI Output Example](#openapi-output-example)
1. [JSON Schema Output Example](#json-schema-output-example)
1. [Hiding endpoints with `@private`](#hiding-endpoints-with-private)
1. [Streaming and LLM Support](#streaming-and-llm-support)
1. [`@stream` type safety](#stream-type-safety)
1. [Using `context.stream()`](#using-contextstream)
1. [Using the `_stream` parameter](#using-the-_stream-parameter)
1. [Selectively listening to specific streams](#selectively-listening-to-specific-streams)
1. [Background execution for webhooks and chatbots](#background-execution-for-webhooks-and-chatbots)
1. [`@background` directive](#background-directive)
1. [Using the `_background` parameter](#using-the-_background-parameter)
1. [Background modes](#background-modes)
1. [Debugging](#debugging)
1. [Using `context.log()` and `context.error()`](#using-contextlog-and-contexterror)
1. [Using the `_debug` parameter](#using-the-_debug-parameter)
1. [Built-in Errors](#built-in-errors)
1. [Testing](#testing)
1. [Quickstart for tests](#quickstart-for-tests)
1. [Custom installation for tests](#custom-installation-for-tests)
1. [Writing tests](#writing-tests)
1. [Running tests](#running-tests)
1. [Deployment](#deployment)
1. [via `instant deploy`](#via-instant-deploy)
1. [Custom deployments](#custom-deployments)
1. [More Information](#more-information)
1. [Logging](#logging)
1. [Error monitoring](#error-monitoring)
1. [Middleware](#middleware)
1. [Roadmap and Feedback](#roadmap-and-feedback)
1. [Acknowledgements](#acknowledgements)
## Getting Started
### Quickstart
The quickest way to get started with Instant API is via the
`instant.dev` [command line tools](https://github.com/instant-dev/instant.dev).
It is the easiest way to get your Instant API project set up, generate new endpoints,
manage tests and comes with built-in deployment tooling for Vercel or AWS.
It comes packaged with the [Instant ORM](https://github.com/instant-dev/orm) which
makes setting up a Postgres-based backend a breeze.
```shell
npm i instant.dev -g
cd ~/projects
mkdir my-new-project
cd my-new-project
instant init
```
From there, you can use more advanced features:
```shell
# Create an endpoint (test generated automatically)
instant g:endpoint first_endpoint
# Run your server
instant serve
# Run tests
instant test
# See all available commands
instant help
```
### Custom installation
**Note:** Most of this documentation will assume you are using the
`instant.dev` [command line tool](https://github.com/instant-dev/). It is the
recommended way to get your Instant API project set up, generate new endpoints,
manage tests and comes with built-in deployment tooling for Vercel or AWS.
To use Instant API without the command line tools, you can do the following;
```shell
cd path/to/my/project
npm i @instant.dev/api --save
```
Then add the following to `package.json`:
```json
"scripts": {
"start": "node instant.mjs"
},
```
And copy the following file to `instant.mjs`:
```javascript
// Third-party imports
import InstantAPI from '@instant.dev/api';
// Native imports
import cluster from 'cluster';
import os from 'os';
// Shorthand references
const Daemon = InstantAPI.Daemon;
const Gateway = InstantAPI.Daemon.Gateway;
const EncryptionTools = InstantAPI.EncryptionTools;
// Constants
const ENVIRONMENT = process.env.NODE_ENV || 'development';
const PORT = process.env.PORT || 8000;
if (cluster.isPrimary) {
// Multi-process daemon
const daemon = new Daemon(
ENVIRONMENT !== 'development'
? os.cpus().length
: 1
);
daemon.start(PORT);
} else {
// Individual webserver startup
const gateway = new Gateway({debug: ENVIRONMENT !== 'production'});
gateway.load(process.cwd()); // load routes from filesystem
gateway.listen(PORT); // start server
}
```
To start your server, simply run:
```javascript
npm start
```
## Endpoints and Type Safety
Instant API relies on a Function as a Service model for endpoint execution: every
{Route, HTTP Method} combination is modeled as an exported function. To add parameter
validation a.k.a. type safety to your endpoints, you simply document your exported
functions with a slightly modified JSDoc specification comment block. For example,
the simplest endpoint possible would look like this;
File: `functions/index.js`
```javascript
export default async function () {
return `hello world`;
}
```
And you could execute it with;
```shell
curl localhost:8000/
> "hello world"
```
Assuming you are running `instant serve` or `npm start` on port `8000`. See
[Getting started](#getting-started) for more details on starting your server.
### Creating endpoints
The easiest way to create endpoints for Instant API is via the `instant.dev`
[command line tools](https://github.com/instant-dev/instant). Once your project
has been initialized, you can write:
```shell
instant g:endpoint path/to/endpoint
```
And voila! A new blank endpoint has been created at `/functions/path/to/endpoint/index.mjs`.
If you want to create an endpoint manually, just create a new `.mjs` file in the `functions/`
directory and make sure it outputs a function corresponding to at least one HTTP method:
`GET`, `POST`, `PUT` or `DELETE`.
### Responding to HTTP methods
In the example above, we used `export default` to export a default function.
This function will respond to to all `GET`, `POST`, `PUT` and `DELETE` requests
with the same function. Alternatively, we can export functions for each method individually,
like so:
File: `functions/index.js`
```javascript
export async function GET () {
return `this was a GET request!`;
}
export async function POST () {
return `this was a POST request!`;
}
```
Any method not specified in this manner will automatically return an HTTP 501 error
(Not Implemented). You can test these endpoints like so;
```shell
curl -X GET localhost:8000/
> "this was a GET request!"
curl -X POST localhost:8000/
> "this was a POST request!"
curl -X PUT localhost:8000/
> {"error":...} # Returns NotImplementedError (501)
```
**Note:** Method names are **case sensitive**, they **must** be uppercase.
Instant API will throw an error if the exports aren't read properly.
#### Endpoint lifecycle
When endpoint files, like `functions/index.js` above, are accessed they
are imported **only once per process**. Code outside of `export` statements
is executed lazily the first time the function is executed. By default,
in a production server environment, Instant API will start one process per virtual core.
Each exported function will be executed every time it is called. For the most part,
you should only use the area external to your `export` statements for critical library
imports and frequently accessed object caching; **not for data persistence**.
Here's an example using [Instant ORM](https://github.com/instant-dev/orm):
```javascript
// DO THIS: Cache connections and commonly used objects, constructors
// Executed only once per process: lazily on first execution
import InstantORM from '@instant.dev/orm';
const Instant = await InstantORM.connectToPool(); // connect to postgres
const User = Instant.Model('User'); // access User model
/**
* Find all users matching a provided username
* @param {string} searchQuery Username portion to search for
* @returns {object[]} users
*/
export async function GET (searchQuery) {
// Executed each time endpoint called
return await User.query()
.where({username__icontains: searchQuery})
.select();
}
```
Here's an example of what you should **not** do:
```javascript
// DO NOT DO THIS: data persistence not reliable in production workloads
// Could be on a multi-core server or serverless deployment e.g. Vercel
let pageViews = 0;
/**
* Track views -- poorly. Persistence unreliable!
*/
export async function GET () {
return `This page has been viewed ${++pageViews} times`;
}
```
#### Typing your endpoint
Endpoints can be typed using a slightly modified JSDoc specification that is
easily interpreted and syntax highlighted by most modern code editors. You
type your endpoint by (1) providing a comment block immediately preceding
your exported function and / or (2) providing default values for your
exported function.
**Note:** Parameter documentation for typing is an all-or-none affair.
Instant API will refuse to start up if documented endpoints do not match the
function signature.
##### Undocumented parameters
By default, if you do not document your parameters **at all**, they will
be assumed to be type `any` and all be required. If you provided default
values, the parameters will be optional but will assume the type of their
default value.
```javascript
export async function GET (name, age = 25) {
return `hello ${name} you are ${age}`;
}
```
In this case, `name` is **required** by can take on any type. `age` is **optional**
but must be a `number`.
```shell
curl -X GET localhost:8000/
> {"error":...} # Returns ParameterError (400) -- name is required
curl -X GET localhost:8000/?name=world
> "hello world you are 25"
curl -X GET 'localhost:8000/?name=world&age=lol'
> {"error":...} # Returns ParameterError (400) -- age should be a number
curl -X GET 'localhost:8000/?name=world&age=99'
> "hello world you are 99"
```
##### Required parameters
A parameter is **required** if you **do not provide a default value** in the function
signature. For example;
```javascript
/**
* @param {string} name
*/
export async function GET (name) {
return `hello ${name}`;
}
```
Will return a `ParameterError` with status code `400` indicating the `name`
parameter is required if no `name` is passed in to the endpoint.
```shell
curl -X GET localhost:8000/
> {"error":...} # Returns ParameterError (400)
curl -X GET localhost:8000/?name=world
> "hello world"
```
##### Optional parameters
A parameter is **optional** if you:
- prefix the type with a `?`
- AND / OR provide a default value in the function signature
If you prefix the type with `?`, the default value is assumed to be `null`.
You **can not** use `undefined` as an acceptable endpoint parameter value.
For example;
```javascript
/**
* @param {?string} name
* @param {number} age
*/
export async function GET (name, age = 4.2e9) {
return `hello ${name}, you are ${age}`;
}
```
Even though `name` was not provided in the function signature, the `?` in
`{?string}` indicates that this parameter is optional. It will be given a
default value of `null`. When included in a template string, null will be
printed as the string `"null"`.
```shell
curl -X GET localhost:8000/
> "hello null, you are 4200000000"
curl -X GET localhost:8000/?name=world
> "hello world, you are 4200000000"
curl -X GET 'localhost:8000/?name=world&age=101'
> "hello world, you are 101"
```
#### `context` object
The `context` object is a "magic" parameter that can be appended to any
function signature. It **can not** be documented and you **can not**
use "context" as a parameter name. The other magic parameters are
`_stream` ([Streaming and LLM support](#streaming-and-llm-support)),
`_debug` ([Debug](#debugging)) and `_background`. However, only
`context` can be added to your function signature.
You can use `context` to access execution-specific information like so;
```javascript
export async function GET (context) {
console.log(context.http.method); // "GET"
console.log(context.http.body); // Request body (utf8)
console.log(context.remoteAddress); // IP address
return context; // ... and much more
}
```
It also comes with a `context.stream()` function which you can read about
in [Streaming and LLM support](#streaming-and-llm-support).
A full list of available properties is as follows;
```javascript
{
"name": "endpoint_name",
"alias": "request_pathname",
"path": ["request_pathname", "split", "by", "/"],
"params": {"jsonified": "params", "passed": "via_query_and_body"},
"remoteAddress": "ipv4_or_v6_address",
"uuid": "request_uuid",
"http": {
"url": "request_url",
"method": "request_method",
"headers": {"request": "headers"},
"body": "request_body_utf8",
"json": "request_body_json_if_applicable_else_null",
},
"stream": function stream (name, value) { /* ... */ }
}
```
#### API endpoints: `functions/` directory
By default, anything in the root `functions/` directory of an Instant API
project is exported as an API endpoint. All `.js`, `.cjs` and `.mjs` files
are valid. We have not covered CommonJS-styled exports here as they are supported
for legacy purposes and not recommended for forward-facing development.
Routing is handled by mapping the pathname of an HTTP request to the internal file
pathname of the function, not including `functions/` or the file extension. For example,
an HTTP request to `/v1/hello-world` will trigger `functions/v1/hello-world.js`.
There are four "magic" filenames that can be used to handle indices or subdirectories.
`index.mjs` / `__main__.mjs` will act as a handler for the root directory and
`404.mjs` / `__notfound__.mjs` will act as a handler for any subdirectory or file
that is not otherwise defined.
##### Index routing with `index.mjs`
Alias: `__main__.mjs`
Handler for the root directory. For example,
`functions/v1/stuff/index.mjs` is accessible via `/v1/stuff`.
##### Subdirectory routing with `404.mjs`
Alias: `__notfound__.mjs`
Handler for subdirectories not otherwise defined. For example, with the following
directory structure:
```yaml
- functions/
- v1/
- stuff/
- 404.mjs
- abc.mjs
```
The following HTTP request pathnames would map to these endpoints;
- `/v1/stuff` -> `functions/v1/stuff/404.mjs`
- `/v1/stuff/abc` -> `functions/v1/stuff/abc.mjs`
- `/v1/stuff/abcd` -> `functions/v1/stuff/404.mjs`
- `/v1/stuff/abc/def` -> `functions/v1/stuff/404.mjs`
You can use this behavior to define custom routing schemes. If you want
custom 404 error pages we recommend using [Subdirectory routing with `404.html`](#subdirectory-routing-with-404html) instead.
#### Static files: `www/` directory
Instant API comes with built-in static file hosting support. Instead
of putting files in the `functions/` directory, put any file you want
in the `www/` directory to automatically have it hosted as a standalone static
file.
The rules for static hosting are as follows;
- The server root `/` maps directly to `www/`
- e.g. `/image.png` -> `www/image.png`
- All `.htm` and `.html` files will be available with AND without suffixes
- `/hello` -> `www/hello.html`
- `/hello.html` -> `www/hello.html`
- API and static routes **can not** conflict
- `functions/wat.mjs` would overlap with `www/wat.htm` and is **not** allowed
There are four "magic" filenames that can be used to handle indices or subdirectories.
`index.html` / `index.htm` will act as a handler for the root directory and
`404.html` / `404.htm` will act as a handler for any subdirectory or file
that is not otherwise defined.
##### Index routing with `index.html`
Alias: `index.htm`
Same behavior as `index.js` for API routes. Handler for the root pathname.
##### Subdirectory routing with `404.html`
Alias: `404.htm`
Same behavior as `404.js` for API routes. Handler for subdirectories that are
not otherwise defined. Ideal use case is for custom 404 error pages.
### Type Safety
Types are applied to parameter and schema validation based upon the comment block
preceding your exported endpoint function.
```javascript
/**
* My GET endpoint
* @param {any} myparam
*/
export async function GET (myparam) {
// do something with myparam
}
```
#### Supported types
| Type | Definition | Example Parameter Input Values (JSON) |
| ---- | ---------- | -------------- |
| boolean | True or False | `true` or `false` |
| string | Basic text or character strings | `"hello"`, `"GOODBYE!"` |
| number | Any double-precision [Floating Point](https://en.wikipedia.org/wiki/IEEE_floating_point) value | `2e+100`, `1.02`, `-5` |
| float | Alias for `number` | `2e+100`, `1.02`, `-5` |
| integer | Subset of `number`, integers between `-2^53 + 1` and `+2^53 - 1` (inclusive) | `0`, `-5`, `2000` |
| object | Any JSON-serializable Object | `{}`, `{"a":true}`, `{"hello":["world"]}` |
| object.http | An object representing an HTTP Response. Accepts `headers`, `body` and `statusCode` keys | `{"body": "Hello World"}`, `{"statusCode": 404, "body": "not found"}`, `{"headers": {"Content-Type": "image/png"}, "body": Buffer.from(...)}` |
| array | Any JSON-serializable Array | `[]`, `[1, 2, 3]`, `[{"a":true}, null, 5]` |
| buffer | Raw binary octet (byte) data representing a file. | `{"_bytes": [8, 255]}` or `{"_base64": "d2h5IGRpZCB5b3UgcGFyc2UgdGhpcz8/"}` |
| any | Any value mentioned above | `5`, `"hello"`, `[]` |
#### Type coercion
The `buffer` type will automatically be converted to a `Buffer` from any `object` with a
**single key-value pair matching the footprints** `{"_bytes": []}` or `{"_base64": ""}`.
Otherwise, parameters provided to a function are expected to match their
defined types. Requests made over HTTP GET via query parameters or POST data
with type `application/x-www-form-urlencoded` will be automatically
converted from strings to their respective expected types, when possible.
Once converted, all types will undergo a final type validation. For example, passing
a JSON `array` like `["one", "two"]` to a parameter that expects an `object` will convert
from string to JSON successfully but fail the `object` type check.
| Type | Conversion Rule |
| ---- | --------------- |
| boolean | `"t"` and `"true"` become `true`, `"f"` and `"false"` become `false`, otherwise will be kept as string |
| string | No conversion: already a string |
| number | Determine float value, if NaN keep as string, otherwise convert |
| float | Determine float value, if NaN keep as string, otherwise convert |
| integer | Determine float value, if NaN keep as string, otherwise convert: may fail integer check |
| object | Parse as JSON, if invalid keep as string, otherwise convert: may fail object check |
| object.http | Parse as JSON, if invalid keep as string, otherwise convert: may fail object.http check |
| array | Parse as JSON, if invalid keep as string, otherwise convert: may fail array check |
| buffer | Parse as JSON, if invalid keep as string, otherwise convert: may fail buffer check |
| any | No conversion: keep as string |
#### Combining types
You can combine types using the pipe `|` operator. For example;
```javascript
/**
* @param {string|integer} myparam String or an integer
*/
export async function GET (myparam) {
// do something
}
```
Will accept a `string` or an `integer`. Types defined this way will validate against
the provided types in order of appearance. In this case, since it is a GET request and
all parameters are passed in as strings via query parameters, `myparam` will **always**
be received a string because it will successfully pass the string type coercion and
validation first.
However, if you use a POST request:
```javascript
/**
* @param {string|integer} myparam String or an integer
*/
export async function POST (myparam) {
// do something
}
```
Then you can pass in `{"myparam": "1"}` or `{"myparam": 1}` via the body which would both
pass type validation.
You can combine as many types as you'd like:
```javascript
@param {string|buffer|array|integer}
```
Including `any` in your list will, as expected, override any other type specifications.
#### Enums and restricting to specific values
Similar to combining types, you can also include specific JSON values in your type definitions:
```javascript
/**
* @param {"one"|"two"|"three"|4} myparam String or an integer
*/
export async function GET (myparam) {
// do something
}
```
This allows you to restrict possible inputs to a list of allowed values. In the case above,
sending `?myparam=4` via HTTP GET **will** successfully parse to `4` (`Number`), because it
will fail validation against the three string options.
You can combine specific values and types in your definitions freely:
```javascript
@param {"one"|"two"|integer}
```
Just note that certain combinations will invalidate other list items. Like `{1|2|integer}` will
accept any valid integer.
#### Sizes (lengths)
The types `string`, `array` and `buffer` support sizes (lengths) via the `{a..b}` modifier on the type.
For example;
```javascript
@param {string{..9}} alpha
@param {string{2..6}} beta
@param {string{5..}} gamma
```
Would expect `alpha` to have a maximum length of `9`, `beta` to have a minimum length of
`2` but a maximum length of `6`, and `gamma` to have a minimum length of `5`.
#### Ranges
The types `number`, `float` and `integer` support ranges via the `{a,b}` modifier on the type.
For example;
```javascript
@param {number{,1.2e9}} alpha
@param {number{-10,10}} beta
@param {number{0.870,}} gamma
```
Would expect `alpha` to have a maximum value of `1 200 000 000`, `beta` to have a minimum value of
`-10` but a maximum value of `10`, and `gamma` to have a minimum value of `0.87`.
#### Arrays
Arrays are supported via the `array` type. You can optionally specify a schema for the array
which applies to **every element in the array**. There are two formats for specifying array
schemas, you can pick which works best for you:
```javascript
@param {string[]} arrayOfStrings1
@param {array<string>} arrayOfStrings2
```
For multi-dimensional arrays, you can use nesting:
```javascript
@param {integer[][]} array2d
@param {array<array<integer>>} array2d_too
```
**Please note**: Combining types are not currently available in array schemas. Open up an
issue and let us know if you'd like them and what your use case is! In the meantime;
```javascript
@param {integer[]|string[]}
```
Would successfully define an array of integers or an array of strings.
#### Object schemas
To define object schemas, use the subsequent lines of the schema after your initial object
definition to define individual properties. For example, the object
`{"a": 1, "b": "two", "c": {"d": true, "e": []}` Could be defined like so:
```javascript
@param {object} myObject
@param {integer} myObject.a
@param {string} myObject.b
@param {object} myObject.c
@param {boolean} myObject.c.d
@param {array} myObject.c.e
```
To define object schemas that are members of arrays, you must identify the array component in the
property name with `[]`. For example:
```javascript
@param {object[]} topLevelArray
@param {integer} topLevelArray[].value
@param {object} myObject
@param {object[]} myObject.subArray
@param {string} myObject.subArray[].name
```
### Parameter validation
Parameter validation occurs based on types as defined per [Type Safety](#type-safety).
The process for parameter validation takes the following steps:
1. Read parameters from the HTTP query string as type `application/x-www-form-urlencoded`
1. If applicable, read parameters from the HTTP body based on the request `Content-Type`
- Supported content types:
- `application/json`
- `application/x-www-formurlencoded`
- `multipart/form-data`
- `application/xml`, `application/atom+xml`, `text/xml`
1. Query parameters **can not** conflict with body parameters, throw an error if they do
1. Perform type coercion on `application/x-www-form-urlencoded` inputs (query and body, if applicable)
1. Validate parameters against their expected types, throw an error if they do not match
During this process, you can encounter a `ParameterParseError` or a `ParameterError` both with
status code `400`. `ParameterParseError` means your parameters could not be parsed based on
the expected or provided content type, and `ParameterError` is a validation error against the
schema for your endpoint.
#### Query and Body parsing with `application/x-www-form-urlencoded`
Many different standards have been implemented and adopted over the years for
HTTP query parameters and how they can be used to specify objects and arrays.
To make things easy, Instant API supports all common query parameter parsing formats.
Here are some query parameter examples of parsing form-urlencoded data:
- Arrays
- Duplicates: `?arr=1&arr=2` becomes `[1, 2]`
- Array syntax: `?arr[]=1&arr[]=2` becomes `[1, 2]`
- Index syntax: `?arr[0]=1&arr[2]=3` becomes `[1, null, 3]`
- JSON syntax: `?arr=[1,2]` becomes `[1, 2]`
- Objects
- Bracket syntax: `?obj[a]=1&obj[b]=2` becomes `{"a": 1, "b": 2}`
- Dot syntax: `?obj.a=1&obj.b=2` becomes `{"a": 1, "b": 2}`
- Nesting: `?obj.a.b.c.d=t` becomes `{"a": {"b": {"c": {"d": true}}}}`
- JSON syntax: `?obj={"a":1,"b":2}` becomes `{"a": 1, "b": 2}`
#### Query vs. Body parameters
With Instant API, **query and body parameters can be used interchangeably**.
The general expectation is that `POST` and `PUT` endpoints should typically
only interface with the content body, but API consumers should be able to freely
manipulate query parameters if they want to play around.
For example, the endpoint defined by:
```javascript
/**
* Hello world endpoint
* @param {string} name
* @param {number} age
*/
export async function POST (name, age) {
return `hello ${name}, you are ${age}!`;
}
```
Could be triggered successfull via;
```shell
curl -X POST 'localhost:8000/hello-world?name=world&age=99'
curl -X POST 'localhost:8000/hello-world?name=world' --data '{"age":99}'
curl -X POST 'localhost:8000/hello-world' --data '{"name":"world","age":99}'
```
Generally speaking, our motivation for this pattern comes from two observations;
1. In decades of software development we have never seen a legitimate use case for
query parameters and body parameters with the same name on a single endpoint
2. Exposing APIs this way is a lot easier for end users to play with
To prevent unexpected errors, naming collisions will throw an error at the gateway layer,
before your endpoint is executed.
### CORS (Cross-Origin Resource Sharing)
By default, all endpoints have a **completely open** CORS policy, they all return
the header `Access-Control-Allow-Origin: *`.
To restrict endpoints to specific URLs use the `@origin` directive. You can add
as many of these as you'd like.
```javascript
/**
* My CORS-restricted endpoint
* @origin staging.my-website.com
* @origin http://localhost:8000
* @origin https://my-website.com
* @origin =process.env.ALLOWED_ORIGIN
* @origin =process.env.ANOTHER_ALLOWED_ORIGIN
* @param {number} age
*/
export async function POST (name, age) {
return `hello ${name}, you are ${age}!`;
}
```
The CORS `Access-Control-Allow-Origin` policy will be set like so;
- If no protocol is specified, allow all traffic from the URL
- If port is specified, only allow traffic from the URL on the specified port
- If `http://` is specified, only allow `http` protocol traffic from the URL
- If `https://` is specified, only allow `https` protocol traffic from the URL
- If origin starts with `=process.env.`, it will rely on the specified environment variable
Note that `=process.env.ENV_NAME` entries will be loaded at startup time. Dynamically
changing `process.env` afterwards will have no effect on your allowed origins.
### Returning responses
Returning API responses from your endpoint is easy. Just add a `return` statement
with whatever data you would like to return.
```javascript
export async function GET () {
return `hello world`; // works as expected
}
```
By default, all responses will be `JSON.stringify()`-ed and returned with the
`Content-Type` header set to `application/json`.
```shell
curl localhost:8000/hello-world
> "hello world"
```
There are two exceptions: returning an `object.http` object
(containing `statusCode`, `headers`, and `body`) allows you to provide a
[Custom HTTP response](#custom-http-responses) and returning a `Buffer`, which are
treated as [raw binary (file) data](#returning-files-with-buffer-responses).
#### `@returns` type safety
Similar to [Parameter validation](#parameter-validation), you can enforce a type
schema on the return value of your endpoint like so;
```javascript
/**
* @returns {object} message
* @returns {string} message.content
*/
export async function GET () {
return {message: `hello world`};
}
```
The difference between `@returns` type safety as compared to `@param` validation
is that this type safety mechanism is run **after** your code has been executed.
If you fail a `@returns` type safety check, the user receives a `ValueError` with
status code `502`: a server error. The function may have executed successfully
but the value does not fulfill the promised API contract. This functionality exists
to ensure users can trust the type contract of your API. To avoid production snafus,
we recommend [writing tests](#writing-tests) to validate that your endpoints
return the values you expect them to.
#### Error responses
Any uncaught promises or thrown errors will result in a `RuntimeError` with a status
code of `420` (unknown) by default. To customize error codes, check out
[Throwing Errors](#throwing-errors).
#### Custom HTTP responses
To return a custom HTTP response, simply return an object with one or all of the following
keys: `statusCode` (integer), `headers` (object) and `body` (Buffer). You can specify
this in the `@returns` schema, however Instant API will automatically detect the type.
```javascript
/**
* I'm a teapot
*/
export async function GET () {
return {
statusCode: 418,
headers: {'Content-Type', 'text/plain'},
body: Buffer.from(`I'm a teapot!`)
};
}
```
#### Returning files with Buffer responses
If you would like to return a raw file from the file system, compose binary data into a
downloadable file, or dynamically generate an image (e.g. with Dall-E or Stable Diffusion)
you can build a custom HTTP response as per above - but Instant API makes it a little easier
than that.
If you return a `Buffer` object you can optionally specify a `contentType` to set the
`Content-Type` http header like so:
```javascript
import fs from 'fs';
/**
* Return an image from the filesystem to be displayed
*/
export async function GET () {
const buffer = fs.readFileSync('./path/to/image.png');
buffer.contentType = 'image/png';
return buffer;
}
```
#### Streaming responses
Instant API has first-class support for streaming using the `text/event-stream`
content type and the "magic" `_stream` parameter.
You can read more in [Streaming and LLM support](#streaming-and-llm-support).
#### Debug responses
In `development` environments, e.g. when `process.env.NODE_ENV=development`, you
can stream the results of any function using the "magic" `_debug` parameter.
This allows you to monitor function execution in the browser for long-running jobs.
You can read more in [Debugging](#debugging).
### Throwing Errors
Whenever a `throw` statement is executed or a Promise is uncaught within the context
of an Instant API endpoint, the default behavior is to return a `RuntimeError` with
a status code of `420`: your browser will refer to this as "unknown", we think of it
as "confused".
To specify a specific error code between 400 and 404, simply throw an error prefixed
with the code and a colon like so:
```javascript
/**
* Errors out
*/
export async function GET () {
throw new Error(`400: No good!`);
}
```
When you execute this function you would see a `BadRequestError` with a status code of `400`:
```json
{
"error": {
"type": "BadRequestError",
"message": "No good!"
}
}
```
The following error codes will automatically map to error types:
- 400: `BadRequestError`
- 401: `UnauthorizedError`
- 402: `PaymentRequiredError`
- 403: `ForbiddenError`
- 404: `NotFoundError`
## OpenAPI Specification Generation
OpenAPI specifications are extremely helpful for machine-readability but are
extremely verbose. Instant API allows you to manage all your type signatures
and parameter validation via JSDoc in a very terse manner while automatically
generating your OpenAPI specification for you. By default Instant API will
create three schema files based on your API:
- `localhost:8000/.well-known/openapi.json`
- `localhost:8000/.well-known/openapi.yaml`
- `localhost:8000/.well-known/schema.json`
The first two are [OpenAPI schemas](https://www.openapis.org/) and the
final one is a [JSON schema](https://json-schema.org/) which outputs a
`{"functions": [...]}` object. The latter is primarily intended for use
with [OpenAI function calling](https://openai.com/blog/function-calling-and-other-api-updates)
and other LLM integrations.
### OpenAPI Output Example
As a simple example, consider the following endpoint:
```javascript
/**
* Gets a "Hello World" message
* @param {string} name
* @param {number{12,199}} age
* @returns {string} message
*/
export async function GET (name, age) {
return `hello ${name}, you are ${age} and you rock!`
}
/**
* Creates a new hello world message
* @param {object} body
* @param {string} body.content
* @returns {object} result
* @returns {boolean} result.created
*/
export async function POST (body) {
console.log(`Create body ... `, body);
return {created: true};
}
```
Once saved as part of your project, if you open `localhost:8000/.well-known/openapi.yaml`
in your browser, you should receive the following OpenAPI specification:
```yaml
openapi: "3.1.0"
info:
version: "development"
title: "(No name provided)"
description: "(No description provided)"
servers:
- url: "localhost"
description: "Instant API Gateway"
paths:
/hello-world/:
get:
summary: "Gets a \"Hello World\" message"
description: "Gets a \"Hello World\" message"
operationId: "service_localhost_hello_world_get"
parameters:
- in: "query"
name: "name"
schema:
type: "string"
- in: "query"
name: "age"
schema:
type: "number"
minimum: 12
maximum: 199
responses:
200:
content:
application/json:
schema:
type: "string"
post:
summary: "Creates a new hello world message"
description: "Creates a new hello world message"
operationId: "service_localhost_hello_world_post"
requestBody:
content:
application/json:
schema:
type: "object"
properties:
body:
type: "object"
properties:
content:
type: "string"
required:
- "content"
required:
- "body"
responses:
200:
content:
application/json:
schema:
type: "object"
properties:
created:
type: "boolean"
required:
- "created"
```
### JSON Schema Output Example
Using the same endpoint defined above would produce the following JSON schema
at `localhost:8000/.well-known/schema.json`:
```json
{
"functions": [
{
"name": "hello-world_get",
"description": "Gets a \"Hello World\" message",
"route": "/hello-world/",
"url": "localhost/hello-world/",
"method": "GET",
"parameters": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"age": {
"type": "number",
"minimum": 12,
"maximum": 199
}
},
"required": [
"name",
"age"
]
}
},
{
"name": "hello-world",
"description": "Creates a new hello world message",
"route": "/hello-world/",
"url": "localhost/hello-world/",
"method": "POST",
"parameters": {
"type": "object",
"properties": {
"body": {
"type": "object",
"properties": {
"content": {
"type": "string"
}
},
"required": [
"content"
]
}
},
"required": [
"body"
]
}
}
]
}
```
### Hiding endpoints with `@private`
Don't want all of your endpoints exposed to your end users? No problem.
Simply mark an endpoint as `@private`, like so:
```javascript
/**
* My admin function
* @private
*/
export async function POST (context) {
await authenticateAdminUser(context);
doSomethingAdministrative();
return `ok!`;
}
```
This will prevent it from being shown in either your OpenAPI or JSON schema
outputs.
## Streaming and LLM support
Instant API comes with built-in support for streaming
[Server-Sent Events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events)
with the `text/event-stream` content type. This allows you to send
events to a user as they are received, and is ideal for developing
LLM-based APIs.
Streams are typed events that can be sent via a special `context.stream()`
method. They must be defined using the `@stream` directive in the JSDoc
descriptor for your API endpoint. Streams are typed like `@param` and `@returns`,
and these types are enforced: if you choose to `context.stream(name, payload)` the
wrong data format in `payload`, your function will throw an error.
By default, functions **will not stream** even when a `@stream` is defined
and `context.stream()` is called. They will simply accept parameters and output a
returned response. In order to activate streaming, you must pass a `_stream` parameter
in the HTTP query parameters or body content - this will initiate a Server-Sent Event
with content type `text/event-stream`.
An example of a simple custom streaming LLM agent endpoint built with Instant API
is below:
```javascript
import OpenAI from 'openai';
const openai = new OpenAI(process.env.OPENAI_API_KEY);
/**
* Streams results for our lovable assistant
* @param {string} query The question for our assistant
* @stream {object} chunk
* @stream {string} chunk.id
* @stream {string} chunk.object
* @stream {integer} chunk.created
* @stream {string} chunk.model
* @stream {object[]} chunk.choices
* @stream {integer} chunk.choices[].index
* @stream {object} chunk.choices[].delta
* @stream {?string} chunk.choices[].delta.role
* @stream {?string} chunk.choices[].delta.content
* @returns {object} message
* @returns {string} message.content
*/
export async function GET (query, context) {
const completion = await openai.chat.completions.create({
messages: [
{role: `system`, content: `You are a lovable, cute assistant that uses too many emojis.`},
{role: `user`, content: query}
],
model: `gpt-3.5-turbo`,
stream: true
});
const messages = [];
for await (const chunk of completion) {
// Stream our response as text/event-stream when ?_stream parameter added
context.stream('chunk', chunk); // chunk has the schema provided above
messages.push(chunk?.choices?.[0]?.delta?.content || '');
}
return {content: messages.join('')};
};
```
### `@stream` type safety
All `@stream` definitions follow the same [Type Safety](#type-safety) rules
as `@param` and `@returns` directives.
### Using `context.stream()`
To send a streaming response to the client, use `context.stream(name, payload)`
where `name` is the name of the stream and `payload` adheres to the correct
type definition for the stream.
**Note:** You must import `context` properly by adding it as the final parameter
in your function arguments.
### Using the `_stream` parameter
By default, **API endpoints will not stream responses**. You must activate a
Server-Sent event by sending the `_stream` parameter. Provided the endpoint defined
above, here is what you would receive given different URL accession patterns:
```
localhost:8000/assistant?query=how%20are%20you%20today?
```
```json
{
"content": "Hey there! 💁♀️ I'm doing great, thank you! 💖✨ How about you? 😊🌈"
}
```
Appending `_stream` to your query parameters gives you a live stream between a
`@begin` and `@response` event, the latter returning an `object.http` payload
containing the typical expected response for the event:
```
localhost:8000/assistant?query=how%20are%20you%20today?&_stream
```
```shell
id: 2023-10-25T04:29:59.115000000Z/2e7c7860-4a66-4824-98fa-a7cf71946f19
event: @begin
data: "2023-10-25T04:29:59.115Z"
[... more events ...]
event: chunk
data: {"id":"chatcmpl-8DPoluIgN4TDIuE1usFOKTLPiIUbQ","object":"chat.completion.chunk","created":1698208199,"model":"gpt-3.5-turbo-0613","choices":[{"index":0,"delta":{"content":" 💯"},"finish_reason":null}]}
[... more events ...]
event: @response
data: {"statusCode":200,"headers":{"X-Execution-Uuid":"2e7c7860-4a66-4824-98fa-a7cf71946f19","X-Instant-Api":"true","Access-Control-Allow-Origin":"*","Access-Control-Allow-Methods":"GET, POST, OPTIONS, HEAD, PUT, DELETE","Access-Control-Allow-Headers":"","Access-Control-Expose-Headers":"x-execution-uuid, x-instant-api, access-control-allow-origin, access-control-allow-methods, access-control-allow-headers, x-execution-uuid","Content-Type":"application/json"},"body":"{\"content\":\"Hey there! 🌞 I'm feeling 💯 today! Full of energy and ready to help you out. How about you? How are you doing? 🌈😊\"}"}
```
#### Selectively listening to specific streams
If you do not want to listen to all streams, you can send in the `_stream` parameter as an object
with keys-value pairs corresponding to the streams you want to listen for. Anything with a truthy value
will be listened to, and `*` means "all streams".
e.g. `localhost:8000/assistant/?_stream={"chunk":true}` would only listen for a `chunk` stream.
## Background execution for webhooks and chatbots
When you are developing against external webhooks, especially chatbots,
sometimes it is important to immediately return a `200 OK` response to a third
party server to acknowledge receipt of the message. Instant API comes
packaged with a "magic" `_background` parameter which can enable background
execution on specified endpoints: the endpoint will return `200 OK` instantly
and continue processing as normal behind the scenes.
### `@background` directive
To enable background processing for an endpoint, simply add a `@background` directive
to the endpoint's JSDoc comment block:
```javascript
/**
* @background
*/
export async function GET (context) {
const params = context.params; // Get all JSON params sent to endpoint
// pseudocode
await doSomethingThatTakesAwhile();
await sendDiscordMessage();
return {"complete": true};
}
```
### Using the `_background` parameter
Background-enabled functions won't execute as background functions by default, you have to
supply them with the `_background` query or body parameter.
If you execute the above endpoint normally, like `localhost:8000/my-webhook`, you would get;
```json
{"complete": true}
```
However, if you execute using `localhost:8000/my-webhook?_background` you see:
```
initiated "my-webhook#GET" ...
```
That means it's working as expected.
### Background modes
Multiple modes are supported for the `@background` directive: `info`, `empty` and `params`.
- `@background info` is the default and equivalent to `@background`, it will always
return `initiated function_name ...`
- `@background empty` returns a completely empty body
- `@background params` returns all parameters provided to the function
- You can choose to return a subset of params by including them in a space-separated list
- e.g. `@background params name created_at` would only reflect back `{"name": "...", "created_at": "..."}`
if provided
## Debugging
Sometimes, and especially when dealing with LLMs, you find you have long-running
endpoints that can be a pain to debug. Instant API exposes two methods, `context.log()`
and `context.error()` that can be streamed to browser output as a Server-Sent Event
**even if streaming is not enabled on your endpoint**. Debugging is only available
when `NODE_ENV=development`.
Simply append `_debug` to your query parameters (or add it to your request body)
to see `context.log()` and `context.error()` output in real-time.
### Using `context.log()` and `context.error()`
These methods are effectively wrappers for `context.stream('@stdout', payload)` and
`context.stream('@stderr', payload)` - only they don't require streams to be enabled
to use. They'll output as streams with the event types `@stdout` and `@stderr`, respectively,
when the `_debug` parameter is passed in.
### Using the `_debug` parameter
Given the following endpoint:
```javascript
const sleep = t => new Promise(res => setTimeout(() => res(), t));
export async function GET (context) {
context.log(`Started!`);
await sleep(100);
context.error(`Oh no.`);
await sleep(500);
context.log(`OK!`);
return {complete: true};
}
```
Calling it normally would result in:
```
localhost:8000/test-debug
```
```json
{
"complete": true
}
```
But appending `_debug` in a `development` environment...
```
localhost:8000/test-debug?_debug
```
```shell
id: 2023-10-26T00:16:42.732000000Z/cae5a3c8-14df-4222-b762-fa3f16645fe7
event: @begin
data: "2023-10-26T00:16:42.732Z"
id: 2023-10-26T00:16:42.732000001Z/cae5a3c8-14df-4222-b762-fa3f16645fe7
event: @stdout
data: "Started!"
id: 2023-10-26T00:16:42.834000000Z/cae5a3c8-14df-4222-b762-fa3f16645fe7
event: @stderr
data: "Oh no."
id: 2023-10-26T00:16:43.337000000Z/cae5a3c8-14df-4222-b762-fa3f16645fe7
event: @stdout
data: "OK!"
event: @response
data: {"statusCode":200,"headers":{"X-Execution-Uuid":"cae5a3c8-14df-4222-b762-fa3f16645fe7","X-Debug":true,"X-Instant-Api":"true","Access-Control-Allow-Origin":"*","Access-Control-Allow-Methods":"GET, POST, OPTIONS, HEAD, PUT, DELETE","Access-Control-Allow-Headers":"","Access-Control-Expose-Headers":"x-execution-uuid, x-debug, x-instant-api, access-control-allow-origin, access-control-allow-methods, access-control-allow-headers, x-execution-uuid","Content-Type":"application/json"},"body":"{\"complete\":true}"}
```
## Built-in Errors
As you develop with Instant API, you may encounter various error types as you test
the limits and boundariess of the framework. They are typically in the format:
```json
{
"error": {
"type": "NamedError",
"message": "error message",
"stack": "",
"details": {}
}
}
```
Note that `error.stack` will **not** appear when `NODE_ENV=production`.
The `details` object may or may not be present. A list of errors you may encounter
are below:
| Error Type | Description | Details Object |
| ---------- | ----------- | -------------- |
| WellKnownError | Error loading a schema from `/.well-known/` pathname | N/A |
| ClientError | Generic 4xx, usually 400 (Bad Request) | N/A |
| ServerError | Generic 5xx, usually 500 (Internal Server Error) | N/A |
| BadRequestError | Returned when `throw new Error('400: [...]')` is called | N/A |
| UnauthorizedError | Returned when `throw new Error('401: [...]')` is called | N/A |
| PaymentRequiredError | Returned when `throw new Error('402: [...]')` is called | N/A |
| ForbiddenError | Returned when `throw new Error('403: [...]')` is called | N/A |
| NotFoundError | Returned when `throw new Error('404: [...]')` is called | N/A |
| ParameterParseError | Could not parse parameters based on content-type | N/A |
| ParameterError | `@param` validation failed | `{[field]: {message: 'string', invalid: true, mismatch: 'obj.a.b', expected: {type}, actual: {value, type}}}` |
| ValueError | `@returns` validation failed | Same as `ParameterError`, only with `"returns"` as the field |
| StreamParameterError | `@stream` validation failed | Same as `ParameterError`, only with the stream name as the field |
| StreamError | Stream specified with `context.stream()` does not exist | N/A |
| StreamListenerError | Specific stream `name` via `_stream: {name: true}` does not exist | N/A |
| OriginError | Invalid `@origin` specified | N/A |
| DebugError | Could not debug endpoint with `_debug`, usually permission issue | N/A |
| ExecutionModeError | Could not execute with `_stream` or `_background` because they are not enabled | N/A |
| TimeoutError | Endpoint took too long to execute. Configurable on gateway initialization. | N/A |
| FatalError | The gateway had a fatal crash event, status code `500` | N/A |
| RuntimeError | An error was thrown during endpoint execution, status code `420` | N/A |
| InvalidResponseHeaderError | A header specified in an `object.http` return statement was invalid | Object containing invalid headers |
| AccessSourceError | Placeholder: Currently unused, intended for platform gateways. | N/A |
| AccessPermissionError | Placeholder: Currently unused, intended for platform gateways. | N/A |
| AccessAuthError | Placeholder: Currently unused, intended for platform gateways. | N/A |
| AccessSuspendedError | Placeholder: Currently unused, intended for platform gateways. | N/A |
| OwnerSuspendedError | Placeholder: Currently unused, intended for platform gateways. | N/A |
| OwnerPaymentRequiredError | Placeholder: Currently unused, intended for platform gateways. | N/A |
| RateLimitError | Placeholder: Currently unused, intended for platform gateways. | N/A |
| AuthRateLimitError | Placeholder: Currently unused, intended for platform gateways. | N/A |
| UnauthRateLimitError | Placeholder: Currently unused, intended for platform gateways. | N/A |
| SaveError | Placeholder: Currently unused, intended for platform gateways. | N/A |
| MaintenanceError | Placeholder: Currently unused, intended for platform gateways. | N/A |
| UpdateError | Placeholder: Currently unused, intended for platform gateways. | N/A |
| AutoformatError | Placeholder: Currently unused, intended error if formatting on static resources goes awry. | N/A |
## Testing
Instant API comes packaged with a `TestEngine` class for automated testing. It designed
to work best with [mocha](https://mochajs.org/) and [chai](https://www.chaijs.com/) but
can be used with any runtime.
### Quickstart for tests
The best way to get started with tests is via the `instant.dev`
[command line tools](https://github.com/instant-dev/instant). Once your project is initialized,
you can generate tests for your endpoints with:
```shell
instant g:test --function path/to/index.mjs
```
Where `./functions/path/to/index.mjs` is an endpoint. This will automatically create
a test for each exported function (HTTP method) on the endpoint in:
`./test/tests/functions/path/to/index.mjs`.
Additionally, if you are using [Instant ORM](https://github.com/instant-dev/orm), you can
generate tests for individual models using:
```shell
instant g:test --model users
```
Which will create a test in `./test/tests/models/user.js`.
Finally, To create blank (empty) tests use:
```shell
instant g:test path/to/my_test_name
```
Which will create an empty test in `./test/tests/path/to/my_test_name.mjs`.
Tests can be run via:
```shell
instant test
```
### Custom installation for tests
If you want to write your own tests without using the `instant.dev`
[command line tools](https://github.com/instant-dev/instant), you should
first install `mocha` and `chai`.
```shell
npm i mocha --save-dev
npm i chai --save-dev
```
Next, create the file `./test/run.mjs` with the following contents:
```javascript
import InstantAPI from '@instant.dev/api';
const Gateway = InstantAPI.Gateway;
const TestEngine = InstantAPI.TestEngine;
const PORT = 7357; // Leetspeak for "TEST"; can be anything
// Load environment variables; make sure NODE_ENV is "test"
process.env.NODE_ENV = `test`;
// Initialize and load tests; set PORT for request mocking
const testEngine = new TestEngine(PORT);
await testEngine.initialize('./test/tests');
// Setup; create objects and infrastructure for tests
// Arguments returned here will be sent to .finish()
testEngine.setup(async () => {
console.log();
console.log(`# Starting test gateway on localhost:${PORT} ... `);
console.log();
// Start Gateway; {debug: true} will print logs
const gateway = new Gateway({debug: false});
gateway.load(process.cwd()); // load routes from filesystem
gateway.listen(PORT); // start server
return { gateway };
});
// Run tests; use first argument to specify a test
const args = process.argv.slice(3);
if (args[0]) {
await testEngine.run(args[0]);
} else {
await testEngine.runAll();
}
// Finish; close Gateway and disconnect from database
// Receive arguments from .setup()
testEngine.finish(async ({ gateway }) => {
gateway.close();
});
```
Finally, you can then add the following to `package.json`:
```json
"scripts": {
"test": "mocha test/run.mjs"
}
```
Tests can then be run via:
```shell
npm test
```
### Writing tests
All tests should be put in the `./test/tests` directory. This directory
will be used by `TestEngine` to load all of your tests. Tests are imported
**when they are run**, not when they are first initialized in `TestEngine`.
The structure of a test should look like this;
```javascript
// Imports, setup to begin with
import chai from 'chai';
const expect = chai.expect;
// Optional: Name your test file
export const name = `Some tests`;
/**
* Your tests
* @param {any} setupResult Result of the function passed to `.setup()` in `test/run.mjs`
*/
export default async function (setupResult) {
before(async () => {
// any necessary setup
});
it('Should test for truthiness of "true"', async () => {
expect(true).to.equal(true);
});
after(async () => {
// any necessary teardown
});
};
```
### Running tests
Tests are run top-down, depth-first, alphabetically.
Given the following directory structure:
```yaml
- test/
- tests/
- a/
- second.mjs
- a/third.mjs
- b/fourth.mjs
- b/
- fifth.mjs
- first.mjs
```
- All tests in the root `test/tests` directory are executed first, alphabetically
- All directories in `test/tests` are organized alphabetically
- All tests in `test/tests/a/` would then run
- Then tests in `test/tests/a/a/`
- Then tests in `test/tests/a/b/`
- then tests in `test/tests/b/`
Giving a test order of:
```yaml
- test/tests/first.mjs
- test/tests/a/second.mjs
- test/tests/a/a/third.mjs
- test/tests/a/b/fourth.mjs
- test/tests/b/fifth.mjs
```
If you set up via `instant.dev` [command line tools](https://github.com/instant-dev/instant),
just run:
```shell
instant test
```
If you are running a custom installation, use:
```shell
npm test
```
## Deployment
Instant API can be deployed out-of-the-box to any host that respects the
`[package.json].scripts.start` field. This includes AWS Elastic Beanstalk and Heroku.
Vercel requires a little bit of finagling. However, the `instant.dev`
[command line tools](https://github.com/instant-dev/instant) will automatically
manage deployments to both AWS Elastic Beanstalk and Vercel for you.
### via `instant deploy`
Simple;
```shell
instant deploy:config # follow instructions; choose Vercel or AWS
instant deploy --env staging # for Elastic Beanstalk
instant deploy --env preview # for Vercel
instant deploy --env production # Works for either
```
### Custom deployments
We defer to platform-specific Node.js deployment instructions. If you would
like to contribute some helpful tips, please submit a PR on this README!
## More Information
### Gateway Configuration
You can configure some custom options in your `instant.mjs` startup script.
```javascript
import InstantAPI from '@instant.dev/api';
// ... other code ...
const Gateway = InstantAPI.Daemon.Gateway;
const gateway = new Gateway({
port: 8000, //Defaults to 8170
name: 'My API Server', // Defaults to "InstantAPI.Gateway"
maxRequestSizeMB: 16, // Requests above this size will error. Defaults to 128MB.
defaultTimeout: 10000 // Max execution time in ms. Defaults to 600000 (10 mins).
debug: true // Whether to show logs or not, defaults to false
});
```
### Logging
Currently logging is controlled entirely via the `debug` parameter in
`new Gateway()` instatiation. When set to `true` this can very quickly overwhelm
log storage on high-volume API servers. We're interested in getting feedback
on your favorite log draining solutions and if there are elegant ways to integrate.
Submit an issue to talk to us about it!
### Error monitoring
The `Gateway` instant comes with a built-in `setErrorHandler()` method to
capture internal errors. You can add it to `instant.mjs` or your startup script easily.
Here's an example using [Sentry](https://sentry.io):
```javascript
import InstantAPI from '@instant.dev/api';
import * as Sentry from '@sentry/node';
Sentry.init({
dsn: '__DSN__',
// ...
});
// ... other code ...
const Gateway = InstantAPI.Daemon.Gateway;
const gateway = new Gateway({port: process.env.PORT});
gateway.setErrorHandler(e => Sentry.captureException(e));
gateway.load(process.cwd());
gateway.listen();
```
This will catch all internal errors with the exception of;
- Validation errors:
- ExecutionModeError, ParameterParseError, ParameterError, StreamError, StreamParameterError
- Intentionally thrown client errors:
- BadRequestError, UnauthorizedError, PaymentRequiredError, ForbiddenError, NotFoundError
### Middleware
For the most part, Instant API has pretty comprehensive body parsing and parameter
validation libraries built right in. However, you still might want to write or use
custome middleware for repeated tasks; like authenticating users based on `headers`.
We recommend a simple approach of a `middleware/` directory with files that each output
a function that takes `context` as a single argument:
e.g. in `./middleware/authenticate.mjs`
```javascript
export default async (context) {
let headers = context.https.headers;
let result = await authenticateUser(headers);
if (result) {
return true;
} else {
throw new Error(`401: Unauthorized, failed header validation`);
}
}
```
Then in your endpoints, you can do the following;
```javascript
import authenticate from '../middleware/authenticate.mjs`;
export async function GET (context) => {
await authenticate(context);
return 'authenticated!';
}
```
## Roadmap and Feedback
We're just getting the first release of Instant API into the wild now, we're excited to hear feedback!
It's a pretty comprehensive framework we've been developing for years and we're happy with the feature
set, but please let us know if there are things we are missing by opening an issue.
# Acknowledgements
Special thank you to [Scott Gamble](https://x.com/threesided) who helps run all of the front-of-house work for instant.dev 💜!
| Destination | Link |
| ----------- | ---- |
| Home | [instant.dev](https://instant.dev) |
| GitHub | [github.com/instant-dev](https://github.com/instant-dev) |
| Discord | [discord.gg/puVYgA7ZMh](https://discord.gg/puVYgA7ZMh) |
| X / instant.dev | [x.com/instantdevs](https://x.com/instantdevs) |
| X / Keith Horwood | [x.com/keithwhor](https://x.com/keithwhor) |
| X / Scott Gamble | [x.com/threesided](https://x.com/threesided) | | Instant API: Build type-safe web APIs with JavaScript | api,api-gateway,bun,deno,gateway,javascript,nodejs,server | 2023-10-02T21:48:40Z | 2024-05-13T06:05:55Z | null | 1 | 0 | 546 | 0 | 4 | 246 | null | MIT | JavaScript |
traceloop/openllmetry-js | main | <p align="center">
<a href="https://www.traceloop.com/openllmetry#gh-light-mode-only">
<img width="600" src="https://raw.githubusercontent.com/traceloop/openllmetry/main/img/logo-light.png">
</a>
<a href="https://www.traceloop.com/openllmetry#gh-dark-mode-only">
<img width="600" src="https://raw.githubusercontent.com/traceloop/openllmetry/main/img/logo-dark.png">
</a>
</p>
<h1 align="center">For Javascript / Typescript</h1>
<p align="center">
<p align="center">Open-source observability for your LLM application</p>
</p>
<h4 align="center">
Get started with <a href="https://traceloop.com/docs/openllmetry/getting-started-ts"><strong>Node.js </strong></a>
or <a href="https://traceloop.com/docs/openllmetry/getting-started-nextjs"><strong>Next.js</strong></a> »
<br />
<br />
<a href="https://traceloop.com/slack">Slack</a> |
<a href="https://traceloop.com/docs/openllmetry/introduction">Docs</a> |
<a href="https://www.traceloop.com/openllmetry">Website</a>
</h4>
<h4 align="center">
<a href="https://www.npmjs.com/package/@traceloop/node-server-sdk">
<img src="https://badge.fury.io/js/@traceloop%2Fnode-server-sdk.svg">
</a>
<a href="https://github.com/traceloop/openllmetry-js/blob/main/LICENSE">
<img src="https://img.shields.io/badge/license-Apache 2.0-blue.svg" alt="OpenLLMetry JS is released under the Apache-2.0 License">
</a>
<a href="https://github.com/traceloop/openllmetry-js/actions/workflows/ci.yml">
<img src="https://github.com/traceloop/openllmetry-js/actions/workflows/ci.yml/badge.svg">
</a>
<a href="https://www.ycombinator.com/companies/traceloop"><img src="https://img.shields.io/website?color=%23f26522&down_message=Y%20Combinator&label=Backed&logo=ycombinator&style=flat-square&up_message=Y%20Combinator&url=https%3A%2F%2Fwww.ycombinator.com"></a>
<a href="https://github.com/traceloop/openllmetry-js/blob/main/CONTRIBUTING.md">
<img src="https://img.shields.io/badge/PRs-Welcome-brightgreen" alt="PRs welcome!" />
</a>
<a href="https://github.com/traceloop/openllmetry-js/issues">
<img src="https://img.shields.io/github/commit-activity/m/traceloop/openllmetry-js" alt="git commit activity" />
</a>
<a href="https://traceloop.com/slack">
<img src="https://img.shields.io/badge/chat-on%20Slack-blueviolet" alt="Slack community channel" />
</a>
<a href="https://twitter.com/traceloopdev">
<img src="https://img.shields.io/badge/follow-%40traceloopdev-1DA1F2?logo=twitter&style=social" alt="Traceloop Twitter" />
</a>
</h4>
**🎉 New**:
Our semantic conventions are now part of OpenTelemetry! Join the [discussion](https://github.com/open-telemetry/community/blob/1c71595874e5d125ca92ec3b0e948c4325161c8a/projects/llm-semconv.md) and help us shape the future of LLM observability.
OpenLLMetry-JS is a set of extensions built on top of [OpenTelemetry](https://opentelemetry.io/) that gives you complete observability over your LLM application. Because it uses OpenTelemetry under the hood, it can be connected to your existing observability solutions - Datadog, Honeycomb, and others.
It's built and maintained by Traceloop under the Apache 2.0 license.
The repo contains standard OpenTelemetry instrumentations for LLM providers and Vector DBs, as well as a Traceloop SDK that makes it easy to get started with OpenLLMetry-JS, while still outputting standard OpenTelemetry data that can be connected to your observability stack.
If you already have OpenTelemetry instrumented, you can just add any of our instrumentations directly.
## 🚀 Getting Started
The easiest way to get started is to use our SDK.
For a complete guide, go to our [docs](https://traceloop.com/docs/openllmetry/getting-started-ts).
Install the SDK:
```shell
npm install --save @traceloop/node-server-sdk
```
Then, to start instrumenting your code, just add these 2 lines to your code:
```js
import * as traceloop from "@traceloop/node-server-sdk";
traceloop.initialize();
```
Make sure to `import` the SDK before importing any LLM module.
That's it. You're now tracing your code with OpenLLMetry-JS!
If you're running this locally, you may want to disable batch sending, so you can see the traces immediately:
```js
traceloop.initialize({ disableBatch: true });
```
Now, you need to decide where to export the traces to.
## ⏫ Supported (and tested) destinations
- ✅ [Traceloop](https://www.traceloop.com/docs/openllmetry/integrations/traceloop)
- ✅ [Dynatrace](https://www.traceloop.com/docs/openllmetry/integrations/dynatrace)
- ✅ [Datadog](https://www.traceloop.com/docs/openllmetry/integrations/datadog)
- ✅ [New Relic](https://www.traceloop.com/docs/openllmetry/integrations/newrelic)
- ✅ [Honeycomb](https://www.traceloop.com/docs/openllmetry/integrations/honeycomb)
- ✅ [Grafana Tempo](https://www.traceloop.com/docs/openllmetry/integrations/grafana)
- ✅ [HyperDX](https://www.traceloop.com/docs/openllmetry/integrations/hyperdx)
- ✅ [SigNoz](https://www.traceloop.com/docs/openllmetry/integrations/signoz)
- ✅ [Splunk](https://www.traceloop.com/docs/openllmetry/integrations/splunk)
- ✅ [OpenTelemetry Collector](https://www.traceloop.com/docs/openllmetry/integrations/otel-collector)
See [our docs](https://traceloop.com/docs/openllmetry/integrations/exporting) for instructions on connecting to each one.
## 🪗 What do we instrument?
OpenLLMetry-JS can instrument everything that [OpenTelemetry already instruments](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node) - so things like your DB, API calls, and more. On top of that, we built a set of custom extensions that instrument things like your calls to OpenAI or Anthropic, or your Vector DB like Pinecone, Chroma, or Weaviate.
### LLM Providers
- ✅ OpenAI
- ✅ Azure OpenAI
- ✅ Anthropic
- ✅ Cohere
- ⏳ Replicate
- ⏳ HuggingFace
- ✅ Vertex AI (GCP)
- ✅ Bedrock (AWS)
### Vector DBs
- ✅ Pinecone
- ✅ Chroma
- ⏳ Weaviate
- ⏳ Milvus
### Frameworks
- ✅ LangChain
- ✅ LlamaIndex
## 🌱 Contributing
Whether it's big or small, we love contributions ❤️ Check out our guide to see how to [get started](https://traceloop.com/docs/openllmetry/contributing/overview).
Not sure where to get started? You can:
- [Book a free pairing session with one of our teammates](mailto:nir@traceloop.com?subject=Pairing%20session&body=I'd%20like%20to%20do%20a%20pairing%20session!)!
- Join our <a href="https://traceloop.com/slack">Slack</a>, and ask us any questions there.
## 💚 Community & Support
- [Slack](https://traceloop.com/slack) (For live discussion with the community and the Traceloop team)
- [GitHub Discussions](https://github.com/traceloop/openllmetry-js/discussions) (For help with building and deeper conversations about features)
- [GitHub Issues](https://github.com/traceloop/openllmetry-js/issues) (For any bugs and errors you encounter using OpenLLMetry)
- [Twitter](https://twitter.com/traceloopdev) (Get news fast)
| Sister project to OpenLLMetry, but in Typescript. Open-source observability for your LLM application, based on OpenTelemetry | datascience,llmops,metrics,ml,model-monitoring,monitoring,observability,opentelemetry,opentelemetry-javascript,typescript | 2023-09-27T22:38:28Z | 2024-05-20T15:31:01Z | 2024-05-20T15:31:01Z | 7 | 259 | 260 | 5 | 16 | 230 | null | Apache-2.0 | TypeScript |
sheep-realms/Echo-Live | master | # Echo Live
这是一款基于 [Echo](https://github.com/sheep-realms/Echo) 的用于无声系虚拟主播直播的仿视觉小说对话框 OBS 插件。该插件无需部署本地服务器，下载后开箱即用。
阅读完整帮助文档请见 [Echo-Live 在线帮助文档](https://sheep-realms.github.io/Echo-Live-Doc/)（另有 [CloudFlare 镜像](https://echo-live-doc.pages.dev/)）。
您还可以加入我们的 [Discord 服务器](https://discord.gg/XuPQBw6tHC) 与我们交流。
## 帮助文档快速参考
[使用指南](https://sheep-realms.github.io/Echo-Live-Doc/main/how-to-use/) ·
[主题样式](https://sheep-realms.github.io/Echo-Live-Doc/custom/theme/) ·
[消息格式](https://sheep-realms.github.io/Echo-Live-Doc/message/) ·
[配置文件](https://sheep-realms.github.io/Echo-Live-Doc/custom/config/) ·
[API 文档](https://sheep-realms.github.io/Echo-Live-Doc/dev/broadcast/)
[常见问题](https://sheep-realms.github.io/Echo-Live-Doc/main/faq/) ·
[更新升级](https://sheep-realms.github.io/Echo-Live-Doc/main/update/)
## 另见
- [如何为 Echo-Live 项目作出贡献？](CONTRIBUTING.md)
- [授权协议与声明](copyright.md)
- [GPL（GNU General Public License，GNU通用公共许可协议）第3版](LICENSE)
### 姊妹项目
- [Echo](https://github.com/sheep-realms/Echo)
- [Echo-Live-Doc](https://github.com/sheep-realms/Echo-Live-Doc)
### 第三方项目
- [Echo-Client](https://github.com/Rickyxrc/echo-client)
- [Echo-Live-Tauri](https://github.com/LuiScreaMed/Echo-Live-Tauri)
- [Echo-Live-Typetool](https://github.com/RaySky-Rt/Echo-Live-Typetool)
## 相关资源
建议您安装可免费商用字体以规避版权纠纷，Echo-Live 默认使用思源黑体。
- [思源黑体](https://github.com/adobe-fonts/source-han-sans)
| 一款基于 Echo 的用于无声系虚拟主播直播的仿视觉小说对话框 OBS 插件 | dialog,javascript,obs,subtitles,visual-novel | 2023-09-14T07:27:31Z | 2024-04-21T05:55:56Z | 2024-04-09T08:53:22Z | 2 | 14 | 196 | 1 | 13 | 221 | null | GPL-3.0 | JavaScript |
FlowTestAI/FlowTest | main | # FlowTestAI
[](https://github.com/FlowTestAI/FlowTest/releases)
[](https://www.linkedin.com/company/flowtestai)
[](https://twitter.com/FlowTestAI)
[](https://discord.gg/Pf9tdSjPeF)
💡 We are proud to announce that we were recently featured in a [LangChain](https://blog.langchain.dev/empowering-development-with-flowtestai/) blog post.\
🔓 Unlock use cases by understanding our motivation [dev.to](https://dev.to/flowtestai/launching-flowtestai-ide-for-api-first-workflows-integrations-and-automations-30hd)
FlowTestAI stands as the world’s first GenAI powered OpenSource Integrated Development Environment (IDE) specifically designed to craft, visualize, and manage API-first workflows. Characterized by its speed, lightweight architecture, and localalized operation, FlowTestAI safeguards privacy while facilitating the seamless integration of API driven workflows.
It works as a normal desktop app and interacts directly with your local file system as other IDE(s) like VSCode, Intellij etc. This not only safeguards privacy but helps one to collaborate with others via git or any version control system.
<img width="1728" alt="Screenshot 2024-04-18 at 5 41 43 PM" src="https://github.com/FlowTestAI/FlowTest/assets/5829490/c04f6e3e-fe69-4d25-a008-ba558c8fe149">
🚧 We are actively working on launching a CLI. The CLI allows you to run API first workflows created using FlowTestAI from command line interface making it easier to automate and run them in a CI/CD (continuous integration/development) fashion.
## Documentation 📝
https://flowtestai.gitbook.io/flowtestai
## Setup
## Production 🚀
FlowTestAI is an electron app that runs entirely in your local environment interacting with your local file system just like other IDE(s) out there like VSCode, Intellij etc. The platform-specific binaries are available for download from our GitHub releases. We currently offer [binaries for macOS](https://github.com/FlowTestAI/FlowTest/releases), with versions for Windows and Linux under development 🚧. If you require a binary for a specific platform, please let us know in the Discussions section. We will prioritize your request accordingly.
## Development 🔧
1. Clone the repository
```bash
git clone https://github.com/FlowTestAI/FlowTest.git
```
2. Go into repository folder
```bash
cd FlowTest
```
3. This project uses pnpm. Use [corepack](https://github.com/nodejs/corepack) to enable the required pnpm version:
```bash
corepack enable pnpm
```
or install with npm
```bash
npm install -g pnpm@9.0.6
```
4. Install all project dependencies:
```bash
pnpm install
```
5. Build and start the app:
```bash
pnpm start
```
The app should start as a normal desktop app
NOTE: if you use npm and corepack to install pnpm you will have two instances of pnpm. Make sure the version you're using is the correct version for the repo. Check the [pnpm docs](https://pnpm.io/installation) and [corepack](https://github.com/nodejs/corepack) for troubleshooting. Pnpm installed with npm will overrun corepacks pnpm instance.
## Contribution 🤝
*"Little drops of water make a mighty ocean"*
No contribution is small even if it means fixing a spelling mistake. Follow our contributing guide below.
https://github.com/FlowTestAI/FlowTest/blob/main/CONTRIBUTING.md
Fun fact: our contributing guide itself was an external contribution 🍺
## Support 🙋
- ❓ QNA: feel free to ask questions, request new features or start a constructive discussion here [discussion](https://github.com/FlowTestAI/FlowTest/discussions)
- 🐛 Issues: Feel free to raise issues here [issues](https://github.com/FlowTestAI/FlowTest/issues) (contributing guidelines coming soon..)
- 🔄 Integration: If you want to explore how you can use this tool in your day to day activities or integrate with your existing stack or in general want to chat, you can reach out to us at any of our [social media handles](https://flowtestai.gitbook.io/flowtestai) or email me at jsajal1993@gmail.com.
- 🔐 Our tool requires OpenAI key if you wish to use the natural language to flow translation feature. You can either get yours by signing up [here](https://platform.openai.com/) or you can contact us on our [social media handles](https://flowtestai.gitbook.io/flowtestai) or at jsajal1993@gmail.com and we can provide you one.
## License 📄
Source code in this repository is made available under the [MIT License](LICENSE.md).
| GenAI powered OpenSource IDE for API first workflows | api,api-client,api-testing-framework,automation,electron,git,javascript,llm,openai,workflow | 2023-09-12T01:38:25Z | 2024-05-16T23:05:27Z | 2024-05-16T23:05:27Z | 4 | 99 | 444 | 3 | 12 | 192 | null | MIT | JavaScript |
Corgea/retriever | main | <p align="center">
<img src="https://raw.githubusercontent.com/Corgea/retriever/main/img/logo.png">
</p>
# Retriever
Secure secret sharing through the browser using web crypto. No server required!
[Try it here](https://retriever.corgea.io)
[Why did we build this?](https://retriever.corgea.io/why.html)
## Features
* 100% client-side
* Uses standard browser web crypto APIs
* Links are secure and won't decrypt the secret
* Your secrets and the private keys that encrypt them are never sent to a server by Retriever
## How it works
## Roadmap
* Support for larger secrets
* File sharing
* Bi-directional sharing
## Analytics disclosure
Retriever does use Mixpanel to help the Corgea team know if it's getting traffic. We do not transmit any of your secrets and private keys to Mixpanel.
It is only used if you use https://retriever.corgea.io/. If you run this locally it will not send any analytics to Mixpanel and you can choose to remove it. | Secure secret sharing through the browser using web crypto. No server required! | javascript,secret-sharing,security | 2023-09-17T18:24:58Z | 2024-01-24T22:37:48Z | null | 6 | 6 | 42 | 3 | 18 | 190 | null | MIT | HTML |
Theo-messi/Theo-Docs | main | null | 流媒体森林 - 全方位流媒体 观影指南 引领您进入五彩斑斓的视听世界，并涵盖了 Netflix 、Disney+ 、Spotify会员 和 YouTube会员 的精彩领域/日常记录/青龙面板/ESXI/OpenWrt/VPS指南/银河录像局/蜜糖商店-Metshop/奈飞小铺-爱合租/FlyingBird/Bridge The Wise/一元机场/阿里云盘/影视资源 | css,docs,javascript,sass,typescript,vercel,vite,vitepress,vue,nextjs | 2023-09-19T16:26:46Z | 2024-05-21T07:21:15Z | null | 2 | 124 | 244 | 0 | 3 | 185 | null | MIT | TypeScript |
roberto-butti/some-drops-of-javascript | main | # Welcome to Some drops of JavaScript
## The reason why
This book collects some useful, unknown, underrated JavaScript functions or stuff discovered, used, and learned during JavaScript daily use.
Using JavaScript frameworks/libraries daily (like React, Vue, Angular), sometimes the perception of the power of the language and the basic functionalities provided by the JavaScript core could be lost.
I see that usually, I used to look at the framework documentation or look for a package in Npm for the system, array, and string functions instead of using core functionalities provided by the language.
While I wrote this HTML-book, I also wrote some scripts to better understand the behavior of the functions. You can find these examples here: https://github.com/roberto-butti/some-drops-of-javascript in the _examples_ directory.
> We are excited to invite you to join our Hacktoberfest celebration by contributing to the open-source book project. More [info here](HACKTOBERFEST.md)
### Requirements
The code used in this book is tested with **Bun** and **NodeJs version 18 (LTS)**.
**Bun** is a JavaScript runtime, package manager, bundler and test runner built from scratch using the Zig programming language. It was designed by Jarred Sumner as a drop-in replacement for Node.js. Bun uses JavaScriptCore as the JavaScript engine, unlike Node.js and Deno, which both use V8. The official website is: https://bun.sh/ .
**Node.js** is an open-source, cross-platform JavaScript runtime environment, and you can obtain Node.js on the official https://nodejs.org/ website.
### Continuous release
I was thinking to print this book, but I think that is not so eco-friendly and a book about development could be improved daily in terms of spellchecking and the content and examples. So, I expect to adopt the same approach in the software with the CI/CD, with a continuous release of the book.
Releases:
- **W.I.P.** the 1.0.0 version is not yet released: writing... ;
> The book is **Work in Progress**, the list of the functions covered by the book at the moment are listed in [list-of-functions.md](list-of-functions.md) file
So, if you have any feedback, or you want to suggest some corrections, feel free to open an issue here: https://github.com/roberto-butti/some-drops-of-javascript/issues
### Where to find this book
This book is available TBD.
- Markdown files: [content/](content/);
- Example files: [examples/](examples/);
### Thanks to...
Thanks to all the Open Source community.
### License
"Some drops of JavaScript" (c) by Roberto Butti
"Some drops of JavaScript" is licensed under a
Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.
You should have received a copy of the license along with this
work. If not, see <http://creativecommons.org/licenses/by-nc-sa/4.0/>.
| This book collects some useful, unknown, underrated JavaScript functions discovered and learned while using JavaScript daily. | book,hacktoberfest,javascript | 2023-09-22T19:07:58Z | 2024-03-10T21:58:47Z | null | 13 | 30 | 138 | 0 | 34 | 136 | null | NOASSERTION | Astro |
aidenybai/reaict | main | # re`ai`ct
### Automatically optimize React components with AI
Reaict is a Next.js / Vite / Webpack plugin that automatically analyses your React components and optimizes them for performance during build time. It uses OpenAI's `gpt-3.5-turbo` model to generate the optimized code.
Ideally this can improve your app's render performance. If you want to improve reconcilliation, run `npx million@latest` in your app to install [Million.js](https://million.dev)
## Installation
```bash
npm install reaict-js
```
## Usage
### Next.js
```js
// next.config.js
const withReaict = require('reaict-js');
module.exports = withReaict(
{
// your next.js config
},
{ apiKey: 'YOUR_OPENAI_KEY' },
);
```
### Create React App
```js
const withReaict = require('reaict-js');
module.exports = {
webpack: {
plugins: { add: [withReaict.webpack({ auto: true })] },
},
};
```
### Vite
```js
// vite.config.js
import { defineConfig } from 'vite';
import withReaict from 'reaict-js';
export default defineConfig({
plugins: [withReaict.vite({ apiKey: 'YOUR_OPENAI_KEY' })],
});
```
### Webpack
```js
const withReaict = require('reaict-js');
module.exports = {
plugins: [withReaict.webpack({ apiKey: 'YOUR_OPENAI_KEY' })],
};
```
## Notes
so much that can be done:
- prompt optimization
- support class / arrow func components
- pre-eval functions
- github action instead of every run
- cache functions across runs
- component validation (perf profiling + screenshot)
- optimizing on threshold (don't memo everything)
- integration w/ v0?
- user hints (e.g. put a function // optimize!)
- integration w/ million.js
- package analysis and auto refactor
- automatic error handing
| Optimize React with AI | automatic,javascript,optimize,performance,react,web | 2023-09-16T20:53:14Z | 2023-09-17T01:12:38Z | 2023-09-17T00:11:55Z | 1 | 2 | 13 | 0 | 6 | 133 | null | MIT | TypeScript |
jsplumb/community-edition | master | # jsPlumb Community Edition
This project is the Community edition of jsPlumb. It is open source and MIT/GPL2 licensed. If you're looking for the Toolkit edition please visit [https://jsplumbtoolkit.com](https://jsplumbtoolkit.com).
This repository was created in October 2023 to be the new home of the original repository - [https://github.com/jsplumb/jsplumb](https://github.com/jsplumb/jsplumb).
If you're new to jsPlumb, please do take the time to read the [documentation](https://docs.jsplumbtoolkit.com/community/).
There are a few integration issues that you should be aware of: z-index needs special attention, for example.
**This project is not the correct place to report issues for the Toolkit edition**. The Toolkit is not a public project. Issues reported for the Toolkit edition in this issue tracker will be deleted.
## Packages
In 6.x we have dispensed with the multiple packages from 5.x and we now ship a single package. If you're using a bundler with tree shaking, as the vast majority of people are nowadays, you'll get a smaller bundle size with 6.x than you did with 5.x as it is more compatible with tree shaking.
The single import for 6.x is:
```json
{
"@jsplumb/browser-ui":"^6.0,0"
}
```
### What if I'm not using a package manager?
If you're not using a package manager at all then you can use the UMD that ships in the jsPlumb package.
```html
<script src="node_modules/@jsplumb/browser-ui/js/jsplumb-browser-ui.umd.js"></script>
```
---
## Documentation
For the Community edition the documentation for version 6.x is here:
[https://docs.jsplumbtoolkit.com/community/](https://docs.jsplumbtoolkit.com/community/)
For the previous versions of jsPlumb, docs are here:
[https://docs.jsplumbtoolkit.com/community/5.x](https://docs.jsplumbtoolkit.com/community/5.x)
and
[https://docs.jsplumbtoolkit.com/community/2.x](https://docs.jsplumbtoolkit.com/community/2.x)
## Issues
jsPlumb uses GitHub's issue tracker for enhancements and bugs
## Requirements
No external dependencies.
## jsPlumb in action
Links to various Community Edition demonstrations can be found [here](https://community.jsplumbtoolkit.com).
## Tests
There is a full suite of unit tests checked in to the `test` and `dist/test` directories.
## Twitter
[https://twitter.com/jsplumblib](https://twitter.com/jsplumblib)
## License
All 1.x.x, 2.x.x, 4.x.x, 5.x.x and 6.x.x versions of jsPlumb Community edition are dual-licensed under both MIT and GPLv2.
| The community edition of jsPlumb, versions 1.x - 6.x | angular,charts,diagram,html5,javascript,no-code,svg,typescript,visualization | 2023-10-10T15:05:53Z | 2024-03-27T22:13:11Z | null | 1 | 0 | 7,956 | 98 | 10 | 129 | null | NOASSERTION | JavaScript |
HimanshuNarware/Devlabs | main | <div align="center">
<h1><img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/Animated-Fluent-Emojis/master/Emojis/Objects/Laptop.png" alt="Laptop" width="50" height="50" /> DevLaps</h1>
<p>Welcome to DevLaps, a website where you can search for free tools that are useful for your daily needs. This application is created by the incredible open-source community. On DevLaps, you can discover a collection of free tools that can assist you in various aspects of your life. Moreover, you have the opportunity to contribute to this project by adding more tools to the database.</p>
<p>Check out the live project at <a href="https://DevLabs-one.vercel.app">DevLaps</a></p>
<img src="https://github.com/HimanshuNarware/Devlabs/assets/83147410/a508cf73-6724-46d3-a66d-6b9a7811bfdd" alt="DevLaps" />
</div>
---
## 🌟 Our Mission
Our website provides a platform for contributors from all over the world to share their ideas in the form of helpful websites that are free to use. It helps us save a ton of time by allowing us to access a list of all the websites in one location. Whether it be a tool or an educational platform, we may discover any type of website here. This makes it a platform for sharing knowledge!
---
## 🚀 Tech Stack
- **React.js**: A JavaScript library for building user interfaces.
---
## 🚀 Quick Start
Contributions are welcome! If you have any ideas, suggestions, or bug fixes, please open an issue or submit a pull request. Make sure to follow the project's code of conduct.
---
## 📦 Installation
You can clone the project directly from this repo to your local system.
### 1. Clone the Repo
```bash
git clone https://github.com/username/Devlabs.git
```
### 2. Install Dependencies
```bash
npm install
```
### 3. Start Development Server
```bash
npm start
#or
npm run dev
```
### 4. Create Backend Environment
```bash
MONGODB_URI=<mongodb connection uri for the database>
PORT=<port number on which backend is running>
FRONTEND_URL=<url of the frontend>
MAIL=<email from which to send mail to self>
PASSWORD=<passkey corresponding to above mail>
```
### 5. Create Frontend Environment
All the environment variables for react must be prefixed with `REACT_APP_`.
```bash
REACT_APP_BACKEND=<url of the backend>
```
### 6. Create a New Branch
```bash
git checkout -b YourBranchName
```
### 7. Make Your Changes to the Source Code
To add a new tool:
> Go to **src > DB > `product.json`** & add your code
```bash
{
productName: "< App_Name >",
category: "remote | resume | tweet | ai | ethical | movies | extensions | tools",
image: "< Image-Url >",
link: "< Link_to_the_website >",
description: "< Description of product >"
},
```
- Ensure that your URLs are short. It is recommended to use bitly for URL shortening.
- Descriptions should not exceed 10-12 words.
### 8. Stage Your Changes
⚠️ **Make sure** not to commit `package.json` or `package-lock.json` file
⚠️ **Make sure** not to run the commands `git add .` or `git add *`
---
Instead, stage your changes for each file/folder specifically.
```bash
git add "<files_you_have_changed>"
```
### 9. Commit Your Changes
```bash
git commit -m "<your_commit_message>"
```
### 10. Push Your Local Commits to the Remote Repository
```bash
git push origin YourBranchName
```
### 11. Create a Pull Request
Create a [Pull Request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request)!
<div align="center">
<h2>Let's Collaborate and Make DevLaps Even Better! 💻🌟</h2>
</div>
| DevLabs is a website where you can search for free tools that are useful for your daily needs. This application is created by the incredible open-source community | css,html,javascript,reactjs,open-source,tools,dwoc,bootstrap,expressjs,hacktoberfest2023 | 2023-09-21T18:01:10Z | 2024-05-22T16:39:16Z | null | 85 | 214 | 481 | 121 | 169 | 121 | null | null | JavaScript |
SarthakKeshari/calc_for_everything | master | # [Calculator for Everything](https://calc-for-everything-psi.vercel.app/)
This repository aims to provide Calculators for educational, professional, scientific, health and well-being and other purposes.
Project Live at - [Calc_for Everything](https://calc-for-everything-psi.vercel.app/)
#### Its a ReactJS project and the UI library used - Material UI
Star ⭐ | Fork 🔗 | Contribute 💻
### Website name - Calc for Everything
### Website logo -
<p align="center">
<img src="https://github.com/SarthakKeshari/calc_for_everything/blob/master/calc_for_everything_logo.png" width=40% height=40%>
</p>
<br>
## Contribution Certificate
All the contributors are requested to fill the Google form. Form will be active till 10th of November, 2023.
### https://forms.gle/oQ5NPE2KP3fkQDwn6
<br/>
## Benefits
#### 🏆 **Special Certificate** for Top 3 contributors of this repository
#### 🥉Collect *5 points* and earn your **Open-Source Contributor Certificate**
#### 🥈Collect *25 points* and earn your **Open-Source Contributor Certificate - (Achiever)**
#### 🥇Collect *50 points* and earn your **Open-Source Contributor Certificate - (Extra Miler)**
<br/>
#### Points Scheme
Level | Points
------------ | -------------
Easy | 5 Points
Medium | 10 Points
Hard | 20 Points
<br/>
## Instructions 🎒
#### Do's:
1) Provide Issue Number in the PR.
#### Dont's:
1) Do not raise PR for issues not assigned to you.
### Maintainers/admins/collaborators of this repository/project/website hold all the rights to amend/add/remove any document wherever/whenever is found necessary. <br></div>
<br/>
## Calculators Covered 🔢
#### Computer Science
- Decimal to Binary and Binary to Decimal
- Hexadecimal to Binary and Binary to Hexadecimal
- Octal to Binary and Binary to Octal
- Decimal to Hexadecimal and Hexadecimal to Decimal
- Hexadecimal to Octal and Octal to Hexadecimal
- Decimal to Octal and Octal to Decimal
- Fraction to Decimal and Decimal to Fraction
- ASCII Text to Binary and Binary to ASCII Text
- Binary Adder
- Binary Subtractor
- Octal Adder
- Hexadecimal Adder
- Number Type Finder
- AND Operator
- OR Operator
- XOR Operator
- NOR Operator
- NAND Operator
- Searching Visualizer
- Sorting Visualizer
- ML Model Performance Evaluation Calculator
- Factorial Calculator
- Infix To Postfix And Prefix Calculator
- Postfix And Prefix To Infix Calculator
- Code Time Complexity Calculator
- Simple On-Screen Calculator
- Advance On-Screen Calculator
- Form Buider
- Question Paper Buider
- Code Editor for Web De
- Pv4 To IPv6 Calculator
- Color Code Format Converter
- Data Storage Converter
- Hamming Distance Calculator
- Flow Chart Maker
- Data Cleaner
- Checksum Calculator
- Paragraph Summarizer
- Decimal/2421 Code Converter
- Hamming Code Calculator
- Random Number Generator
- Image Text Reader
- IEEE754 Converter
- IP Address Calculator
- Image To PDF Consolidator
- Computer Algebra System (CAS) Calculator
- Base Change Calculator
- POS-SOP Converter
- Gray Code Calculator
- Complement Calculator
#### Mathematical
- Simple Interest
- Compound Interest
-Statistics
- Prime Factors
- Log and Antilog
- BODMAS Solver
- Quadratic Equation Solver
- Polynomial Equation Root Finder
- Set Operations
- Graph Maker
- Quadratic Equation Intersection
- Linear Equation Intersection
- Matrix Addition
- Matrix Substraction
- Matrix Multiplication
- Matrix Transpose
- Matrix Inverse
- Matrix Adjoint
- Matrix Determinant
- First Order Differential Equation Solver
- Work and Time Calculator
- Co-Linear Points Finder
- Grouping Points On Same Side Of Line
- Grouping Points On/Inside/Outside of Quadratic Curve
- Polynomial Equation Differential Calculator
- Polynomial Equation Integral Calculator
- LCM Calculator
- HCF Calculator
- Angle Type Classifie
- Trignometric Value Calculator
- Percentage Calculator
- Percentile Calculator
- Co-Prime Finder
- Metric Unit Converter
- Profit Loss Calculator
- Distance Calculator
- Bayesian Probability Calculator
- Triangle Type Finder
- Fraction Sorting Calculator
- Place And Face Value Calculator
- Equating Denominator Of Fraction
- Table Of A Number
- Factors Of A Number
-Pythagoras Theorem Calculator
- Mixed To Improper And Improper To Mixed Fraction Calculator
- Cube Root And Square Root Calculator
- Area Of 2D Shapes Calculator
- Surface Area Of 3D Shapes Calculator
- Square And Cube Calculator
- Roman Numeral Converter
- Operations On Fractions Calculator
- Statistical Graph Creator
- Volume 3D Shapes Calculator
- Congruency Of Triangle Calculator
- Numerals To Words Converter
- Permutation And Combination Calculator
- Similarity Of Triangle Calculator
- Sum of N terms of AP/GP/HP Calculator
- Differential Calculator
- Laplace Calculator
- Pipes And Cisterns Calculator
- Factorial Calculator (Gamma)
- Analytical Function Calculator
#### Chemistry
- pH Calculator
- Chemical Equation Balancer
- Chemical Kinetics Calculator
- Molecular Weight Calculator
- Chemical Formula Validator
- Empirical Formula Calculator
#### Physics
- Pressure Calculator
- Cosmo Mass Converter
- Amplitude Calculator
- Vibrational response Calculator
- Density Calculator
- Projectile Calculator
- ohm's Law Calculator
- MKS-CS-FPS Calculator
- Combined Gas Laws Calculator
- Kinetic Energy Calculator
- Time Dilation Calculator
- Momentum Calculator
#### Finance
- FD Maturity Calculator
- RD Maturity Calculator
- Loan Repayment Calculator
- Savings Calculator
- Expense Tracker
- Currency Converter
- Profit Margin Calculator
- Tip Calculator
- Reciept Generator
- GDP Calculator
#### Health
- BMI
- BMR
- Body Fat
- Age Calculator
- ddddPregnancy Due Date Calculator
- Drug Dosage Calculator
- APGAR Score Calculator
- Water Intake Calculator
- Novelty Age Calculator
- Day Scheduler
- Task Planner
#### ART
- Drawing Canvas
- Mandala Creator
#### Space
- Satellite Location using TLE
-
<br/>
## 🌟 Contributors
#### Ranklist
Rank | Githib Handle | Points Scored
------------ | ------------- | ------------
1 | @syash7202 | 120
1 | @nipun221 | 120
2 | @Upadhyay-Harshit | 105
3 | @maskboyAvi | 95
4 | @dvtushar | 70
5 | @imsoumik03 | 55
5 | @anushka-srivastava22 | 55
5 | @sikehish | 55
5 | @PrachiDev11 | 55
5 | @ravishrivas | 55
5 | @VincentPaulV | 55
6 | @Deathanni | 50
7 | @7twik | 45
8 | @Saksham-245 | 40
8 | @uttkarsh1m | 40
8 | @Rida-Nuha | 40
8 | @tejxv | 40
9 | @IshaanShettigar | 35
9 | @Rishika631 | 35
10 | @Akash0420 | 30
10 | @Sk783 | 30
10 | @Satvik-Garg | 30
10 | @ashishnallana | 30
10 | @aditya962 | 30
11 | @Sam-bhav-20 | 25
11 | @Celebi07 | 25
11 | @aniketsinha5552 | 25
11 | @rishirohilla | 25
11 | @divyansh-4 | 25
11 | @its-kumar-yash | 25
11 | @DeexithParand2k2 | 25
12 | @DanishGBU | 20
12 | @capsy14 | 20
12 | @sachinsingh2020 | 20
12 | @munfaridzahera | 20
12 | @remonix | 20
12 | @girisha-pawan | 20
12 | @mr-kadyan | 20
12 | @ShashWorks | 20
12 | @amwaiting1 | 20
12 | @Pasqua101 | 20
12 | @aditish11 | 20
13 | @hiren2599 | 15
13 | @govardhanshah456 | 15
13 | @farhanalws4u | 15
13 | @dfordp | 15
13 | @Ayushlion8 | 15
13 | @chinmayr633 | 15
13 | @Ayush-Vish | 15
14 | @Vimal-Dubey | 10
14 | @shrinidhihegde3 | 10
14 | @shreyashsingh-101 | 10
14 | @Saifullah00 | 10
14 | @plon-Susk7 | 10
14 | @Kris0011 | 10
14 | @ArnabBCA | 10
14 | @ctln23 | 10
14 | @Zinc-ion | 10
14 | @hubsMIT1 | 10
14 | @tiwari00ayush | 10
14 | @roniragilimankhoirul | 10
14 | @mannbajpai | 10
15 | @vendhan-ds | 5
15 | @tmsagarofficial | 5
15 | @TANYA03GUPTA | 5
15 | @srronaksingh | 5
15 | @Musak2 | 5
15 | @Heramb4270 | 5
15 | @atharvsawant2003 | 5
15 | @abhijithhegde | 5
15 | @Ahasasjain | 5
15 | @XronTrix10 | 5
15 | @shivanshhgit | 5
15 | @real-varshney | 5
15 | @DapaoK | 5
15 | @Alfred-hhy | 5
15 | @Upkar0904 | 5
15 | @wuyu-wy | 5
15 | @M111ku | 5
15 | @WaterCubeGod | 5
15 | @Shantanu-Tiwari | 5
## Contribution Certificate
All the contributors are requested to fill the Google form. Form will be active till 10th of November, 2023.
### https://forms.gle/oQ5NPE2KP3fkQDwn6
<br/>
<br/>
### Thanks to all the wonderful peoples, you all made this project possible ✨✨
<p><a href="https://github.com/SarthakKeshari/calc_for_everything/graphs/contributors">
<img src="https://contributors-img.web.app/image?repo=SarthakKeshari/calc_for_everything" />
</a></p>
| This repository aims to provide Calculators for educational, professional, scientific, health and well-being and other purposes. | calculator,computer-science,documentation,hacktoberfest,hacktoberfest-accepted,hacktoberfest2023,javascript,mathematical,newcomers,reactjs | 2023-09-28T16:06:18Z | 2023-12-13T16:24:42Z | null | 81 | 305 | 1,050 | 51 | 105 | 116 | null | MIT | JavaScript |
V-E-N-O-X/IRIS-MD | main | [](#table-of-contents)
<div align="center" class= "main">
<img src="https://imgur.com/D60nScQ.jpg" width="300" height="300"/>
<h1>ＩＲＩＳ- ＭＤ</h1>
<a href="https://github.com/V-E-N-O-X"><img title="Creator" src="https://img.shields.io/badge/Creator-VENOX-red.svg?style=for-the-badge&logo=github"></a>
<br>
<a href="https://github.com/V-E-N-O-X?tab=followers"><img title="Followers" src="https://img.shields.io/github/followers/V-E-N-O-X?color=green&style=flat-square"></a>
<a href="https://github.com/V-E-N-O-X/IRIS-MD/stargazers/"><img title="Stars" src="https://img.shields.io/github/stars/V-E-N-O-X/IRIS-MD?color=white&style=flat-square"></a>
<a href="https://github.com/V-E-N-O-X/IRIS-MD/network/members"><img title="Forks" src="https://img.shields.io/github/forks/V-E-N-O-X/IRIS-MD?color=yellow&style=flat-square"></a>
<div align="left"
<br><br>
<p align="center"><img src="https://profile-counter.glitch.me/{IRIS-MD}/count.svg" alt="V-E-N-O-X :: Visitor's Count" /></p>
## sᴇᴛᴜᴘ
1. _Fork This Repo_
<br>
<a href='https://github.com/V-E-N-O-X/IRIS-MD/fork' target="_blank"><img alt='Fork Repo' src='https://img.shields.io/badge/Fork_Repo-100000?style=for-the-badge&logo=scan&logoColor=white&labelColor=black&color=black'/></a>
2. 𝘚𝘤𝘢𝘯 𝘵𝘩𝘦 𝘘𝘙 𝘢𝘯𝘥 𝘤𝘰𝘱𝘺 𝘪𝘵
<br>
<a href='https://irisweb.alphasoft.org' target="_blank"><img alt='SCAN QR' src='https://img.shields.io/badge/Scan_qr-100000?style=for-the-badge&logo=scan&logoColor=white&labelColor=black&color=black'/></a>
### ᴅᴇᴘʟᴏʏ ᴛᴏ ʜᴇʀᴏᴋᴜ
1. 𝘊𝘳𝘦𝘢𝘵𝘦 𝘢𝘯 𝘢𝘤𝘤𝘰𝘶𝘯𝘵.
<br>
<a href='https://signup.heroku.com/' target="_blank"><img alt='Heroku' src='https://img.shields.io/badge/-Create-black?style=for-the-badge&logo=heroku&logoColor=white'/></a>
2. 𝘕𝘰𝘸 𝘋𝘦𝘱𝘭𝘰𝘺
<br>
<a href='https://irisweb.alphasoft.org/deploy' target="_blank"><img alt='DEPLOY' src='https://img.shields.io/badge/-DEPLOY-black?style=for-the-badge&logo=heroku&logoColor=white'/></a>
### ᴅᴇᴘʟᴏʏ ᴛᴏ ʀᴇᴘʟɪᴛ
3. 𝘊𝘳𝘦𝘢𝘵𝘦 𝘢𝘯 𝘢𝘤𝘤𝘰𝘶𝘯𝘵.
<br>
<a href='https://replit.com/signup' target="_blank"><img alt='replit' src='https://img.shields.io/badge/-Create-black?style=for-the-badge&logo=replit&logoColor=orange'/></a>
4. 𝘕𝘰𝘸 𝘋𝘦𝘱𝘭𝘰𝘺
<br>
<a href='https://replit.com/github/V-E-N-O-X/IRIS-MD' target="_blank"><img alt='DEPLOY' src='https://img.shields.io/badge/-DEPLOY-black?style=for-the-badge&logo=replit&logoColor=orange'/></a>
### ᴅᴇᴘʟᴏʏ ᴛᴏ ʀᴀɪʟᴡᴀʏ
5. 𝘊𝘳𝘦𝘢𝘵𝘦 𝘢𝘯 𝘢𝘤𝘤𝘰𝘶𝘯𝘵.
<br>
<a href='https://railway.app/login' target="_blank"><img alt='railway' src='https://img.shields.io/badge/-Create-black?style=for-the-badge&logo=railway&logoColor=white'/></a>
6. 𝘕𝘰𝘸 𝘋𝘦𝘱𝘭𝘰𝘺
<br>
<a href='https://railway.app/template/12FD9C?referralCode=Wbbu1p' target="_blank"><img alt='DEPLOY' src='https://img.shields.io/badge/-DEPLOY-black?style=for-the-badge&logo=railway&logoColor=white'/></a>
<br><br>
### sᴜᴘᴘᴏʀᴛ ᴍᴇ
<a href="https://whatsapp.com/channel/0029VaHt1710AgWB1B0Lkg0Q"><img alt="WhatsApp" src="https://img.shields.io/badge/-Whatsapp%20Channel-white?style=for-the-badge&logo=whatsapp&logoColor=black"/></a>
<br><br>
### ᴛʜᴀɴᴋs ᴛᴏ
- [ABRAHAM ❤️](https://github.com/abrahamdw882) <br>
- [TygerGracia ❤](https://github.com/TygerGarcia) <br>
- [X-Electra](https://github.com/X-Electra) for [X-Asena](https://github.com/X-Electra/X-Asena)
<br><br>
### 📮s&ᴋ
- *I will only Assist You in Bot Deployment*
- *Do not revamp my modules/plugins*
- *This Bot is not 100% secure,So keep this in mind*
- ***Regards [Venox-Senpai](https://github.com/V-E-N-O-X)***
| ғᴏʀᴋ ᴛʜɪs ʀᴇᴘᴏ ᴀɴᴅ ᴅᴏɴ'ᴛ ғᴏʀɢᴇᴛ ɢɪᴠᴇ sᴛᴀʀ ᴛᴏ ᴛʜɪs ʀᴇᴘᴏ 🎐 | whatsapp-web,baileys-md,javascript,nodejs,whatsapp-bot-md,whatsappbot,iris-md | 2023-10-11T08:06:22Z | 2024-05-09T02:47:29Z | 2024-03-28T09:57:02Z | 9 | 11 | 164 | 0 | 602 | 108 | null | Apache-2.0 | JavaScript |
gssbotwa/Gssbotwa2 | main | <h1 align="center">GSS BOTWA-MD</h1>
<p align="center">
<a href="https://youtu.be/WcA7GZuaN0A">
<img alt="botgsswa" height="300" src="https://github.com/gssbotwa.png">
<p align="center">
<a href="https://github.com/gssbotwa"><img title="Author" src="https://img.shields.io/badge/GSS-BOTWA-black?style=for-the-badge&logo=WhatsApp"></a>
<p align="center"> Introducing GSS BOTWA MD, It is designed to bring a whole new level of excitement to your boring WhatsApp use. </p>
<p align="center">
<a aria-label="GSS BOTWA MD is free to use" href="https://youtube.com/@mhmodsofc" target="_blank">
<img alt="MH MODS OFC Yt" src="https://img.shields.io/youtube/channel/subscribers/UCWHA-PreVSVaYhDTAiUipCA" target="_blank" />
</a>
</p>
<p align="center"><img src="https://profile-counter.glitch.me/{chhaseeb47}/count.svg" alt="chhaseeb47 :: Visitor's Count" /></p>
<p align="center">
<a href="https://whatsapp.com/channel/0029Va8SjGU1noyxsYBA2K2e"><img src="https://img.shields.io/badge/Connect on WhatsApp-25D366?style=for-the-badge&logo=whatsapp&logoColor=white"></a>
<a href="https://www.youtube.com/channel/UCWHA-PreVSVaYhDTAiUipCA"><img src="https://img.shields.io/badge/Subcribe On Youtube-E4405F?style=for-the-badge&logo=youtube&logoColor=white"></a>
<a href="https://whatsapp.com/channel/0029VaFNrVHBfxoBuY2TzH2w"><img src="https://img.shields.io/badge/Join WhatsApp Group-25D366?style=for-the-badge&logo=whatsapp&logoColor=white"></a>
<p align="center">
<a href="https://github.com/gssbotwa/followers"><img title="Followers" src="https://img.shields.io/github/followers/gssbotwa?color=red&style=flat-square"></a>
<a href="https://github.com/gssbotwa/Gssbotwa2/stargazers/"><img title="Stars" src="https://img.shields.io/github/stars/gssbotwa/Gssbotwa2?color=blue&style=flat-square"></a>
<a href="https://github.com/gssbotwa/Gssbotwa2/network/members"><img title="Forks" src="https://img.shields.io/github/forks/gssbotwa/Gssbotwa2?color=red&style=flat-square"></a>
<a href="https://github.com/gssbotwa/Gssbotwa2/watchers"><img title="Watching" src="https://img.shields.io/github/watchers/gssbotwa/Gssbotwa2?label=Watchers&color=blue&style=flat-square"></a>
<a href="https://github.com/gssbotwa/Gssbotwa2"><img title="Open Source" src="https://img.shields.io/badge/Author-ETHIX SID X %20HASEEB-red?v=103"></a>
<a href="https://github.com/gssbotwa/Gssbotwa2/"><img title="Size" src="https://img.shields.io/github/repo-size/gssbotwa/Gssbotwa2?style=flat-square&color=green"></a>
<a href="https://github.com/gssbotwa/Gssbotwa2/graphs/commit-activity"><img height="20" src="https://img.shields.io/badge/Maintained%3F-yes-green.svg"></a>
</p>
<p align='center'>
</p>
---
### 1. FORK THIS REPO
<a href='https://github.com/gssbotwa/Gssbotwa2/fork' target="_blank"><img alt='Fork repo' src='https://img.shields.io/badge/Fork This Repo-black?style=for-the-badge&logo=git&logoColor=white'/></a>
### 2. GET SESSION VIA PAIR CODE
<a href='https://replit.com/@MHMODS/GSS-BOT-WA-PAIR-1?v=1' target="_blank"><img alt='Fork repo' src='https://img.shields.io/badge/Click here to get your credit js-black?style=for-the-badge&logo=opencv&logoColor=white'/></a>
## Your Bot Cannot run without this.
```
mongodb+srv://mohsin:mohsin@cluster0.iauaztt.mongodb.net/?retryWrites=true&w=majority
```
<a href='https://youtu.be/_Yqtsho9eI0?si=_ezalTW5QiTI-0w2' target="_blank"><img alt='Mongodb Url Tutorial' src='https://img.shields.io/badge/-Mongodb Url Tutorial-green?style=for-the-badge&logo=mongodb&logoColor=darkgreen'/></a>
#### DEPLOY TO HEROKU
1. If You don't have a account in Heroku. Create a account.
<br>
<a href='https://signup.heroku.com/' target="_blank"><img alt='Heroku' src='https://img.shields.io/badge/-Create-black?style=for-the-badge&logo=heroku&logoColor=white'/></a>
2. Now Deploy
<br>
<a href='https://heroku.com/deploy' target="_blank"><img alt='DEPLOY' src='https://img.shields.io/badge/-DEPLOY-black?style=for-the-badge&logo=heroku&logoColor=white'/></a>
3. How To Deploy video Tutorial.
<br>
<a href='https://youtu.be/NbREC9DTQcA?si=bamV9UTA5nXGwDDD' target="_blank"><img alt='Heroku Deploy Tutorial' src='https://img.shields.io/badge/-Heroku Deploy Tutorial-red?style=for-the-badge&logo=youtube&logoColor=white'/></a>
#### DEPLOY TO CODESPACE
1. If You don't have a account in Codespace. Create a account.
<br>
<a href='https://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fcodespaces' target="_blank"><img alt='Codespaces' src='https://img.shields.io/badge/CREATE-h?color=black&style=for-the-badge&logo=visualstudiocode' width="96.35" height="28"/></a></p>
2. Now Deploy
<br>
<a href='https://github.com/codespaces/new' target="_blank"><img alt='DEPLOY' src='https://img.shields.io/badge/DEPLOY -h?color=black&style=for-the-badge&logo=visualstudiocode' width="96.35" height="28"/></a></p>
#### DEPLOY TO RAILWAY
1. If You don't have a account in Railway. Create a account.
<br>
<a href='https://railway.app/login' target="_blank"><img alt='Railway' src='https://img.shields.io/badge/CREATE-h?color=black&style=for-the-badge&logo=railway' width="96.35" height="28"/></a></p>
2. Now Deploy
<br>
<a href='https://railway.app/new' target="_blank"><img alt='DEPLOY' src='https://img.shields.io/badge/DEPLOY -h?color=black&style=for-the-badge&logo=railway' width="96.35" height="28"/></a></p>
#### DEPLOY TO MONGENIUS
1. If You don't have a account in Mongenius. Create a account.
<br>
<a href='https://studio.mogenius.com/user/registration' target="_blank"><img alt='Mongenius' src='https://img.shields.io/badge/CREATE-h?color=black&style=for-the-badge&logo=genius' width="96.35" height="28"/></a></p>
2. Now Deploy
<br>
<a href='https://railway.app/new' target="_blank"><img alt='DEPLOY' src='https://img.shields.io/badge/DEPLOY -h?color=black&style=for-the-badge&logo=genius' width="96.35" height="28"/></a></p>
#### DEPLOY TO REPLIT
1. If You don't have a account in Replit. Create a account.
<br>
<a href='https://replit.com/' target="_blank"><img alt='Heroku' src='https://img.shields.io/badge/-Create-black?style=for-the-badge&logo=replit&logoColor=white'/></a>
2. Now Deploy
<br>
<a href='https://replit.com/github/gssbotwa/Gssbotwa2' target="_blank"><img alt='Heroku' src='https://img.shields.io/badge/-Deploy-black?style=for-the-badge&logo=replit&logoColor=white'/></a>
---
## `DEVELOPERS`
<div align="left">
<a href="[https://github.com/gssbotwa]"><img src="https://github.com/gssbotwa.png" width="150" height="200" alt="Ash"/></a>
<a href="[https://github.com/chhaseeb47]"><img src="https://github.com/chhaseeb47.png" width="200" height="200" alt="Ash"/></a>
</div>
<br>
<h4 align="left">
| [SIDHARTH ](https://github.com/gssbotwa) |
| Owner, Developer, Bug Fixer, Maintainer, updates|
| [ CH HASEEB ](https://github.com/chhaseeb47) |
| CO.Devloper |
</br>
<h4 align="left">
***Tap On Logo To Subscribe MY YouTube Channel***
</p>
<p align="left">
<a href="https://www.youtube.com/@SinghaniyaTech0744?sub_confirmation=1">
<img alt=Support height="70" src="https://telegra.ph/file/eb6347e2764939fbbd35d.png">
</p>
***Tap On Logo To Contat Me***
<p align="left">
<a href="mailto:bsid4961@gmail.com"><img title="Author" src="https://img.shields.io/badge/GMAIL-ME-black?style=for-the-badge&logo=Gmail"></a>
<p align="left">
<a href="https://wa.me/919142294671?text=Hi+sid+Sir...+I+need+some+help+in+Gss_Botwa"><img title="Author" src="https://img.shields.io/badge/WHATSAPP-ME-red?style=for-the-badge&logo=WhatsApp"></a>
</br>
<h2 align="center"> Reminder
</h2>
- This bot is not made by `WhatsApp Inc.` So misusing the bot might `ban` your `WhatsApp account!`(Though your WhatsApp account can be unbanned only once.)
- I am not responsible for banning your account.
- Use at your own risk by keeping this warning in mind.
---
</p>
<h1 align="center"> Keep Supporting
</h1>
<br><br>
| GSSBOTWA MD is a Cool Multi-Device WhatsApp bot developed by Ethix Sid & CH HASEEB. It offers a wide range of extraordinary features, making it an advanced and user-friendly bot for various purposes. | bot,whatsappbot,gss-md,heroku-deployment,javascript,gss-wa-bot,gssbot2024,gssbotgithub,gssbotwa2,newbot2024 | 2023-10-06T05:00:13Z | 2024-05-21T13:02:33Z | null | 3 | 19 | 2,524 | 0 | 378 | 105 | null | null | JavaScript |
NarendraKoya999/Frontend-Machine-Coding-Interview-Questions | main | # Machine Coding🧠 Round Questions-Frontend🎯
### HTML and CSS
1. **Build a Basic HTML Page**: Create a basic HTML page that includes a header, navigation menu, main content section, and a footer.
2. **Responsive Navigation Menu**: Implement a responsive navigation menu that collapses into a hamburger menu on smaller screens using HTML, CSS, and JavaScript/jQuery.
3. **JavaScript Calculator**: Build a simple calculator using HTML, CSS, and JavaScript that can perform basic arithmetic operations (addition, subtraction, multiplication, division).
4. **Image Carousel**: Create an image carousel/slider using HTML, CSS, and JavaScript/jQuery that allows users to navigate through a set of images with next and previous buttons.
5. **To-Do List Application**: Develop a to-do list web application using HTML, CSS, and JavaScript. Users should be able to add, edit, and delete tasks.
6. **Responsive Design**: Take an existing web page and make it responsive for various screen sizes (e.g., desktop, tablet, mobile) using media queries and CSS.
7. **Fetch API**: Use the Fetch API to retrieve data from a JSON endpoint and display it on a web page using JavaScript.
8. **Single Page Application (SPA)**: Build a simple single-page application (SPA) using a frontend framework of your choice (e.g., React, Angular, Vue.js). Create multiple views and navigate between them.
9. **Form Validation**: Implement client-side form validation for a registration form using HTML5 and JavaScript. Validate fields like email, password strength, and required fields.
10. **Implement a Drag and Drop Feature**: Create a web page with a drag-and-drop interface using HTML, CSS, and JavaScript. Allow users to drag elements and drop them into designated areas.
11. **Infinite Scroll**: Implement an infinite scroll feature on a web page. Load additional content as the user scrolls down the page using JavaScript and AJAX.
12. **Interactive Map**: Build an interactive map using a mapping library (e.g., Leaflet, Google Maps API) and allow users to search for locations, add markers, and display additional information when clicking on markers.
13. **Web Accessibility**: Ensure that a web page complies with web accessibility standards (WCAG). Make necessary HTML and CSS modifications to improve accessibility for users with disabilities.
14. **CSS Animation**: Create a CSS animation, such as a spinning loader or a fading effect, to enhance user experience on a webpage.
15. **Responsive Email Template**: Design and code a responsive email template that looks good on both desktop and mobile email clients.
16. **Dynamic Content Filtering**: Create a web page that allows users to filter content dynamically based on categories or tags using JavaScript.
17. **Social Media Sharing Buttons**: Implement social media sharing buttons (e.g., Facebook, Twitter) on a webpage. When a user clicks a button, a share dialog should appear.
18. **Image Lazy Loading**: Implement image lazy loading to improve page performance. Images should only load when they are in the viewport.
19. **Form Autocomplete**: Add autocomplete functionality to a search input field using JavaScript. Provide suggestions as the user types.
20. **Implement a Lightbox**: Create a lightbox/modal window that displays images or content when a user clicks on a thumbnail or a button.
### Intermediate Frontend Development
21. **Real-time Chat Application**: Build a real-time chat application using a frontend framework (e.g., React, Vue.js) and a backend technology like WebSocket or Firebase.
22. **Responsive Tables**: Make HTML tables responsive. Ensure that tables adapt to different screen sizes without horizontal scrolling.
23. **Data Visualization**: Create a data visualization chart (e.g., bar chart, pie chart) using a JavaScript library like D3.js or Chart.js.
24. **Sticky Navigation**: Implement a sticky navigation bar that sticks to the top of the page when scrolling down and returns to its original position when scrolling up.
25. **Web Performance Optimization**: Optimize the performance of a slow-loading webpage. Identify bottlenecks and apply optimizations to reduce load times.
26. **Progressive Web App (PWA)**: Convert a web application into a Progressive Web App. Add features like offline access and push notifications.
27. **Unit Testing**: Write unit tests for a JavaScript function or component using a testing framework like Jest.
28. **Cross-browser Compatibility**: Ensure that a webpage works correctly and looks consistent across different web browsers (e.g., Chrome, Firefox, Edge).
29. **Web Security**: Identify and fix security vulnerabilities in a web application, such as Cross-Site Scripting (XSS) or Cross-Site Request Forgery (CSRF).
30. **Responsive Email Signature**: Design and code a responsive email signature that can be used in email clients.
31. **Infinite Carousel**: Create an infinite carousel/slider that automatically loops through a set of images or content, providing navigation controls for the user.
32. **Image Gallery**: Build an image gallery where users can view a collection of images, click to enlarge, and navigate through them using previous and next buttons.
33. **Tooltip Component**: Design and implement a reusable tooltip component in HTML, CSS, and JavaScript/jQuery that appears when hovering over specific elements.
34. **Data Fetch and Display**: Fetch data from a public API (e.g., GitHub API, OpenWeatherMap API) and display it on a webpage using JavaScript. Format and style the data appropriately.
35. **Animated Dropdown Menu**: Create a dropdown menu that expands and collapses with smooth animations when the user hovers over a trigger element.
36. **Interactive Forms**: Enhance a web form with interactive features like auto-suggestions, input validation, and conditional form fields using JavaScript.
37. **Page Transitions**: Implement smooth page transitions between different sections or pages of a website using CSS transitions and JavaScript.
38. **Keyboard Shortcuts**: Add keyboard shortcuts to a web application to improve user accessibility and navigation.
39. **Dark Mode Toggle**: Create a dark mode toggle button that switches the website's color scheme between light and dark mode.
40. **WebGL Experiment**: Develop an interactive WebGL project, such as a 3D visualization or animation, and embed it into a webpage.
41. **Custom Video Player**: Build a custom HTML5 video player with custom controls, such as play, pause, volume, and progress bar.
42. **Page Printing Styles**: Define CSS styles for printing a web page so that it looks well-formatted when printed on paper.
43. **Implement a Photo Gallery**: Create a photo gallery with albums, thumbnails, and the ability to view images in a larger size.
44. **Web Audio Player**: Build a web-based audio player with features like play, pause, volume control, and playlist support.
45. **SVG Animation**: Animate SVG graphics using CSS or JavaScript to create eye-catching visual effects.
46. **Custom CSS Framework**: Develop a custom CSS framework with pre-designed components and styles for rapid front-end development.
47. **Web Animation Framework**: Create a JavaScript animation framework that simplifies the process of animating elements on a webpage.
48. **Augmented Reality Web App**: Develop an augmented reality (AR) web application that overlays digital content on the user's real-world view using WebXR or similar technology.
49. **Progressive Image Loading Placeholder**: Implement a progressive image loading technique that displays a blurred or low-quality image as a placeholder while the high-quality image loads.
50. **Automated Web Testing**: Write automated tests for a web application using testing frameworks like Selenium or Cypress.
### Expert Frontend Development (Part 1)
51. **Custom Web Animation Library**: Create a small JavaScript library for animating elements on a webpage, including support for various easing functions.
52. **Custom UI Components**: Create custom UI components, such as a modal dialog, date picker, or autocomplete, from scratch using HTML, CSS, and JavaScript.
53. **Mobile-First Development**: Develop a webpage following the mobile-first approach, ensuring it looks and functions well on mobile devices and scales up to larger screens.
54. **Third-Party API Integration**: Integrate with a third-party API (e.g., Google Maps, Twitter, YouTube) and display data or content from that API on your webpage.
55. **Offline Support**: Implement offline support for a web application, allowing users to access content even when they have no internet connection.
56. **Browser History API**: Use the Browser History API to implement client-side routing in a single-page application (SPA).
57. **Infinite Scroll with Pagination**: Combine infinite scrolling with pagination to load and display content efficiently while allowing users to navigate through pages of data.
58. **Web Audio Player**: Build a web-based audio player with features like play, pause, volume control, and playlist support.
59. **WebGL Experiment**: Develop an interactive WebGL project, such as a 3D visualization or animation, and embed it into a webpage.
60. **Lazy-Loaded Modules**: Implement lazy-loading for modules in a frontend framework (e.g., React, Angular, Vue.js) to reduce the initial bundle size.
61. **SVG Icon Library**: Create a reusable SVG icon library with a search and usage feature for easy integration into web projects.
62. **WebGL 3D Scene**: Develop a 3D scene using WebGL, including 3D models, textures, and interactive elements.
63. **Lazy-Loaded Images**: Implement lazy-loaded images that load only when they come into the user's viewport, improving page loading performance.
64. **Web Performance Monitoring**: Implement web performance monitoring and analytics to track and analyze website performance over time.
65. **Web Security Audit**: Perform a security audit on a web application and identify vulnerabilities like SQL injection, XSS, and CSRF. Suggest and implement fixes.
66. **Server-Side Rendering (SSR) with React**: Set up server-side rendering (SSR) for a React application.
67. **WebGL Shader Effects**: Build a WebGL-based shader effect, such as a water ripple effect or a dynamic particle system.
68. **Lazy-Loaded Images**: Implement lazy-loaded images that load only when they come into the user's viewport, improving page loading performance.
69. **Web Performance Monitoring**: Implement web performance monitoring and analytics to track and analyze website performance over time.
70. **Web Security Audit**: Perform a security audit on a web application and identify vulnerabilities like SQL injection, XSS, and CSRF. Suggest and implement fixes.
71. **Server-Side Rendering (SSR)**: Implement server-side rendering for a frontend framework (e.g., React, Angular) to improve initial page load performance.
72. **WebGL Shader Effects**: Build a WebGL-based shader effect, such as a water ripple effect or a dynamic particle system.
73. **Virtual DOM Implementation**: Implement a simplified virtual DOM (similar to React's virtual DOM) in JavaScript.
74. **Progressive Image Loading**: Develop an image loading technique that progressively loads images, starting with low-quality placeholders and improving to high-quality images.
75. **Touch and Gesture Events**: Implement touch and gesture events in a web application to provide touch-based interactions on mobile devices.
76. **Browser Storage Management**: Build a utility for managing browser storage (localStorage, sessionStorage) and provide methods for setting, getting, and removing data.
77. **Web Worker**: Use a web worker to offload computationally intensive tasks from the main thread, improving performance.
78. **Custom UI Components**: Create custom UI components, such as a modal dialog, date picker, or autocomplete, from scratch using HTML, CSS, and JavaScript/jQuery.
79. **Mobile-First Development**: Develop a webpage following the mobile-first approach, ensuring it looks and functions well on mobile devices and scales up to larger screens.
80. **Third-Party API Integration**: Integrate with a third-party API (e.g., Google Maps, Twitter, YouTube) and display data or content from that API on your webpage.
81. **Offline Support**: Implement offline support for a web application, allowing users to access content even when they have no internet connection.
82. **Browser Storage Encryption**: Implement encryption for data stored in browser storage (e.g., localStorage) to enhance security.
83. **WebGL Particle Animation**: Create a particle animation using WebGL, simulating effects like fire, rain, or fireworks.
84. **WebGL Data Visualization**: Develop a data visualization using WebGL to represent complex datasets in an interactive 3D format.
85. **Custom Drag and Drop**: Create a custom drag-and-drop functionality for elements on a webpage without relying on external libraries.
86. **Server-Side Rendering (SSR)**: Implement server-side rendering for a frontend framework (e.g., React, Angular) to improve initial page load performance.
87. **WebGL Shader Effects**: Build a WebGL-based shader effect, such as a water ripple effect or a dynamic particle system.
88. **Virtual DOM Implementation**: Implement a simplified virtual DOM (similar to React's virtual DOM) in JavaScript.
89. **Progressive Image Loading**: Develop an image loading technique that progressively loads images, starting with low-quality placeholders and improving to high-quality images.
90. **Touch and Gesture Events**: Implement touch and gesture events in a web application to provide touch-based interactions on mobile devices.
91. **Browser Storage Management**: Build a utility for managing browser storage (localStorage, sessionStorage) and provide methods for setting, getting, and removing data.
92. **Web Worker**: Use a web worker to offload computationally intensive tasks from the main thread, improving performance.
93. **Browser Storage Encryption**: Implement encryption for data stored in browser storage (e.g., localStorage) to enhance security.
94. **WebGL Particle Animation**: Create a particle animation using WebGL, simulating effects like fire, rain, or fireworks.
95. **WebGL Data Visualization**: Develop a data visualization using WebGL to represent complex datasets in an interactive 3D format.
96. **Custom Drag and Drop**: Create a custom drag-and-drop functionality for elements on a webpage without relying on external libraries.
## React
97. **React Component**: Create a simple React component (e.g., a button or a card) and render it on a webpage.
98. **State Management**: Build a React component that manages and displays state, such as a counter that increments when a button is clicked.
99. **Props and PropTypes**: Create a React component that accepts props and uses PropTypes to define and validate the expected props.
100. **Conditional Rendering**: Implement conditional rendering in a React component based on a condition like user authentication.
101. **Handling Events**: Add event handlers to React components (e.g., onClick, onChange) to make them interactive.
102. **Component Lifecycle**: Utilize component lifecycle methods (e.g., componentDidMount, componentDidUpdate) in a React component.
103. **Forms in React**: Create a form in a React component and manage its state as users input data.
104. **React Router**: Set up routing in a React application using React Router, with multiple routes and navigation.
105. **API Data Fetching**: Fetch data from an API in a React component and display it.
106. **Context API**: Use React's Context API to manage and share state or data across multiple components.
107. **Redux Setup**: Set up a Redux store, actions, and reducers in a React application.
108. **Redux State Management**: Implement state management with Redux, connecting React components to the Redux store.
109. **Redux Middleware**: Use Redux middleware (e.g., Thunk) to handle asynchronous actions in a Redux-powered React application.
110. **Authentication Flow**: Implement user authentication and authorization in a React application, including login and protected routes.
111. **React Hooks**: Rewrite class-based React components into functional components using hooks like useState and useEffect.
112. **Redux Saga**: Integrate Redux Saga for handling side effects (e.g., API calls) in a Redux-based React application.
113. **React Higher-Order Components (HOCs)**: Create a higher-order component (HOC) to add functionality to existing React components.
114. **Error Handling**: Implement error handling and display error messages in a React application.
115. **Optimizing Performance**: Optimize the performance of a React application by reducing unnecessary renders and using memoization.
116. **Unit Testing with React Testing Library**: Write unit tests for React components using React Testing Library and Jest.
117. **Server-Side Rendering (SSR) with React**: Set up server-side rendering (SSR) for a React application.
118. **Progressive Web App (PWA) with React**: Convert a React application into a Progressive Web App with offline support.
119. **Internationalization (i18n)**: Implement internationalization and localization in a React application.
120. **React Animation**: Add animations and transitions to React components using libraries like React Spring or Framer Motion.
121. **Data Pagination**: Implement data pagination in a React application, fetching and displaying data in chunks.
122. **Real-time Updates**: Enable real-time updates in a React application using WebSocket or a similar technology.
123. **Authentication with OAuth**: Implement OAuth-based authentication (e.g., OAuth 2.0) in a React application.
124. **Testing React Hooks**: Write unit tests for custom React hooks using React Testing Library and Jest.
125. **Custom React Router**: Build a custom router using React Router's low-level APIs to gain a deeper understanding of routing.
## Redux
126. **Redux Store**: Create a Redux store and define actions and reducers to manage state.
127. **Redux Actions and Reducers**: Implement Redux actions and reducers to handle specific features or data in a Redux store.
128. **Redux Middleware**: Add custom middleware to a Redux store to intercept and modify actions.
129. **Redux Thunk**: Use Redux Thunk middleware to handle asynchronous actions in a Redux store.
130. **Redux Saga**: Set up Redux Saga to manage side effects, such as API calls, in a Redux-powered application.
131. **Redux State Normalization**: Normalize the shape of the Redux store to efficiently manage relational data.
132. **Redux Selector Functions**: Create selector functions in a Redux application to efficiently retrieve and compute the derived state.
133. **Redux Immutable State**: Ensure that the Redux store's state remains immutable to prevent unintended mutations.
134. **Redux Persistence**: Implement state persistence in a Redux application, allowing the state to be saved and restored across sessions.
135. **Redux Testing**: Write unit tests for Redux actions, reducers, and selectors using testing libraries like Jest.
136. **Redux Middleware Testing**: Test Redux middleware, such as Thunk or Saga, to ensure correct behavior.
137. **Redux DevTools**: Integrate and use Redux DevTools to inspect and debug the Redux store.
138. **Redux Integration with React**: Connect a React application to a Redux store, dispatch actions, and map state to props.
139. **Redux Integration with Angular**: Integrate Redux with an Angular application using libraries like NgRx.
140. **Redux Integration with Vue.js**: Integrate Redux with a Vue.js application using libraries like Vuex.
## Angular
141. **Angular Component**: Create a simple Angular component and display it in a template.
142. **Angular Template Syntax**: Use Angular's template syntax to render dynamic content and data.
143. **Angular Two-Way Binding**: Implement two-way data binding in Angular to synchronize data between a component and its template.
144. **Angular Directives**: Use built-in and custom Angular directives to manipulate the DOM and control rendering.
145. **Angular Services**: Create and use Angular services to share data and logic across components.
146. **Angular Dependency Injection**: Apply dependency injection in Angular to inject services into components.
147. **Angular Routing**: Set up routing in an Angular application with multiple views and navigation.
148. **Angular Forms**: Build forms in Angular, including template-driven and reactive forms.
149. **HTTP Requests in Angular**: Make HTTP requests to retrieve data from an API in an Angular application.
150. **Angular Observables**: Use observables and the RxJS library to work with asynchronous data in Angular.
151. **Angular Pipes**: Create custom pipes in Angular to transform and format data in templates.
152. **Angular Directives**: Develop custom Angular directives to add behavior and interactivity to elements.
153. **Angular Modules**: Organize an Angular application into feature modules to improve maintainability.
154. **Angular Animation**: Implement animations and transitions in Angular components using Angular's animation features.
155. **Unit Testing in Angular**: Write unit tests for Angular components, services, and pipes using testing frameworks like Jasmine and Karma.
156. **End-to-End Testing in Angular**: Perform end-to-end (E2E) testing of an Angular application using tools like Protractor.
157. **Angular Routing Guards**: Create routing guards in Angular to control access to routes based on conditions like authentication.
158. **Angular Interceptors**: Implement interceptors in Angular to add global error handling, logging, or authentication to HTTP requests.
159. **Server-Side Rendering (SSR) with Angular**: Set up server-side rendering (SSR) for an Angular application.
160. **Angular Internationalization (i18n)**: Implement internationalization and localization in an Angular application.
161. **Angular Lazy Loading**: Optimize an Angular application by lazy-loading feature modules.
162. **Angular Custom Forms**: Create custom form controls and validators in Angular for complex form scenarios.
163. **Angular Testing Best Practices**: Apply best practices for testing Angular applications, including component testing and mocking dependencies.
164. **Angular Material**: Integrate and use Angular Material components and styles in an Angular application.
165. **Angular State Management**: Implement state management in an Angular application using libraries like NgRx.
## Vue.js
166. **Vue.js Instance**: Create a Vue.js instance and render data in a template.
167. **Vue.js Data Binding**: Implement data binding in Vue.js to update the UI based on changes in data.
168. **Vue.js Directives**: Use Vue.js directives to manipulate the DOM and add behavior to templates.
169. **Vue.js Components**: Create Vue.js components and pass data between parent and child components.
170. **Vue.js Event Handling**: Handle user events in Vue.js components and trigger actions.
171. **Vue.js Forms**: Build forms in Vue.js and manage form data using directives and methods.
172. **Vue.js Routing**: Set up routing in a Vue.js application with multiple views and navigation.
173. **Vue.js State Management**: Manage application state in Vue.js using Vuex.
174. **Vue.js HTTP Requests**: Make HTTP requests to fetch data from an API in a Vue.js application.
175. **Vue.js Lifecycle Hooks**: Utilize Vue.js lifecycle hooks to perform actions at different stages of a component's lifecycle.
176. **Vue.js Custom Directives**: Create custom directives in Vue.js to extend functionality.
177. **Vue.js Filters**: Define and use custom filters in Vue.js to format and transform data in templates.
178. **Vue.js Transitions and Animations**: Add transitions and animations to Vue.js components for smooth UI effects.
179. **Vue.js Unit Testing**: Write unit tests for Vue.js components using testing libraries like Jest.
180. **Vue.js End-to-End Testing**: Perform end-to-end (E2E) testing of a Vue.js application using tools like Cypress.
181. **Vue.js Routing Guards**: Create routing guards in Vue.js to control access to routes based on conditions like authentication.
182. **Vue.js Server-Side Rendering (SSR)**: Set up server-side rendering (SSR) for a Vue.js application.
183. **Vue.js Internationalization (i18n)**: Implement internationalization and localization in a Vue.js application.
184. **Vue.js Lazy Loading**: Optimize a Vue.js application by lazy-loading components and routes.
185. **Vue.js Composition API**: Develop components using the Vue.js Composition API for more flexible and reusable code.
186. **Vue.js Custom Directives**: Create custom directives in Vue.js to extend functionality.
187. **Vue.js Filters**: Define and use custom filters in Vue.js to format and transform data in templates.
188. **Vue.js Transitions and Animations**: Add transitions and animations to Vue.js components for smooth UI effects.
189. **Vue.js Unit Testing**: Write unit tests for Vue.js components using testing libraries like Jest.
190. **Vue.js End-to-End Testing**: Perform end-to-end (E2E) testing of a Vue.js application using tools like Cypress.
191. **Vue.js Routing Guards**: Create routing guards in Vue.js to control access to routes based on conditions like authentication.
192. **Vue.js Server-Side Rendering (SSR)**: Set up server-side rendering (SSR) for a Vue.js application.
193. **Vue.js Internationalization (i18n)**: Implement internationalization and localization in a Vue.js application.
194. **Vue.js Lazy Loading**: Optimize a Vue.js application by lazy-loading components and routes.
195. **Vue.js Composition API**: Develop components using the Vue.js Composition API for more flexible and reusable code.
| This Repository contains List of Frontend Development Interview Questions | api,css3,es6,html5,javascript,nodejs,reactjs,redux,rest-api,sass-framework | 2023-09-29T05:19:03Z | 2023-11-07T03:21:40Z | null | 1 | 0 | 8 | 0 | 20 | 104 | null | null | null |
HarshwardhanPatil07/HactoberFest2023 | main | # HactoberFest2023
A Simple😉 beginner friendly😊 Repo for all programmers and coders. All contributors are requested to star🌟this repo and and follow me. Contribute to start your journey with hacktoberfest. Happy Hacking💻!!!
# 🌟Languages
- 💻 C
- 💻 C++
- 💻 PHP
- 💻 Python
- 💻 Java
- 💻 Javascript
- 💻 CSS
- 💻 HTML
- 💻 Nodejs
# 🛡Rules to Contribute
- ⚓Star this repo to get latest updates.
- ⚓Give your file a proper extension according to language. Ex. .py, .java, .js. html etc.
- ⚓Name your file related to your topic.
- ⚓Put your files in correct folder like .py in Python, .js in Javascript etc.
- ⚓Make sure you have entered your github - username, aim and date in your file as a comment.
- ⚓Make sure you have entered your name in CONTRIBUTORS.md file as mentioned (It's your responsibility) (optional).
- ⚓You can follow ME😁.
### ⚡If you are creating any PR then Add your name in CONTRIBUTORS.md file
## 🛡Follow rules strictly for successful merged PR!!!
# ❄Programs
- ⚡Create any pattern
- ⚡Make any algorithm (exclude calculator or related to it)
- ⚡Print 1 to 100 without using numbers
- ⚡Make calculator without using operators in program
- ⚡Calculate fibonacci series with classes
- ⚡Calculate factorial with classes
- ⚡Print IP Address and Hostname
## Don't forget to read the contributing rules above to be successfully merged your PR and get rewards!!!
🏹 Visit <a href="hacktoberfest.com" target="_blank">Hacktoberfest</a> to get more information about Hacktoberfest 2023!!!
# 🛡 Strictly follow rules to contribute for successful merged PR!!!
# Note
All contributors who have followed the rules to contribute get successfully merged PR. Don't forget to follow!!!
Have some patience to get successfully merged PR. Keep Patience!!!
# HAPPY HACKING🤞❤💻!!!
| A Simple😉 beginner friendly😊 Repo for all programmers and coders. All contributors are requested to star🌟this repo and and folllllow me. Contribute to start your journey with hacktoberfest. Happy Hacking💻!!! | aws,c,cpp,css,html,java,javascript,nodejs,php,python | 2023-10-09T09:04:27Z | 2023-12-20T07:42:00Z | null | 73 | 253 | 304 | 1 | 245 | 96 | null | MIT | Jupyter Notebook |
zya/litellmjs | main | <h1 align="center">
🚅 LiteLLM.js
</h1>
<p align="center">
<p align="center">JavaScript implementation of <a href="https://github.com/BerriAI/litellm">LiteLLM</a>. </p>
</p>
# Usage
```
npm install litellm
```
```ts
import { completion } from 'litellm';
process.env['OPENAI_API_KEY'] = 'your-openai-key';
const response = await completion({
model: 'gpt-3.5-turbo',
messages: [{ content: 'Hello, how are you?', role: 'user' }],
});
// or stream the results
const stream = await completion({
model: "gpt-3.5-turbo",
messages: [{ content: "Hello, how are you?", role: "user" }],
stream: true
});
for await (const part of stream) {
process.stdout.write(part.choices[0]?.delta?.content || "");
}
```
# Features
We aim to support all features that [LiteLLM python package](https://github.com/BerriAI/litellm) supports.
* Standardised completions
* Standardised embeddings
* Standardised input params 🚧 - List is [here](/docs/input-params.md)
* Caching ❌
* Proxy ❌
## Supported Providers
| Provider | Completion | Streaming | Embedding
| ------------- | ------------- | ------------- | ------------- |
| [openai](https://docs.litellm.ai/docs/providers/openai) | ✅ | ✅ | ✅ |
| [cohere](https://docs.litellm.ai/docs/providers/cohere) | ✅ | ✅ | ❌ |
| [anthropic](https://docs.litellm.ai/docs/providers/anthropic) | ✅ | ✅ | ❌ |
| [ollama](https://docs.litellm.ai/docs/providers/ollama) | ✅ | ✅ | ✅ |
| [ai21](https://docs.litellm.ai/docs/providers/ai21) | ✅ | ✅ | ❌ |
| [replicate](https://docs.litellm.ai/docs/providers/replicate) | ✅ | ✅ | ❌ |
| [deepinfra](https://docs.litellm.ai/docs/providers/deepinfra) | ✅ | ✅ | ❌ |
| [mistral](https://docs.litellm.ai/docs/providers/mistral) | ✅ | ✅ | ✅ |
| [huggingface](https://docs.litellm.ai/docs/providers/huggingface) | ❌ | ❌ | ❌ |
| [together_ai](https://docs.litellm.ai/docs/providers/togetherai) | ❌ | ❌ | ❌ |
| [openrouter](https://docs.litellm.ai/docs/providers/openrouter) | ❌ | ❌ | ❌ |
| [vertex_ai](https://docs.litellm.ai/docs/providers/vertex) | ❌ | ❌ | ❌ |
| [palm](https://docs.litellm.ai/docs/providers/palm) | ❌ | ❌ | ❌ |
| [baseten](https://docs.litellm.ai/docs/providers/baseten) | ❌ | ❌ | ❌ |
| [azure](https://docs.litellm.ai/docs/providers/azure) | ❌ | ❌ | ❌ |
| [sagemaker](https://docs.litellm.ai/docs/providers/aws_sagemaker) | ❌ | ❌ | ❌ |
| [bedrock](https://docs.litellm.ai/docs/providers/bedrock) | ❌ | ❌ | ❌ |
| [vllm](https://docs.litellm.ai/docs/providers/vllm) | ❌ | ❌ | ❌ |
| [nlp_cloud](https://docs.litellm.ai/docs/providers/nlp_cloud) | ❌ | ❌ | ❌ |
| [aleph alpha](https://docs.litellm.ai/docs/providers/aleph_alpha) | ❌ | ❌ | ❌ |
| [petals](https://docs.litellm.ai/docs/providers/petals) | ❌ | ❌ | ❌ |
# Development
## Clone the repo
```
git clone https://github.com/zya/litellmjs.git
```
## Install dependencies
```
npm install
```
## Run unit tests
```
npm t
```
## Run E2E tests
First copy the example env file.
```
cp .example.env .env
```
Then fill the variables with your API keys to be able to run the E2E tests.
```
OPENAI_API_KEY=<Your OpenAI API key>
....
```
Then run the command below to run the tests
```
npm run test:e2e
``` | JavaScript implementation of LiteLLM. | javascript,llama2,llm,nodejs,ollama,openai | 2023-10-03T22:42:27Z | 2024-01-03T23:06:05Z | 2024-01-03T23:06:05Z | 4 | 8 | 97 | 1 | 12 | 70 | null | MIT | TypeScript |
devcarlosalberto/pix-payload | main | # Package Pix Payload
Use it when you need to generate a pix payload following the pix standardization rules. This payload can be transformed into a QR Code or, for example, used for PIX "copy & paste".
## 🔧 Installation
Install the public package:
```bash
npm i pix-payload
```
## 👨💻 How To Use
```javascript
import { payload } from "pix-payload"
const data = {
key: "devcarlosalberto@gmail.com",
name: "Carlos Alberto",
city: "Praia Grande",
amount: 150,
transactionId: "PAY123",
}
const myPayload = payload(data)
```
The parameters when calling the payload() function are these and must be inside an object:
`key: string`<br/>
`name: string`<br/>
`city: string`<br/>
`amount?: number`<br/>
`transactionId?: string`<br/>
The values accepted as pix key are listed below and must follow the formatting pattern followed by their respective example:
*CPF*: `12345678900`<br/>
*CNPJ*: `00038166000105`<br/>
*E-mail*: `fulano_da_silva.recebedor@example.com`<br/>
*Phone*: `+5561912345678`<br/>
## 🕹️ Functions
- Create payload PIX
## 🚀 Technologies
Thats project has utilized following technologies:
- Typescript
## 🔗 Links
[](https://devcarlosalberto.netlify.app)
[](https://www.linkedin.com/in/devcarlosalberto)
## Authors
- [@devcarlosalberto](https://www.github.com/devcarlosalberto)
| Published package on NPM. Use it when you need to generate a pix payload following the pix standardization rules. This payload can be transformed into a QR Code or, for example, used for PIX "copy & paste". | javascript,npm-package,typescript | 2023-10-10T05:04:07Z | 2023-10-10T15:02:30Z | null | 1 | 0 | 4 | 1 | 1 | 68 | null | null | TypeScript |
prinsss/export-twitter-following-list | master | # export-twitter-following-list
[](https://www.tampermonkey.net/)
**Export your Twitter/X's following/followers list like a breeze.**
The script supports exporting:
轻松导出你的 Twitter/X 关注列表与关注者列表。本脚本支持导出：
- User's following list (用户的正在关注)
- User's followers list (用户的关注者/粉丝)
- List's members list (列表包含的用户)
- List's followers list (关注此列表的用户)
> Introducing my new project [twitter-web-exporter](https://github.com/prinsss/twitter-web-exporter), a completely rewritten version of this script, which is a more powerful tool for exporting Twitter data, including tweets, replies, likes, bookmarks, following, followers and more.
>
> 广告：全新脚本 [twitter-web-exporter](https://github.com/prinsss/twitter-web-exporter) 现已发布，不仅支持本脚本的全部功能，还可以导出推文、回复、点赞、书签等更多数据。
## Installation / 安装
1. Install the browser extension [Tampermonkey](https://www.tampermonkey.net/) (安装浏览器扩展 [Tampermonkey](https://www.tampermonkey.net/))
2. Click [here](https://raw.githubusercontent.com/prinsss/export-twitter-following-list/master/export-twitter-following-list.user.js) to install the user script (点击 [安装用户脚本](https://raw.githubusercontent.com/prinsss/export-twitter-following-list/master/export-twitter-following-list.user.js))
## Usage / 使用
Once the user script is installed, navigate to your following list and you will see a floating panel on the left side of the page:
脚本安装完成后，进入你的用户关注页面，可以看到左侧的悬浮面板：
The control panel will automatically show on supported pages and will hide otherwise. You can not only export following/followers list of yourself but also export for other users.
当你进入支持导出的页面时，控制面板会自动打开，在其他页面则会自动隐藏。你不仅可以导出自己的关注/关注者列表，还可以导出其他人的关注/关注者列表。
Click "Start" button to start extracting data from current list. The active list container will be decorated with a blue border.
点击「Start」按钮开始从当前列表中提取信息，当前正在操作的列表会有蓝色边框提示。
Since we are using an different approach by leveraging the Web API of Twitter itself, instead of the official programmatic API, we need to make sure that Twitter loaded enough data for the list to be exported completely.
我们与传统类似工具不同，使用的是 Twitter 自身的 Web API 来获取关注列表，而非其官方的开发者 API。因此，你需要保证 Twitter 自身加载完了列表的全部内容，这样最终导出的列表才是完整的。
When you scroll down the page, Twitter will lazy-load the list data and the script will intercept it and save the API responses to a local database. The items saved to the memory is marked as "✅" on the list, with a number indicating its sorting index.
当你往下滚动页面时，Twitter 会以瀑布流的形式不断加载剩余的列表。此脚本会监听相关的 API 调用，并将 API 响应保存至浏览器的本地数据库。已经保存的列表内容会使用「✅」标记出来，后面的数字代表了其在这个列表中的排列顺序。
Keep scrolling down until the end of the list, and "Saved count" number on the control panel should matches the list length.
随后，持续向下滚动页面，直到到达列表底端。此时控制面板中显示的「Saved count」已保存数量应该与列表长度相同。
Click "Preview" button will show a table of currently saved list content in memory. If you are okay with it, click "Export as CSV/JSON/HTML" to download an archive file.
点击「Preview」按钮即可以表格形式预览当前已经暂存的列表数据。如果没问题，点击「Export as」按钮即可导出 CSV/JSON/HTML 格式的列表归档数据。
> Tips: The user data retrieved from API responses is persisted in browser's IndexedDB. Open your browser's DevTools or use the "Dump Database" button to inspect it.
>
> 小提示：从 API 响应中保存的用户数据都持久化存储在浏览器的 IndexedDB 中。你可以使用浏览器的开发者工具，或者控制面板的「Dump Database」按钮来查看数据库的内容。
## FAQ / 常见问题
Q: What about privacy?<br>
A: Everything is processed on your local browser. No data is sent to the cloud.
Q: Why do you build this?<br>
A: For archival usage. Twitter's archive only contains the numeric user ID of your following/followers which is not human-readable.
Q: What's the difference between this and other alternatives?<br>
A: You don't need a developer account for accessing the Twitter API. You don't need to send your personal data to someone's server. The script is completely free and open-source.
Q: The script does not work!<br>
A: A platform upgrade will possibly breaks the script's functionality. Please file an [issue](https://github.com/prinsss/export-twitter-following-list/issues) if you encountered any problem.
Q: 这个脚本如何处理隐私数据？<br>
A: 所有数据都在你的本地浏览器中处理完成，不会被发送到云端。
Q: 你开发这个脚本的原因是？<br>
A: 为了个人存档使用。Twitter 官方的归档功能只包含了关注列表和关注者的数字用户 ID，人类根本不可读。
Q: 这个脚本与其他类似工具有什么区别？<br>
A: 无需注册 Twitter 开发者账号；无需将个人数据上传至第三方服务器；完全免费开源。
Q: 脚本无法正常工作！<br>
A: 平台的升级改动可能会导致此脚本的功能失效。如果你遇到任何问题，请提交 [issue](https://github.com/prinsss/export-twitter-following-list/issues) 反馈。
## License / 开源许可
MIT
| Export your Twitter/X's following/followers list like a breeze. (关注列表与关注者列表导出工具) | exporter,followers,following,twitter,twitter-api,tampermonkey,userscript,javascript | 2023-09-17T00:59:30Z | 2023-12-31T17:20:18Z | null | 1 | 0 | 7 | 0 | 2 | 61 | null | MIT | JavaScript |
TechShreyash/AnimeDexLite | main | ## ⚠️ **Note: This Project Is Stopped**
The **AnimeDexLite Project** has been discontinued. I have made this decision to avoid potential copyright claims in the future. As a result, all public domains and APIs hosted by me are now inactive.
The code for the website and API will remain accessible for anyone who wishes to experiment with it or make modifications. However, please be aware that there will be no further updates or releases from my side.
Thank you for your understanding and support during the project's active phase! 🙌🌟
### Project Links :
<p>Telegram Support Group : <a href=https://telegram.me/TechZBots_Support>@TechZBots_Support</a>
<p>AnimeDexLite Repository : <a href=https://github.com/TechShreyash/AnimeDexLite>TechShreyash/AnimeDexLite</a>
<p>AnimeDex Api Repository : <a href=https://github.com/TechShreyash/AnimeDexApi>TechShreyash/AnimeDexApi</a>
<p>AnimeDex Proxy Repository : <a href=https://github.com/TechShreyash/CloudflareWorker/tree/main/animedexproxy>TechShreyash/animedexproxy</a>
<p>ThumbGen Api Repository : <a href=https://github.com/TechShreyash/ThumbApi>TechShreyash/ThumbApi</a>
<p>Stats Api Repository : <a href=https://github.com/TechShreyash/StatsApi>TechShreyash/StatsApi</a>
[](https://animedex.pages.dev)
<h1 align="center"><b>AnimeDexLite v3.0</b></h1>
AnimeDexLite is a pure HTML, CSS, and JS version of AnimeDex. It is lightweight, fast, ad-free, open-source, and easy to deploy. The design is responsive, and it uses Gogoanime and Anilist to get content. Powered by the blazing-fast [AnimeDexApi](https://api.anime-dex.workers.dev).
<p align="center">
<img src="https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgithub.com%2FTechShreyash%2FAnimeDexLite&count_bg=%2379C83D&title_bg=%23555555&icon=github.svg&icon_color=%23E7E7E7&title=Page+Views&edge_flat=false"/>
</p>
## 🌐 Demo
- Run On Your PC : https://github.com/TechShreyash/AnimeDexLite?tab=readme-ov-file#-run-on-your-pc
## 🔥 Host Your Own
### 🆓 Free Hostings
You have several options for free hosting services:
- Cloudflare, Netlify, Github Pages, Vercel, Render
- And Many More! Search On Google For `Free Static Website Hostings`
### 💰 Paid Hostings
If you prefer paid hosting, look for services that allow using HTML files. Search on Google for `Static Website Hostings`
### 🏠 Run On Your PC
To run AnimeDexLite on your local machine:
- Download this repository
- Open the `index.html` file in a browser
## 🚀 Deploy AnimeDexApi (Required)
- You must deploy AnimeDexApi for AnimeDexLite to work
- You can deploy AnimeDexApi for free on cloudflare workers
- [AnimeDexApi](https://github.com/TechShreyash/AnimeDexApi) : API to get all anime data.
<details>
<summary>Add your Api to your site</summary>
> - Open [js folder](js), there is a AvailableServers variable at top of every js file
> - By default it is like this `const AvailableServers = ["https://api.anime-dex.workers.dev"];`
> - Change this `https://api.anime-dex.workers.dev` to your api domain
> - You can add multiple api domain too, just seperate it with commas
</details>
## 🎯 Deploy AnimeDex Proxy (Recommended)
- [AnimeDexProxy](https://github.com/TechShreyash/CloudflareWorker/tree/main/animedexproxy) : Proxy to bypass CORS errors.
<details>
<summary>Add your Proxy to your site</summary>
> - Open [js folder](js), there is a ProxyApi variable at top of every js file
> - By default it is like this `const ProxyApi = "https://proxy.techzbots1.workers.dev/?u="`
> - Change this `https://proxy.techzbots1.workers.dev` to your api domain
> - You must include `/?u=` in the url
</details>
## 🔔 Join For Latest Updates
Stay informed about the latest updates by joining our channels / groups :
[](https://telegram.me/TechZBots) [](https://telegram.me/TechZBots_Support)
| AnimeDex Lite Version, Watch Animes For Free | anime,anime-downloader,anime-scraper,anime-streaming,anime-website,animedex,css,gogoanime,html,javascript | 2023-10-08T10:41:37Z | 2024-03-31T13:25:47Z | 2024-03-04T14:08:39Z | 2 | 16 | 138 | 0 | 80 | 60 | null | null | CSS |
instant-dev/orm | main | # Instant ORM
 
## JavaScript ORM for Postgres with built-in Vector Support
This is the core ORM package for [**`instant.dev`**](https://github.com/instant-dev/instant).
It is recommended that you use it with the `instant` command line utility
available at [instant-dev/instant](https://github.com/instant-dev/instant) for
easy migration management, **however, it can be used as a standalone ORM**. By
default, upon connecting to a database, the Instant ORM will introspect your
Database schema and determine appropriate models and relationships.
## Table of Contents
1. [Getting Started](#getting-started)
1. [Connecting to a Database](#connecting-to-a-database)
1. [Connecting to another Database](#connecting-to-another-database)
1. [Querying your databases directly](#querying-your-databases-directly)
1. [Disconnecting](#disconnecting)
1. [Loading a Schema](#loading-a-schema)
1. [Loading custom Model logic](#loading-custom-model-logic)
1. [Using Models](#using-models)
1. [CRUD operations](#crud-operations)
1. [Create](#create)
1. [Read](#read)
1. [Update](#update)
1. [Incrementing values and custom SQL](#incrementing-values-and-custom-sql)
1. [Destroy](#destroy)
1. [Vector fields](#vector-fields)
1. [Setting a vector engine](#setting-a-vector-engine)
1. [Setting a vector engine globally](#setting-a-vector-engine-globally)
1. [Using vector fields](#using-vector-fields)
1. [Query composition](#query-composition)
1. [Composer instance methods](#composer-instance-methods)
1. [Composer#safeWhere](#composersafewhere)
1. [Composer#safeJoin](#composersafejoin)
1. [Composer#where](#composerwhere)
1. [Custom SQL](#custom-sql)
1. [Composer#join](#composerjoin)
1. [One-to-many](#one-to-many)
1. [One-to-one](#one-to-one)
1. [Naming conventions](#naming-conventions)
1. [Composer#orderBy](#composerorderby)
1. [Composer#limit](#composerlimit)
1. [Composer#groupBy](#composergroupby)
1. [Composer#aggregate](#composeraggregate)
1. [Composer#search](#composersearch)
1. [Composer#similarity](#composersimilarity)
1. [Transactions](#transactions)
1. [Input validation](#input-validation)
1. [Relationship verification](#relationship-verification)
1. [Calculated and hidden fields](#calculated-and-hidden-fields)
1. [Lifecycle callbacks](#lifecycle-callbacks)
1. [Using Migrations, Seeding and Code Generation](#using-migrations-seeding-and-code-generation)
1. [Acknowledgements](#acknowledgements)
## Getting Started
Installing the Instant ORM:
```shell
npm i @instant.dev/orm@latest --save
```
Initializing (CommonJS):
```javascript
const InstantORM = require('@instant.dev/orm');
const Instant = new InstantORM();
```
Initializing (ESM):
```javascript
import InstantORM from '@instant.dev/orm';
const Instant = new InstantORM();
```
## Connecting to a Database
By default, the Instant ORM will attempt to load database credentials from
`_instant/db.json[process.env.NODE_ENV]["main"]`:
```javascript
await Instant.connect(); // connects based on _instant/db.json
```
However, you can also provide custom credentials to any database you'd like
by passing in a `cfg` configuration object with the credentials in the following
format:
```javascript
const cfg = {
host: 'my.postgres.host',
port: 5432,
user: 'postgres',
password: '',
database: 'postgres',
ssl: false, // optional: acceptable values are [true, false, "unauthorized"]
in_vpc: false, // optional: if false, will use provided SSH tunnel when deployed
tunnel: { // optional: use this if we need to SSH tunnel into database
host: 'my.ssh.host.com',
port: 22,
user: 'ec2-user',
private_key: 'path/to/private_key.pem'
}
};
await Instant.connect(cfg); // now connected to custom Database
```
You can also opt to provide a `connectionString` instead:
```javascript
const cfg = {
connectionString: 'postgres://postgres:mypass@my.postgres.host:5432/postgres?sslmode=true',
in_vpc: false, // optional: if false, will use provided SSH tunnel when deployed
tunnel: { // optional: use this if we need to SSH tunnel into database
host: 'my.ssh.host.com',
port: 22,
user: 'ec2-user',
private_key: 'path/to/private_key.pem'
}
};
await Instant.connect(cfg); // now connected to custom Database
```
### Connecting to another database
By default, the `Instant.connect()` method will assign your initial database
connection the alias `"main"`. You can access your Database object directly
via:
```javascript
const db = Instant.database();
const mainDb = Instant.database('main');
console.log(db === mainDb); // true, "main" is an alias for your main db
```
To connect to another database, simply use:
```javascript
// connect
Instant.addDatabase(name, cfg);
// read
const otherDb = Instant.database(name);
```
### Querying your databases directly
Querying your database directly is easy. To run a standalone query;
```javascript
const db = Instant.database();
const result = await db.query(`SELECT * FROM my_table WHERE x = $1`, [27]);
```
To execute a batched transaction from prepared statements and queries;
```javascript
const db = Instant.database();
// Pass in an array of statements
const result = await db.transact([
`SELECT * FROM my_table`,
`INSERT INTO my_table(field) VALUES((1))`,
// Parameterized statements can be passed in as well
[`INSERT INTO my_other_table(other_field) VALUES(($1))`, [2]]
]);
```
And to create a transaction that you want to work with in real-time, potentially
querying third party services before deciding whether or not to commit the query:
```javascript
const db = Instant.database();
const txn = db.createTransaction();
let result = await txn.query(`SELECT * FROM my_table WHERE x = $1`, [27]);
let result2 = await txn.query(`INSERT INTO my_table(field) VALUES(($1))`, [5]);
let manyQueries = await txn.transact([
`SELECT * FROM my_table`,
`INSERT INTO my_table(field) VALUES((1))`,
]);
// to commit
await txn.commit();
// to rollback
await txn.rollback();
```
### Disconnecting
To disconnect from a specific database:
```javascript
Instant.closeDatabase(name);
```
And to disconnect from all open databases and reset your connection:
```javascript
await Instant.disconnect();
```
## Loading a Schema
When you connect to a database, Instant ORM will attempt to determine the
schema of your database in a few ways.
- First, it will check to see if `_instant/cache/schema.json` exists
- If it does, it will load the schema from this file
- Next, it will check to see if an `_instant_migrations` table exists in your
database
- This table holds all migrations applied to the database and is generated by
the [instant.dev](https://github.com/instant-dev/instant) CLI automatically
- If it does exist and has entries, it will load the schema from the latest
migration
- Finally, it will introspect your database structure
- All tables, columns, sequences and constraints will be inspected
- Foreign keys and uniqueness will be used to determine one-to-one and
one-to-many relationships
Additionally, you can also pass a custom `schema` object to the
`Instant.connect(cfg)` method as a second argument, but this is
**not recommended**. It is usually reserved for testing purposes.
## Loading custom Model logic
By default, the Instant ORM will load models from the `_instant/models`
directory.
**You do not need a model file for every, or even any, table in your database**.
These are only meant to extend models in the case you want to add
[Lifecycle callbacks](#lifecycle-callbacks), validations, verifications,
calculated fields or hide data. Each file should look something like this;
File: `_instant/models/sample_model.mjs`
```javascript
import InstantORM from '@instant.dev/orm';
class SampleModel extends Model {
static tableName = 'sample_models';
async beforeSave (txn) {}
async afterSave (txn) {}
async beforeDestroy (txn) {}
async afterDestroy (txn) {}
}
SampleModel.calculates(/* ... */);
SampleModel.validates(/* ... */);
SampleModel.verifies(/* ... */);
SampleModel.hides(/* ... */);
export default SampleModel;
```
The Instant ORM will automatically associate each file with the appropriate
table in your database schema, provided `SampleModel.tableName` matches a table
on your Database. You can access your Models using;
```javascript
// Note that "SampleModels", "samplemodel", "sample_models" etc.
// will all work as well as long as there's no ambiguity
Instant.Model('SampleModel');
```
## Using Models
Models are accessible via the `Instant.Model(modelName)` method. This method
will automatically look up the most likely model based on the matching `table`
in your database schema.
```javascript
const User = Instant.Model('User');
```
This method would also accept the strings `Users`, `user`, `users`. If your
table has pluralization and underscores we recommend using the singular version,
but you can access using the table name as well. For example, the table name
`object_children` could be accessed via:
```javascript
const ObjectChild = Instant.Model('ObjectChild'); // recommended
```
However, the following would also work:
```javascript
Instant.Model('ObjectChildren');
Instant.Model('object_child');
Instant.Model('object_children');
```
In the case of ambiguity - multiple tables potentially matching the object name -
`Instant.Model()` will throw an error and ask you to use the specific table.
### CRUD Operations
#### Create
You can create new model instances and save them to the database with
`Model.create(data)` or `new Model(data)` and then a subsequent `model.save()`:
```javascript
const User = Instant.Model('User');
// Model.create() method creates a user:
let user1 = await User.create({email: 'keith@instant.dev', username: 'keith'});
console.log(user1.inStorage()); // true
// Can also use new Model() and then save it
let user2 = new User({email: 'scott@instant.dev'});
user2.set('username', 'scott'); // can set values independently
console.log(user2.inStorage()); // false
await user2.save();
console.log(user2.inStorage()); // true
```
#### Read
Reading model data can be done in a few ways: `Model.find()`, `Model.findBy()`
or via [Query composition](#query-composition) using the `query.select()`
method.
```javascript
let user1 = await User.find(1); // uses id
let user2 = await User.findBy('email', 'keith@instant.dev');
let user3 = await User.query()
.where({email: 'keith@instant.dev'})
.first(); // throws error if not found
let userList = await User.query()
.where({email: 'keith@instant.dev'})
.select(); // can return an empty list
let userCount = await User.query()
.where({email: 'keith@instant.dev'})
.count();
```
#### Update
Updating model data can be performed by (1) updating and saving individual
models, (2) update and saving ModelArrays, (3) `Model.updateOrCreateBy()` or
(4) [Query composition](#query-composition) using the `query.update()` method.
**Note:** `query.update()` will bypass model lifecycle methods `beforeSave()`
and `afterSave()` as well as all validations verifications. Read more in
[Lifecycle callbacks](#lifecycle-callbacks).
```javascript
let user = await user.findBy('username', 'keith');
user.set('username', 'keith_h');
await user.save();
// Update by reading from data
user.read({username: 'keith_h2'});
await user.save();
// Save many models at once using ModelArrays
// Let's make all our moderators superusers
let users = await User.query()
.where({is_moderator: true})
.select();
users.setAll('is_superuser', true);
await users.saveAll();
// Can also use `readAll`
users.readAll({free_credits: 100});
await users.saveAll();
// Can update models directly with new data if there's a matching entry
user = await User.updateOrCreateBy(
'username',
{username: 'keith_h2', email: 'keith+new@instant.dev'}
);
// Bypass lifecycle callbacks, validations and verifications
// Useful for updating many models at once and batch processing
users = await User.query()
.where({username: 'keith_h2'})
.update({username: 'keith'});
```
##### Incrementing values and custom SQL
You can run custom SQL when updating models using the `query.update()` method.
**This will bypass [Lifecycle callbacks](#lifecycle-callbacks)**. However it is
the most efficient way to do things like incrementing values.
```javascript
const user = User.findBy('email', 'keith@instant.dev');
await User.query()
.where({user_id: user.get('id')})
.update({post_count: (post_count) => `${post_count} + 1`});
```
In this case, the `post_count` variable will hold the query column reference.
You can reference multiple fields by including more fields in the function
arguments:
```javascript
const user = User.findBy('email', 'keith@instant.dev');
await User.query()
.where({user_id: user.get('id')})
.update({
post_count: (post_count) => `${post_count} + 1`,
karma: (karma, post_count) => `${karma} + LOG(${post_count})`
});
```
Any valid SQL expression can be returned by these methods.
#### Destroy
We purposefully **do not** include a `delete` method in
[Query composition](#query-composition). In most application contexts,
permanently deleting records is bad practice from a security and monitoring
perspective. We usually recommend `is_archived` or `is_deleted` flags.
In the case you really do need to delete records, there is a `Model.destroy(id)`
method, a `model.destroy()` method and a `modelArray.destroyAll()` method.
We also provide `model.destroyCascade()` and `modelArray.destroyCascade()` for
a cascading delete if foreign key constraints prevent deleting a model directly.
```javascript
await User.destroy(100); // goodbye User(id=100)!
let user = await User.findBy('email', 'nouser@instant.dev');
await user.destroy();
let user2 = await User.findBy('email', 'nouser2@instant.dev');
await user2.destroyCascade(); // destroy model + children (useful for foreign keys)
/* ModelArray methods */
let bannedUsers = await User.query().where({is_banned: true}).select();
await bannedUsers.destroyAll();
let mutedUsers = await User.query().where({is_muted: true}).select();
await mutedUsers.destroyCascade();
```
### Vector fields
Instant ORM comes with built-in support for [pgvector](https://github.com/pgvector/pgvector) and the
`vector` field type. To install `pgvector` locally, follow the instructions in the GitHub repo above.
**Note:** In order to use vector fields, `pgvector` will need to be enabled on every database
you're working with. To enable `pgvector`, assuming it is installed and you are using the
[instant.dev CLI](https://github.com/instant-dev/instant), run:
```shell
instant db:ext vector --enable # enable for local
instant db:ext vector --enable --env staging # enable for staging
instant db:ext vector --enable --env production # enable for production ... and so on
```
Or you can also simple `psql` into your database and run:
```sql
CREATE EXTENSION vector;
```
Database providers with built-in `pgvector` support include:
- AWS RDS for PostgreSQL (15+) ([announcement](https://aws.amazon.com/about-aws/whats-new/2023/05/amazon-rds-postgresql-pgvector-ml-model-integration/))
- [Vercel Postgres](https://vercel.com/docs/storage/vercel-postgres)
- [Neon](https://neon.tech)
- [Supabase](https://supabase.com)
#### Setting a vector engine
Instant ORM uses the [@instant.dev/vectors](https://github.com/instant-dev/vectors) package to
make creating vectors a breeze. It will automatically handle batching requests to OpenAI or
any other third party vector service.
To set a vector engine, you can use `Instant.Vectors.setEngine()` like so:
```javascript
// values will automatically be batched appropriately
Instant.Vectors.setEngine(async (values) => {
const embeddingResult = await openai.embeddings.create({
model: 'text-embedding-ada-002',
input: values,
});
return embeddingResult.data.map(entry => entry.embedding);
});
```
#### Setting a vector engine globally
**Quickstart:** If you are using the [instant.dev CLI](https://github.com/instant-dev/instant),
you can simply run `instant kit vector`. It will set up a plugin automatically.
To automatically load a vector engine, we will need to add a **plugin**. These are executed
as part of lifecycle events when using the Instant ORM. You'll need to create a file:
File `_instant/000_set_vector_engine.mjs`:
```javascript
import OpenAI from 'openai';
const openai = new OpenAI({apiKey: process.env.OPENAI_API_KEY});
export const plugin = async (Instant) => {
Instant.Vectors.setEngine(async (values) => {
const embedding = await openai.embeddings.create({
model: 'text-embedding-ada-002',
input: values
});
return embedding.data.map((entry, i) => entry.embedding);
});
};
```
Plugins **must** export a `plugin` function. Plugins are executed in the
alphabetized order they exist in the filesystem, with directories being loaded first.
#### Using vector fields
Using vector fields is easy. The vector engine, specified above, will do all the heavy lifting
of converting strings to vectors and `pgvector` will handle comparisons automatically.
To automatically populate vector fields when models are saved:
File: `_instant/models/blog_post.mjs`
```javascript
import InstantORM from '@instant.dev/orm';
class BlogPost extends InstantORM.Core.Model {
static tableName = 'blog_posts';
}
// Stores the `title` and `content` fields together as a vector
// in the `content_embedding` vector field
BlogPost.vectorizes(
'content_embedding',
(title, content) => `Title: ${title}\n\nBody: ${content}`
);
export default BlogPost;
```
And then to query vector fields:
```javascript
const blogPost = await BlogPost.create({title: `My first post`, content: `some content`});
const vector = blogPost.get('content_embedding'); // length 1,536 array
// Find the top 10 blog posts matching "blog posts about dogs"
// Automatically converts query to a vector
let searchBlogPosts = await BlogPost.query()
.search('content_embedding', 'blog posts about dogs')
.limit(10)
.select();
```
You can read more on vector queries at
[Composer#search](#composersearch), [Composer#similarity](#composersimilarity) and
[Composer#classify](#composerclassify).
### Query composition
Instant ORM provides a query composer that enables you to construct complex
SQL queries with multiple layers of nesting and joins easily. It is heavily
inspired by the
[Rails ActiveRecord ORM](https://guides.rubyonrails.org/active_record_querying.html#hash-conditions)
and the
[Django ORM](https://docs.djangoproject.com/en/4.2/topics/db/queries/#chaining-filters),
where you can filter using objects and chain multiple queries and statements
together. If you've worked with these ecosystems, querying with the Instant ORM
will come naturally to you. Otherwise, it's easy to pick up!
Here's a basic example that;
- Selects users with an id matching 7, 8, or 9
- Orders them by their username
- Retrieves a maximum of 2 results
```javascript
const User = Instant.Model('User');
// Basic querying
let users = await User.query()
.where({id__in: [7, 8, 9]})
.orderBy('username', 'ASC')
.limit(2)
.select();
```
A couple of things to note here
- `User.query()` returns an immutable [Composer](core/lib/composer.js) instance
- Each new chained command, like `.where()`, `.orderBy()` returns
a new, immutable [Composer](core/lib/composer.js) instance
- Any of these instances can individually be queried
- `.select()` is an async function that executes the actual SQL query
- As such, **the query is not executed until `.select()` is called**
We could rewrite this like so:
```javascript
let query = User.query();
let idQuery = query.where({id__in: [7, 8, 9]});
let orderQuery = idQuery.orderBy('username', 'ASC')
let limitQuery = orderQuery.limit(2);
let users = await limitQuery.select();
```
Each query could be executed on its own. For readability, we suggest chaining
queries as we show in the docs, but for advanced composition and reusability
you can cache `Composer` instances.
#### Composer instance methods
##### Composer#safeWhere
Alias for `Composer#where` that prevents querying on fields that the model has
hidden via `Model.hides('field_name')`. This is useful for querying against
user-supplied data, e.g. if you pass in POST data from a web request directly
to the ORM.
##### Composer#safeJoin
Alias for `Composer#join` that prevents querying on fields that the model has
hidden via `Model.hides('field_name')`. This is useful for querying against
user-supplied data, e.g. if you pass in POST data from a web request directly
to the ORM.
##### Composer#where
```javascript
/**
* Add comparisons to SQL WHERE clause.
* @param {Object} comparisons Comparisons object. {age__lte: 27}, for example.
* @return {Nodal.Composer} new Composer instance
*/
where (comparisonsArray) { ... }
```
This method can be passed a `comparisons` object, multiple `comparisons`
objects, or an Array of `comparisons` object. If multiple `comparisons` are
passed to this method (via an Array or as different arguments), they will be
treated as an OR clause.
A comparison object follows the
format:
```javascript
{
field__comparator: value
}
```
Where `field` is of the format:
- `field_name`,
- `joined_model__joined_model_field_name`
- `joined_model__other_joined_model__other_joined_model_field_name`
- ... and so on
And `comparator` is a comparator from `PostgresAdapter.prototype.comparators` in
[PostgresAdapter](core/db/adapters/postgres.js). If no comparator is provided,
the comparator will default to `is`.
```javascript
PostgresAdapter.prototype.comparators = {
is: field => `${field} = __VAR__`,
not: field => `${field} <> __VAR__`,
lt: field => `${field} < __VAR__`,
lte: field => `${field} <= __VAR__`,
gt: field => `${field} > __VAR__`,
gte: field => `${field} >= __VAR__`,
contains: field => `${field} LIKE '%' || __VAR__ || '%'`,
icontains: field => `${field} ILIKE '%' || __VAR__ || '%'`,
startswith: field => `${field} LIKE __VAR__ || '%'`,
istartswith: field => `${field} ILIKE __VAR__ || '%'`,
endswith: field => `${field} LIKE '%' || __VAR__`,
iendswith: field => `${field} ILIKE '%' || __VAR__`,
like: field => `${field} LIKE __VAR__`,
ilike: field => `${field} ILIKE __VAR__`,
is_null: field => `${field} IS NULL`,
is_true: field => `${field} IS TRUE`,
is_false: field => `${field} IS FALSE`,
not_null: field => `${field} IS NOT NULL`,
not_true: field => `${field} IS NOT TRUE`,
not_false: field => `${field} IS NOT FALSE`,
in: field => `ARRAY[${field}] <@ __VAR__`,
not_in: field => `NOT (ARRAY[${field}] <@ __VAR__)`,
json: (field, value) => {
return `${field.replace(/"/g,"")} = __VAR__`;
},
jsoncontains: (field) => {
return `${field.replace(/"/g,"")} ? __VAR__`;
}
};
```
So, if you had a `User` with `BlogPost`s and `Comment`s...
```javascript
// Select only for users that have comments on their blog posts matching "lol"
let users = await User.query()
.join('blogPosts__comments') // joins in both blogPosts and comments
.where({blogPosts__comments__body__contains: 'lol'})
```
###### Custom SQL
In your `comparisons` object instead of passing in a raw `value`, you can pass
in a synchronous function that returns a SQL statement. For example;
```javascript
// Fetch users with email being equal to [their username]@gmail.com
let gmailUsers = await User.query() // || is str_concat in Postgres
.where({email: username => `${username} || '@gmail.com'`})
.select();
```
You can compare to multiple fields on the model by adding more arguments;
```javascript
// Fetch users with email being equal to [firstname].[lastname]@gmail.com
let gmailUsers = await User.query() // || is str_concat in Postgres
.where({
email: (first_name, last_name) => {
return `${first_name} || '.' || ${last_name} || '@gmail.com'`
}
})
.select();
```
**Important:** Field names are aliased by the query composer during query
generation, so please use the above format to make sure the correct column
reference is used in comparisons. You **must** concatenate these fields when
trying to create strings.
##### Composer#join
```javascript
/**
* Join in a relationship.
* @param {string} joinName The name of the joined relationship
* @param {array} comparisons comparisons to perform on this join, similar to where
*/
join (joinName, comparisons) { ... }
```
Use `.join()` to join in related models.
Related models are determined by foreign keys and column uniqueness. Names are
automatically generate based on the field name. You can also join in based on
comparisons similar to the `where()` method. For example, to get a user and
join in all of their posts from the last 24 hours:
```javascript
let posts = await User.query()
.join('posts', {created_at__gte: new Date(Date.now() - (24 * 60 * 60 * 1000))})
.select();
```
You can also pass in an to `comparisons` to create an OR clause between the two
objects.
**Note:** Using this method, **all joins are `LEFT JOIN`s**. If you need to
perform a more complex join we recommend querying the database directly.
###### One-to-many
If a `User` has many `Post`s:
```
// pseudocode for SQL relationships
foreign_key("post"."user_id", "user".id")
NOT unique("post"."user_id")
```
You would query this with;
```javascript
let users = User.query()
.join('posts') // plural
.select();
users[0].joined('posts'); // returns ModelArray instance
```
###### One-to-one
If a `User` has just one `Profile`:
```
// pseudocode for SQL relationships
foreign_key("profile"."user_id", "user".id")
unique("profile"."user_id")
```
You would query this with;
```javascript
let users = User.query()
.join('profile') // not plural
.select();
users[0].joined('profile'); // returns Model instance
```
###### Naming conventions
Joined models will be automatically named in `lowerCamelCase` as either
`lowerCamelCaseModels` (one-to-many, plural) or `lowerCamelCaseModel` (one-to-one, singular)
when joined. For example;
- `BlogPost` (model) / `blog_posts` (table) => `blogPosts` (when 1:many)
- `BlogPost` (model) / `blog_posts` (table) => `blogPost` (when 1:1)
- `CalendarEntryChild` (model) / `calendar_entry_children` (table) => `calendarEntryChildren` (when 1:many)
- `CalendarEntryChild` (model) / `calendar_entry_children` (table) => `calendarEntryChild` (when 1:1)
- `BigBox` (model) / `big_boxes` (table) => `bigBoxes` (when 1:many)
- `BigBox` (model) / `big_boxes` (table) => `bigBox` (when 1:1)
**Don't worry about using the wrong naming convention.** You will receive an error
explaining what join relationships are possible if you get it wrong.
Additionally, child models will primarily be joined in on parents based on the
`parent_reference` column -- not the table name. So if an `Account` belongs to a
`User` but uses the field `owner_id` instead of `user_id`:
```
// pseudocode for SQL relationships
foreign_key("account"."owner_id", "user".id")
unique("account"."owner_id")
```
You would query `Account` like this:
```javascript
let users = User.query()
.join('account')
.select();
users[0].joined('account');
```
But `Account` would be queried like so:
```javascript
let accounts = Account.query()
.join('owner')
.select()
accounts[0].joined('owner');
```
##### Composer#orderBy
```javascript
/**
* Order by field belonging to the current Composer instance's model
* @param {string} field Field to order by
* @param {string} direction Must be 'ASC' or 'DESC'
*/
orderBy (field, direction) { ... }
```
Orders the query by a specific field. These can be stacked to change order when
fields have the same value
##### Composer#limit
```javascript
/**
* Limit to an offset and count
* @param {number} offset The offset at which to set the limit. If this is the only argument provided, it will be the count instead.
* @param {number} count The number of results to be returned. Can be omitted, and if omitted, first argument is used for count
*/
limit (offset, count) { ... }
```
Limits the query to a specific number of results. If only the first argument
is provided it will be used as `count` and `offset` will be 0.
##### Composer#groupBy
```javascript
/**
* Groups by a specific field, or a transformation on a field
* @param {String} column The column to group by
*/
groupBy (column) { ... }
```
Creates a `GROUP BY` statement, aggregating results by a field. Note that
by default the only column returned in the grouped object response will be
the `column` specified here. You must use the `aggregate()` method to add
aggregate columns. `column` can also be a method, if you need to execute
SQL as part of the aggregation.
Here is an example query that groups `ActivityTimeEntry` entries by day and
returns the total entries and sum of the activity time, then orders by the day.
```javascript
let activityEntryData = await ActivityTimeEntry.query()
.aggregate('total', (id) => `COUNT(${id})`)
.aggregate('total_activity_time', (activity_time) => `SUM(COALESCE(${activity_time}, 0))`)
.groupBy(created_at => `DATE_TRUNC('day', ${created_at})`)
.orderBy(created_at => `DATE_TRUNC('day', ${created_at})`, 'ASC');
console.log(activityEntryData);
// [
// {
// "created_at": "2023-09-01T00:00:00.000Z"
// "total": 7,
// "total_activity_time": 221
// },
// {
// "created_at": "2023-09-02T00:00:00.000Z"
// "total": 23,
// "total_activity_time": 1056
// }
// ]
```
##### Composer#aggregate
```javascript
/**
* Aggregates a field
* @param {string} alias The alias for the new aggregate field
* @param {function} transformation The transformation to apply to create the aggregate
*/
aggregate (alias, transformation) { ... }
```
Use with `.groupBy()`, example is provided above.
##### Composer#search
```javascript
/**
* Search a vector field by dot product similarity to a string or object
* This method is ideal when using normalized vectors, eg using OpenAI embeddings
* This is an alias for an orderBy function that orders by dot product similarity
* @param {string} field Field to search
* @param {string} value Value to search for
* @param {?string} direction Orders by dot product, default is ASC (least to most distance)
* @returns {Composer} new Composer instance
*/
search (field, value, direction = 'ASC') { ... }
```
Performs a vector comparison (dot product) against the specified vector field.
This is ideal to use when your vectors are normalized, like OpenAI embeddings.
Order by distance (min: `0`, max: `Infinity`), ascending is default.
This method creates an aliased field, accessible via `model.getMetafield('field_product')`
representing the dot product where `field` is the vector field name you are searching for.
##### Composer#similarity
```javascript
/**
* Search a vector field by cosine similarity to a string or object
* This is an alias for an orderBy function that orders by cosine similarity
* @param {string} field Field to search
* @param {string} value Value to search for
* @param {?string} direction Orders by similarity, default is DESC (most to least similar)
* @returns {Composer} new Composer instance
*/
similarity (field, value, direction = 'DESC') { ... }
```
Performs a vector comparison (cosine similarity) against the specified vector field.
This is ideal to use when your vectors are NOT normalized. For normalized vectors,
like OpenAI embeddings, this will return the same result as `search()` but is slightly
slower. Orders by similarity (min: `0`, max: `1.0`), defaults to `DESC` order (most similar = 1.0).
This method creates an aliased field, accessible via `model.getMetafield('field_similarity')`
representing the cosine similarity where `field` is the vector field name you are searching for.
##### Composer#classify
```javascript
/**
* Classifies results based on cosine similarity to provided terms
* @param {string} field Field to search
* @param {Array<string>} values Classification values
* @returns {Composer} new Composer instance
*/
classify (field, values = []) { ... }
```
Classifies rows based on their cosine similarity to the terms provided. This method
creates an aliased field, accessible via `model.getMetafield('field_classification')` where
`field` is the vector field name that contains the classified term as well as a map of
cosine similarity scores for each provided term.
### Transactions
Transactions can be used to ensure integrity of your data and prevent orphaned
rows from being inserted into your database. For example, if you need to create
a `User` and an `Account` at the same time but run some logic between them:
```javascript
const User = Instant.Model('User');
const Account = Instant.Model('Account');
const txn = Instant.database().createTransaction();
try {
const user = await User.create({email: 'keith@instant.dev'}, txn);
await sendUserEmail(user.get('email'), `Welcome to our website!`);
const account = await Account.create({user_id: user.get('id')}, txn);
await txn.commit();
} catch (e) {
// If any step fails, including sending the welcome email,
// we can just roll the whole thing back
await txn.rollback();
}
```
Transactions can also be queried directly:
```javascript
let result = await txn.query(`SELECT * FROM my_table WHERE id = $1`, [100]);
```
And support the `.transact()` function to send in multiple statements:
```javascript
let result = await txn.transact([
`SELECT * FROM my_table`,
`INSERT INTO my_table(field) VALUES((1))`,
// Parameterized statements can be passed in as well
[`INSERT INTO my_other_table(other_field) VALUES(($1))`, [2]]
]);
```
Finally, they can be passed in to a number of existing query methods. This
gives you transaction-level control right in the ORM.
**When you pass a transaction object into an ORM method, you must remember to commit it to complete the queries.**
```javascript
// Can pass transactions to the following Class methods
await Model.find(id, txn);
await Model.findBy(field, value, txn);
await Model.create(data, txn);
await Model.update(id, data, txn);
await Model.updateOrCreateBy(field, data, txn);
await Model.query().count(txn);
await Model.query().first(txn);
await Model.query().select(txn);
await Model.query().update(fields, txn);
// Instance methods
await model.save(txn);
await model.destroy(txn);
await model.destroyCascade(txn);
// Instance Array methods
await modelArray.saveAll(txn);
await modelArray.destroyAll(txn);
await modelArray.destroyCascade(txn);
```
### Input validation
Validations allow you to ensure the right data is being added into the database.
Validations are performed **immediately** and synchronously, right as data
is being set in the model. You can check validation errors at any time
with `model.hasErrors()` and `model.getErrors()`. Validation errors will cause
`model.save()` to throw an error and prevent writing a row to your database.
You can use validations by creating a file
for your model in the directory `_instant/models`. Note that the
[`instant` command line utility](https://github.com/instant-dev/instant) can
automatically generate these files for you.
File: `_instant/models/user.mjs`
```javascript
import InstantORM from '@instant.dev/orm';
class User extends InstantORM.Core.Model {
static tableName = 'users';
}
// Validates email and password before .save()
User.validates(
'email',
'must be valid',
v => v && (v + '').match(/.+@.+\.\w+/i)
);
User.validates(
'password',
'must be at least 5 characters in length',
v => v && v.length >= 5
);
export default User;
```
Now validations can be used;
```javascript
const User = Instant.Model('User');
try {
await User.create({email: 'invalid'});
} catch (e) {
// Will catch a validation error
console.log(e.details);
/*
{
"email": ["must be valid"],
"password": ["must be at least 5 characters in length"]
}
*/
}
```
You can also check errors before the model is saved:
```javascript
const User = Instant.Model('User');
let user = new User({email: 'invalid'});
if (user.hasErrors()) {
console.log(user.getErrors());
/*
{
"email": ["must be valid"],
"password": ["must be at least 5 characters in length"]
}
*/
}
await user.save(); // will throw an error
```
### Relationship verification
Verifications allow you to validate fields in your model **asynchronously**,
as opposed to validations which are only synchronous. Unlike validations,
**verifications are performed at `INSERT` time**, right before a model is saved
as a new row in its corresponding table.
You can use verifications by creating a file for your model in the directory
`_instant/models`. Note that the
[`instant` command line utility](https://github.com/instant-dev/instant) can
automatically generate these files for you.
File: `_instant/models/user.mjs`
```javascript
import InstantORM from '@instant.dev/orm';
class User extends InstantORM.Core.Model {
static tableName = 'users';
}
// Before saving to the database, asynchronously compare fields to each other
User.verifies(
'phone_number',
'must correspond to country and be valid',
async (phone_number, country) => {
let phoneResult = await someAsyncPhoneValidationAPI(phone_number);
return (phoneResult.valid === true && phoneResult.country === country);
}
);
export default User;
```
Now verifications can be used;
```javascript
const User = Instant.Model('User');
try {
await User.create({phone_number: '+1-416-555-1234', country: 'SE'});
} catch (e) {
// Will catch a validation error
console.log(e.details);
/*
{
"phone_number": ["must correspond to country and be valid"],
}
*/
}
```
### Calculated and hidden fields
Calculated fields will populate your model with fields that do not exist in your
table by can be computed **synchronously** at runtime. They are exposed via the
`model.get(field)` interface or `model.toJSON()`. Hidden fields prevent exposure
of sensitive data when using `model.toJSON()`; useful for hiding IDs, encrypted
fields and more when displaying results to a user.
You can use calculated and hidden fields by adding to your model file:
File: `_instant/models/user.mjs`
```javascript
import InstantORM from '@instant.dev/orm';
class User extends InstantORM.Core.Model {
static tableName = 'users';
}
User.calculates(
'formatted_name',
(first_name, last_name) => `${first_name} ${last_name}`
);
User.hides('last_name');
export default User;
```
```javascript
const User = Instant.Model('User');
let user = await User.create({first_name: 'Steven', last_name: 'Nevets'});
let name = user.get('formatted_name') // Steven Nevets
let json = user.toJSON();
/*
Last name is hidden from .hides()
{
first_name: 'Steven',
formatted_name: 'Steven Nevets'
}
*/
```
### Lifecycle callbacks
Lifecycle callbacks are used to execute custom logic inside of transaction
blocks associated with the creation and destruction of models. Four lifecycle
events are supported, `beforeSave()`, `afterSave()`, `beforeDestroy()` and
`afterDestroy()`. Each of these methods receives a transaction associated with
the model creation or destruction query and is performed either before or after
the associated event.
**If an error is thrown in a lifecycle callback, the transaction will be rolled back automatically.**
Lifecycle callbacks allow you to create multiple codependent resources
simultaneously and can help ensure consistency with third-party services. They
are manage directly inside your model files. Note that the
[`instant` command line utility](https://github.com/instant-dev/instant) can
automatically generate these files for you.
File: `_instant/models/user.mjs`
```javascript
import InstantORM from '@instant.dev/orm';
class User extends InstantORM.Core.Model {
static tableName = 'users';
async beforeSave (txn) {
const NameBan = this.getModel('NameBan');
const nameBans = NameBan.query()
.where({username: this.get('username')})
.limit(1)
.select(txn);
if (nameBans.length) {
throw new Error(`Username "${this.get('username')}" is not allowed`);
}
}
async afterSave (txn) {
// Create an account after the user id is set
// But only when first creating the user
if (this.isCreating()) {
const Account = this.getModel('Account');
await Account.create({user_id: this.get('id')}, txn);
}
}
async beforeDestroy (txn) { /* before we destroy */ }
async afterDestroy (txn) { /* after we destroy */ }
}
export default User;
```
## Using Migrations, Seeding and Code Generation
Migrations, seeds and code generation can be managed via the
[instant.dev](https://github.com/instant-dev/instant) CLI.
## Acknowledgements
Special thank you to [Scott Gamble](https://x.com/threesided) who helps run all
of the front-of-house work for instant.dev 💜!
| Destination | Link |
| ----------- | ---- |
| Home | [instant.dev](https://instant.dev) |
| GitHub | [github.com/instant-dev](https://github.com/instant-dev) |
| Discord | [discord.gg/puVYgA7ZMh](https://discord.gg/puVYgA7ZMh) |
| X / instant.dev | [x.com/instantdevs](https://x.com/instantdevs) |
| X / Keith Horwood | [x.com/keithwhor](https://x.com/keithwhor) |
| X / Scott Gamble | [x.com/threesided](https://x.com/threesided) |
| Instant ORM: JavaScript ORM for Postgres | bun,database,deno,javascript,migrations,nodejs,orm,postgres,postgresql | 2023-09-14T23:49:26Z | 2024-05-12T07:34:47Z | null | 1 | 0 | 250 | 0 | 1 | 60 | null | MIT | JavaScript |
thoughtspile/hippotable | master | # [🦛 Hippotable](https://thoughtspile.github.io/hippotable/)
Hippotable is a simple tool to work with data in the browser. Your data is never sent to a third-party server, protecting your privacy and saving bandwidth. All processing happens in-memory to ensure great performance and real-time feedback. Try it now at [thoughtspile.github.io/hippotable](https://thoughtspile.github.io/hippotable/)
Features:
- 📦 Open CSV files — tested with datasets up to 100 Mb.
- 🚀 Clean and efficient UI lets you scroll though thousands of rows.
- 🔎 Filter and sort your data without delay.
- 👩🔬 Aggregate / groupby data to gain deeper insights.
- 🏗️ Build powerful data pipelines with multiple filter / aggrefate steps.
- 💾 Share results with CSV export.
- 💯 Free and open-source.
## Running locally
Clone this repository, then:
```sh
npm ci
npm run dev
```
## Contributing
See [CONTRIBUTING.md](./CONTRIBUTING.md)
## Acknowledgements
[Arquero](https://github.com/uwdata/arquero) provides the solid dataframe foundation — thanks to [Jeffrey Heer](https://twitter.com/jeffrey_heer) and all the contributors!
[SolidJS](https://github.com/solidjs/solid/) gives us the good developer experience with the performance of vanilla DOM — great work by [Ryan Carniato](https://twitter.com/RyanCarniato) and the team.
Last but not least, [TanStack virtual](https://github.com/TanStack/virtual) by [Tanner Linsley](https://twitter.com/tannerlinsley) gives us powerful table virtualization — and is one of the few projects that support SolidJS.
[Finos perspective,](https://github.com/finos/perspective) especially its [datagrid component](https://perspective.finos.org/block/?example=editable) was a big influence on hippotable. Perspective has a more integrated design, while hippotable goes with a more modular setup, leveraging other open-source projects under the hood. Hippotable is also designed with multi-layer analysis (aggregate-filter-aggregate) in mind, and should eventually support operations spanning multiple tables.
## License
[GPLv3 License](./LICENSE)
Built in 2023 by [Vladimir Klepov](https://thoughtspile.github.io/)
| Lightweight data analysis in your browser | csv,dashboard,data-analysis,data-science,javascript,table,visualization | 2023-10-05T14:51:55Z | 2024-01-21T11:17:43Z | null | 1 | 0 | 71 | 7 | 3 | 53 | null | GPL-3.0 | TypeScript |
FelipeSantos92Dev/react-tds-2023-alunos | main | # Projeto NextJS com Requisições API
[](https://github.com/FelipeSantos92Dev/react-tds-2023-alunos)
## Descrição
Este projeto é uma aplicação em NextJS com páginas dedicadas a diferentes funcionalidades: "pokemons", "finances" e "students". As requisições à API são feitas apenas nas páginas de "pokemons" e "students", demonstrando a integração eficiente de NextJS com APIs externas.
## Tecnologias
- NextJS
- React
- JavaScript
- Axios (para requisições API)
- CSS (ou Styled Components para estilização)
- Git
- Github
## Objetivo
O objetivo desta aplicação é fornecer um exemplo prático de como integrar o NextJS com APIs externas, demonstrando o uso de rotas dinâmicas e a eficácia do framework para o desenvolvimento de aplicações React.
## Pré-requisitos
Para executar este projeto, é necessário ter instalado:
- NodeJS
- NPM ou Yarn
## Etapas de criação do projeto
1. Clone o projeto para sua máquina.
2. Navegue até o diretório do projeto e execute o comando `npm install` ou `yarn install` para instalar as dependências.
3. Crie os arquivos de configuração do ambiente, como o `.env` para armazenar chaves de API ou outras configurações sensíveis.
4. Execute o projeto com o comando `npm run dev` ou `yarn dev`.
5. Acesse a aplicação no navegador em [http://localhost:3000](http://localhost:3000).
## Estrutura do Projeto
O projeto está organizado da seguinte maneira:
- `/pokemons.js`: Página dedicada à exibição de informações sobre pokémons, fazendo requisições à API correspondente.
- `/finances.js`: Página dedicada à gestão financeira (adicionar, visualizar transações, etc.). Não possui requisições à API neste exemplo.
- `/students.js`: Página dedicada a informações sobre estudantes, fazendo requisições à API correspondente.
- `/components/`: Pasta contendo componentes reutilizáveis.
- `/api/`: Pasta contendo arquivos de rotas para a API.
## Instalação
1. Clone o repositório: `git clone https://github.com/FelipeSantos92Dev/react-tds-2023-alunos.git`
2. Navegue até o diretório: `cd react-tds-2023-alunos`
3. Instale as dependências: `npm install` ou `yarn install`
4. Execute o projeto: `npm run dev` ou `yarn dev`
5. Acesse a aplicação no navegador: [http://localhost:3000](http://localhost:3000)
## Autor
[Felipe Santos](https://github.com/FelipeSantos92Dev)
## Links Úteis
- [NextJS](https://nextjs.org/)
- [React](https://reactjs.org/)
- [Axios](https://axios-http.com/)
- [NodeJS](https://nodejs.org/en/)
- [NPM](https://www.npmjs.com/)
- [Yarn](https://yarnpkg.com/)
- [Git](https://git-scm.com/)
- [Github](https://github.com/FelipeSantos92Dev/node-tds-2023-alunos)
- [Github](https://github.com/FelipeSantos92Dev/react-tds-2023-alunos)
| Repositório para os alunos do segundo semestre do curso técnico em desenvolvimento de sistemas - SENAI | css-modules,javascript,nextjs,reactjs,senai,tds | 2023-10-05T11:01:54Z | 2024-03-22T19:07:18Z | null | 2 | 0 | 34 | 0 | 64 | 51 | null | null | JavaScript |
aptos-labs/aptos-ts-sdk | main | # Typescript SDK for Aptos
![License][github-license]
[![Discord][discord-image]][discord-url]
[![NPM Package Downloads][npm-image-downloads]][npm-url]
### Reference Docs
1. For SDK documentation, check out the [TypeScript SDK documentation](https://aptos.dev/sdks/new-ts-sdk/)
2. For detailed reference documentation you can search, check out the [API reference documentation](https://aptos-labs.github.io/aptos-ts-sdk/) for the associated version.
3. For in-depth examples, check out the [examples](./examples) folder with ready-made `package.json` files to get you going quickly!
### Latest Version
[![NPM Package Version][npm-image-version]][npm-url]
### Experimental Development Version
[][experimental-url]
The Aptos TypeScript SDK provides a convenient way to interact with the Aptos blockchain using TypeScript. It offers a
set of utility functions, classes, and types to simplify the integration process and enhance developer productivity.
This repository supports version >= 0.0.0 of the [Aptos SDK npm package](https://www.npmjs.com/package/@aptos-labs/ts-sdk).
## Installation
##### For use in Node.js or a web application
Install with your favorite package manager such as npm, yarn, or pnpm:
```bash
pnpm install @aptos-labs/ts-sdk
```
##### For use in a browser (<= 1.9.1 version only)
You can add the SDK to your web application using a script tag:
```html
<script src="https://unpkg.com/@aptos-labs/ts-sdk/dist/browser/index.global.js" />
```
Then, the SDK can be accessed through `window.aptosSDK`.
## Usage
Initialize `Aptos` to access the SDK API.
```ts
// initiate the main entry point into Aptos SDK
const aptos = new Aptos();
```
If you want to pass in a custom config
```ts
// an optional config information for the SDK client instance.
const config = new AptosConfig({ network: Network.LOCAL }); // default network is devnet
const aptos = new Aptos(config);
```
### Read data from chain
---
```ts
const modules = await aptos.getAccountModules({ accountAddress: "0x123" });
```
### Account management (default to Ed25519)
> Note: We introduce a Single Sender authentication (as introduced in [AIP-55](https://github.com/aptos-foundation/AIPs/pull/263)). Generating an account defaults to Legacy Ed25519 authentication with the option to use the Single Sender unified authentication
---
#### Generate new keys
```ts
const account = Account.generate(); // defaults to Legacy Ed25519
const account = Account.generate({ scheme: SigningSchemeInput.Secp256k1Ecdsa }); // Single Sender Secp256k1
const account = Account.generate({ scheme: SigningSchemeInput.Ed25519, legacy: false }); // Single Sender Ed25519
```
#### Derive from private key
```ts
// Create a private key instance for Ed25519 scheme
const privateKey = new Ed25519PrivateKey("myEd25519privatekeystring");
// Or for Secp256k1 scheme
const privateKey = new Secp256k1PrivateKey("mySecp256k1privatekeystring");
// Derive an account from private key
// This is used as a local calculation and therefore is used to instantiate an `Account`
// that has not had its authentication key rotated
const account = await Account.fromPrivateKey({ privateKey });
// Also, can use this function that resolves the provided private key type and derives the public key from it
// to support key rotation and differentiation between Legacy Ed25519 and Unified authentications
// Read more https://github.com/aptos-labs/aptos-ts-sdk/blob/main/src/api/account.ts#L364
const aptos = new Aptos();
const account = await aptos.deriveAccountFromPrivateKey({ privateKey });
```
#### Derive from private key and address
```ts
// Create a private key instance for Ed25519 scheme
const privateKey = new Ed25519PrivateKey("myEd25519privatekeystring");
// Or for Secp256k1 scheme
const privateKey = new Secp256k1PrivateKey("mySecp256k1privatekeystring");
// Derive an account from private key and address
// create an AccountAddress instance from the account address string
const address = AccountAddress.from("myaccountaddressstring");
// Derieve an account from private key and address
const account = await Account.fromPrivateKeyAndAddress({ privateKey, address });
```
#### Derive from path
```ts
const path = "m/44'/637'/0'/0'/1";
const mnemonic = "various float stumble...";
const account = Account.fromDerivationPath({ path, mnemonic });
```
### Submit transaction
---
#### Single Signer transaction
Using transaction submission api
```ts
const alice: Account = Account.generate();
const bobAddress = "0xb0b";
// build transaction
const transaction = await aptos.transaction.build.simple({
sender: alice.accountAddress,
data: {
function: "0x1::coin::transfer",
typeArguments: ["0x1::aptos_coin::AptosCoin"],
functionArguments: [bobAddress, 100],
},
});
// using sign and submit separately
const senderAuthenticator = aptos.transaction.sign({ signer: alice, transaction });
const committedTransaction = await aptos.transaction.submit.simple({ transaction, senderAuthenticator });
// using signAndSubmit combined
const committedTransaction = await aptos.signAndSubmitTransaction({ signer: alice, transaction });
```
Using built in `transferCoinTransaction`
```ts
const alice: Account = Account.generate();
const bobAddress = "0xb0b";
// build transaction
const transaction = await aptos.transferCoinTransaction({
sender: alice,
recipient: bobAddress,
amount: 100,
});
const pendingTransaction = await aptos.signAndSubmitTransaction({ signer: alice, transaction });
```
### Testing
To run the SDK tests, simply run from the root of this repository:
> Note: for a better experience, make sure there is no aptos local node process up and running (can check if there is a process running on port 8080).
```bash
pnpm i
pnpm test
```
## Troubleshooting
If you see import error when you do this
```typescript
import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
```
It could be your `tsconfig.json` is not incompatible, make sure your `moduleResolution` is set to `node` instead of `bundler`.
## Contributing
If you found a bug or would like to request a feature, please file an [issue](https://github.com/aptos-labs/aptos-ts-sdk/issues/new/choose).
If, based on the discussion on an issue you would like to offer a code change, please make a [pull request](https://github.com/aptos-labs/aptos-ts-sdk/CONTRIBUTING.md).
If neither of these describes what you would like to contribute, checkout out the [contributing guide](https://github.com/aptos-labs/aptos-ts-sdk/CONTRIBUTING.md).
[npm-image-version]: https://img.shields.io/npm/v/%40aptos-labs%2Fts-sdk.svg
[npm-image-downloads]: https://img.shields.io/npm/dm/%40aptos-labs%2Fts-sdk.svg
[npm-url]: https://npmjs.org/package/@aptos-labs/ts-sdk
[experimental-url]: https://www.npmjs.com/package/@aptos-labs/ts-sdk/v/experimental
[discord-image]: https://img.shields.io/discord/945856774056083548?label=Discord&logo=discord&style=flat~~~~
[discord-url]: https://discord.gg/aptosnetwork
[github-license]: https://img.shields.io/github/license/aptos-labs/aptos-ts-sdk
[discord-url]: https://discord.gg/aptosnetwork
| An SDK for accessing the Aptos blockchain data, submitting transactions, and more! | aptos,blockchain,javascript,sdk,typescript | 2023-10-10T16:09:57Z | 2024-05-22T22:25:54Z | null | 23 | 362 | 384 | 13 | 25 | 51 | null | Apache-2.0 | TypeScript |
phuocng/mirror-a-text-area | main | # Mirror a text area
We have been using text areas in many web applications. However, there are many limitations when working with text area. For example, it only accept raw text value. This can be a hindrance when trying to implement advanced features such as highlighting a keyword, displaying the line numbers.
This series introduces a technique to mirror a text area element. Instead of working with the text area element directly, we create a copied element that look identical with the original text area. It's also placed at the same position as the text area. By doing this, we can enhance the user experience by allowing users to interact with the mirrored element in ways that were not possible with the original text area.
- [01: Mirror a text area for improving user experience](https://phuoc.ng/collection/mirror-a-text-area/mirror-a-text-area-for-improving-user-experience/)
- [02: Highlight keywords in a text area](https://phuoc.ng/collection/mirror-a-text-area/highlight-keywords-in-a-text-area/)
- [03: Display the line numbers in a text area](https://phuoc.ng/collection/mirror-a-text-area/display-the-line-numbers-in-a-text-area/)
- [04: Calculate the coordinates of the current cursor in a text area](https://phuoc.ng/collection/mirror-a-text-area/calculate-the-coordinates-of-the-current-cursor-in-a-text-area/)
- [05: Highlight the current line in a text area](https://phuoc.ng/collection/mirror-a-text-area/highlight-the-current-line-in-a-text-area/)
- [06: Create your own custom cursor in a text area](https://phuoc.ng/collection/mirror-a-text-area/create-your-own-custom-cursor-in-a-text-area/)
- [07: Add autocomplete to your text area](https://phuoc.ng/collection/mirror-a-text-area/add-autocomplete-to-your-text-area/)
- [08: Insert emojis](https://phuoc.ng/collection/mirror-a-text-area/insert-emojis/)
- [09: Mention](https://phuoc.ng/collection/mirror-a-text-area/mention/)
- [10: Provide a preview of the suggestion as users type in a text area](https://phuoc.ng/collection/mirror-a-text-area/provide-a-preview-of-the-suggestion-as-users-type-in-a-text-area/)
- [11: Implement inline input suggestions](https://phuoc.ng/collection/mirror-a-text-area/implement-inline-input-suggestions/)
- [12: Make a text area fit its content automatically](https://phuoc.ng/collection/mirror-a-text-area/make-a-text-area-fit-its-content-automatically/)
- [13: Show a toolbar after selecting text in a text area](https://phuoc.ng/collection/mirror-a-text-area/show-a-toolbar-after-selecting-text-in-a-text-area/)
- [14: Copy the content of an element to your clipboard](https://phuoc.ng/collection/mirror-a-text-area/copy-the-content-of-an-element-to-your-clipboard/)
- [15: Build a simple code editor](https://phuoc.ng/collection/mirror-a-text-area/build-a-simple-code-editor/)
- [16: Convert text links in a text area to clickable links](https://phuoc.ng/collection/mirror-a-text-area/convert-text-links-in-a-text-area-to-clickable-links/)
| Enhancing user experience through text area mirroring | dom-manipulation,javascript | 2023-09-26T12:40:14Z | 2023-10-28T06:30:58Z | null | 1 | 10 | 28 | 3 | 4 | 50 | null | MIT | HTML |
JC-Coder/startease | dev | # StartEase ⚡️
StartEase is a command-line interface (CLI) tool designed to make project setup a breeze. Whether you're working with your favorite technologies or exploring new ones, StartEase is your companion for quickly and effortlessly scaffolding projects.
<img width="1248" alt="start-ease" src="https://github.com/JC-Coder/startease/assets/99423608/e7da3f92-4841-49da-bbfc-d42a162a5f37">
</br>
[](https://github.com/acekyd/made-in-nigeria)
## Features
- **Effortless Scaffolding**: StartEase streamlines project creation and technology scaffolding, providing a smooth and efficient experience for developers.
- **Tech Stack Freedom**: With StartEase, you have the freedom to choose and set up projects with your preferred technologies.
## Installation 💿
You can install StartEase using either `npm` or `yarn`. Choose your preferred package manager:
**Using npm:**
```bash
npm install -g startease-cli
```
**Using yarn:**
```bash
yarn global add startease-cli
```
## Usage 🚦
To start using StartEase, run the following command in your terminal:
```bash
startease-cli
```
This command will launch StartEase and guide you through the project setup process with easy-to-follow prompts.
That's it! StartEase simplifies project setup so you can focus on your development tasks.
## Available Templates
The following project templates are available:
- **Frontend**:
- [x] React App (Javascript / TypeScript)
- [ ] Vue.js App
- [ ] Angular App
- [x] HTML/CSS/JavaScript Template
- **Backend**:
- [x] Express.js Server
- [x] Nest.js Server
- [x] Django Web App
- [ ] Ruby on Rails API
- [ ] Flask API
- **Full Stack**:
- [ ] MERN Stack App
- [ ] MEAN Stack App
- [ ] Django + React App
- [ ] Ruby on Rails + Vue.js App
## Supported Databases
The Project Starter Tool supports the following databases:
- [ ] PostgreSQL
- [ ] MySQL
- [x] MongoDB
- [x] SQLite
# Contribution Guidelines
We appreciate your interest in contributing to our project. Whether you want to report a bug, suggest an enhancement, or contribute code, these guidelines will help you get started.
## Table of Contents
1. [How Can I Contribute?](#how-can-i-contribute)
- [Reporting Bugs](#reporting-bugs)
- [Suggesting Enhancements](#suggesting-enhancements)
- [Contributing Code](#contributing-code)
2. [Getting Started](#getting-started)
- [Forking the Repository](#forking-the-repository)
- [Setting Up Your Development Environment](#setting-up-your-development-environment)
- [Making Changes](#making-changes)
- [Running Tests](#running-tests)
- [Creating Pull Requests](#creating-pull-requests)
3. [License](#license)
## How Can I Contribute?
### Reporting Bugs
If you encounter a bug or unexpected behavior in StartEase, please [open an issue](https://github.com/JC-Coder/startease/issues/new) and provide the following information:
- A clear and descriptive title.
- A detailed description of the bug, including steps to reproduce it.
- Information about your environment (e.g., operating system, Node.js version).
- Any relevant screenshots or error messages.
### Suggesting Enhancements
We welcome suggestions for new features or improvements. To suggest an enhancement, [open an issue](https://github.com/JC-Coder/startease/issues/new) with the following details:
- A clear and concise title.
- A detailed description of the enhancement or feature request.
- Any relevant context or examples that help explain the suggestion.
### Contributing Code
We appreciate contributions that enhance StartEase. To contribute code:
1. Fork the repository.
2. Create a branch for your changes.
3. Make your code changes and commit them with clear messages.
4. Submit a pull request (PR).
## Getting Started
### Forking the Repository
Click the "Fork" button at the top-right of the [StartEase repository](https://github.com/JC-Coder/startease) to create a copy of the repository in your GitHub account.
### Setting Up Your Development Environment
1. Clone your forked repository to your local machine:
```bash
git clone https://github.com/JC-Coder/startease.git
```
2. Change to the project directory:
```bash
cd startease
```
3. Install project dependencies:
```bash
npm install
```
or
```bash
yarn install
```
### Making Changes
1. Create a new branch for your changes:
```bash
git checkout -b my-feature-branch
```
### Running Tests
Before submitting your changes, test your changes to ensure it's working as expected. and also test other features to ensure nothing breaks.
### Creating Pull Requests
When you're ready to submit your changes:
1. Commit your changes with a descriptive commit message.
2. Push your changes to your forked repository:
```bash
git push origin my-feature-branch
```
3. Visit the [StartEase repository](https://github.com/JC-Coder/startease) on GitHub.
4. Click the "New Pull Request" button and follow the prompts.
We'll review your pull request as soon as possible.
Note: Pull requests are to be made against the dev branch.
## License
By contributing to StartEase, you agree that your contributions will be licensed under the [MIT License](LICENSE.md).
---
| StartEase is a command-line interface (CLI) tool designed to make project setup a breeze. Whether you're working with your favorite technologies or exploring new ones, StartEase is your companion for quickly and effortlessly scaffolding projects. | css,expressjs,hacktoberfest,html,javascript,nestjs,nextjs,open-source,reactjs | 2023-09-25T15:18:25Z | 2024-05-14T17:15:17Z | null | 9 | 43 | 116 | 8 | 20 | 50 | null | MIT | JavaScript |
JC-Coder/startease | dev | # StartEase ⚡️
StartEase is a command-line interface (CLI) tool designed to make project setup a breeze. Whether you're working with your favorite technologies or exploring new ones, StartEase is your companion for quickly and effortlessly scaffolding projects.
<img width="1248" alt="start-ease" src="https://github.com/JC-Coder/startease/assets/99423608/e7da3f92-4841-49da-bbfc-d42a162a5f37">
</br>
[](https://github.com/acekyd/made-in-nigeria)
## Features
- **Effortless Scaffolding**: StartEase streamlines project creation and technology scaffolding, providing a smooth and efficient experience for developers.
- **Tech Stack Freedom**: With StartEase, you have the freedom to choose and set up projects with your preferred technologies.
## Installation 💿
You can install StartEase using either `npm` or `yarn`. Choose your preferred package manager:
**Using npm:**
```bash
npm install -g startease-cli
```
**Using yarn:**
```bash
yarn global add startease-cli
```
## Usage 🚦
To start using StartEase, run the following command in your terminal:
```bash
startease-cli
```
This command will launch StartEase and guide you through the project setup process with easy-to-follow prompts.
That's it! StartEase simplifies project setup so you can focus on your development tasks.
## Available Templates
The following project templates are available:
- **Frontend**:
- [x] React App (Javascript / TypeScript)
- [ ] Vue.js App
- [ ] Angular App
- [x] HTML/CSS/JavaScript Template
- **Backend**:
- [x] Express.js Server
- [x] Nest.js Server
- [x] Django Web App
- [ ] Ruby on Rails API
- [ ] Flask API
- **Full Stack**:
- [ ] MERN Stack App
- [ ] MEAN Stack App
- [ ] Django + React App
- [ ] Ruby on Rails + Vue.js App
## Supported Databases
The Project Starter Tool supports the following databases:
- [ ] PostgreSQL
- [ ] MySQL
- [x] MongoDB
- [x] SQLite
# Contribution Guidelines
We appreciate your interest in contributing to our project. Whether you want to report a bug, suggest an enhancement, or contribute code, these guidelines will help you get started.
## Table of Contents
1. [How Can I Contribute?](#how-can-i-contribute)
- [Reporting Bugs](#reporting-bugs)
- [Suggesting Enhancements](#suggesting-enhancements)
- [Contributing Code](#contributing-code)
2. [Getting Started](#getting-started)
- [Forking the Repository](#forking-the-repository)
- [Setting Up Your Development Environment](#setting-up-your-development-environment)
- [Making Changes](#making-changes)
- [Running Tests](#running-tests)
- [Creating Pull Requests](#creating-pull-requests)
3. [License](#license)
## How Can I Contribute?
### Reporting Bugs
If you encounter a bug or unexpected behavior in StartEase, please [open an issue](https://github.com/JC-Coder/startease/issues/new) and provide the following information:
- A clear and descriptive title.
- A detailed description of the bug, including steps to reproduce it.
- Information about your environment (e.g., operating system, Node.js version).
- Any relevant screenshots or error messages.
### Suggesting Enhancements
We welcome suggestions for new features or improvements. To suggest an enhancement, [open an issue](https://github.com/JC-Coder/startease/issues/new) with the following details:
- A clear and concise title.
- A detailed description of the enhancement or feature request.
- Any relevant context or examples that help explain the suggestion.
### Contributing Code
We appreciate contributions that enhance StartEase. To contribute code:
1. Fork the repository.
2. Create a branch for your changes.
3. Make your code changes and commit them with clear messages.
4. Submit a pull request (PR).
## Getting Started
### Forking the Repository
Click the "Fork" button at the top-right of the [StartEase repository](https://github.com/JC-Coder/startease) to create a copy of the repository in your GitHub account.
### Setting Up Your Development Environment
1. Clone your forked repository to your local machine:
```bash
git clone https://github.com/JC-Coder/startease.git
```
2. Change to the project directory:
```bash
cd startease
```
3. Install project dependencies:
```bash
npm install
```
or
```bash
yarn install
```
### Making Changes
1. Create a new branch for your changes:
```bash
git checkout -b my-feature-branch
```
### Running Tests
Before submitting your changes, test your changes to ensure it's working as expected. and also test other features to ensure nothing breaks.
### Creating Pull Requests
When you're ready to submit your changes:
1. Commit your changes with a descriptive commit message.
2. Push your changes to your forked repository:
```bash
git push origin my-feature-branch
```
3. Visit the [StartEase repository](https://github.com/JC-Coder/startease) on GitHub.
4. Click the "New Pull Request" button and follow the prompts.
We'll review your pull request as soon as possible.
Note: Pull requests are to be made against the dev branch.
## License
By contributing to StartEase, you agree that your contributions will be licensed under the [MIT License](LICENSE.md).
---
| StartEase is a command-line interface (CLI) tool designed to make project setup a breeze. Whether you're working with your favorite technologies or exploring new ones, StartEase is your companion for quickly and effortlessly scaffolding projects. | css,expressjs,hacktoberfest,html,javascript,nestjs,nextjs,open-source,reactjs | 2023-09-25T15:18:25Z | 2024-05-14T17:15:17Z | null | 9 | 43 | 116 | 8 | 20 | 50 | null | MIT | JavaScript |
Git21221/JS-beginner-projects | master | null | Here you will get small JS projects for starters. | begineersfriendly,game,javascript | 2023-09-21T15:54:05Z | 2024-01-21T08:30:22Z | null | 73 | 154 | 332 | 92 | 71 | 48 | null | null | JavaScript |
SuperJakov/Badusb | main | # Badusb for Flipper Zero
## How to install badusb files
**To install badusb files follow [THIS GUIDE](/How2Install.pdf)**
## Related projects
### Base64 encoder & decoder
Do you hate when you have to encode and decode to base64 all the time when you're writing powershell?
**Install my chrome extension [here](https://github.com/SuperJakov/Base-64-extension)**
## Beigeworm
Beigeworm helped me a lot! **Check him out [here](https://github.com/beigeworm)**
Beigeworm also has a [**BadUsb for Flipper repository**](https://github.com/beigeworm/BadUSB-Files-For-FlipperZero)
## Stars
[](https://starchart.cc/SuperJakov/Badusb)
| Badusb files for Flipper zero. This repository provides both ducky script and JS version,powershell version and documentation. | badusb,duckyscript,flipper-zero,flipperzero,powershell,javascript | 2023-09-27T09:25:57Z | 2024-05-04T20:05:26Z | null | 1 | 1 | 176 | 0 | 4 | 45 | null | null | PowerShell |
edison-js/Edison | master | <p align="center">
<img width="300px" src="/public/images/icon.png" alt="Something nice img">
</p>
<h1 align="center">Edison</h1>
<p align="center">Edison can control microcontroller board with TypeScript or JavaScript!</p>
<div align="center">
<a href="https://github.com/edison-js/Edison/stargazers">
<img src="https://img.shields.io/github/stars/edison-js/Edison" alt="GitHub stars">
</a>
[](https://www.npmjs.com/package/edison)
[](https://www.npmjs.com/package/edison)
[](https://github.com/edison-js/Edison/blob/main/LICENSE)
</div>
## Documentation
Our documentation site is [here](https://edison-js-document.vercel.app/)!
## If you have not yet installed the Arduino IDE ?
please click on [the official site](https://www.arduino.cc/en/software) and install it.
## How to use in WSL
Please read [this article](https://zenn.dev/konjikun/articles/e905f4ce99d3ea).
## Installation
Install Edison your project
```console
npm install edison
```
or
```console
yarn add edison
```
## Getting Started
```.ts
import { Board, Button, Led, render } from "edison"
import React from "react"
const App: React.FC = () => {
return (
<Board port={'/dev/ttyUSB0'}> // Please replace with your port
<Led
pin={13}
blink={500}
/>
</Board>
)
}
render(<App />)
```
## Contributing
We love collaborating with folks inside and outside of GitHub and welcome contributions!
> 👉 [Discord](eHB5dBkZyW)
| 💡Edison can controll microcomputer with TypeScript and React💡 | iot,javascript,nodejs,robot,typescript,arduino,esp32,robotics-control,react | 2023-09-12T09:11:32Z | 2024-05-22T04:02:50Z | null | 4 | 73 | 266 | 5 | 5 | 43 | null | MIT | TypeScript |
dishamodi0910/APIVerse | master | <div align = "center">
# 💥 A-P-I-V-E-R-S-E : 𝐂𝐨𝐥𝐥𝐞𝐜𝐭𝐢𝐨𝐧 𝐨𝐟 𝐀𝐏𝐈𝐬 !! 🤝
</div>
<div align = "center">
</div>
<div align = "center">
<i>APIVerse is a collection of APIs that are useful for developers. It simplifies the process of both adding new APIs and learning how to harness the power of existing ones. Whether you're a developer looking to expand your toolbox or a newcomer eager to dive into the API ecosystem, APIVerse empowers you to seamlessly learn about API!😃
</i>
</div>
<div align = "center">
<br>
<img src="https://img.shields.io/badge/Maintained%3F-yes-green.svg">
[](https://opensource.org/licenses/MIT)
[](https://discord.gg/mv4NTzN)
<table align="center">
<thead align="center">
<tr border: 1px;>
<td><b>🌟 Stars</b></td>
<td><b>🍴 Forks</b></td>
<td><b>🐛 Issues</b></td>
<td><b>🔔 Open PRs</b></td>
<td><b>🔕 Close PRs</b></td>
</tr>
</thead>
<tbody>
<tr>
<td><img alt="Stars" src="https://img.shields.io/github/stars/developer-student-clubs/APIVerse?style=flat&logo=github"/></td>
<td><img alt="Forks" src="https://img.shields.io/github/forks/developer-student-clubs/APIVerse?style=flat&logo=github"/></td>
<td><img alt="Issues" src="https://img.shields.io/github/issues/developer-student-clubs/APIVerse?style=flat&logo=github"/></td>
<td><img alt="Open Pull Requests" src="https://img.shields.io/github/issues-pr/developer-student-clubs/APIVerse?style=flat&logo=github"/></td>
<td><img alt="Close Pull Requests" src="https://img.shields.io/github/issues-pr-closed/developer-student-clubs/APIVerse?style=flat&color=critical&logo=github"/></td>
</tr>
</tbody>
</table>
</div>
<br>
<div align = "center">
<h2><img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/Animated-Fluent-Emojis/master/Emojis/Objects/Pushpin.png" alt="Pushpin" width="25" height="25" /> Tech Stacks!</h2>
<img src= "https://img.shields.io/badge/Express.js-404D59?style=for-the-badge">
<img src="https://img.shields.io/badge/TypeScript-007ACC?style=for-the-badge&logo=typescript&logoColor=white">
<img src="https://img.shields.io/badge/Node.js-43853D?style=for-the-badge&logo=node.js&logoColor=white">
<img src="https://img.shields.io/badge/JavaScript-F7DF1E?style=for-the-badge&logo=JavaScript&logoColor=black">
</div>
<br>
<div align="left">
<h2 align="center">🚀When you can expect your PR will get accepted?</h2>
<div style="color : red">
<i><b>
✅ You should add either 1 new API or 1 existing APIafter testing the code properly. The file structure should be followed. README.md file should be present inside your folder. <br>
✅If you are contributing towards enhancement of any API, you need to make sure that you are enhancing atleast 2 APIs. <br>
✅If you are contributing towards any documentation related bug, you should solve atleast 5 documentation bugs to get your PR merged. <br>
### Note : For existing API, You should submit the corresponding html and css files also so that we can better visualise how this API can be used within projects. Only submitting JS files won't work.
</b>
</i>
</div>
Here you go🚀, Looking towards great contributions from your side!🔥
Happy Coding!❤️
<div>
</div>
<h2 align = "center">✨ How to contribute?</h2>
<div align = "left">
- Go through project [README.md](./README.md) and [CONTRIBUTING GUIDELINES](./CONTRIBUTING.md) to know about project and related guidelines.
- Go through project to know what you can contribute towards it.
* *CREATING ISSUE!*
- Under issues section, you can select proper template, and fill all the necessary details.
`YOU ARE NOT SUPPOSED TO ALTER THE PROJECT TITLE. ISSUE TITLE SHOULD BE MENTIONED AFTER []`.
#### You can go through the issues mentioned here before creating any issue to know how the issue is supposed to be created : [Issue 1](https://github.com/developer-student-clubs/APIVerse/issues/1) , [Issue 2](https://github.com/developer-student-clubs/APIVerse/issues/2) , [Issue 3](https://github.com/developer-student-clubs/APIVerse/issues/3), [Issue 4](https://github.com/developer-student-clubs/APIVerse/issues/4)
- You have to wait till the issue is assigned to you. After the issue is assigned, you can start working on the issue.
* *ADDING YOUR CODE!*
- You need to fork the repository to work on the project.
- After forking into your account, you need to clone it using `git clone "repo_link"`
- After cloning the repository, you need to create a new branch `git checkout -b <BRANCH_NAME>`
- Add the code that you want to contribute from your side under newly created branch.
- Make sure you follow proper file structure. If you are creating a new api, then you should add your folder(`NAMEOFAPI`) into the `New_APIs` folder. If you are adding any existing api, make sure proper file structure is followed and you have added `README.md` files for the APIs you are adding.
* *BRINGING YOUR CODE ON GITHUB!*
- `git add .` to stage your changes.
- Use `git commit -m "message"` to commit the changes. Make sure you are on the branch you have created.
- Push your changes into github using `git push origin <BRANCH_NAME>`.
- Once you are done pushing, create a PR and you are done!😎💗🎯
</div>
<h2 align = "center">Our Contributors ❤️</h2>
<div align = "center">
<h3>Thank you for contributing to our repository.😃</h3>
### Show some ❤️ by starring this awesome repository!
</div>
| APIVerse is a collection of APIs that are useful for developers. It simplifies the process of both adding new APIs and learning how to harness the power of existing ones. | api,express,node-js,collaboration,community,open-source,open-source-project,javascript | 2023-09-25T06:34:22Z | 2024-05-23T12:40:27Z | null | 28 | 66 | 168 | 27 | 45 | 41 | null | MIT | JavaScript |
ProjectRavel/JavaScript-Indonesia | master | null | javascript,javascript-tutorial,javascript-indonesia | 2023-09-29T17:08:30Z | 2023-11-07T13:14:45Z | null | 1 | 0 | 13 | 0 | 0 | 41 | null | null | JavaScript | |
Dinil-Thilakarathne/ui-components | main | # UI components
## Accordions
| Accordion 01 | [Click here](https://github.com/Dinil-Thilakarathne/ui-components/tree/main/accordion-01) |
| ------------ | ----------------------------------------------------------------------------------------- |
## Buttons
| Button 01 | [Click here](https://github.com/Dinil-Thilakarathne/ui-components/tree/main/button-01) |
| --------- | -------------------------------------------------------------------------------------- |
| Button 02 | [Click here](https://github.com/Dinil-Thilakarathne/ui-components/tree/main/button-02) |
| Button 03 | [Click here](https://github.com/Dinil-Thilakarathne/ui-components/tree/main/button-03) |
| Button 04 | [Click here](https://github.com/Dinil-Thilakarathne/ui-components/tree/main/button-04) |
| Button 05 | [Click here](https://github.com/Dinil-Thilakarathne/ui-components/tree/main/button-05) |
## Cards
| Card 01 | [Click here](https://github.com/Dinil-Thilakarathne/ui-components/tree/main/card-01) |
| ------- | ------------------------------------------------------------------------------------ |
| Card 02 | [Click here](https://github.com/Dinil-Thilakarathne/ui-components/tree/main/card-02) |
| Card 03 | [Click here](https://github.com/Dinil-Thilakarathne/ui-components/tree/main/card-03) |
| Card 04 | [Click here](https://github.com/Dinil-Thilakarathne/ui-components/tree/main/card-04) |
| Card 05 | [Click here](https://github.com/Dinil-Thilakarathne/ui-components/tree/main/card-05) |
| Card 06 | [Click here](https://github.com/Dinil-Thilakarathne/ui-components/tree/main/card-06) |
| Card 07 | [Click here](https://github.com/Dinil-Thilakarathne/ui-components/tree/main/card-07) |
## Carousels
| Carousel 01 | [Click here](https://github.com/Dinil-Thilakarathne/ui-components/tree/main/carousel-01) |
| ----------- | ---------------------------------------------------------------------------------------- |
## Drop downs
| Drop down 01 | [Click here](https://github.com/Dinil-Thilakarathne/ui-components/tree/main/drop-down-01) |
| ------------ | ----------------------------------------------------------------------------------------- |
| Drop down 02 | [Click here](https://github.com/Dinil-Thilakarathne/ui-components/tree/main/drop-down-02) |
## Footers
| Footer 01 | [Click here](https://github.com/Dinil-Thilakarathne/ui-components/tree/main/footer-01) |
| --------- | -------------------------------------------------------------------------------------- |
| Footer 02 | [Click here](https://github.com/Dinil-Thilakarathne/ui-components/tree/main/footer-02) |
## Image Galleries
| Image Gallery 01 | [Click here](https://github.com/Dinil-Thilakarathne/ui-components/tree/main/gallery-01) |
| ---------------- | --------------------------------------------------------------------------------------- |
| Image Gallery 02 | [Click here](https://github.com/Dinil-Thilakarathne/ui-components/tree/main/gallery-02) |
## Headers
| Header 01 | [Click here](https://github.com/Dinil-Thilakarathne/ui-components/tree/main/header-01) |
| -------------------- | ------------------------------------------------------------------------------------------------- |
## Horizontal Scroll
| Horizontal Scroll 01 | [Click here](https://github.com/Dinil-Thilakarathne/ui-components/tree/main/horizontal-scroll-01) |
| -------------------- | ------------------------------------------------------------------------------------------------- |
## Loaders
| Loader 01 | [Click here](https://github.com/Dinil-Thilakarathne/ui-components/tree/main/loader-01) |
| --------- | -------------------------------------------------------------------------------------- |
| Loader 02 | [Click here](https://github.com/Dinil-Thilakarathne/ui-components/tree/main/loader-02) |
| Loader 03 | [Click here](https://github.com/Dinil-Thilakarathne/ui-components/tree/main/loader-03) |
## Menus
| Menu 01 | [Click here](https://github.com/Dinil-Thilakarathne/ui-components/tree/main/menu-01) |
| ------- | ------------------------------------------------------------------------------------ |
| Menu 02 | [Click here](https://github.com/Dinil-Thilakarathne/ui-components/tree/main/menu-02) |
## Profile cards
| Card 01 | [Click here](https://github.com/Dinil-Thilakarathne/ui-components/tree/main/profile-card-01) |
| ------- | ------------------------------------------------------------------------------------ |
## Sidebars
| Sidebar 01 | [Click here](https://github.com/Dinil-Thilakarathne/ui-components/tree/main/sidebar-01) |
| ---------- | --------------------------------------------------------------------------------------- |
| Sidebar 02 | [Click here](https://github.com/Dinil-Thilakarathne/ui-components/tree/main/sidebar-02) |
| Sidebar 03 | [Click here](https://github.com/Dinil-Thilakarathne/ui-components/tree/main/sidebar-03) |
## text animations
| Text animation 01 | [Click here ](https://github.com/Dinil-Thilakarathne/ui-components/tree/main/text-animation-01) |
| ----------------- | ----------------------------------------------------------------------------------------------- |
| Text animation 02 | [Click here ](https://github.com/Dinil-Thilakarathne/ui-components/tree/main/text-animation-02) |
| Text animation 03 | [Click here ](https://github.com/Dinil-Thilakarathne/ui-components/tree/main/text-animation-03) |
# Make sure to follow us on 👇
Linkedin : [@dinil-thilakarathne](https://www.linkedin.com/in/dinil-thilakarathne/)
Instagram: [@sona_code](https://www.instagram.com/sona_code/)
Twitter: [@sone_code](https://twitter.com/sona_code/)
GitHub: [@dinil-thilakarathne](https://github.com/dinil-Thilakarathne/)
| This repository includes all my project's source code from my social media | css,html,ui,ui-components,javascript,js | 2023-10-02T07:14:21Z | 2024-05-13T14:48:07Z | null | 1 | 0 | 75 | 0 | 16 | 38 | null | null | HTML |
avani07joshi/oct_project_2023 | main | Hacktoberfest-2023
# Submit your PR on this new repo [Hacktoberfest](https://github.com/fineanmol/hacktoberfest) , There we are merging all PR.
ub.io/Hacktoberfest2022/)}
**This is a beginner-friendly project to help you get started with your
[hacktoberfest](https://hacktoberfest.digitalocean.com/)
P.S. Star ⭐ and Share this repository, if you had fun!! 😍
Hacktoberfest 2023
# 📌 Videos 📽️:
- [Hacktoberfest Intro](https://www.youtube.com/watch?v=mq_FIHdxmIk)
- [How to pull request [Overview]] (https://youtu.be/DIj2q02gvKs)
- [Merge Conflict / comment](https://youtu.be/zOx5PJTY8CI)
# Contribution Rules📚:
- You are allowed to make pull requests that break the rules. We just merge it ;)
- Do NOT add any build steps e.g npm install (we want to keep this a simple static site)
- Do NOT remove other content.
- Styling/code can be pretty, ugly or stupid, big or small as long as it works
<!-- - Add your name to the contributorsList file. -->
- Try to keep pull requests small to minimize merge conflicts
## Getting Started 🤩🤗:
- Fork this repo (button on top)
- Clone on your local machine
```terminal
git clone https://github.com/avani2002joshi/oct_project_2023.git
```
- Navigate to project directory.
```terminal
cd oct_project_2023
```
- Create a new Branch
```markdown
git checkout -b my-new-branch
```
<!--- - Add your Name to `contributors/contributorsList.js`. -->
```markdown
git add .
```
- Commit your changes.
```markdown
git commit -m "Relevant message"
```
- Then push
```markdown
git push origin my-new-branch
```
- Create a new pull request from your forked repository
<br>
## Avoid Conflicts {Syncing your fork}
An easy way to avoid conflicts is to add an 'upstream' for your git repo, as other PR's may be merged while you're working on your branch/fork.
```terminal
git remote add upstream https://github.com/avani2002joshi/oct_project_2023
```
You can verify that the new remote has been added by typing
```terminal
git remote -v
```
To pull any new changes from your parent repo simply run
```terminal
git merge upstream/master
```
This will give you any eventual conflicts and allow you to easily solve them in your repo. It's a good idea to use it frequently in between your own commits to make sure that your repo is up to date with its parent.
For more information on syncing forks [read this article from Github](https://help.github.com/articles/syncing-a-fork/).
<li><B><p><img src="https://miro.medium.com/max/1050/1*4JctIO7irt8hFxBmTvUpiQ.jpeg" width="400" height="225" style="width: 400px; height: 225px;" alt="tshirt image"></a></p><p><img src="https://miro.medium.com/max/1050/1*jkffr74bq5RsQ_xqDhgqYQ.jpeg" width="400" height="225" style="width: 400px; height: 225px;" alt="stickers image"></p>
</b></li>
# FAQs (Frequently Asked Questions)
- Who all can contribute?
- Anyone with a github account and who is signed up for
[hacktoberfest](https://hacktoberfest.digitalocean.com/) :)
- Are you getting paid for this?
- Sadly no. But we think we should. This is 100% unofficial and we do it for fun, fame and glory.
- Who are you and why are you doing this?
- We are two programmers from India [Anmol](https://www.linkedin.com/in/fineanmol/)
and [Ritesh](https://github.com/ritesh2905). We are doing this because we love Open Source and Hacktoberfest. We want to make it easier for people to get started with Hacktoberfest and Open Source.
- Why are you not using digitalocean?
- Because we only know JavaScript and suck at servers. We use [now](https://zeit.co/now) instead.
- Should I come closer to the text saying 'Don't come closer' on the left side of the home tab ?
- Nope.
- How many pull request (PR) must be made, if I want to get an awesome tshirt from Hacktoberfest 2022?
- 4
- How do I track my progress to get an awesome shirt from Hacktoberfest 2022?
- [go to :](https://hacktoberfest.digitalocean.com/profile/). (Check Out Your Own Stats at Right Top)
- What is the duration of Hacktoberfest 2022?
- It is from 1st october to 31st october 2022...
- What is the event for?
- For the open source community engagement and learn how to contribute to open source.
###### *We will do our best to merge as much as possible from everyone. However, time is limited and the merge conflicts are horrible :astonished: <3*
<br>
## Our Top Contributors
<p align="center"><a href="https://github.com/fineanmol/Hacktoberfest2022/graphs/contributors">
<img src="https://contributors-img.web.app/image?repo=fineanmol/Hacktoberfest2022" />
</a></p>
| october 2023 project | css,hacktoberfest,hacktoberfest-accepted,hacktoberfest2023,html,javascript,hacktoberfest2023-accepted,c,cpp | 2023-09-26T16:38:33Z | 2023-10-31T03:43:54Z | null | 12 | 34 | 73 | 0 | 12 | 36 | null | null | HTML |
DaytimeLobster/gogrow | master | null | The GoGrow planning, homesteading, and image annotation app | flask,gardening,gardening-app,image-annotation,javascript,mapping,open-source,python,homesteading,journal | 2023-09-30T23:59:07Z | 2024-02-13T17:44:51Z | null | 1 | 0 | 24 | 0 | 1 | 34 | null | NOASSERTION | JavaScript |
divyanshudhruv/Minifolio | main | <p align="center"><img src="Minifolio.png" width="120" height="120"></p>
<h1 align="center"> Minifolio ⚡</h1>
<br>
<p align="center"><code>A minimal portfolio template for developers </code>
<br>
<code>⚠️ We are now accepting pull requests ! Let's code</code></p>
<br>
<br>
<p align="center"> <img src="https://img.shields.io/badge/Version-0.2-808fff?style=for-the-badge"> <img src="https://img.shields.io/badge/Made%20for-developers-orange?style=for-the-badge"> <img src="https://img.shields.io/github/stars/divyanshudhruv/Minifolio?style=for-the-badge&color=dfb317 "> <img src="https://img.shields.io/badge/GH--page-active-green?style=for-the-badge"> <img src="https://img.shields.io/badge/license-mit-6fbfff?style=for-the-badge"></p>
<br>
<br>
## 🚩 License
<br>
> <code><a href="https://github.com/divyanshudhruv/Minifolio/blob/master/LICENSE">MIT License</a></code>
<br>
## 🫥 Code Of Conduct
<br>
> <code><a href="https://github.com/divyanshudhruv/Minifolio/blob/master/CODE_OF_CONDUCT.md">Code Of Conduct</a></code>
<br>
<!--
## 👀 Hacktoberfest
> <code><a href="https://hacktoberfest.com">Hacktoberfest 2023</a></code>
<br>
-->
## ⚡ What's New ?
<br>
> **`v0.1` `24/09/2023`** - Published Minifolio
> **`v0.2` `12/10/2023`** - Added new features
> **`vRes` `26/12/2023`** - Resumed the project
<!--
> **`v0.2`**
> **`v0.3`**
-->
<br>
## ✌🏻 Contribute
<br>
> **`1`** Join The **<code><a href="https://github.com/divyanshudhruv/Minifolio/issues/1">Discussion</a></code>**
> **`2`** Visit **<code><a href="https://github.com/divyanshudhruv/Minifolio/blob/main/CONTRIBUTING.md">CONTRIBUTING.md</a></code>**
> **`3`** Create **<code><a href="https://github.com/divyanshudhruv/Minifolio/issues">Issues</a></code>**
> **`4`** Create **<code><a href="https://github.com/divyanshudhruv/Minifolio/pulls">Pull Request</a></code>**
> **`5`** Star The **<code><a href="https://github.com/divyanshudhruv/Minifolio">Repository</a></code>**
<br>
## 📁 Content
<br>
> **`1️`** [Features](#features)
> **`2️`** [Getting Started](#getting-started)
> **`3`** [How To Use](#use)
> **`4️`** [Deployment](#deployment)
> **`5️`** [Technology](#technology)
> **`6`** [Star](#star)
> **`7`** [Hacktoberfest](#hacktoberfest)
> **`8`** [Author](#author)
<br>
## 😄 Features <a id="features"> </a>
<br>
<!--
```markdown
1. Modern UI/UX
2. One page layout
3. Valid HTML5 and CSS3
4. Fully responsive
```
-->
> **`1`** Modern UI/UX
> **`2`** One page layout
> **`3`** Valid HTML5 and CSS3
> **`4`** Fully responsive
<br>
## 🚀 Getting Started <a id="getting-started"> </a>
<br>
> **`1`** Fork this repo
> **`2`** Clone the repo
> **`3`** Create a branch
> **`4`** Make pull request
<br>
## 🔥 How To Use <a id="use"> </a>
<br>
```rust
Follow the instruction to customize the portfolio
```
<br>
> ## 🌳 Tree Diagram
```
.
└── Minifolio
├── index.html
├── css
│ ├── style.css
│ └── button.css
└── js
├── script.js
├── copyRight.js
└── typingAnimation.js
```
<br>
> ## 🏠 Home Page
<Br>
> **`<span>`** Replace it with Your Name
> **`<a>`** Replace it with Custom Label
<br>
```html
<div class="home">
<div class="container">
Hi, my name is <span>Your Name</span> <br />I'm <span id="role"></span>
<a class="button" href="#about">Know more</a>
</div>
</div>
```
<br>
> ## 🫤 About Me
<br>
> **`<title>`** Replace it with Custom Title
> **`<text>`** Replace it Your Name or any Text
> **`<textMain>`** Replace it with a short Bio
<br>
```html
<div class="aboutC">
<div class="title">     ABOUT 🫥</div>
<div class="titleGap"></div>
<div class="titleSmall">This and that</div>
<div class="containerGap"></div>
<div class="container">
<div class="leftC">
<div class="text">Hi, I'm a developer</div>
<br />
<div class="textMain">
I design websites. That's the long and short of it. UI and UX,
Sketch, Design, and pretty decent HTML and CSS — with Javascript and
that nice dabble with Java.
</div>
</div>
<div class="rightC">
<div class="text">TL;DR</div>
<br />
<div class="textMain">Web UI & UX <br />Figma<br />HTML & CSS</div>
<div class="btnC">
<a class="btn btn-custom btn-lg btn-about" href="#"> Click Me </a>
</div>
</div>
</div>
<div class="bottomC"></div>
</div>
```
<br>
> ## 🌗 Footer
<br>
> **`<footer>`** Do not change
<br>
```html
<div class="footer">
...
</div>
```
<br>
## 📦 Deployment <a id="deployment"> </a>
<br>
```rust
Minifolio is deployed by Github Page
```
<br>
## 🌱 Technology <a id="technology"> </a>
<br>
> **`1`** HTML
> **`2`** CSS
> **`3`** JavaScript
> **`4`** Github
<br>
## ⭐ Star <a id="star"> </a>
<br>
> If you like the project, give a **`Star`**
<br>
## 🎯 Hacktoberfest <a id="hacktoberfest"> </a>
<br>
```rust
Hacktoberfest is a month-long celebration of open source projects, the maintainers, and the entire community of contributors.
```
```rust
You'll receive your digital reward once you’ve completed four accepted pull/merge requests.
```
```rust
The first 50,000 participants to have their first PR/MR accepted will have a tree planted in their name through Tree Nation.
```
<br>
<!--
## 🤔 Participation
<br>
> **`1`** Fork the repo
> **`2`** Make your changes
> **`3`** Create your branch
> **`4`** Submit the pull request
> **`5`** Wait for the merge
<br>
-->
## ✒️ Author <a id="author"> </a>
<br>
> **<code><a href="https://github.com/divyanshudhruv">@ Divyanshu Dhruv</a></code>**
| ⚡ A minimal portfolio template for Developers | 2024 | css,hacktoberfest,hacktoberfest-accepted,hacktoberfest2023,html,javascript,portfolio,template,minifolio,portfolio-template | 2023-09-24T12:44:06Z | 2024-02-01T11:47:25Z | null | 9 | 47 | 69 | 13 | 40 | 34 | null | MIT | CSS |
SUGAM-ARORA/UniCollab | main | <p align="center">
<img src="Unicollab.png">
</p>
<h1><p align="center">UniCollab: Unleashing Collaborative Learning</p></h1>
<h3><p align="center">Welcome to UniCollab, where knowledge knows no boundaries</h3></p>
## 👋 About UniCollab
UniCollab is more than just a platform; it's a gateway to a world where students from different universities/colleges converge to collaborate, innovate, and elevate their projects. Imagine a space where ideas flow freely, where knowledge is shared effortlessly, and where learning transcends classrooms. That's UniCollab for you.
## 🖌️ Scope of the Project
To actively contribute to UniCollab, I encourage you to delve into the [PROPOSED-AIM](AIM_OF_THIS_PROJECT.md) file which provides a comprehensive outline of our project's overarching goals and feature set. If you identify features that are needed but not yet implemented(as mostly are), please create an issue outlining the feature request for discussion and implementation. Your input will drive UniCollab's evolution as a dynamic and impactful platform for student collaboration.
## 🔄 Tech Stack
Proposed tech stack for project(although you are free to use any other stack outside of these):
1. **Backend:**
- Node.js with Express.js for the server 💻
- MongoDB for the database (using Mongoose for object modeling) 📊
- Firebase Authentication for user authentication and authorization 🔐
- Firebase Cloud Functions for serverless backend logic ☁️
2. **Frontend:**
- React.js for a dynamic and responsive user interface ⚛️
- HTML5, CSS3, JavaScript for elegant and modern design 🎨
- Firebase Hosting for fast and secure web hosting 🚀
- Firebase Realtime Database for real-time data synchronization 🔥
3. **DevOps & Deployment:**
- Continuous Integration/Continuous Deployment (CI/CD): GitLab CI/CD for automated testing and deployment 🔄
- Containerization: Docker for efficient and scalable deployment 🐳
- Orchestration: Kubernetes for managing containerized applications ⚙️
4. **Cloud Platform:**
- Hosting: AWS (Amazon Web Services) for reliable and scalable hosting ☁️
- Serverless Computing: AWS Lambda for cost-effective and scalable backend services 🚀
- Storage: AWS S3 for secure and scalable storage solutions 📦
5. **Machine Learning & AI:**
- Frameworks: TensorFlow and PyTorch for advanced machine learning capabilities 🧠
- Libraries: scikit-learn, pandas, NumPy for data manipulation and analysis 📊
- Deployment: Docker containers for easy deployment of machine learning models 🐳
6. **Database:**
- MongoDB for flexible and scalable NoSQL database solutions 📊
7. **Other Tools and Technologies:**
- Websockets for real-time communication and collaboration features 🔄
- Security: JWT (JSON Web Tokens) for secure authentication and authorization 🔒
- Data Visualization: D3.js or Chart.js for interactive and visually appealing data representation 📊
- Testing: Jest for React.js unit testing, Selenium for end-to-end testing 🧪
## ✔ Key Features
- **Project Showcase:** Showcase your projects and discover what other students are working on.
- **Collaborative Tools:** Work together seamlessly with integrated collaboration tools.
- **Knowledge Sharing:** Share insights, tips, and tricks with a community passionate about learning.
- **Career Opportunities:** Explore internship and job opportunities from our partner organizations.
## 🚀 Get Started
1. **Explore Projects:** Browse through projects and find ones that interest you.
2. **Create Your Profile:** Showcase your skills, projects, and aspirations.
3. **Start Collaborating:** Connect with like-minded individuals and start collaborating.
## 🛠️ Available Scripts
All contributors should look for [LEARN](LEARN.md). This file provides detailed instructions on how to build the project locally and contains other essential information. Whether you're new to the project or a seasoned contributor, the [LEARN](LEARN.md) file is a valuable resource for understanding the project's structure and requirements.
## 📄 Documentation
Explore our comprehensive documentation in the [DOCUMENTATION](Documentation.md) file, which serves as a detailed guide to understanding and contributing to UniCollab. This document covers various aspects of the project, including setup instructions, architecture overview, and contribution guidelines. We recommend referring to this documentation to gain a deeper insight into UniCollab and make meaningful contributions to its development.
## 🛡️ License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## 🌱 Contribute
We believe in the power of collaboration. If you have ideas to improve UniCollab, feel free to contribute! Check out our [Contribution Guidelines](CONTRIBUTING.md) to get started.
## 🤝 Contributors
Kudos to you wonderful and dedicated contributors <br>
<a href="https://github.com/SUGAM-ARORA/UniCollab/graphs/contributors">
<img src="https://contrib.rocks/image?repo=SUGAM-ARORA/UniCollab" />
</a>
## 📬 Contact Details
You can connect with me on various platforms:<br>
[](https://linkedin.com/in/sugam-arora-117265142) [](https://instagram.com/sugam.arora.393?utm_source=qr&igshid=MzNlNGNkZWQ4Mg%3D%3D) [](https://twitter.com/SugamArora14) [](https://facebook.com/sugam.arora.393)[](https://youtube.com/@sugamarora5997)
[](mailto:sugam.arora23@gmail.com)
## 🌟 Join Us
Ready to embark on a journey of collaborative learning? Join UniCollab now and be a part of a community that believes in the power of collaboration!
Thank you for contributing to our open-source project! We appreciate your support 🚀
Don't forget to leave a star ⭐
<p align="right">{<a href="#top">Back to top</a>}</p> | UniCollab is more than just a platform; it's a gateway to a world where students from different universities/colleges converge to collaborate, innovate, and elevate their projects. Imagine a space where ideas flow freely, where knowledge is shared effortlessly, and where learning transcends classrooms. That's UniCollab for you. | aws,azure,css,html5,javascript,machine-learning,plagiarism-checker,python,vscode | 2023-09-19T03:01:55Z | 2024-05-22T10:40:30Z | null | 22 | 44 | 97 | 59 | 60 | 34 | null | MIT | JavaScript |
internoapp/pocketblocks | main | 
<img src="client/packages/openblocks/src/assets/images/logo-with-name.svg" width="280" alt="Logo">
## What is PocketBlocks?
**Openblocks + PocketBase = PocketBlocks.**
PocketBlocks is a integration between Openblocks and PocketBase.
Traditionally, building an internal app requires complex frontend and backend interactions with hundreds and thousands lines of code, not to mention work on packaging, integration and deployment. PocketBlocks significantly reduces the work you need to do to build an app.
In PocketBlocks, all you need to do is drag and drop pre-built or self-customized components onto the What-You-See-Is-What-You-Get (WYSIWYG) canvas, PocketBlocks helps you build an app quickly and focus on business logic.
## Why choose PocketBlocks?
- **Open source**: Makes your ideas more feasible.
- **High scalability**: Allows to execute JavaScript almost anywhere you would like to customize your business processes and UI components.
- **Clean design**: Follows the principles of Ant Design and supports display on screens of different sizes. We have a number of UI components, based on which you can freely build dashboard, admin panel, and content management system (CMS).
## How to build an app in PocketBlocks?
Building an internal app basically takes 4 steps:
1. Quickly connect to your Pocketbase API using its SDK.
2. Use pre-built or user-customized UI components to build your app UI.
3. Set up [event handlers](build-apps/event-handlers.md) to trigger javascript functions, control components or other actions in reaction to user interactions.
4. Preview and share your app with others.
## License
AGPL3
| Integration between Openblocks and Pocketbase. | docker,internal-applications,internal-project,internal-tool,internal-tools,javascript,low-code,low-code-development-platform,low-code-framework,no-code | 2023-09-26T00:21:59Z | 2024-05-23T16:04:08Z | 2024-05-21T12:16:05Z | 3 | 29 | 155 | 0 | 3 | 32 | null | AGPL-3.0 | TypeScript |
BidyasagarAnupam/YearBook | main | <!-- Improved compatibility of back to top link: See: https://github.com/othneildrew/Best-README-Template/pull/73 -->
<a name="readme-top"></a>
<!--
*** Thanks for checking out the Best-README-Template. If you have a suggestion
*** that would make this better, please fork the repo and create a pull request
*** or simply open an issue with the tag "enhancement".
*** Don't forget to give the project a star!
*** Thanks again! Now go create something AMAZING! :D
-->
<!-- PROJECT SHIELDS -->
<!--
*** I'm using markdown "reference style" links for readability.
*** Reference links are enclosed in brackets [ ] instead of parentheses ( ).
*** See the bottom of this document for the declaration of the reference variables
*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.
*** https://www.markdownguide.org/basic-syntax/#reference-style-links
-->
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
<!-- PROJECT LOGO -->
<!-- TABLE OF CONTENTS -->
<!-- ABOUT THE PROJECT -->
<h1>About The Project</h1>
<h2><a href="https://year-book-two.vercel.app/index.html">YearBook</a></h2>
Welcome to the Year Book project! This delightful digital Year Book is a showcase of our memorable moments and achievements, crafted exclusively using HTML and CSS.
<h2>Overview</h2>
This project is a testament to the power of simplicity in web design. It relies solely on HTML for content structuring and CSS for elegant styling. You won't find complex scripts or heavy frameworks here; it's all about capturing the essence of our year in a clean and visually appealing way.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<h2>Features</h2>
<b>Memorable Moments: </b>Explore a curated collection of our year's highlights, each accompanied by a photo and a brief description.
<b >User-Friendly Design: </b>Enjoy a seamless user experience, thanks to the harmonious combination of HTML and CSS.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- GETTING STARTED -->
## Getting Started
1.Clone this repository to your local machine.<br/>
2.Open the index.html file in your web browser to start exploring our Year Book.
<!-- CONTRIBUTING -->
## Contribution
We welcome contributions and improvements to this project. Feel free to fork the repository, make your changes, and submit a pull request. Let's make our Year Book even more special together!
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- LICENSE -->
<!-- CONTACT -->
<!-- ACKNOWLEDGMENTS -->
## Acknowledgments
Use this space to find resources you might find helpful. I've included a few of my favorites to kick things off!
* [HTML](https://www.w3schools.com/html/)
* [CSS](https://www.w3schools.com/Css/)
* [GitHub Pages](https://pages.github.com)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- MARKDOWN LINKS & IMAGES -->
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
[contributors-shield]: https://img.shields.io/github/contributors/BidyasagarAnupam/YearBook.svg?style=for-the-badge
[contributors-url]: https://github.com/BidyasagarAnupam/YearBook/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/BidyasagarAnupam/YearBook.svg?style=for-the-badge
[forks-url]: https://github.com/BidyasagarAnupam/YearBook/network/members
[stars-shield]: https://img.shields.io/github/stars/BidyasagarAnupam/YearBook.svg?style=for-the-badge
[stars-url]: https://github.com/BidyasagarAnupam/YearBook/stargazers
[issues-shield]: https://img.shields.io/github/issues/BidyasagarAnupam/YearBook.svg?style=for-the-badge
[issues-url]: https://github.com/BidyasagarAnupam/YearBook/issues
| Year Book for MCA | basic,css,hacktoberfest,hacktoberfest2023,html,javascript | 2023-09-18T19:01:56Z | 2023-10-30T10:09:03Z | null | 17 | 69 | 51 | 29 | 66 | 32 | null | null | HTML |
Grinch3214/vite-starter-markup-template | main | # Vite simple starter markup template
On the Internet, it was difficult for me to find a simple template assembly to replace Gulp, and I decided to implement my “Simple markup template for beginners VITE” so that you can start comfortably developing simple landing pages or simple multi-pages sites. The build leverages Vite's capabilities for a modern and reliable build process.
Key features of this template:
Build Tools: Vite.js
Plugins: Autoprefixer, Imagemin, Imagemin-Webp, PostCSS Sort Media Queries, Vite plugin Image Optimizer
Styles: SCSS
Reset: Reset.css
Get your project up and running quickly with this template and start creating amazing web applications!
## Dependencies
This template uses the following dependencies:
- **[Vite](https://vitejs.dev/):** A next-generation frontend build tool that offers a fast dev server and optimized builds.
- **[autoprefixer](https://www.npmjs.com/package/autoprefixer):** Autoprefixer automatically adds vendor prefixes to CSS.
- **[vite-plugin-image-optimizer](https://github.com/FatehAK/vite-plugin-image-optimizer):** Image optimization (png, jpeg, gif, tiff, webp, avif).
- **[imagemin-webp](https://www.npmjs.com/package/imagemin-webp):** Converts formats such as .png/.jpg etc to .webp format
- **[postcss-sort-media-queries](https://www.npmjs.com/package/postcss-sort-media-queries):** Plugin for sorting and combining CSS media queries with mobile first / desktop first methodologies.
## Starting
1. To start using this template, clone the repository with this command:
```bash
git clone https://github.com/Grinch3214/vite-builder.git
```
2. Then rename the folder "vite-builder" and install the dependencies:
```bash
cd your-project-name
npm install
```
## Further steps
After cloning the template, make sure to clean up and update the following:
1. Remove the .git directory and run `git init` to clean the commit history.
2. Clean up the README.md file.
3. Adapt the LICENSE file to your project.
4. Delete `public/vite.svg`, folder `demo/`, `src/img/**/*`, `src/fonts/**/*` and also `src/scss/**.*` except `style.scss` and `_reset.scss`.
5. Remove unnecessary `.html` files in the `pages` folder.
6. Delete the content from `src/scss/style.scss` except `@import "reset.scss";`.
7. In the `src/js/main.js` file, leave only these import statements: `import '../scss/style.scss';`.
## Scripts
Use the following scripts for your development workflow:
```bash
# Start the development server
npm run dev
# Build for production
npm run build
# Preview the build
npm run preview
```
## Folder Structure
This is the structure of the project:
```plaintext
/
├── node_modules # Node.js dependencies for the project.
├── pages # Folder for additional .html pages
├── public # Public assets and resources
├── src # Source code
│ ├── fonts # Folder for your fonts
│ ├── img # Folder for your images
│ ├── js # Javascript files of your project
│ ├── scss # SCSS styles for your project
├── .gitignore # Files and folders to be ignored by Git
├── index.html # The HTML file for your project
├── LICENSE # The license for your project
├── package-lock.json # Lockfile for your project's dependencies
├── package.json # Defines your project and its dependencies
├── postcss.config.cjs # Configuration for PostCSS
├── README.md # This file
├── vite.config.js # Configuration for Vite
```
## License
This template was created under the [MIT License](LICENSE).
**Thank you and happy coding!** 💻 | ViteJS starter template for markup/vanilla JS | autoprefixer,image-optimizer,imagemin,imagemin-webp,javascript,markup,open-source,reset-css,scss,sort-media-query | 2023-09-23T21:09:35Z | 2024-03-15T13:15:17Z | null | 1 | 1 | 18 | 0 | 1 | 31 | null | MIT | SCSS |
KiranAminPanjwani/MedStats | main | null | A Personal Health Journal Website | beginner-friendly,beginners,bootstrap,contributions-welcome,hacktoberfest,hacktoberfest2023,health,healthcare-application,html-css,html-css-javascript | 2023-10-09T12:27:32Z | 2023-10-31T04:16:47Z | null | 27 | 74 | 159 | 22 | 53 | 30 | null | MIT | HTML |
Luizboaventura1/fastdevelopment | main | <div align="center">
<img src="./assets/logo-fastdevelopment.png" width="150">
</div>
<h1 align="center">FastDevelopment</h1>
<p align="center">FastDevelopment is a tool for those who want more productivity in their projects, but with an easy-to-use platform and a clean, modern design.</p>
## Deploy 🚀
Link: https://fastdevelopment.vercel.app
### Developer guide 📚
[click here](./docs/developer-guide)
### User guide 📖
[click here](./docs/user-guide/Introdution.md)
## Get started with a few commands ⚙️
install dependencies
```bash
npm install
```
Run project
```bash
npm run dev
```
Make the build
```bash
npm run build
```
### Features 🌟
- [x] Login system
- [x] Kanban board
- [ ] Workspace
- [ ] addition of members
## License 📜
[MIT](./LICENSE)
## 🛠 Technologies
- [Vue.js 3](https://vuejs.org)
- [Nuxt.js 3](https://nuxt.com)
- [Tailwind css](https://tailwindcss.com)
- [Pinia](https://pinia.vuejs.org)
- [Scss](https://sass-lang.com)
## Database and tools 🗃️
- [Firebase](https://firebase.google.com/?hl=pt-br)
- [Figma](www.figma.com)
## Libs 📚
- [Motion vueuse](https://motion.vueuse.org)
- [VueUse](https://vueuse.org)
- [Vue draggable](https://sortablejs.github.io/Vue.Draggable/#/simple)
## Interface 🎨
<p align="center">
https://github.com/Luizboaventura1/fastdevelopment/assets/122652168/38c2cca1-3118-44fb-a0b3-dd93093520e0
</p>
## How to Contribute 🚀
1. **Fork the Repository:**
- Fork this repository by clicking the "Fork" button in the top right corner of this page. This will create a copy of the repository in your GitHub account.
2. **Clone the Repository:**
- Clone the forked repository to your local development environment.
```bash
git clone git@github.com:Luizboaventura1/fastdevelopment.git
cd fastdevelopment
3. **Create your firebase project**
- put the environment variables in the `.env.template` example.
4. **Firebase configuration**
- Create a "users" document in Firebase and then create the Google login option in Firebase Authentication
[Detailed installation here](./docs//developer-guide/en-us/structure.md)
## Status 🚦
<h4 align="center">
🚧 FastDevelopment 🚀 In development... 🚧
</h4>
| Agile tool leveraging Kanban methodology 🚀 | firebase,javascript,nuxt,scss,tailwind,vue,vueuse,pinia,tiptap | 2023-09-24T16:52:49Z | 2024-05-21T15:18:04Z | 2024-03-09T17:17:39Z | 1 | 1 | 258 | 0 | 1 | 28 | null | MIT | Vue |
PB2204/Convert-JavaScript-To-Python | main | # Convert JavaScript To Python
Using this NPM package you can convert your JavaScript code to Python and then use it .
## Table of Contents
- [Installation](#installation)
- [Usage](#usage)
- [CLI Command](#cli-command)
- [Project Structure](#project-structure)
- [Limitations](#limitations)
- [License](#license)
- [Contributing](#contributing)
- [Code of Conduct](#code-of-conduct)
- [Learn More](#learn-more)
- [Issues](#issues)
- [Contact](#contact)
## Installation
Provide instructions on how to install and set up your project. Include any prerequisites and step-by-step instructions to ensure a smooth installation process.
```bash
npm i convert-js2py
```
## Usage
Explain how to use your project. Include code examples, usage scenarios, and any relevant information that can help users understand how to get started.
```javascript
// Import the convertJsToPython function from your library
const { translateJSToPython } = require('convert-js2py');
// Define your JavaScript code that you want to convert
const jsCode = `
console.log("Hello, World!");
`;
// Use the convertJsToPython function to convert the JavaScript code to Python
const pythonCode = translateJSToPython(jsCode);
// Print the generated Python code
console.log(pythonCode);
```
You can see the translated Python code in the terminal .
## CLI Command
If your project includes a CLI command, provide instructions on how to use it. Include examples of how to run the command and its various options.
```bash
npm i convert-js2py
# Convert a JavaScript file to Python
js-to-python test.js output
```
here `test.js` is your input JavaScript file and `output` is the folder name where the `output.py` file will be written.
## Project Structure
``` bash
js-to-python-converter/
├── bin/
│ └── js-to-python.js
├── lib/
│ ├── converter.js
│ └── index.js
├── package.json
├── LICENSE
├── CODE_OF_CONDUCT.md
├── LEARN.md
├── CONTRIBUTING.md
└── README.md
```
## Limitations
This can't convert a complex JavaScript code into a Python code now , but we'll fix this ASAP .
## License
This project is licensed under the [License Name] - see the [LICENSE](https://github.com/PB2204/Convert-JavaScript-To-Python/LICENSE) file for details.
## Contributing
Contributions are welcome! Please read [CONTRIBUTING.md](https://github.com/PB2204/Convert-JavaScript-To-Python/CONTRIBUTING.md) for details on how to contribute to this project.
## Code of Conduct
Please read [CODE_OF_CONDUCT.md](https://github.com/PB2204/Convert-JavaScript-To-Python/CODE_OF_CONDUCT.md) for our code of conduct.
## Learn More
Visit [LEARN.md](https://github.com/PB2204/Convert-JavaScript-To-Python/LEARN.md) for additional resources, tutorials, and documentation related to this project.
## Issues
If you encounter any issues, bugs, or have questions, please open an issue on the [Issues](https://github.com/PB2204/Convert-JavaScript-To-Python/issues) page.
## Contact
For further information or inquiries about this project, you can contact the developer:
- Developer Name: [Pabitra Banerjee](https://pabitrabanerjee.me)
- Email: [rockstarpabitra2204@gmail.com](mailto:rockstarpabitra2204@gmail.com)
- GitHub: [PB2204](https://github.com/PB2204)
## Happy Coding 🚀 | Using this NPM package you can convert your JavaScript code to Python and then use it . | development,javascript,javascript-library,programming,python,transpiler,code-conversation,collaborate,communityexchange,ghdesktop | 2023-09-25T19:58:51Z | 2023-09-25T20:49:11Z | 2023-09-25T20:49:11Z | 1 | 0 | 9 | 1 | 2 | 28 | null | MIT | JavaScript |
easy-form/react-form-simple | main | <div align="center">
<a href="https://easy-form.github.io/react-form-simple" target="_blank">
<img src="./public//logo.jpg" alt="React-form-simple logo" width="100%">
</a>
</div>
<br />
<div align="center">
[](https://github.com/easy-form/react-form-simple/actions/workflows/test.yml)
[](https://npmjs.org/package/react-form-simple)
[](https://npmjs.org/package/react-form-simple)
<div>
English | <a href="https://github.com/easy-form/react-form-simple/blob/master/README.zh-CN.md">简体中文</a>
</div>
</div>
<br />
## 📚 Documentation
- [English](https://easy-form.github.io/react-form-simple)
- [简体中文](https://easy-form.github.io/react-form-simple/zh-CN)
## ✨ Features
- By creating an observable object to observe the model operation of the form, the controlled form items are assigned directly through `_.`.
- You can complete form control with just a few lines of code. You don't need to care about the controlled logic or the controlled process. You only need to know the controlled results and how to apply your controlled state.
- The rendering between each form item is automatically completely isolated, without the need for self organizing component isolation. This will enable faster response time after form input and greatly avoid page lag caused by large dynamic data.
- With data observation function, it can perform single or unified observation and monitoring of the entire form or a specific form item in certain scenarios. It can subscribe to values where you need to render with the latest values of form items.
- Flexible usage methods, flexible page layout combinations, developers can use certain methods and built-in layouts according to their preferences and scenarios. In most scenarios, developers do not need to manually lay out.
- Minimalist API design, in the process of operating forms, simply introducing two APIs can complete most of the work.
- Highly scalable form interface for easy customization of forms.
- Easy integration with third-party UI.
- Complete type inference.
## 📦 Installing
Using NPM
```
npm install react-form-simple
```
Using Yarn
```
yarn add react-form-simple
```
## 🔨 Usage
Create form items using the 'render' function
```js
import { useForm } from 'react-form-simple';
const { render } = useForm(fields, [config]);
```
Create form items in component form
```js
import { Form, FormItem } from 'react-form-simple';
```
## 💻 Demo
```js
import Button from '@components/Button';
import React from 'react';
import { useForm } from 'react-form-simple';
export default function App() {
const { render, model } = useForm({
name: '',
age: '',
});
const renderName = render('name')(<input className="input" />);
const renderAge = render('age')(<input className="input" />);
const renderSubmit = (
<Button onClick={() => console.log(model)}>submit</Button>
);
return (
<>
{renderName}
{renderAge}
{renderSubmit}
</>
);
}
```
## 🎧 Watch
```js
import Button from '@components/Button';
import React from 'react';
import { useForm } from 'react-form-simple';
export default function App() {
const { render, model, useWatch } = useForm({ name: '' });
const renderName = render('name')(<input className="input" />);
useWatch(
({ model }) => [model.name],
(value) => {
/** code */
},
);
return (
<>
{renderName}
{renderAge}
</>
);
}
```
## 📄 Unit Test
<div >
<img src="./public/unit-test01.jpg" alt="unit-test" width="80%">
</div>
<div >
<img src="./public/unit-test02.jpg" alt="unit-test" width="80%">
</div>
## 🤝 Community
### <div align="center">Join WeChat Group</div>
<div align="center">
<img src="./public/wechat-group.jpg?v=3" alt="wechat-group" width="30%">
</div>
## 📝 License
[MIT](https://github.com/easy-form/react-form-simple/blob/main/LICENSE)
| A form library for quickly controlling react form input | form,form-builder,form-validation,forms,hooks,javascript,library,react,react-form,react-form-hook | 2023-10-08T09:16:01Z | 2024-05-20T03:17:15Z | 2024-05-09T13:57:28Z | 3 | 74 | 237 | 0 | 3 | 26 | null | MIT | TypeScript |
calwoodford/anki_decks | main | # anki_decks
<div align="center">
<img height="60" src="https://upload.wikimedia.org/wikipedia/commons/thumb/3/3d/Anki-icon.svg/1200px-Anki-icon.svg.png">
<h1>Full Stack Anki Flashcards</h1>
<br>
<a href="https://ankiweb.net/shared/info/376600095?cb=1696104749579"> Download the Anki deck here </a>
<br>
<br>
<img src="./images/learning.gif" alt="Neo learning">
<br>
<br>
</div>
<div style="text-align: justify;">
Questions and answers for [Anki](https://apps.ankiweb.net/) spaced repetition software decks.
---
Please feel free to submit pull requests, which will be added to the decks on the [Anki Web website](https://ankiweb.net/shared/info/376600095?cb=1696104749579). This will download all of the decks, you will be able to choose between topics once it's installed on your system.
If you have previously downloaded the decks and added them to Anki, to get updates and new decks, you will need to manually download and re-add them.
Note: These questions and answers were created in autumn 2023 and information may become outdated in the future.
---
<br>
<div align="center">
<img src="./images/anki_screen.png" height="250px" alt="Anki screen">
</div>
<br>
Anki is [spaced repetition](https://quantifiedself.com/blog/spaced-repetition-and-learning/) software that [optimises learning](https://gwern.net/spaced-repetition) by showing you flashcards, asking you to rate how difficult you found answering it, and then showing you cards that you found more difficult more often.
It is available to use on their web app, desktop software or via their [iOS app](https://apps.apple.com/us/app/ankimobile-flashcards/id373493387).
The benefit of using their mobile app is that it allows one to study whilst on the move, whilst fulfilling other commitments or during downtime such as waiting in a queue.
----
"Every minute of your life which passes resculpts, often imperceptibly, the way your neurons are wired together. Anki is a tool which allows you to get certain neurons to fire together at an interval which science has loosely deemed 'optimal' for keeping them wired together." - [Reddit guy](https://www.reddit.com/r/Anki/comments/171gwp3/its_not_retaining_information_its_sculpting_your/)
'The competitive nature of plasticity affects us all. There is an endless war of nerves going on inside each of our brains. If we stop exercising our mental skills, we do not just forget them: the brain map space for those skills is turned over to the skills we practice instead. If you ever ask yourself, “How often must I practice French, or guitar, or math to keep on top of it?” you are asking a question about competitive plasticity. You are asking how frequently you must practice one activity to make sure its brain map space is not lost to another.' - The Brain That Changes Itself, Norman Doidge.
</div>
---
## Contributors
<a href="https://github.com/calwoodford/anki_decks/graphs/contributors">
<img src="https://contrib.rocks/image?repo=calwoodford/anki_decks" />
</a>
| Questions and answers for Anki spaced repetition software decks. | anki,bootcamp,javascript,js,postgresql,sql,express,expressjs,dataset,flashcard | 2023-09-28T20:39:15Z | 2024-01-19T23:38:41Z | null | 15 | 43 | 236 | 0 | 22 | 26 | null | MIT | null |
harshal255/Unique-Javascript | master | # Contribution is fun! :green_heart:
In order to make a hassle-free environment, I implore you all (_while contributing_) to follow the instructions mentioned below!
Happy Submissions :slightly_smiling_face:
## Contribution Guidelines🏗
Are we missing any of your project, which you think you can add to it❓ We invite you to contribute to this project and make it better.
To start contributing, follow the below guidelines:
**1.** Fork this repository.
**2.** Clone your forked copy of the project.
```
git clone https://github.com/<your_user_name>/Unique-Javascript.git
```
**3.** Navigate to the project directory :file_folder: .
```
cd Unique-Javascript
```
**4.** Add a reference(remote) to the original repository.
```
git remote add upstream https://github.com/harshal255/Unique-Javascript.git
```
**5.** Check the remotes for this repository.
```
git remote -v
```
**6.** 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
```
**7.** Create a new branch.
```
git checkout -b <your_branch_name>
```
**8.** Perform your desired changes to the code base.
**9.** Add your project Details in project.js file (json file).
**10.** Track your changes:heavy_check_mark: .
```
git add .
```
**11.** Commit your changes .
Also you can use Emoji for creating commit message, follow this [GitHub commit Emoji Docs](https://gist.github.com/parmentf/035de27d6ed1dce0b36a) 📚
```
git commit -m "Relevant message"
```
**12.** Push the committed changes in your feature branch to your remote repo.
```
git push -u origin <your_branch_name>
```
**13.** To create a pull request, click on `compare and pull requests`.
**14.** Add appropriate title and description to your pull request explaining your changes and efforts done.
**15.** Click on `Create Pull Request`.
**16** Congratulations :exclamation: You have made a PR to the Unique-Javascript :boom: . Wait for your submission to be accepted and your PR to be merged.(Hacktoberfest 2023)
## Thank you guys for Contributing in my repo 🚀🐍🎮
<a href="https://github.com/harshal255/Unique-Javascript/graphs/contributors">
<img src="https://contrib.rocks/image?repo=harshal255/Unique-Javascript" />
</a>
| This repository contains unique project using html,css & javascript only | css,html,javascript,hacktoberfest,hacktoberfest-accepted,hacktoberfest2023 | 2023-10-06T12:23:10Z | 2023-11-01T20:03:58Z | null | 53 | 92 | 250 | 0 | 61 | 26 | null | null | JavaScript |
codeesura/Anti-phishing-extension | main | # Anti-Phishing Extension
This repository contains the [Anti-Phishing](https://chrome.google.com/webstore/detail/anti-phishing/npipcajipdkafdkellochifbfmppdalo) Google Chrome Extension developed to protect users from potential phishing attacks. With the Anti-Phishing Extension, users can easily check the safety of the websites they visit.
## Table of Contents
1. [Features](#features)
2. [Extension Overview](#extension-overview)
3. [Directory Structure](#directory-structure)
4. [Installation](#installation)
- [From Google Web Store](#from-google-web-store)
- [Manually](#manually)
5. [Usage](#usage)
6. [Contributing](#contributing)
7. [License](#license)
8. [Contact](#contact)
## Features
- **Real-Time Website Scanning**: The Extension scans the websites visited by the user in real-time.
- **Blacklist Checking**: Visited sites are checked against an updated blacklist.
- **Alert System**: The user receives immediate alerts if the visited site is on the blacklist.
## Extension Overview
The Anti-Phishing Extension is designed to serve as a primary defense line against malicious phishing websites for users. Incorporating a mix of real-time website scanning and an updated blacklist check, the extension strives to provide a seamless and secure browsing experience.
### How it Works
1. **Real-Time Scanning:**
- Once a webpage is accessed, the extension immediately begins its scanning process in the background.
- It evaluates the structure of the website, domain details, and other metadata to determine its authenticity.
2. **Blacklist Verification:**
- The URL of the visited website is cross-referenced with an extensive blacklist database.
- If a match is found, it signifies that the website has been previously identified as harmful or suspicious.
3. **User Notification and Blockage:**
- Should the website be flagged as suspicious, an overlay alert system is activated. This overlay will cover the entire website, preventing the user from interacting with potentially harmful content.
- This ensures that users do not accidentally engage in potentially harmful activities, such as interacting with fake crypto wallets or entering sensitive information like credit card details.
4. **Active/Inactive Toggle:**
- The extension comes with a toggle button allowing users to activate or deactivate its functionality as per their needs.
- By toggling the extension to the inactive state, it will cease its scanning and alert processes until reactivated.
## Directory Structure
- `filter/`: This directory contains the logic for filtering the domains in the blacklist, considering different domain extensions, the first two characters, and the total length of the domain.
- `website/`: This directory holds the source code for the anti-phishing website.
- `extension/`: This directory contains the source code for the Chrome extension.
## Installation
### From Google Web Store
1. You can download and install the Extension from the Google Web Store [Anti Phishing](https://chrome.google.com/webstore/detail/anti-phishing/npipcajipdkafdkellochifbfmppdalo).
### Manually
1. Clone the repository to your local machine.
```sh
git clone https://github.com/codeesura/Anti-phishing-extension.git
```
2. Open `chrome://extensions/` page in your Chrome browser.
3. Enable "Developer mode" in the top right corner.
4. Click on "Load unpacked" and select the `extension/` directory from the cloned repository.
5. The Extension should now be installed and active in your browser.
## Usage
Once the Extension is successfully installed, it will be active in your browser. The websites you visit will be automatically scanned, and you will receive alerts if a website is on the blacklist.
## Contributing
If you'd like to contribute to the project, please follow the steps below:
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## Contact
If you have any questions about our project, you can reach us at: [codeesura@gmail.com](mailto:codeesura@gmail.com)
| Safeguard your online experience with Anti-Phishing Extension! This extension is meticulously developed to protect users from potential phishing attacks by actively scanning the websites visited in real-time. It employs an updated blacklist to cross-check each website and promptly alerts users if a potential threat is detected, enhancing | anti-phishing,blacklist,browser-extension,chrome-extension,cybersecurity,internet-safety,javascript,phishing-protection,web-security,real-time-scanning | 2023-09-17T14:19:23Z | 2024-05-23T08:16:49Z | null | 1 | 0 | 184 | 0 | 11 | 25 | null | MIT | JavaScript |
d-coder111/DSAmplify | main | # DSAmplify: Cultivating Knowledge, Fostering Collaboration 👩💻
📌Our aim is to build a website that comprehensively covers algorithms in C++, Java, Python, and other programming languages, along with acknowledging the contributors to this repository.
#### For that our to-do tasks are-
1. Data Structures and algorithm programs implemented in C++ & Java and other languagues.
2. Making a html,css and javascript page to form a working website showing all the contributors and along with their contributions in this repository.
<div align="left">
[](https://github.com/d-coder111/DS-algo-fundamentals-cpp-JAVA)
[](https://github.com/d-coder111/DS-algo-fundamentals-cpp-JAVA)
[](https://github.com/d-coder111/DS-algo-fundamentals-cpp-JAVA)
[](https://github.com/d-coder111/DS-algo-fundamentals-cpp-JAVA)
</div>
### 🌟 Steps to Contribute:
1. Register your GitHub ID on [Hackoberfest Website](https://hacktoberfest.com/auth/)
2. Fork the repository and mark it with a star to demonstrate your support⭐.
3. Add the programs in their designated folders or contribute to the web development section of this repository, making sure to avoid redundant and duplicate programs.
4. Commit and push your changes.
5. Create a pull request to the original repository.
6. Your pull request will be reviewed and merged.
### 🎯 Goal
- 🌱 Given that data structures and algorithms constitute the core principles of computer science, our aim is to promote collaboration and learning.
- 🎗 Consequently, we enthusiastically invite programs covering a wide range of complexity, from fundamental to advanced levels, with a specific focus on data structures and algorithms.
- 👩💻 We also welcome people to contribute to build a working website displaying all the contributors and their programs for this repository.
### 💟😊Feel like sprinkling a little stardust of encouragement? Hit that star button on the repository to let us know you're cheering us on!🌟💫
| Hacktoberfest2023 accepted-Our aim is to build a website that comprehensively covers algorithms in C++, Java, Python, and other programming languages, along with acknowledging the contributors to this repository. | cpp,hacktoberfest,hacktoberfest-accepted,java,algorithms,data-structures,hacktoberfest2023,beginner-friendly,css,html | 2023-10-06T22:45:44Z | 2023-11-02T08:50:44Z | null | 43 | 129 | 260 | 3 | 49 | 25 | null | null | Java |
danawoodman/bun-htmx | main | # Bun + HTMX + TailwindCSS example app
A simple example app using Bun and it's HTML server along with HTMX for interactivity and Tailwind + DaisyUI for styling.
- [TypeScript](https://www.typescriptlang.org)
- [Bun](https://bun.sh)
- [HTMX](https://htmx.org)
- [Tailwind](https://tailwindcss.com)
- [DaisyUI](https://daisyui.com)
- [Docker](https://docker.com)
- [Fly.io](https://fly.io)
Source code can be found in `./src`. JSX components live in `./src/components`.
Components are converted to static strings and served as HTML to the browser. HTMX is used to add interactivity to the page as needed.
TailwindCSS classes can be given to any component and the `bun dev:tailwind` command will regenerate the CSS file when needed.
There is a very dumb/simple static file server in `./src/response.tsx` which takes any file in `./public` and serves it using the `Bun.file` helper. This probably shouldn't be used in any production capacity and instead you should use a static file server for these files, but it's here for demonstration purposes.
## Setup
Clone the repo and make sure you have Bun installed, then:
```sh
bun i
```
## Development
```sh
# Run dev server with hot reload (in one tab)
bun dev:server
# Run production server (in another tab)
bun dev:tailwind
```
Now open up <http://localhost:3000> to see the app running.
If you want a custom port or to enable dev mode, create a `.env` file:
```sh
PORT=3000
NODE_ENV="development"
```
## Production
Build a compiled version of the server for running in Bun and TalwindCSS classes:
```sh
bun build:tailwind
bun build:server
```
Now run the built production bundle:
```sh
bun start
```
## Deployment
This projet includes a Dockerfile and docker-compose.yml file so you can run anywhere Docker is supported.
Using Fly.io, you can deploy this by running:
```sh
flyctl launch
```
On subsequent changes, run:
```sh
flyctl deploy
```
## Credits
Put together by me, [Dana Woodman](https://danawoodman.com).
## License
MIT
Use it however you please. [Tweet me](https://twitter.com/danawoodman) if you do something cool with it 🤓
| An example app using Bun's built-in HTTP server + HTMX + TailwindCSS + DaisyUI | bun,daisyui,demo,example,htmx,javascript,node,tailwind,tailwindcss,typescript | 2023-09-13T01:02:37Z | 2023-09-13T16:29:06Z | null | 1 | 1 | 10 | 0 | 7 | 24 | null | null | TypeScript |
jtvargas/TheLock | main |
# The Lock: Game
Mobile application game developed with **React Native** and **Expo**. A game to guess numbers with a spinner. With haptic feedback and visuals as hints and collect different themes.
<img src="./assets/preview/logoexpo.png" width="100" height="25"> <img src="./assets/preview/reactnativelogo.png" width="140" height="25">
## Table of Contents
- [Screenshots](#screenshots)
- [Structure](#structure)
- [Features](#features)
- [Prerequisites](#prerequisites)
- [Dependencies](#dependencies)
- [Installation](#installation)
- [License](#license)
## Screenshots
<img src="./assets/preview/splashscreen.png" width="170" height="300"> <img src="./assets/preview/gamescreen.png" width="170" height="300"> <img src="./assets/preview/themescreen.png" width="170" height="300">
## Structure
The architectural blueprint for this app closely mirrors the **Atomic Design Pattern**.
- `Core Components`: Essential, reusable building blocks like buttons or text inputs.
- `Components`: Customized mix of core components, focused with specific logic.
- `Containers`: Predefined screen layouts. Here, components come together, shaped by page-specific logic (styles, animations...).
- `Screens`: Deploy containers, manage external business logic, like API communication (submit, get data...).
## Features
The current application offers:
- **Customization**: The application is built to support multiple themes and customization using `react-native-unistyles`
- **Full Offline**: The application is built full offline, no need any backend services.
- **Haptic Engine**: The application is using haptic engine to enhance the user experience.
- **Redux Toolkit (RTK)**: The application is using redux as global state management.
- **Expo**: The application is built with Expo.
- **In App Review**: The application offer in-app store review.
## Prerequisites
Ensure you have met the following requirements:
* You have installed the latest version of:
* `yarn`
* `npx`
* Expo (**SDK 49**)
## Dependencies
The following major dependencies are used in the project:
- React (`react: 18.2.0`)
- React Native (`react-native: 0.72.5`) as the main frameworks for building the app interface.
- Expo (`expo: 49.0.13`, `expo-haptics: 12.6.0`, `expo-font: ~11.4.0`, `expo-splash-screen: ~0.20.5`,) as the framework for bootstrapping the application.
- Redux (`redux: 4.2.1`, `@reduxjs/toolkit:1.9.7`) as global state management.
## Installation
Describe the installation process. Include the step-by-step process.
```bash
# Clone this repository
$ git clone git@github.com:jtvargas/TheLock.git
# Go into the repository
$ cd TheLock
# Install dependencies
$ yarn install
# Start the server
$ yarn start-clear-cache
```
### Run the app (**Simulator**)
**iOS**
- Run `yarn ios`
**Android**
- At the moment this app has been focused for iOS platform only, but you can try the android app using `yarn android`
### Run the app (**Device**)
This app is made with `Expo` so after start the server (`yarn start`) in the console will prompt a QR Code, you need to scan this code with your device camera.
## Supporting the project
You can support the maintainer of this project through the links below
[](https://www.buymeacoffee.com/dev0x07)
## License
Copyright 2023 © Jonathan Taveras | Mobile game made with React Native and Expo | expo,game,ios-app,javascript,react-native,typescript | 2023-10-07T12:26:53Z | 2023-12-22T22:19:07Z | null | 1 | 18 | 57 | 1 | 5 | 23 | null | MIT | TypeScript |
bytecodealliance/StarlingMonkey | main | # The StarlingMonkey JS Runtime
StarlingMonkey is a [SpiderMonkey](https://spidermonkey.dev/) based JS runtime optimized for use in [WebAssembly Components](https://component-model.bytecodealliance.org/).
StarlingMonkey's core builtins target WASI 0.2.0 to support a Component Model based event loop and standards-compliant implementations of key web builtins, including the fetch API, WHATWG Streams, text encoding, and others. To support tailoring for specific use cases, it's designed to be highly modular, and can be readily extended with custom builtins and host APIs.
## Requirements
The runtime's build is managed by [cmake](https://cmake.org/), which also takes care of downloading the build dependencies.
To properly manage the Rust toolchain, the build script expects [rustup](https://rustup.rs/) to be installed in the system.
## Building and Running
With sufficiently new versions of `cmake` and `rustup` installed, the build process is as follows:
1. Clone the repo
```bash
git clone https://github.com/bytecodealliance/StarlingMonkey
cd StarlingMonkey
```
2. Run the configuration script
For a release configuration, run
```bash
cmake -S . -B cmake-build-release -DCMAKE_BUILD_TYPE=Release
```
For a debug configuration, run
```bash
cmake -S . -B cmake-build-debug -DCMAKE_BUILD_TYPE=Debug
```
3. Build the runtime
The following command will build the `starling.wasm` runtime module in the `cmake-build-release` directory:
```bash
# Use cmake-build-debug for the debug build
# Change the value for `--parallel` to match the number of CPU cores in your system
cmake --build cmake-build-release --parallel 8
```
4. Testing the build
After completing the build (a debug build in this case), the integration test runner can be built:
```bash
cmake --build cmake-build-debug --target integration-test-server
```
Then tests can be run with `ctest` directly via:
```bash
ctest --test-dir cmake-build-debug -j8 --output-on-failure
```
Alternatively, the integration test server can be directly run with `wasmtime serve` via:
```bash
wasmtime serve -S common cmake-build-debug/test-server.wasm
```
Then visit http://0.0.0.0:8080/timers, or any test name and filter of the form `[testName]/[filter]`
5. Using the runtime with other JS applications
The build directory contains a shell script `componentize.sh` that can be used to create components from JS applications. `componentize.sh` takes a single argument, the path to the JS application, and creates a component with a name of the form `[input-file-name].wasm` in the current working directory.
For example, the following command is equivalent to the `cmake` invocation from step 5, and will create the component `cmake-build-release/smoke.wasm`:
```bash
cd cmake-build-release
./componentize.sh ../tests/smoke.js
```
## Thorough testing with the Web Platform Tests suite
StarlingMonkey includes a test runner for the [Web Platform Tests](https://web-platform-tests.org/) suite. The test runner is built as part of the `starling.wasm` runtime, and can be run using the `wpt-test` target.
### Requirements
The WPT runner requires `Node.js` to be installed, and during build configuration the environment variable `WPT` must be defined.
When running the test, `WPT_ROOT` must be set to the path of a checkout of the WPT suite at revision `1014eae5e66f8f334610d5a1521756f7a2fb769f`:
```bash
WPT=1 WPT_ROOT=[path to your WPT checkout] cmake -S . -B cmake-build-debug -DCMAKE_BUILD_TYPE=Debug
cmake --build cmake-build-debug --parallel 8 --target wpt-runtime
cd cmake-build-debug
ctest --verbose # Note: some of the tests run fairly slowly in debug builds, so be patient
```
## Configuring available builtins
StarlingMonkey supports enabling/disabling bundled builtins using CMake options. You can get a full list of bundled builtins by running the following shell command:
```shell
cmake -P [PATH_TO_STARLING_MONKEY]/cmake/builtins.cmake
```
Note that it's required to include builtins defining all exports defined by the used host API. Using the default WASI 0.2.0 host API, that means including the `fetch_event` builtin.
## Using StarlingMonkey as a CMake sub-project
StarlingMonkey can be used as a subproject in a larger CMake project.
The importing project must at a minimum contain the following line in its `CMakeLists.txt`:
```cmake
include("${PATH_TO_STARLING_MONKEY}/cmake/add_as_subproject.cmake")
```
With that line added (and `${PATH_TO_STARLING_MONKEY}` replaced with the actual path to StarlingMonkey), the importing project will have all the build targets of StarlingMonkey available to it.
Note that building the `starling.wasm` target itself will result in the linked `starling.wasm` file being created in the `starling.wasm` sub-directory of the importing project's build directory.
To make use of importing StarlingMonkey in this way, you'll probably want to add additional builtins, or provide your own implementation of the host interface.
### Adding custom builtins
Adding builtins is as simple as calling `add_builtin` in the importing project's `CMakeLists.txt`. Say you want to add a builtin defined in the file `my-builtin.cpp`, like so:
```cpp
// The extension API is automatically on the include path for builtins.
#include "extension-api.h"
// The namespace name must match the name passed to `add_builtin` in the CMakeLists.txt
namespace my_project::my_builtin {
bool install(api::Engine* engine) {
printf("installing my-builtin\n");
return true;
}
} // namespace my_builtin
```
This file can now be included in the runtime's builtins like so:
```cmake
add_builtin(my_project::my_builtin SRC my-builtin.cpp)
```
If your builtin requires multiple `.cpp` files, you can pass all of them to `add_builtin` as values for the `SRC` argument.
### Providing a custom host API implementation
The [host-apis](host-apis) directory contains implementations of the host API for different versions of WASI. Those can be selected by setting the `HOST_API` environment variable to the name of one of the directories. By default, the [wasi-0.2.0](host-apis/wasi-0.2.0) host API is used.
To provide a custom host API implementation, you can set `HOST_API` to the (absolute) path of a directory containing that implementation.
| The StarlingMonkey JS runtime | component-model,javascript,js,runtime,wasi,wasm,webassembly,webassembly-components | 2023-10-04T11:20:34Z | 2024-05-21T17:58:50Z | null | 16 | 25 | 35 | 13 | 8 | 22 | null | Apache-2.0 | C |
pezzolabs/UniLLM | main | <p align="center">
<a href="https://docs.unillm.ai/" target="_blank">
<img src="https://cdn.pezzo.ai/unillm/logo-light-mode.svg" alt="logo" width="280">
</a>
</p>
<p align="center">
<strong>UniLLM allows you to call any LLM using the OpenAI API, with 100% type safety.</strong>
</p>
<p align="center">
<img src="https://github.com/pezzolabs/unillm/actions/workflows/ci.yaml/badge.svg" />
<a href="CODE_OF_CONDUCT.md">
<img src="https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg" alt="Contributor Covenant">
</a>
<a href="https://opensource.org/licenses/MIT">
<img src="https://img.shields.io/badge/License-MIT-blue.svg" alt="License">
</a>
<a href="https://www.npmjs.com/package/unillm" target="_blank">
<img src="https://img.shields.io/badge/npm-unillm-green">
</a>
</p>
<p align="center">
<img src="https://cdn.pezzo.ai/unillm/animated-demo.gif" width="540" />
</p>
# Benefits
- ✨ Integrate with any provider and model using the OpenAI API
- 💬 Consistent chatCompletion responses and logs across all models and providers
- 💯 Type safety across all providers and models
- 🔁 Seamlessly switch between LLMs without rewriting your codebase
- ✅ If you write tests for your service, you only need to test it once
- 🔜 (Coming Soon) Request caching and rate limiting
- 🔜 (Coming Soon) Cost monitoring and alerting
# Usage
## [✨ Check our interactive documentation ✨](https://docs.unillm.ai)
## 💬 Chat Completions
With UniLLM, you can use chat completions even for providers/models that don't natively support it (e.g. Anthropic).
```bash
npm i unillm
```
```ts
import { UniLLM } from 'unillm';
const unillm = new UniLLM();
// OpenAI
const response = await unillm.createChatCompletion("openai/gpt-3.5-turbo", { messages: ... });
const response = await unillm.createChatCompletion("openai/gpt-4", { messages: ... });
// Anthropic
const response = await unillm.createChatCompletion("anthropic/claude-2", { messages: ... });
const response = await unillm.createChatCompletion("anthropic/claude-1-instant", { messages: ... });
// Azure OpenAI
const response = await unillm.createChatCompletion("azure/openai/<deployment-name>", { messages: ... });
// More coming soon!
```
Want to see more examples? Check out the **[interactive docs](https://docs.unillm.ai)**.
## ⚡️ Streaming
To enable streaming, simply provide `stream: true` in the options object. Here is an example:
```ts
const response = await unillm.createChatCompletion("openai/gpt-3.5-turbo", {
messages: ...,
stream: true
});
```
Want to see more examples? Check out the **[interactive docs](https://docs.unillm.ai)**.
# Contributing
We welcome contributions from the community! Please feel free to submit pull requests or create issues for bugs or feature suggestions.
If you want to contribute but not sure how, join our [Discord](https://discord.gg/XcEVPePwn2) and we'll be happy to help you out!
Please check out [CONTRIBUTING.md](CONTRIBUTING.md) before contributing.
# License
This repository's source code is available under the [MIT](LICENSE).
| 🦄 Consume any LLM from any provider, using the OpenAI API | ai,api,gpt-3,gpt-4,hacktoberfest,javascript,langchain,llm,llmops,monitoring | 2023-10-10T21:58:03Z | 2023-10-23T01:21:11Z | null | 1 | 1 | 39 | 0 | 0 | 21 | null | MIT | TypeScript |
Trevohack/TryHackMe-Zero-To-Hero | main |
<div align="center">
<a target="_blank" href="#"><img src="https://i.postimg.cc/mZmsVfV8/f7450454-158c-45e0-8b38-0c0ae4d7394c.png" width="1000"></a>
</div>
<h1 align="center">TryHackMe - Hackers Learning Path</h1>
* Below is a series of rooms/machines in TryHackMe for beginners to cyber security to learn and practice.
## Ultimate Setup
* Configure environment in one line!
```bash
trevohack@anonymous $ curl -O https://raw.githubusercontent.com/Trevohack/TryHackMe-Zero-To-Hero/main/Scripts/setup.sh && chmod +x setup.sh && ./setup.sh
```
## Beginner Level Theory - [ 0x1 - 0x6 ]
- [Tutorial](https://tryhackme.com/room/tutorial)
- [Beginner](https://tryhackme.com/room/beginnerpathintro)
### Linux & Bash
- [Linux](https://tryhackme.com/room/linuxfundamentalspart1)
- [Linux 2](https://tryhackme.com/room/linuxfundamentalspart2)
- [Linux 3](https://tryhackme.com/room/linuxfundamentalspart3)
- [Bash Scripting](https://tryhackme.com/room/bashscripting)
- [Linux Modules](https://tryhackme.com/room/linuxmodules)
### Acquainting yourself with tools
> **Acquainting** yourself with tools in cybersecurity involves learning how to effectively use software, hardware, and techniques to secure digital systems and networks against cyber threats.
#### Nmap & Networking
> Nmap, short for "Network Mapper," is a powerful network scanning and exploration tool used in cybersecurity. It's designed to discover hosts, services, and vulnerabilities within a computer network. Nmap employs various scanning techniques, like TCP, UDP, SYN, and ICMP scans, to identify open ports, services running on those ports, and operating systems. This information is crucial for assessing network security, finding potential entry points, and strengthening defenses against potential threats.
- [Nmap 1](https://tryhackme.com/room/nmap01)
- [Nmap 2](https://tryhackme.com/room/nmap02)
- [Nmap 3](https://tryhackme.com/room/nmap03)
- [Nmap 4](https://tryhackme.com/room/nmap04)
- [Further Nmap](https://tryhackme.com/room/furthernmap)
- [Networking](https://tryhackme.com/jr/introtonetworking)
- [Networking Services](https://tryhackme.com/jr/networkservices)
- [Protocols And Servers](https://tryhackme.com/jr/protocolsandservers)
- [Protocols And Servers 2](https://tryhackme.com/jr/protocolsandservers2)
#### Tmux: Terminal Configuration
- [Tmux](https://tryhackme.com/room/rptmux)
- [Tmux 2](https://tryhackme.com/room/tmuxremux)
#### Burp Suite
> Burp Suite: Essential tool for web app security testing, uncovering vulnerabilities and aiding in their resolution.
- [Burp: The Basics](https://tryhackme.com/jr/burpsuitebasics)
- [Burp: Repeater](https://tryhackme.com/jr/burpsuiterepeater)
- [Burp: Intruder](https://tryhackme.com/jr/burpsuiterepeater)
- [Burp: Other Modules](https://tryhackme.com/jr/burpsuiteom)
#### Metasploit
> Metasploit is a leading penetration testing tool for identifying and testing system vulnerabilities, widely used by cybersecurity professionals.
- [Metasploit: Introduction](https://tryhackme.com/jr/metasploitintro)
- [Metasploit: Exploitation](https://tryhackme.com/jr/metasploitexploitation)
- [Metasploit: Meterpreter](https://tryhackme.com/jr/meterpreter)
### Web Penetration
> Web penetration testing: Assessing web app security by simulating attacks to uncover and address vulnerabilities.
- [Walking An Application](https://tryhackme.com/jr/walkinganapplication)
- [Content Discovery](https://tryhackme.com/jr/contentdiscovery)
- [Subdomain Enumeration](https://tryhackme.com/jr/subdomainenumeration)
- [Authentication Bypass](https://tryhackme.com/jr/authenticationbypass)
- [IDOR](https://tryhackme.com/jr/idor)
- [XSS](https://tryhackme.com/jr/xss)
- [Command Injection](https://tryhackme.com/jr/oscommandinjection)
- [SSRF](https://tryhackme.com/jr/ssrfqi)
- [File Inclusion](https://tryhackme.com/jr/fileinc)
- [SQL Injection](https://tryhackme.com/jr/sqlinjectionlm)
### Vulnerability Research
- [Vulns](https://tryhackme.com/jr/vulnerabilities101)
- [Exploitation](https://tryhackme.com/jr/exploitingavulnerabilityv2)
- [Vulnerability Capstone](https://tryhackme.com/jr/vulnerabilitycapstone)
### Priv Escalation
> Privilege escalation (priv esc) is the act of gaining higher levels of access or privileges than initially granted to a user or system. It involves exploiting vulnerabilities to elevate privileges, granting unauthorized access to resources or actions. This can be a critical step for attackers to gain control over a system, making it a crucial focus in security assessments to prevent unauthorized escalation of privileges.
- [Linux Priv Esc](https://tryhackme.com/jr/linprivesc)
- [Windows Priv Esc](https://tryhackme.com/jr/windowsprivesc20)
### Other Essentials
#### Python
- [Python 1](https://tryhackme.com/room/pythonbasics)
- [Python 2](https://tryhackme.com/room/pythonforcybersecurity)
- [Flask](https://tryhackme.com/room/flask)
#### Poc Scripting
- [Poc Writing](https://tryhackme.com/room/intropocscripting)
#### Javascript
- [Javascript Basics](https://tryhackme.com/room/javascriptbasics)
- [Jason](https://tryhackme.com/room/jason)
## Pro Level - [ 0x7 - 0xD ]
### Active Directory
- [Enumerating AD](https://tryhackme.com/room/adenumeration)
- [Breaching AD](https://tryhackme.com/room/breachingad)
- [Lateral Movement & Pivoting](https://tryhackme.com/room/lateralmovementandpivoting)
- [Exploiting AD](https://tryhackme.com/room/exploitingad)
- [Persisting AD](https://tryhackme.com/room/persistingad)
- [Holo](https://tryhackme.com/room/hololive)
### Buffer Overflow Exploitation
- [Buffer Overflow Prep](https://tryhackme.com/jr/bufferoverflowprep)
- [Brainstorm](https://tryhackme.com/jr/brainstorm)
> You could get to this level or position after completing the above theory content and starting to practice through CTF challenges.
### CTF challenges
> For the machines/rooms mentioned below writeups will be added soon!
#### Easy
- [X] [ Rootme](https://tryhackme.com/room/rrootme)
- [ ] [ Ignite](https://tryhackme.com/room/ignite)
- [X] [ Pickle Rick](https://tryhackme.com/room/picklerick)
- [ ] [ Cyborg](https://tryhackme.com/room/cyborgt8)
- [ ] [ Tomghost](https://tryhackme.com/room/tomghost)
- [ ] [ Source](https://tryhackme.com/room/source)
- [ ] [ Res](https://tryhackme.com/room/res)
- [ ] [ Lazy Admin](https://tryhackme.com/room/lazyadmin)
- [ ] [ Overpass](https://tryhackme.com/room/overpass)
- [ ] [ Startup](https://tryhackme.com/room/startup)
- [ ] [ Wgel CTF](https://tryhackme.com/room/wgelctf)
- [ ] [ Gaming Server](https://tryhackme.com/room/gamingserver)
#### Medium
- [X] [ Athena](https://tryhackme.com/room/4th3n4)
- [ ] [ Wonderland](https://tryhackme.com/room/wonderland)
- [ ] [ Mr Robot CTF](https://tryhackme.com/room/mrrobot)
- [ ] [ dogcat](https://tryhackme.com/room/relevant)
- [ ] [ The Marketplace](https://tryhackme.com/room/marketplace)
- [ ] [ GoldenEye](https://tryhackme.com/room/goldeneye)
#### Hard
- [ ] [ Internal](https://tryhackme.com/room/internal)
- [ ] [ Year of the fox](https://tryhackme.com/room/yotf)
- [ ] [ Retro](https://tryhackme.com/room/retro)
- [ ] [ Ra](https://tryhackme.com/room/ra)
```
Congrats! 🥳 If you have done all the rooms mentioned here, you are officially a penetration tester. You can go ahead in your career with other resources and platforms.
```
| TryHackMe Roadmap | ctfs,cybersec,tryhackme,writeups,cryptography,ctf-solutions,ctf-tools,ctf-writeups,exploitation,javascript | 2023-10-04T12:13:44Z | 2024-04-23T18:56:35Z | null | 1 | 0 | 35 | 1 | 1 | 20 | null | null | JavaScript |
mrmcsoftware/CPUsimulator | main | CPU Simulator And Assembler
===========================
This is an HTML/Javascript CPU simulator and assembler for the CPU I designed.
Originally, I created this CPU on paper many years ago for a homework
assignment in college. More recently, I implemented my design in the
Logisim (and Logisim Evolution) logic simulator, and eventually it ran on an
FPGA. Refer to the [Video Series](#videoseries) section for links to my
youtube series about this design.
<table border=5><tr><td><img src="images/screenshot.png" /></td></tr></table>
<table border=5><tr><td><img src="images/screenshot4.png" /></td></tr></table>
<table border=5><tr><td><img src="images/screenshot3.png" /></td></tr></table>
<table border=5><tr><td><img src="images/screenshot2.png" /></td></tr></table>
<table border=5><tr><td><img src="images/screenshot5.png" /></td></tr></table>
(I purposely used an older browser for the screenshots because I prefer the 3d
look over the flat button look of some modern browsers.)
## Setup and Running
>**OPTIONAL:** If you want a gradual transition between Dark and Light modes,
>uncomment the line containing **transition: color 300ms, background-color 300ms;**
There are various ways of starting up this webpage. If your browser is in your
search path you could simply do the following, for example, at a command prompt:
firefox sim.html
Or you could start your browser and use your browser's "Open File" (or
equivalent) menu option. Or you could use the **`file:///`** URI/protocol and
specify the whole path.
BTW, if you prefer to have the assembler be in a separate tab, you could use
the provided **`assem.html`**, but you would lose the automatic loading of the
program into the simulator.
For a live demo, go to **https://mrmcsoftware.github.io/CPUsimulator** but do
try to use your own copy instead. Since the file loading function will only
upload files from your computer (not a github repo), for the Live Demo, I've
added the **Examples:** drop-down selection button at the top. You can select
the example program you want to run, then click **Start**.
>Note: Ignore **`index.html`** and **`programs.js`**. They are only there to
>make Github Pages work.
## URL Parameters
These are optional parameters you can use if you don't like the defaults.
Use these like this, for example (If specifying this on a terminal commandline,
you probably will need to escape the special characters, depending on your OS
(for example: **`sim.html?dark=false\&assembler=true`** if using Linux,
**`"sim.html?dark=false&assembler=true"`** if using Windows)):
sim.html?dark=false&assembler=true&wordwrap=off&midimode=off&image=2
- **dark=false** - Turn off dark mode
- **assembler=true** - Show the assembler at startup
- **midimode=off** - The assembly program will be providing frequencies rather than midi note numbers
- **verbose=on** - Provide some extra simulation information in the browser's console
- **wordwrap=off** - Don't use word wrap on TTY screen
- **image={number}** - Select which fancy "CPU Simulator" image to use (**0**, **1**, **2**, **3**, **4**, or **-1** (-1 for no image))
## Using The Simulator
All the buttons, input boxes, checkboxes, and file selectors have tool tips
to better explain the function. Hover your pointer over the desired element
to view the tool tip.
The I/O panel contains the Video screen (256x256, 128x128 (scaled to 256x256),
and 320x240), Y and A register LED displays, a 12x7 LED Matrix display, a
Strobe LED and a CPU status LED below it (green means program running, red
means program (CPU) halted).
Below the I/O panel is the TTY screen. Your program can output text to this
TTY screen. After you click **Start**, keyboard focus will automatically
switch to the TTY screen and you will be able to press keys which will then be
given to your program via the **`DATAIN`** instruction. If you click elsewhere
after clicking **Start**, you would need to first click the mouse pointer in
the TTY screen for any key presses to be registered. For any subsequent key
presses, you won't have to click the TTY screen again, unless you have clicked
somewhere else since the click in the TTY screen. Note: any key presses that
occur before a **`DATAIN`** is executed will be buffered and can be seen in
the blue textbox (labeled **KB**) located above the checkboxes.
To the right of the I/O panel and TTY screen is the disassembly panel. You
can click the **Disassemble** button to disassemble (convert your machine code
(the running program) to assembly code) the machine code in the simulated
computer's RAM. The image will be replaced with the disassembled code. Click
**Clear Disassembly** to remove the disassembled code and return the image.
If you click the **Instruction TTY** checkbox on, an Instruction TTY will
appear below the Disassembly panel. When your program runs, the currently
running instruction and a few previously run instructions will be shown. Click
the **Instruction TTY** checkbox off to remove the panel.
>Note: These panels can be resized by clicking on and dragging the resize
>indicators at the bottom-right corner of the panels.
To assemble a program, click the **Assembler** checkbox on. The assembler
section will appear below the simulator. Type (or Paste (by clicking the right
mouse button in the panel)) your assembly code in the leftmost text box. You
can also click the file upload box (some browsers call it **Browse**) below the
assembly panel to select a file to load instead. Click the **Assemble** button
to assemble your program. The text box to the right will show error messages
and general information. You can control what information is shown by selecting
from the drop-down list under the text box. The **Save As:** and
**Save Machine Code As:** buttons will save your assembly source code and your
assembled machine code (once assembled) respectively. The filename will be
**`untitled.asm`** and **`untitled`** respectively if not specified in the
colored text boxes near the buttons. Any saved machine code can be loaded into
the simulator by choosing it with the file upload box at the top right corner
of the simulator section.
>Note: Even though I use uppercase for all the CPU instructions and assembler
>directives in the sample programs and in the lists below, lowercase can also
>be used (even any combination of lowercase and uppercase).
Once assembled, your program will be in the simulated computer's RAM, and you
can click the **Start** button on the simulator to run it. You can click the
**Go To Top** button to conveniently go back to the simulator.
### Pausing and Stepping
Usually, you would first click the **Start** button to start running your
program. You can pause the running program by clicking the **Pause** button.
Click on **Resume** when you want to continue running the program. Or click
the **Step** button to execute a CPU instruction on each click (and then click
**Resume** to return to normal execution if desired). You could also click
**Pause** before clicking **Start**, and then **Step** to step from the
start.
### Halting
The CPU's **`HALT`** instruction will stop the simulation of your program (and
so will the **Reset** button). As a safety measure, when loading in a
previously assembled program into the simulator, or when assembling using the
assembler, a HALT instruction is automatically added at the end of the program
to make sure the program will end instead of executing whatever might be in the
simulated computer's RAM after your program. Be aware of that when assigning
memory locations to your variables.
### Speed
I use Javascript's **`setInterval`** to execute a CPU instruction at most once
every millisecond (since setInterval is in milliseconds). Unfortunately, this
means the fastest the simulation could be is 1000Hz, which is fairly slow.
You can set this interval timer by entering a millisecond value in the yellow
text input box at the top.
You can check the **Fast Mode (Be Careful)** checkbox which will bypass
setInterval by running all the CPU instructions in your program in one shot.
Be careful though, NO simulator control or browser function will be available
until your program either finishes (with a **`HALT`** instruction) or reaches
a **`DATAIN`** instruction (unless you have **`FASTINTR`** in various places
in your code. I'll cover **`FASTINTR`** in the next paragraph). If neither
can happen in your program, an infinite loop will occur and you will likely
need to kill your browser (via whatever method is available in your OS).
SO BE CAREFUL when selecting this option. If a **`DATAIN`** instruction is
reached, Fast Mode will be turned off and you would have to click it on again
(after a key press has satisfied the **`DATAIN`** loop (if there is one in
your program)) if you want it back on. To avoid having to repeatedly click
the Fast Mode checkbox and the TTY screen back and forth, you can press
**`Ctrl-Shift`** in the TTY screen (while the TTY screen has focus) to turn on
Fast Mode - that way the TTY screen won't lose focus. If the **left**
**`Ctrl-Shift`** combination doesn't work for you, try the **right**
**`Ctrl-Shift`**, **OR** hold the **`Ctrl`** key down while pressing **`Shift`**
twice (probably a "browser thing"). Another caveat: if your program takes too
long to either reach HALT or DATAIN, I suspect the browser's "safety feature"
allowing you to stop the script will kick in, except the browser will perhaps
be too busy to put the dialog up, thus creating a worse situation than it was
supposed to solve. This is just a guess though.
There is a partial solution to this problem. **`FASTINTR`** will interrupt the
continuous run loop temporarily allowing the browser to do whatever function
it needs to do, and then go back to Fast Mode until the next **`FASTINTR`**,
a **`HALT`**, or a **`DATAIN`**. It might be challenging to find the best
places to put **`FASTINTR`**. Refer to the example program **`fractal.asm`**
to see where I chose to put it - after each scanline of the generated fractal
image.
### Getting Data Into the Simulated Computer
The **`DATAIN`** CPU instruction will read from the simulated keyboard, the
clock, and the (hypothetical) external device. The external device's value can
be set (in hex) via the orange text input box at the top. For the most part,
you wouldn't likely ever need to set it to anything, but it's there in case you
want to. If the value is set to anything other than 0 (or nothing), any key
press or clock value won't be accurate.
### The Rest
The rest should be (I think) self-explanatory, so I won't cover the rest here.
## Sample Programs
I've provided sample programs in the **examples** directory that you can look
at and run on this simulator to better understand the instruction set, assembler
directives, and the simulated computer's I/O. Both assembly source code
(ending in **`.asm`**) and assembled machine code (no extension) are provided.
For some of the programs you would need to click the checkboxes to set the
necessary option - the program will tell you what you need to check or uncheck.
In the case of **`io`** and **`io.asm`**, if you choose option 2 or 3 from the
menu, you will have to click **Reset** to stop the effect since there's no way
to exit via a key press. Same thing with **`clock`** and **`clock.asm`**.
**`readme`** and **`readme.asm`** don't really do anything, they just contain
all the example instructions listed in this **`README.md`** file. They will,
however, show you how a breakpoint is handled. By the way, for option 2 and
3 of **`io`** and **`io.asm`** you would need to have the **Show Y** checkbox
checked to see the effect, and for option 1, you would need to have the
**No Lag LED Matrix** checkbox unchecked (this program won't tell you this
unlike the other programs). Also by the way, for the programs that have a menu,
press a key not in the menu to exit program.
## CPU Instruction Set
<center>
<TABLE BORDER=2 bgcolor="#6080c8" VALIGN=center CELLPADDING=4>
<TR>
<TH ALIGN=center><b> OpCode </b></TD>
<TH ALIGN=center><b>Instruction</b></TD>
<TH ALIGN=center><b>Function</b></TD>
<TH ALIGN=center><b>Examples</b></TD>
</TR>
<TR>
<TD ALIGN=center><b>0</b></TD>
<TD ALIGN=left><b> LOADI</b></TD>
<TD ALIGN=left><b> Y ⇦ Z</b></TD>
<TD ALIGN=left><b><code> LOADI 128 </code></b></TD>
<!--TD ALIGN=left><b> Y <- Z</b></TD--!>
<!--TD ALIGN=left><b> Y ← Z</b></TD--!>
</TR>
<TR>
<TD ALIGN=center><b>1</b></TD>
<TD ALIGN=left><b> LOAD</b></TD>
<TD ALIGN=left><b> Y ⇦ M(Z)</b></TD>
<TD ALIGN=left><b><code> LOAD Xmin </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>2</b></TD>
<TD ALIGN=left><b> STOREI</b></TD>
<TD ALIGN=left><b> M(Z) ⇦ Y</b></TD>
<TD ALIGN=left><b><code> STOREI X0 </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>3</b></TD>
<TD ALIGN=left><b> STORE</b></TD>
<TD ALIGN=left><b> A ⇦ M(Y), Z ⇦ M(A)</b></TD>
<TD ALIGN=left><b> Not Implemented</b></TD>
</TR>
<TR>
<TD ALIGN=center><b>4</b></TD>
<TD ALIGN=left><b> ADDI</b></TD>
<TD ALIGN=left><b> Y ⇦ Y + Z</b></TD>
<TD ALIGN=left><b><code> ADDI 1 </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>5</b></TD>
<TD ALIGN=left><b> ADD</b></TD>
<TD ALIGN=left><b> Y ⇦ Y + M(Z)</b></TD>
<TD ALIGN=left><b><code> ADD pixel </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>6</b></TD>
<TD ALIGN=left><b> SUBI</b></TD>
<TD ALIGN=left><b> Y ⇦ Y - Z</b></TD>
<TD ALIGN=left><b><code> SUBI 1 </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>7</b></TD>
<TD ALIGN=left><b> SUB</b></TD>
<TD ALIGN=left><b> Y ⇦ Y - M(Z)</b></TD>
<TD ALIGN=left><b><code> SUB Offset </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>8</b></TD>
<TD ALIGN=left><b> JUMP</b></TD>
<TD ALIGN=left><b> PC ⇦ Z</b></TD>
<TD ALIGN=left><b><code> JUMP Menu </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>9</b></TD>
<TD ALIGN=left><b> JUMPI (indirect)</b></TD>
<TD ALIGN=left><b> PC ⇦ M(Z)</b></TD>
<TD ALIGN=left><b><code> JUMPI CalcOff </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>10</b></TD>
<TD ALIGN=left><b> JUMPII (ind.-ind.) </b></TD>
<TD ALIGN=left><b> A ⇦ M(Z), PC ⇦ M(A)</b></TD>
<TD ALIGN=left><b> Not Implemented</b></TD>
</TR>
<TR>
<TD ALIGN=center><b>11</b></TD>
<TD ALIGN=left><b> DATAIN</b></TD>
<TD ALIGN=left><b> Y ⇦ external data</b></TD>
<TD ALIGN=left><b><code> DATAIN </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>12</b></TD>
<TD ALIGN=left><b> HALT</b></TD>
<TD ALIGN=left><b> Stop running</b></TD>
<TD ALIGN=left><b><code> HALT </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>13</b></TD>
<TD ALIGN=left><b> SKIPNEG</b></TD>
<TD ALIGN=left><b> If Y is negative, PC ⇦ PC + 1 </b></TD>
<TD ALIGN=left><b><code> SKIPNEG </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>14</b></TD>
<TD ALIGN=left><b> STROBE</b></TD>
<TD ALIGN=left><b> Generate STROBE pulse</b></TD>
<TD ALIGN=left><b><code> STROBE </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>15</b></TD>
<TD ALIGN=left><b> NOOP</b></TD>
<TD ALIGN=left><b> No Operation</b></TD>
<TD ALIGN=left><b><code> NOOP </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>16</b></TD>
<TD ALIGN=left><b> MULI</b></TD>
<TD ALIGN=left><b> Y ⇦ Y * Z</b></TD>
<TD ALIGN=left><b><code> MULI 10 </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>17</b></TD>
<TD ALIGN=left><b> MUL</b></TD>
<TD ALIGN=left><b> Y ⇦ Y * M(Z)</b></TD>
<TD ALIGN=left><b><code> MUL val </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>18</b></TD>
<TD ALIGN=left><b> DIVI</b></TD>
<TD ALIGN=left><b> Y ⇦ Y / Z</b></TD>
<TD ALIGN=left><b><code> DIVI 10 </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>19</b></TD>
<TD ALIGN=left><b> DIV</b></TD>
<TD ALIGN=left><b> Y ⇦ Y / M(Z)</b></TD>
<TD ALIGN=left><b><code> DIV val </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>20</b></TD>
<TD ALIGN=left><b> MODI</b></TD>
<TD ALIGN=left><b> Y ⇦ Y % Z</b></TD>
<TD ALIGN=left><b><code> MODI 6 </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>21</b></TD>
<TD ALIGN=left><b> MOD</b></TD>
<TD ALIGN=left><b> Y ⇦ Y % M(Z)</b></TD>
<TD ALIGN=left><b><code> MOD num </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>22</b></TD>
<TD ALIGN=left><b> LOADAI</b></TD>
<TD ALIGN=left><b> A ⇦ Z</b></TD>
<TD ALIGN=left><b><code> LOADAI 256 </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>23</b></TD>
<TD ALIGN=left><b> LOADA</b></TD>
<TD ALIGN=left><b> A ⇦ M(Z)</b></TD>
<TD ALIGN=left><b><code> LOADA val </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>24</b></TD>
<TD ALIGN=left><b> JUMPEQI</b></TD>
<TD ALIGN=left><b> If Y = A, PC ⇦ Z</b></TD>
<TD ALIGN=left><b><code> JUMPEQI done </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>25</b></TD>
<TD ALIGN=left><b> JUMPGTI</b></TD>
<TD ALIGN=left><b> If Y > A, PC ⇦ Z</b></TD>
<TD ALIGN=left><b><code> JUMPGTI done </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>26</b></TD>
<TD ALIGN=left><b> JUMPLTI</b></TD>
<TD ALIGN=left><b> If Y < A, PC ⇦ Z</b></TD>
<TD ALIGN=left><b><code> JUMPLTI done </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>27</b></TD>
<TD ALIGN=left><b> JUMPNEQI</b></TD>
<TD ALIGN=left><b> If Y ≠ A, PC ⇦ Z</b></TD>
<TD ALIGN=left><b><code> JUMPNEQI done </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>28</b></TD>
<TD ALIGN=left><b> JUMPGTEI</b></TD>
<TD ALIGN=left><b> If Y ≥ A, PC ⇦ Z</b></TD>
<TD ALIGN=left><b><code> JUMPGTEI done </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>29</b></TD>
<TD ALIGN=left><b> JUMPLTEI</b></TD>
<TD ALIGN=left><b> If Y ≤ A, PC ⇦ Z</b></TD>
<TD ALIGN=left><b><code> JUMPLTEI done </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>30</b></TD>
<TD ALIGN=left><b> NEGY</b></TD>
<TD ALIGN=left><b> Y ⇦ -Y</b></TD>
<TD ALIGN=left><b><code> NEGY </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>31</b></TD>
<TD ALIGN=left><b> STOREAI</b></TD>
<TD ALIGN=left><b> M(Z) ⇦ A</b></TD>
<TD ALIGN=left><b><code> STOREAI t2 </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>32</b></TD>
<TD ALIGN=left><b> LOADAIND</b></TD>
<TD ALIGN=left><b> A ⇦ M(Y)</b></TD>
<TD ALIGN=left><b><code> LOADAIND </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>33</b></TD>
<TD ALIGN=left><b> ANDI</b></TD>
<TD ALIGN=left><b> Y ⇦ Y & Z</b></TD>
<TD ALIGN=left><b><code> ANDI 128 </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>34</b></TD>
<TD ALIGN=left><b> AND</b></TD>
<TD ALIGN=left><b> Y ⇦ Y & M(Z)</b></TD>
<TD ALIGN=left><b><code> AND val </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>35</b></TD>
<TD ALIGN=left><b> ORI</b></TD>
<TD ALIGN=left><b> Y ⇦ Y | Z</b></TD>
<TD ALIGN=left><b><code> ORI 128 </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>36</b></TD>
<TD ALIGN=left><b> OR</b></TD>
<TD ALIGN=left><b> Y ⇦ Y | M(Z)</b></TD>
<TD ALIGN=left><b><code> OR val </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>37</b></TD>
<TD ALIGN=left><b> NOT</b></TD>
<TD ALIGN=left><b> Y ⇦ ~Y</b></TD>
<TD ALIGN=left><b><code> NOT </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>38</b></TD>
<TD ALIGN=left><b> XORI</b></TD>
<TD ALIGN=left><b> Y ⇦ Y ^ Z</b></TD>
<TD ALIGN=left><b><code> XORI 128 </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>39</b></TD>
<TD ALIGN=left><b> XOR</b></TD>
<TD ALIGN=left><b> Y ⇦ Y ^ M(Z)</b></TD>
<TD ALIGN=left><b><code> XOR val </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>40</b></TD>
<TD ALIGN=left><b> JUMPEQ (indirect)</b></TD>
<TD ALIGN=left><b> If Y = A, PC ⇦ M(Z)</b></TD>
<TD ALIGN=left><b><code> JUMPEQ val </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>41</b></TD>
<TD ALIGN=left><b> JUMPGT (indirect)</b></TD>
<TD ALIGN=left><b> If Y > A, PC ⇦ M(Z)</b></TD>
<TD ALIGN=left><b><code> JUMPGT val </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>42</b></TD>
<TD ALIGN=left><b> JUMPLT (indirect)</b></TD>
<TD ALIGN=left><b> If Y < A, PC ⇦ M(Z)</b></TD>
<TD ALIGN=left><b><code> JUMPLT val </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>43</b></TD>
<TD ALIGN=left><b> JUMPNEQ (indirect) </b></TD>
<TD ALIGN=left><b> If Y ≠ A, PC ⇦ M(Z)</b></TD>
<TD ALIGN=left><b><code> JUMPNEQ val </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>44</b></TD>
<TD ALIGN=left><b> JUMPGTE (indirect) </b></TD>
<TD ALIGN=left><b> If Y ≥ A, PC ⇦ M(Z)</b></TD>
<TD ALIGN=left><b><code> JUMPGTE val </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>45</b></TD>
<TD ALIGN=left><b> JUMPLTE (indirect) </b></TD>
<TD ALIGN=left><b> If Y ≤ A, PC ⇦ M(Z)</b></TD>
<TD ALIGN=left><b><code> JUMPLTE val </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>46</b></TD>
<TD ALIGN=left><b> STOREAIND</b></TD>
<TD ALIGN=left><b> M(Y) ⇦ A</b></TD>
<TD ALIGN=left><b><code> STOREAIND </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>47</b></TD>
<TD ALIGN=left><b> FADDA</b></TD>
<TD ALIGN=left><b> Y ⇦ Y + A</b></TD>
<TD ALIGN=left><b><code> FADDA </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>48</b></TD>
<TD ALIGN=left><b> FADD</b></TD>
<TD ALIGN=left><b> Y ⇦ Y + M(Z)</b></TD>
<TD ALIGN=left><b><code> FADD val </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>49</b></TD>
<TD ALIGN=left><b> FSUBA</b></TD>
<TD ALIGN=left><b> Y ⇦ Y - A</b></TD>
<TD ALIGN=left><b><code> FSUBA </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>50</b></TD>
<TD ALIGN=left><b> FSUB</b></TD>
<TD ALIGN=left><b> Y ⇦ Y - M(Z)</b></TD>
<TD ALIGN=left><b><code> FSUB val </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>51</b></TD>
<TD ALIGN=left><b> FMULA</b></TD>
<TD ALIGN=left><b> Y ⇦ Y * A</b></TD>
<TD ALIGN=left><b><code> FMULA </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>52</b></TD>
<TD ALIGN=left><b> FMUL</b></TD>
<TD ALIGN=left><b> Y ⇦ Y * M(Z)</b></TD>
<TD ALIGN=left><b><code> FMUL val </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>53</b></TD>
<TD ALIGN=left><b> FDIVA</b></TD>
<TD ALIGN=left><b> Y ⇦ Y / A</b></TD>
<TD ALIGN=left><b><code> FDIVA </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>54</b></TD>
<TD ALIGN=left><b> FDIV</b></TD>
<TD ALIGN=left><b> Y ⇦ Y / M(Z)</b></TD>
<TD ALIGN=left><b><code> FDIV val </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>55</b></TD>
<TD ALIGN=left><b> FMODA</b></TD>
<TD ALIGN=left><b> Y ⇦ Y % A</b></TD>
<TD ALIGN=left><b><code> FMODA </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>56</b></TD>
<TD ALIGN=left><b> FMOD</b></TD>
<TD ALIGN=left><b> Y ⇦ Y % M(Z)</b></TD>
<TD ALIGN=left><b><code> FMOD val </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>57</b></TD>
<TD ALIGN=left><b> FNEGY</b></TD>
<TD ALIGN=left><b> Y ⇦ -Y</b></TD>
<TD ALIGN=left><b><code> FNEGY </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>58</b></TD>
<TD ALIGN=left><b> FSQRTY</b></TD>
<TD ALIGN=left><b> Y ⇦ sqrt(Y)</b></TD>
<TD ALIGN=left><b><code> FSQRTY </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>59</b></TD>
<TD ALIGN=left><b> FSQRT</b></TD>
<TD ALIGN=left><b> Y ⇦ sqrt(M(Z))</b></TD>
<TD ALIGN=left><b><code> FSQRT val </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>60</b></TD>
<TD ALIGN=left><b> FSINY</b></TD>
<TD ALIGN=left><b> Y ⇦ sin(Y)</b></TD>
<TD ALIGN=left><b><code> FSINY </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>61</b></TD>
<TD ALIGN=left><b> FSIN</b></TD>
<TD ALIGN=left><b> Y ⇦ sin(M(Z))</b></TD>
<TD ALIGN=left><b><code> FSIN val </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>62</b></TD>
<TD ALIGN=left><b> FCOSY</b></TD>
<TD ALIGN=left><b> Y ⇦ cos(Y)</b></TD>
<TD ALIGN=left><b><code> FCOSY </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>63</b></TD>
<TD ALIGN=left><b> FCOS</b></TD>
<TD ALIGN=left><b> Y ⇦ cos(M(Z))</b></TD>
<TD ALIGN=left><b><code> FCOS val </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>64</b></TD>
<TD ALIGN=left><b> FTANY</b></TD>
<TD ALIGN=left><b> Y ⇦ tan(Y)</b></TD>
<TD ALIGN=left><b><code> FTANY </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>65</b></TD>
<TD ALIGN=left><b> FTAN</b></TD>
<TD ALIGN=left><b> Y ⇦ tan(M(Z))</b></TD>
<TD ALIGN=left><b><code> FTAN val </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>66</b></TD>
<TD ALIGN=left><b> FASINY</b></TD>
<TD ALIGN=left><b> Y ⇦ asin(Y)</b></TD>
<TD ALIGN=left><b><code> FASINY </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>67</b></TD>
<TD ALIGN=left><b> FASIN</b></TD>
<TD ALIGN=left><b> Y ⇦ asin(M(Z))</b></TD>
<TD ALIGN=left><b><code> FASIN val </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>68</b></TD>
<TD ALIGN=left><b> FACOSY</b></TD>
<TD ALIGN=left><b> Y ⇦ acos(Y)</b></TD>
<TD ALIGN=left><b><code> FACOSY </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>69</b></TD>
<TD ALIGN=left><b> FACOS</b></TD>
<TD ALIGN=left><b> Y ⇦ acos(M(Z))</b></TD>
<TD ALIGN=left><b><code> FACOS val </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>70</b></TD>
<TD ALIGN=left><b> FATANY</b></TD>
<TD ALIGN=left><b> Y ⇦ atan(Y)</b></TD>
<TD ALIGN=left><b><code> FATANY </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>71</b></TD>
<TD ALIGN=left><b> FATAN</b></TD>
<TD ALIGN=left><b> Y ⇦ atan(M(Z))</b></TD>
<TD ALIGN=left><b><code> FATAN val </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>72</b></TD>
<TD ALIGN=left><b> FATAN2A</b></TD>
<TD ALIGN=left><b> Y ⇦ atan2(Y,A)</b></TD>
<TD ALIGN=left><b><code> FATAN2A </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>73</b></TD>
<TD ALIGN=left><b> FATAN2</b></TD>
<TD ALIGN=left><b> Y ⇦ atan2(Y,M(Z))</b></TD>
<TD ALIGN=left><b><code> FATAN2 val </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>74</b></TD>
<TD ALIGN=left><b> FPOWA</b></TD>
<TD ALIGN=left><b> Y ⇦ pow(Y,A)</b></TD>
<TD ALIGN=left><b><code> FPOWA </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>75</b></TD>
<TD ALIGN=left><b> FPOW</b></TD>
<TD ALIGN=left><b> Y ⇦ pow(Y,M(Z))</b></TD>
<TD ALIGN=left><b><code> FPOW val </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>76</b></TD>
<TD ALIGN=left><b> FLNY</b></TD>
<TD ALIGN=left><b> Y ⇦ ln(Y)</b></TD>
<TD ALIGN=left><b><code> FLNY </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>77</b></TD>
<TD ALIGN=left><b> FLN</b></TD>
<TD ALIGN=left><b> Y ⇦ ln(M(Z))</b></TD>
<TD ALIGN=left><b><code> FLN val </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>78</b></TD>
<TD ALIGN=left><b> FLOGY</b></TD>
<TD ALIGN=left><b> Y ⇦ log(Y)</b></TD>
<TD ALIGN=left><b><code> FLOGY </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>79</b></TD>
<TD ALIGN=left><b> FLOG</b></TD>
<TD ALIGN=left><b> Y ⇦ log(M(Z))</b></TD>
<TD ALIGN=left><b><code> FLOG val </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>80</b></TD>
<TD ALIGN=left><b> FABSY</b></TD>
<TD ALIGN=left><b> Y ⇦ abs(Y)</b></TD>
<TD ALIGN=left><b><code> FABSY </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>81</b></TD>
<TD ALIGN=left><b> FABS</b></TD>
<TD ALIGN=left><b> Y ⇦ abs(M(Z))</b></TD>
<TD ALIGN=left><b><code> FABS val </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>82</b></TD>
<TD ALIGN=left><b> FEXPY</b></TD>
<TD ALIGN=left><b> Y ⇦ exp(Y)</b></TD>
<TD ALIGN=left><b><code> FEXPY </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>83</b></TD>
<TD ALIGN=left><b> FEXP</b></TD>
<TD ALIGN=left><b> Y ⇦ exp(M(Z))</b></TD>
<TD ALIGN=left><b><code> FEXP val </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>84</b></TD>
<TD ALIGN=left><b> FPTOINTY</b></TD>
<TD ALIGN=left><b> Y ⇦ (int)(Y)</b></TD>
<TD ALIGN=left><b><code> FPTOINTY </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>85</b></TD>
<TD ALIGN=left><b> FPTOINT</b></TD>
<TD ALIGN=left><b> Y ⇦ (int)(M(Z))</b></TD>
<TD ALIGN=left><b><code> FPTOINT val </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>86</b></TD>
<TD ALIGN=left><b> INTTOFPY</b></TD>
<TD ALIGN=left><b> Y ⇦ (float)(Y)</b></TD>
<TD ALIGN=left><b><code> INTTOFPY </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>87</b></TD>
<TD ALIGN=left><b> INTTOFP</b></TD>
<TD ALIGN=left><b> Y ⇦ (float)(M(Z))</b></TD>
<TD ALIGN=left><b><code> INTTOFP val </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>88</b></TD>
<TD ALIGN=left><b> FJUMPEQI</b></TD>
<TD ALIGN=left><b> If Y = A, PC ⇦ Z</b></TD>
<TD ALIGN=left><b><code> FJUMPEQI done </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>89</b></TD>
<TD ALIGN=left><b> FJUMPGTI</b></TD>
<TD ALIGN=left><b> If Y > A, PC ⇦ Z</b></TD>
<TD ALIGN=left><b><code> FJUMPGTI done </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>90</b></TD>
<TD ALIGN=left><b> FJUMPLTI</b></TD>
<TD ALIGN=left><b> If Y < A, PC ⇦ Z</b></TD>
<TD ALIGN=left><b><code> FJUMPLTI done </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>91</b></TD>
<TD ALIGN=left><b> FJUMPNEQI</b></TD>
<TD ALIGN=left><b> If Y ≠ A, PC ⇦ Z</b></TD>
<TD ALIGN=left><b><code> FJUMPNEQI done </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>92</b></TD>
<TD ALIGN=left><b> FJUMPGTEI</b></TD>
<TD ALIGN=left><b> If Y ≥ A, PC ⇦ Z</b></TD>
<TD ALIGN=left><b><code> FJUMPGTEI done </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>93</b></TD>
<TD ALIGN=left><b> FJUMPLTEI</b></TD>
<TD ALIGN=left><b> If Y ≤ A, PC ⇦ Z</b></TD>
<TD ALIGN=left><b><code> FJUMPLTEI done </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>94</b></TD>
<TD ALIGN=left><b> FJUMPEQ (indirect)</b></TD>
<TD ALIGN=left><b> If Y = A, PC ⇦ M(Z)</b></TD>
<TD ALIGN=left><b><code> FJUMPEQ val </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>95</b></TD>
<TD ALIGN=left><b> FJUMPGT (indirect)</b></TD>
<TD ALIGN=left><b> If Y > A, PC ⇦ M(Z)</b></TD>
<TD ALIGN=left><b><code> FJUMPGT val </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>96</b></TD>
<TD ALIGN=left><b> FJUMPLT (indirect)</b></TD>
<TD ALIGN=left><b> If Y < A, PC ⇦ M(Z)</b></TD>
<TD ALIGN=left><b><code> FJUMPLT val </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>97</b></TD>
<TD ALIGN=left><b> FJUMPNEQ (indirect) </b></TD>
<TD ALIGN=left><b> If Y ≠ A, PC ⇦ M(Z)</b></TD>
<TD ALIGN=left><b><code> FJUMPNEQ val </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>98</b></TD>
<TD ALIGN=left><b> FJUMPGTE (indirect) </b></TD>
<TD ALIGN=left><b> If Y ≥ A, PC ⇦ M(Z)</b></TD>
<TD ALIGN=left><b><code> FJUMPGTE val </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>99</b></TD>
<TD ALIGN=left><b> FJUMPLTE (indirect) </b></TD>
<TD ALIGN=left><b> If Y ≤ A, PC ⇦ M(Z)</b></TD>
<TD ALIGN=left><b><code> FJUMPLTE val </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>100</b></TD>
<TD ALIGN=left><b> CALL </b></TD>
<TD ALIGN=left><b> Stack ⇦ PC, PC ⇦ Z</b></TD>
<TD ALIGN=left><b><code> CALL print </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>101</b></TD>
<TD ALIGN=left><b> RETURN </b></TD>
<TD ALIGN=left><b> PC ⇦ Stack</b></TD>
<TD ALIGN=left><b><code> RETURN </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>102</b></TD>
<TD ALIGN=left><b> PUSH </b></TD>
<TD ALIGN=left><b> UserStack ⇦ Y</b></TD>
<TD ALIGN=left><b><code> PUSH </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>103</b></TD>
<TD ALIGN=left><b> POP </b></TD>
<TD ALIGN=left><b> Y ⇦ UserStack</b></TD>
<TD ALIGN=left><b><code> POP </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>104</b></TD>
<TD ALIGN=left><b> SREAD </b></TD>
<TD ALIGN=left><b> Y ⇦ UserStack(Z)</b></TD>
<TD ALIGN=left><b><code> SREAD 4 </code></b></TD>
</TR>
</TABLE>
Pseudo Instructions Only Useful In Simulators (Not Part of CPU Design):
<TABLE BORDER=2 bgcolor="#6080c8" VALIGN=center CELLPADDING=4>
<TR>
<TH ALIGN=center><b> OpCode </b></TD>
<TH ALIGN=center><b>Instruction</b></TD>
<TH ALIGN=center><b>Function</b></TD>
<TH ALIGN=center><b>Examples</b></TD>
</TR>
<TR>
<TD ALIGN=center><b>253</b></TD>
<TD ALIGN=left><b> FASTINTR </b></TD>
<TD ALIGN=left><b> Interrupt fast mode temporarily so browser can do things</b></TD>
<TD ALIGN=left><b><code> FASTINTR </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>254</b></TD>
<TD ALIGN=left><b> BREAKPOINTS </b></TD>
<TD ALIGN=left><b> Pause execution to output a 0 (null)-terminated string</b></TD>
<TD ALIGN=left><b><code> BREAKPOINTS Message<br> HALT<br> : Message DCS0 Trace start </code></b></TD>
</TR>
<TR>
<TD ALIGN=center><b>255</b></TD>
<TD ALIGN=left><b> BREAKPOINT </b></TD>
<TD ALIGN=left><b> Pause execution to output a register or memory value</b></TD>
<TD ALIGN=left><b><code> BREAKPOINT aedge2<br> BREAKPOINT $ffffff /* output Y */ </code><br><code> BREAKPOINT $fffffe /* output A */ </code></b></TD>
</TR>
</TABLE>
</center>
## Assembler Directives
<center>
<TABLE BORDER=2 bgcolor="#6080c8" VALIGN=center CELLPADDING=4>
<TR>
<TH ALIGN=center><b>Directive</b></TD>
<TH ALIGN=center><b>Function</b></TD>
<TH ALIGN=center><b>Examples</b></TD>
</TR>
<TR>
<TD ALIGN=left><b> EQU </b></TD>
<TD ALIGN=left><b> Equate label with a value</b></TD>
<TD ALIGN=left><b><code> EQU Menu1 49 EQU Color1 $14ff14 EQU val1 ~12.75 EQU val2 %11101 </code></b></TD>
</TR>
<TR>
<TD ALIGN=left><b> : </b></TD>
<TD ALIGN=left><b> Create an address label (space after ":")</b></TD>
<TD ALIGN=left><b><code> : Loop STROBE NOOP JUMP Loop </code></b></TD>
</TR>
<TR>
<TD ALIGN=left><b> /* */ </b></TD>
<TD ALIGN=left><b> Comment between the delimiters</b></TD>
<TD ALIGN=left><b><code> /* This is a comment */ STROBE /* Another comment */ </code></b></TD>
</TR>
<TR>
<TD ALIGN=left><b> # </b></TD>
<TD ALIGN=left><b> Comment to the end of the line</b></TD>
<TD ALIGN=left><b><code> STROBE # This is a comment </code></b></TD>
</TR>
<TR>
<TD ALIGN=left><b> DC </b></TD>
<TD ALIGN=left><b> Define a constant</b></TD>
<TD ALIGN=left><b><code> : Xstart DC ~3.28125<br> : Values DC 'This_is_a_test','#',1234,%1101,val1,~1.26<br> DC 123 </code></b></TD>
</TR>
<TR>
<TD ALIGN=left><b> DCS+[N,0,I,A] </b></TD>
<TD ALIGN=left><b> Define a string (to the end of the line)<br> N: add newline at end,<br> 0: 0 (null)-terminated string,<br> I: inline (generate code to output to TTY),<br> A: use A register (with I)</b></TD>
<TD ALIGN=left><b><code> DCSI Enter n:<br> DCSNIA This is a test<br> DCSNI Hello World<br> DCS0 Testing 123 </code></b></TD>
</TR>
<TR>
<TD ALIGN=left><b> DS </b></TD>
<TD ALIGN=left><b> Define empty storage (number of bytes)</b></TD>
<TD ALIGN=left><b><code> DS 1 DS 256 DS val2 </code></b></TD>
</TR>
<TR>
<TD ALIGN=left><b> OUTPUT </b></TD>
<TD ALIGN=left><b> If 1, output generated machine code</b></TD>
<TD ALIGN=left><b><code> OUTPUT 1 STROBE NOOP OUTPUT 0 </code></b></TD>
</TR>
</TABLE>
</center>
## Possible Improvements
This simulator could probably be improved to make it faster by using
multithreading. This could possibly be achieved by using "web workers". There
may also be other ways I'm not aware of.
Timing could also be better: I used **`setInterval`**. Many say
**`setTimeout`** would be better. Since this program really isn't showing
animations or video, I'm not sure the benefits of setTimeout would really
apply much. However, the midi sound at times is inconsistent perhaps because
of this.
Also, a better midi note player could be used. I purposely picked one that had
the least amount of added files/dependencies. But there are ones that have
more (and better) instruments, for example.
There is a chance that the Pause/Step/Run sequence could get messed up under
certain circumstances/sequences. This is because there are two variables
(**`interval`** and **`pause`**) that could get out of sync. I think it's
fixed, but I could be wrong.
And finally, I used various javascript graphics fill routines for the LEDs and
video screen. **`createImageData`** / **`putImageData`** could also be used.
In various benchmarks people have performed in the past (non-related to this
project), some say fill routines are faster, some say putImageData is faster.
At any rate, for the video screen, a putImageData would/should be performed
after every pixel is set (to mimic the behavior of the design), so I'm not sure
if performance would be better with putImageData. I tried putImageData two
different ways: "blitting" the whole image each time, and blitting only the
desired pixel each time. There didn't seem to be any performance difference
between the putImageData method and the fill area method. Probably depends on
your hardware, though.
## Acknowledgements
Midi sound javascript (**`audiosynth.js`**) by **Keith William Horwood** (https://keithwhor.com/music/)
## Video Series<a name="videoseries"></a>
- [Testing and Improving My CPU Design with Logisim (And Digital Logic Basics)](https://www.youtube.com/watch?v=YRacHluDx_g)
- [Using My Even More Improved CPU in a Full-Fledged Computer Via Logisim](https://www.youtube.com/watch?v=Os-1ZQ6BXFI)
- [My CPU With Improved Sound and MIDI Musical Keyboard Via Logisim](https://www.youtube.com/watch?v=_VW074myq44)
- [My CPU / Computer: Conversion from Original Logisim to Logisim Evolution](https://www.youtube.com/watch?v=yd7DeWTbfWQ)
- [Converting My CPU to VHDL Via Logisim Evolution (for Eventual FPGA Board?)](https://www.youtube.com/watch?v=drIQLX6GrM4)
- [Converting My CPU to Verilog Via Logisim Evolution (for Eventual FPGA Board?)](https://www.youtube.com/watch?v=zh_X6_6jCik)
- [My CPU: Goodbye Gated Clocks! Hello Indirect Jumps (Now With More Programs)](https://www.youtube.com/watch?v=exkqWAXH0y8)
- [My CPU & Computer Simulator - A Very Useful Tool For My Logisim CPU](https://www.youtube.com/watch?v=Fwkt0emsCnY)
- [My Logisim CPU / Computer - Now With Floating Point (FPU) (Fractals, Raytracer, Etc.)](https://www.youtube.com/watch?v=ygf0aa1r3NY)
- [My CPU / Computer: Hardware Stack, Compilers, Java Simulator, and A Different Version of Logisim](https://www.youtube.com/watch?v=LSVmB59xYwI)
- [My Logisim CPU / Computer: Hardware User Stack for Easy Subroutine Parameter Passing and Recursion](https://www.youtube.com/watch?v=FCvAsunELB4)
- [My CPU Design in an FPGA Via Collaboration with Dr. Kevin Walsh & His Improvements to Logisim](https://www.youtube.com/watch?v=rpuB1mYrEKY)
## Other Resources
Here's some links to my other Github repos pertaining to this CPU design.
The fractal assembly programs were spin-offs of the CPU project.
- [MyCPUfiles](https://github.com/mrmcsoftware/MyCPUfiles)
- [MIDIkeyboard](https://github.com/mrmcsoftware/MIDIkeyboard)
- [FractalAsm](https://github.com/mrmcsoftware/FractalAsm)
- [FractalAsm-Linux](https://github.com/mrmcsoftware/FractalAsm-Linux)
## Author
Mark Craig
[https://www.youtube.com/MrMcSoftware](https://www.youtube.com/MrMcSoftware)
| This is an HTML/Javascript CPU simulator and assembler for the CPU I designed. Originally, I created this CPU on paper many years ago for a homework assignment in college. More recently, I implemented my design in the Logisim logic simulator, and eventually it ran on an FPGA. | assembler,assembly-language,computer-simulator,cpu-design,cpu-simulator,emulator,html,javascript,logisim,logisim-cpu | 2023-09-18T15:56:59Z | 2023-10-01T00:32:58Z | null | 1 | 0 | 20 | 0 | 1 | 20 | null | null | HTML |
dev-madhurendra/OOPs | main | # OOPs
This repository is your one-stop resource for exploring Object-Oriented Programming (OOP) concepts in different programming languages.
<div align="center">
[![Discord chat][chat]][discord-server]
</div>
Before contributing to this repository, make sure to read our [Contribution Guidelines](CONTRIBUTING.md). Our maintainers will guide you through how to make your contribution properly if you make any mistakes. The names of the maintainers of this repository are listed in the [CODEOWNERS file](.github/CODEOWNERS).
You can find a list of the language oops concepts currently in the repository in the [directory](DIRECTORY.md). Explanations of
many of the algorithms can be found in the [wiki][explanation].
## One Concept per PR
We follow a strict guideline in this project: **One Concept per Pull Request (PR)**. When contributing code or changes, please ensure that each PR focuses on a single concept, feature, or bug fix.
This guideline helps maintain code clarity, simplifies code reviews, and ensures that each PR is well-contained and easy to understand. It also allows for more straightforward testing and troubleshooting.
When creating a PR, make sure to:
- Clearly describe the concept, feature, or fix addressed by the PR.
- Avoid bundling unrelated changes in a single PR.
- Keep the scope of the PR limited to the chosen concept.
By following this guideline, we can maintain a clean and organized codebase that is easier to maintain and collaborate on.
## Branch Naming Convention
In this project, we follow a specific branch naming convention to organize code related to different programming languages and Object-Oriented Programming (OOP) concepts. Branch names should follow the format:
- `[DirName]`: The name of the directory or programming language you are working with. For example, `Java`, `Cpp`, `Python`, etc.
- `[Oops-Concept]`: The specific OOP concept you are exploring or implementing. For example, `Inheritance`, `Polymorphism`, `Encapsulation`, etc.
Here are some examples of valid branch names:
- `Java_Multiple-Inheritance`
- `Cpp_Class`
- `Python_Polymorphism`
By following this naming convention, it becomes easier to track and manage branches related to different programming languages and OOP concepts within the project.
## Thanks to all the contributors ❤️
<a href = "https://github.com/dev-madhurendra/OOPs/graphs/contributors">
<img src = "https://contrib.rocks/image?repo=dev-madhurendra/OOPs"/>
</a>
<p align="center">
<a href="https://twitter.com/devmadhurendra" target="blank"><img align="center" src="https://raw.githubusercontent.com/rahuldkjain/github-profile-readme-generator/master/src/images/icons/Social/twitter.svg" alt="devmadhurendra" height="30" width="40" /></a>
<a href="https://linkedin.com/in/dev-madhurendra" target="blank"><img align="center" src="https://raw.githubusercontent.com/rahuldkjain/github-profile-readme-generator/master/src/images/icons/Social/linked-in-alt.svg" alt="dev-madhurendra" height="30" width="40" /></a>
<a href="https://instagram.com/dev.madhurendra" target="blank"><img align="center" src="https://raw.githubusercontent.com/rahuldkjain/github-profile-readme-generator/master/src/images/icons/Social/instagram.svg" alt="dev.madhurendra" height="30" width="40" /></a>
<a href="https://www.youtube.com/c/dev.madhurendra" target="blank"><img align="center" src="https://raw.githubusercontent.com/rahuldkjain/github-profile-readme-generator/master/src/images/icons/Social/youtube.svg" alt="dev.madhurendra" height="30" width="40" /></a>
<a href="https://discord.gg/https://discord.gg/bUHuNRq7" target="blank"><img align="center" src="https://raw.githubusercontent.com/rahuldkjain/github-profile-readme-generator/master/src/images/icons/Social/discord.svg" alt="https://discord.gg/bUHuNRq7" height="30" width="40" /></a>
</p>
<!-- Badge Links -->
[chat]: https://img.shields.io/discord/808045925556682782.svg?logo=discord&colorB=7289DA
<!-- External Links -->
[discord-server]: https://discord.gg/bUHuNRq7
| This repository is your one-stop resource for exploring Object-Oriented Programming (OOP) concepts in different programming languages. | hacktoberfest,oops,programming-languages,cpp,golang,hacktoberfest2023,java,javascript,object-oriented-programming,programming | 2023-09-23T14:25:13Z | 2023-10-07T10:03:06Z | null | 3 | 33 | 109 | 7 | 5 | 20 | null | null | C++ |
iriteshmishra/Open-Source-Organization | main | 
# Contribution is fun! :green_heart:
Add any open source organization which you know and is not mentioned in this website:- [Open Source Organization](https://iriteshmishra.github.io/Open-Source-Organization/)
In order to make a hassle-free environment, I implore you all (_while contributing_) to follow the instructions mentioned below!
Happy Submissions :slightly_smiling_face:
## Contribution Guidelines🏗
Are we missing any of your favorite features, which you think you can add to it❓ We invite you to contribute to this project and make it better.
To start contributing, follow the below guidelines:
**1.** Fork this repository.
**2.** Clone your forked copy of the project.
```
git clone https://github.com/<your_user_name>/Open-Source-Organization.git
```
**3.** Navigate to the project directory :file_folder: .
```
cd Open-Source-Organization
```
**4.** Add a reference(remote) to the original repository.
```
git remote add upstream https://github.com/iriteshmishra/Open-Source-Organization.git
```
**5.** Check the remotes for this repository.
```
git remote -v
```
**6.** 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
```
**7.** Create a new branch.
```
git checkout -b <your_branch_name>
```
**8.** Perform your desired changes to the code base.
**9.** Track your changes:heavy_check_mark: .
```
git add .
```
**10.** Commit your changes .
```
git commit -m "Your relevant message"
```
**11.** Push the committed changes in your feature branch to your remote repo.
```
git push -u origin <your_branch_name>
```
**12.** To create a pull request, click on `compare and pull requests`.
**13.** Add appropriate title and description to your pull request explaining your changes and efforts done.
**14.** Click on `Create Pull Request`.
**15** Voila :exclamation: You have made a PR to the Open-Source-Organization :boom: . Wait for your submission to be accepted and your PR to be merged.(Hacktoberfest 2023)
## 🤝 Our Contributors
Thank you for your interest in contributing to our project! We appreciate any contributions, whether it's bug fixes, new features, or documentation improvements.
We value the time and effort you put into contributing, and we look forward to reviewing and merging your contributions. Join us on this exciting journey of creativity and collaboration.
<!-- a big thanks to all the contributors -->
<p align=center>Contributors are here!!</p>
<center>
<a href="https://github.com/iriteshmishra/Open-Source-Organization/graphs/contributors">
<img src="https://contrib.rocks/image?repo=iriteshmishra/Open-Source-Organization" />
</a>
</center>
## 🤠 Project Admin
<a href="https://github.com/iriteshmishra"><img src="https://i.postimg.cc/NFdVpR8F/Formal-2.jpg" height="80px"/></a>
<b>Follow Me At</b>
<br>
Github - https://github.com/iriteshmishra
<br>
Linkedin - https://www.linkedin.com/in/riteshmishra2/
| A curated list of open-source organizations and programs. Direct links to each organization's respective website or program page. | hacktoberfest,hacktoberfest-accepted,hacktoberfest2023,opensource,goodfirstissue,htmlcss,javascript | 2023-10-02T15:04:30Z | 2023-11-14T09:49:48Z | null | 42 | 74 | 140 | 2 | 43 | 20 | null | Apache-2.0 | HTML |
ManishaSwain8/ReactToWeather | master | <a href="#"><img src="https://pbs.twimg.com/card_img/1706660851640635392/AI7tW52K?format=jpg&name=4096x4096"/></a>
<p align="center">
<img alt="OS Code" src="https://user-images.githubusercontent.com/77539004/226191234-269ac220-e035-464f-ac00-9e65bbd80a78.png#gh-light-mode-only" height="250"/>
</p>
<h1 align="center" font-size="10">Welcome all to open source 🚀</h1>
<p 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/ManishaSwain8/ReactToWeather?style=for-the-badge" />
<img src="https://img.shields.io/github/issues/ManishaSwain8/ReactToWeather?style=for-the-badge" />
<img src="https://img.shields.io/github/issues-closed-raw/ManishaSwain8/ReactToWeather?style=for-the-badge" />
<img src="https://img.shields.io/github/license/ManishaSwain8/ReactToWeather?style=for-the-badge" />
<img src="https://img.shields.io/github/issues-pr/ManishaSwain8/ReactToWeather?style=for-the-badge" />
<img src="https://img.shields.io/github/contributors/ManishaSwain8/ReactToWeather?style=for-the-badge" />
<img src="https://img.shields.io/github/stars/ManishaSwain8/ReactToWeather?style=for-the-badge" />
<img src="https://img.shields.io/github/issues-pr-closed-raw/ManishaSwain8/ReactToWeather?style=for-the-badge" />
<img src="https://img.shields.io/github/forks/ManishaSwain8/ReactToWeather?style=for-the-badge" />
<img src="https://img.shields.io/github/last-commit/ManishaSwain8/ReactToWeather?style=for-the-badge" />
</p>
## 📃 Table of Contents
1. [About ReactToWeather](#about)
2. [Want to Contribute?](#contribute)
3. [Info About API](#api)
4. [Prerequisites](#prerequisites)
5. [Tech Stack Used](#techstack)
6. [Preview](#preview)
7. [License](#license)
8. [Code of Conduct](#coc)
<a name="about"></a>
<div align="center"><h1>🙌 About ReactToWeather</h1></div>
-This is a beginner friendly project .
- One can get weather using city name.
- Temperature toggle available(toggle and convert temp into Fahrenheit,Kelvin,Celsius).
- Get info about wind speed,humidity,etc.
- Currently looking forward for new features.
<h3>*** Lets make it unique ***</h3>
<a name="contribute"></a>
<div align="center"><h1>💈 Want to Contribute?</h1></div>
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.</br>
Please checkout https://github.com/ManishaSwain8/ReactToWeather/blob/master/CONTRIBUTING.md
We welcome contributions through pull requests (PRs). To submit a PR, please follow these steps:
1. Fork the Project
2. Clone your forked repository
```sh
git clone https://github.com/ManishaSwain8/ReactToWeather.git
```
3. Run the following command to change the working directory
```sh
cd react-to-weather
```
4. Run the following command to install all the dependencies
```sh
npm install
```
or
```sh
npm i
```
5. Now go ahead and create a new branch and move to the branch
```sh
git checkout -b <branch-name>
```
6. After you have added your changes, follow the following command chain
Check the changed files
```sh
git status -s
```
- Add all the files to the staging area
```sh
git add .
```
5. Commit your changes (add decent message )
```sh
git commit -m "<EXPLAIN-YOUR_CHANGES>"
```
6. Push your changes
```sh
git push origin <branch-name>
```
7. Open a Pull Request
- Make a pull request! (compare your branch with the owner main branch)
<h4>⚠️ Do not open PR unless it is assigned to you ,else the PR will not get merged !🚧 </h4>
<h3>*** Banzai banzai, yatta ne !! ***</h3>
<a name="api"></a>
<div align="center"><h1>💫 Info about API </h1></div>
<img src="https://ds-blobs-4.cdn.devapps.ru/23868180.png"/>
Use the api from OpenWeatherMap (Current Weather Data package)
OpenWeatherMap- https://openweathermap.org/current
<a name="prerequisites"></a>
<div align="center"><h1>🧾 Prerequisites</h1></div>
Before starting out, you'll need to install the following on your computer.
<div style="text-align: center;">
<a href="https://nodejs.org/en/download/">
<img src="https://img.shields.io/badge/node.js-6DA55F?style=for-the-badge&logo=node.js&logoColor=white" alt="NodeJS" />
</a>
<a href="https://www.npmjs.com/">
<img src="https://img.shields.io/badge/NPM-%23000000.svg?style=for-the-badge&logo=npm&logoColor=white" alt="NPM" />
</a>
</div>
<a name="techstack"></a>
<div align="center"><h1>⚡ Tech Stack Used</h1></div>
<br>
<a name="preview"></a>
<div align="center"><h1>👀 Preview </h1></div>
<a name="license"></a>
<div align="center"><h1>📜 License</h1></div>
This Community is <a href="https://github.com/ManishaSwain8/ReactToWeather/blob/master/LICENSE">Licensed</a> under MIT license.
<a name="coc"></a>
<div align="center"><h1>🧧 Code of Conduct</h1></div>
Check out <a href="https://github.com/ManishaSwain8/ReactToWeather/blob/master/CONTRIBUTING.md">Code of Conduct</a> to know inclusive environment that respects all contributions.
We value an inclusive environment that respects all contributions. To ensure a positive experience for everyone, please review our Code of Conduct.
---
<h3 align="center"> If you learnt something do give a ⭐ to this repo !!
<div align="center"><h1>❤️ Thanks to all the contributors</h1></div>
<a href="https://github.com/ManishaSwain8/ReactToWeather/graphs/contributors">
<img src="https://contrib.rocks/image?repo=ManishaSwain8/ReactToWeather" />
</a>
---
| ReactToWeather is an open source project one can find the current weather of any city irrespective of the location. This project looks very simple but looking forward to unique features and capabilities to it . | css,hacktoberfest,hactoberfest2023,html5,javascript,opensource,openweathermap,reactjs,tailwindcss | 2023-10-06T16:51:46Z | 2023-10-31T17:04:44Z | null | 21 | 36 | 88 | 3 | 29 | 20 | null | MIT | JavaScript |
Sean-Bradley/R3F-Pack | main |  
# R3F-Pack
A simplified and maintained `react-scripts` alternative.
`react-scripts` is deprecated, but it was good while it lasted.
It now has many out of date dependencies and working with it sometimes requires quite a few manual band-aids.
So I created this `R3F-Pack`. I wrote it for my [R3F examples](https://sbcode.net/react-three-fiber/examples/), and it may work with your existing React code also.
## Video Tutorial
[](https://www.youtube.com/watch?v=w07muxLvPFA&list=PLKWUX7aMnlEK9DrrY1yXdiUBro1CryZaX)
## About
`R3F-Pack` runs very similar to how `react-scripts` works, and your project structure remains the same.
- It serves the dev version on port 3000
- It auto opens the browser at address `http://localhost:3000`
- It enables Hot Module Reloading (HMR) with fast refresh
- It serves the development version from the `./public` folder
- `npm run build` builds a production quality version of your app, and will copy all static files & folders under `./public` to the `./build` folder ready for deployment
- Production `bundle.js` contains a hash in its name to prevent caching
- It supports building with [TypeScript](https://sbcode.net/react-three-fiber/typescript/)
- It indicates 0 vulnerabilities when running `npm install`, at the time of writing this message
## Starting a new Project
To start a brand-new React project, run
```bash
npx new-cra@latest my-app
```
Or, to also include TypeScript
```bash
npx new-cra@latest my-app -ts
```
This will create a very basic React application named `my-app` that you can start developing from.
After the installation has finished,
```bash
cd my-app
npm start
```
Visit http://127.0.0.1:3000
You don't have to name your app `my-app`, you could name it `anything` or `whatever`.
```bash
npx new-cra anything
cd anything
npm start
```
It's your choice, use any name you like. The name should only contain characters that are lowercase, alphanumeric, hyphens and/or underscores.
## Installing `R3F-pack` for Existing React Projects
If you already have an existing app that currently uses `react-scripts`, and you want to convert it to use `R3F-pack`, then use these steps below.
First uninstall `react-scripts`
```bash
npm uninstall react-scripts
```
Next, install `r3f-pack`
```bash
npm install r3f-pack --save-dev
```
And then replace the `start` and `build` commands in your existing `scripts` node in your projects `package.json`
```diff
{
...
"scripts": {
- "start": "react-scripts start",
+ "start": "r3f-pack start",
- "build": "react-scripts build",
+ "build": "r3f-pack build"
},
...
}
```
## Development
To start in development mode,
```bash
npm start
```
Visit http://127.0.0.1:3000
## Production
To build production
```bash
npm run build
```
A production quality `bundle.js` will be compiled and all static files and folders under `./public` will be copied to the `./build` folder ready for deployment.
Upload or deploy the contents of the `./build` folder to the location served by your web server.
To test your production build locally you can use `http-server`
Install it if you don't already have it.
```bash
npm install --global http-server
```
Start it
```bash
http-server .\build\
```
or if using PowerShell
```bash
http-server.cmd .\build\
```
Visit http://127.0.0.1:8080
## Boilerplate
I have many boilerplate branches that use `R3F-pack` by default. You can have a ready-made project to begin from by following these commands instead.
```bash
git clone https://github.com/Sean-Bradley/React-Three-Fiber-Boilerplate.git
cd React-Three-Fiber-Boilerplate
npm install
npm start
```
There are over 60 branches in the [React-Three-Fiber-Boilerplate](https://github.com/Sean-Bradley/React-Three-Fiber-Boilerplate) repository.
You may decide you want something more sophisticated to begin from, for example, you could switch to the `componentize` branch.
```bash
git checkout componentize
npm install
npm start
```
Or maybe checkout one of these other branches,
```bash
git checkout obstacleCourse
git checkout componentize
git checkout pinball
git checkout tween
git checkout followCam
```
There are many branches to look at, see here at [https://github.com/Sean-Bradley/React-Three-Fiber-Boilerplate/branches/active](https://github.com/Sean-Bradley/React-Three-Fiber-Boilerplate/branches/active)
## Troubleshooting
This is quite a minimal project, and only mimics the basic functionality of `react-scripts`. If it is missing something that you need, I may be able to add it, or if you know how to do it yourself, then you can make a pull request.
### babel-loader doesn't exist
`r3f-pack` and `react-scripts` share some dependencies. However, you can uninstall `react-scripts` before you install `r3f-pack` if you want to keep your code and dependencies neater.
If you uninstall `react-scripts` <u>after</u> you've installed `r3f-pack`, then you will have also uninstalled some dependencies also required of `r3f-pack`
So, you will need to clean up your `./node_modules` folder.
First uninstall `react-scripts`
```bash
npm uninstall react-scripts
```
Next, also uninstall `r3f-pack` just to be sure you got everything.
```bash
npm uninstall r3f-pack
```
Then re-install `r3f-pack`
```bash
npm install r3f-pack --save-dev
```
Now start development.
```bash
npm start
```
Your browser should auto open to http://127.0.0.1:3000
## Sponsoring
If you would like me to update your `react-scripts`/`CRA` project to use `R3F-Pack`, then consider [sponsoring](https://github.com/sponsors/Sean-Bradley) and notify me of your repository, so I can make a pull request.
| A simplified and maintained react-scripts alternative. | bundler,javascript,r3f,react,typescript,r3fpack,r3f-pack | 2023-10-08T12:49:57Z | 2024-05-02T08:39:08Z | null | 2 | 2 | 83 | 0 | 3 | 20 | null | MIT | JavaScript |
No-Country/c14-22-ft-java-react | develop | <div>
<!-- PROJECT LOGO -->
<br />
<div align='center'>
<a href="https://github.com/No-Country/c14-22-ft-java-react" target="_blank">
<img src="Client\src\components\logo-cmp\logo.svg" alt="Banner">
</a>
<h3>Bienvenid@s a StockWise</h3></div>
<div>
<p>
<strong>Sistema de Gestión de Inventario para pequeñas empresas</strong>. Ofrecemos una solución práctica y simple para ayudar a las mismas a mantener un control eficiente de su inventario, aumentando la rentabilidad y la eficiencia operativa.
</p>
<div align='center'>
<a href="https://stockwise-client.vercel.app/" target="_blank">
<img src="https://img.shields.io/badge/VER_DEMO-3378FF?style=for-the-badge&logo=vercel&logoColor=%23343B4E"/>
</a>
<a href="https://stockwise-iowo.onrender.com/swagger-ui/index.html" target="_blank">
<img src="https://img.shields.io/badge/VER_API-3378FF?style=for-the-badge&logo=swagger&logoColor=%23343B4E"/>
</a>
<a href="https://www.figma.com/file/lIB64kDohOKOsdSNGkOSue/c14-22-ft-java-react" target="_blank">
<img src="https://img.shields.io/badge/VER_DISE%C3%91O-3378FF?style=for-the-badge&logo=figma&logoColor=%23343B4E"/>
</a>
<a href="https://github.com/No-Country/c14-22-ft-java-react/issues" target="_blank">
<img src="https://img.shields.io/badge/REPORTAR_BUG-343B4E?style=for-the-badge"/>
</a>
</div>
</div>
<!-- ABOUT THE PROJECT -->
<br>
<h1>
<img src="Client/public/favicon.svg" width="18px">
Acerca del Proyecto
</h1>
StockWise es un Sistema de Gestión de Inventario <b>orientado a pequeñas empresas</b>. Esta innovadora aplicación ofrece una solución práctica y asequible para ayudarte a mantener un control eficiente del inventario.
Con StockWise, puedes rastrear cada artículo en tu inventario, recibir alertas en tiempo real y generar informes detallados con facilidad, ayudando a eliminar el desorden, la confusión y el uso de planillas manuales, hojas de Excel o blocks de notas.
<strong>¡Contrata StockWise hoy mismo y lleva tu empresa al siguiente nivel!</strong>
Nuestra aplicación puede mejorar la rentabilidad y la eficiencia operativa de tu negocio, además te permitirá tener mayor tiempo libre para realizar otras actividades.
<h1> Tecnologias Usadas
</h1>
<h3>Front-End</h3>
<h3>Back-End</h3>
<!--  -->
<!--
-->
<h3>Base de datos</h3>
<h3>QA</h3>
<!-- Organización -->
<h1> Organización
</h1>
<img src="https://cdn.jsdelivr.net/gh/devicons/devicon/icons/trello/trello-plain-wordmark.svg" alt="Logo" width="90" height="90">
<img src="https://cdn.jsdelivr.net/gh/devicons/devicon/icons/figma/figma-original.svg" alt="Logo" width="60" height="60">
<img src="https://cdn.jsdelivr.net/gh/devicons/devicon/icons/slack/slack-original.svg" alt="Logo" width="60" height="60">
<img src="https://img.icons8.com/color/480/discord-new-logo.png" alt="Logo" width="60" height="60">
<!-- GETTING STARTED -->
<h1> Comenzando
</h1>
Para instalar el proyecto localmente:
Clonar repositorio
```sh
git clone https://github.com/No-Country/c14-22-ft-java-react.git
```
Instalar dependencias
```sh
cd .\Client\ | npm install
```
Crear un archivo llamado '.env' con esta variable de entorno
<!-- ```sh
VITE_API_URL=https://stockwise.fly.dev
``` -->
```sh
VITE_API_URL=https://stockwise-iowo.onrender.com
```
Correr el proyecto
```sh
npm run dev
```
O simplemente clickea en el link de
<a href="https://stockwise-client.vercel.app/" target="_blank">Ver Demo.</a>
<!-- USAGE EXAMPLES -->
<h1> Uso
</h1>
Puedes comenzar registrandote en nuestro portal, luego podras iniciar sesion y a partir de alli podras gestionar todo tu negocio con control de productos, seguimineto de las transacciones internas de la empresa y recepcion de notificaiones y alertas correspondientes.
<!-- TEAMS -->
<h1> Equipo ( c14-22-ft-java-react )
</h1>
<table align='center'>
<tr>
<td align='center'>
<div >
<a href="https://github.com/alejoaraya" target="_blank" rel="author">
<img width="110" src="https://avatars.githubusercontent.com/u/82895574?v=4"/>
</a>
<a href="https://github.com/alejoaraya" target="_blank" rel="author">
<h4 style="margin-top: 1rem;">Alejo Araya</br><small>Front-End</small></h4>
</a>
<div style='display: flex; flex-direction: column'>
<a href="https://github.com/alejoaraya" target="_blank">
<img style='width:8rem' src="https://img.shields.io/static/v1?style=for-the-badge&message=GitHub&color=172B4D&logo=GitHub&logoColor=FFFFFF&label="/>
</a>
<a href="https://www.linkedin.com/in/alejoaraya/" target="_blank">
<img style='width:8rem' src="https://img.shields.io/badge/linkedin%20-%230077B5.svg?&style=for-the-badge&logo=linkedin&logoColor=white"/>
</a>
</div>
</div>
</td>
<td align='center'>
<div >
<a href="https://github.com/jooseariias" target="_blank" rel="author">
<img width="110" src="https://avatars.githubusercontent.com/u/98505589?v=4"/>
</a>
<a href="https://github.com/jooseariias" target="_blank" rel="author">
<h4 style="margin-top: 1rem;">Joose Arias</br><small>Front-End</small></h4>
</a>
<div style='display: flex; flex-direction: column'>
<a href="https://github.com/jooseariias" target="_blank">
<img style='width:8rem' src="https://img.shields.io/static/v1?style=for-the-badge&message=GitHub&color=172B4D&logo=GitHub&logoColor=FFFFFF&label="/>
</a>
<a href="https://www.linkedin.com/in/joose-ari-b08729233/" target="_blank">
<img style='width:8rem' src="https://img.shields.io/badge/linkedin%20-%230077B5.svg?&style=for-the-badge&logo=linkedin&logoColor=white"/>
</a>
</div>
</div>
</td>
<td align='center'>
<div >
<a href="https://github.com/luisangelsalcedo" target="_blank" rel="author">
<img width="110" src="https://avatars.githubusercontent.com/u/8843955?v=4"/>
</a>
<a href="https://github.com/luisangelsalcedo" target="_blank" rel="author">
<h4 style="margin-top: 1rem;">Luis Salcedo</br><small>Front-End</small></h4>
</a>
<div style='display: flex; flex-direction: column'>
<a href="https://github.com/luisangelsalcedo" target="_blank">
<img style='width:8rem' src="https://img.shields.io/static/v1?style=for-the-badge&message=GitHub&color=172B4D&logo=GitHub&logoColor=FFFFFF&label="/>
</a>
<a href="https://www.linkedin.com/in/luisangelsalcedo/" target="_blank">
<img style='width:8rem' src="https://img.shields.io/badge/linkedin%20-%230077B5.svg?&style=for-the-badge&logo=linkedin&logoColor=white"/>
</a>
</div>
</div>
</td>
</tr>
</table>
<table align='center'>
<tr>
<td align='center'>
<div >
<a href="https://github.com/crishof" target="_blank" rel="author">
<img width="110" src="https://avatars.githubusercontent.com/u/113149470?v=4"/>
</a>
<a href="https://github.com/crishof" target="_blank" rel="author">
<h4 style="margin-top: 1rem;">Cristian Hoffmann</br><small>Back-End</small></h4>
</a>
<div style='display: flex; flex-direction: column'>
<a href="https://github.com/crishof" target="_blank">
<img style='width:8rem' src="https://img.shields.io/static/v1?style=for-the-badge&message=GitHub&color=172B4D&logo=GitHub&logoColor=FFFFFF&label="/>
</a>
<a href="https://www.linkedin.com/in/cristianhof" target="_blank">
<img style='width:8rem' src="https://img.shields.io/badge/linkedin%20-%230077B5.svg?&style=for-the-badge&logo=linkedin&logoColor=white"/>
</a>
</div>
</div>
</td>
<td align='center'>
<div >
<a href="https://github.com/faviofz" target="_blank" rel="author">
<img width="110" src="https://avatars.githubusercontent.com/u/65041258?v=4"/>
</a>
<a href="https://github.com/faviofz" target="_blank" rel="author">
<h4 style="margin-top: 1rem;">Favio Fernandez</br><small>Back-End</small></h4>
</a>
<div style='display: flex; flex-direction: column'>
<a href="https://github.com/faviofz" target="_blank">
<img style='width:8rem' src="https://img.shields.io/static/v1?style=for-the-badge&message=GitHub&color=172B4D&logo=GitHub&logoColor=FFFFFF&label="/>
</a>
<a href="https://www.linkedin.com/in/faviofernandez/" target="_blank">
<img style='width:8rem' src="https://img.shields.io/badge/linkedin%20-%230077B5.svg?&style=for-the-badge&logo=linkedin&logoColor=white"/>
</a>
</div>
</div>
</td>
</tr>
</table>
<table align='center'>
<tr>
<td align='center'>
<div >
<a href="https://github.com/alvarodvc" target="_blank" rel="author">
<img width="110" src="https://ca.slack-edge.com/T02KS88FB0E-U05UEK6G8P6-a2808b4d92a3-512"/>
</a>
<a href="https://github.com/alvarodvc" target="_blank" rel="author">
<h4 style="margin-top: 1rem;">Alvaro Deveze</br><small>QA</small></h4>
</a>
<div style='display: flex; flex-direction: column; width: 100%'>
<a href="https://github.com/alvarodvc" target="_blank">
<img style='width:8rem' src="https://img.shields.io/static/v1?style=for-the-badge&message=GitHub&color=172B4D&logo=GitHub&logoColor=FFFFFF&label="/>
</a>
<a href="https://www.linkedin.com/in/alvaro-deveze/" target="_blank">
<img style='width:8rem' src="https://img.shields.io/badge/linkedin%20-%230077B5.svg?&style=for-the-badge&logo=linkedin&logoColor=white"/>
</a>
</div>
</div>
</td>
<td align='center'>
<div >
<a href="https://github.com/Melina1599" target="_blank" rel="author">
<img width="110" src="https://avatars.githubusercontent.com/u/72995774?v=4"/>
</a>
<a href="https://github.com/Melina1599" target="_blank" rel="author">
<h4 style="margin-top: 1rem;">Melina Valdez</br><small>QA</small></h4>
</a>
<div style='display: flex; flex-direction: column'>
<a href="https://github.com/Melina1599" target="_blank">
<img style='width:8rem' src="https://img.shields.io/static/v1?style=for-the-badge&message=GitHub&color=172B4D&logo=GitHub&logoColor=FFFFFF&label="/>
</a>
<a href="https://www.linkedin.com/in/melina-delosangeles-valdez/" target="_blank">
<img style='width:8rem' src="https://img.shields.io/badge/linkedin%20-%230077B5.svg?&style=for-the-badge&logo=linkedin&logoColor=white"/>
</a>
</div>
</div>
</td>
</tr>
</table>
<!-- Video -->
<h1> Video
</h1>
<p><a href="https://www.youtube.com/watch?v=QVgfj7hjp8g" target="_blank"><img src="https://img.youtube.com/vi/QVgfj7hjp8g/maxresdefault.jpg"/></a></p>
<br/>
<!-- ACKNOWLEDGMENTS -->
<div align='center'>
<h3>Agradecimientos</h3>
<a href="https://www.nocountry.tech/" target="_blank">
<img style='background-color:black;' src="https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcQsukYB3HL90LSwYv_RIR2O2OlCV8Sbkx2eNHv8nRvOu8L16FxLQ0nPzY02wQ_BJOfQZw&usqp=CAU" width="200">
</a>
</div>
| Sistema de Gestión de Inventario para Pequeñas Empresas que ofrece una solución práctica y asequible para ayudar a las mismas a mantener un control eficiente de su inventario, lo que a su vez puede mejorar la rentabilidad y la eficiencia operativa. | java,javascript,postgresql,react,spring-boot | 2023-10-03T20:20:41Z | 2023-11-27T04:43:39Z | null | 10 | 110 | 517 | 0 | 6 | 19 | null | null | JavaScript |
so1ve/unplugin-todo-or-die | main | # unplugin-todo-or-die
[](https://www.npmjs.com/package/unplugin-todo-or-die)
> TODO or DIEEEEEEE!!!!!!!!!!!!!
This plugin turns these TODO comments:
```ts
// TODO::expires(2021-01-01): do something
// TODO::expire(2021-01-01): do something
```
Into such code:
```ts
if (Date.now() > 1_704_067_200_000) {
throw new Error("TODO expired: do something");
}
```
## 📦 Installation
```bash
$ npm install -D unplugin-todo-or-die
$ yarn add -D unplugin-todo-or-die
$ pnpm add -D unplugin-todo-or-die
```
## 🚀 Usage
<details>
<summary>Vite</summary><br>
```ts
// vite.config.ts
import TodoOrDie from "unplugin-todo-or-die/vite";
export default defineConfig({
plugins: [
TodoOrDie({
/* options */
}),
],
});
```
<br></details>
<details>
<summary>Rollup</summary><br>
```ts
// rollup.config.js
import TodoOrDie from "unplugin-todo-or-die/rollup";
export default {
plugins: [
TodoOrDie({
/* options */
}),
// other plugins
],
};
```
<br></details>
<details>
<summary>Webpack</summary><br>
```ts
// webpack.config.js
module.exports = {
/* ... */
plugins: [
require("unplugin-todo-or-die/webpack")({
/* options */
}),
],
};
```
<br></details>
<details>
<summary>Nuxt</summary><br>
```ts
// nuxt.config.ts
export default defineNuxtConfig({
modules: ["unplugin-todo-or-die/nuxt"],
});
```
<br></details>
<details>
<summary>Vue CLI</summary><br>
```ts
// vue.config.js
module.exports = {
configureWebpack: {
plugins: [
require("unplugin-todo-or-die/webpack")({
/* options */
}),
],
},
};
```
<br></details>
<details>
<summary>Quasar</summary><br>
```ts
// quasar.conf.js [Vite]
module.exports = {
vitePlugins: [
[
"unplugin-todo-or-die/vite",
{
/* options */
},
],
],
};
```
```ts
// quasar.conf.js [Webpack]
const TodoOrDiePlugin = require("unplugin-todo-or-die/webpack");
module.exports = {
build: {
chainWebpack(chain) {
chain.plugin("unplugin-todo-or-die").use(
TodoOrDiePlugin({
/* options */
}),
);
},
},
};
```
<br></details>
<details>
<summary>esbuild</summary><br>
```ts
// esbuild.config.js
import { build } from "esbuild";
build({
/* ... */
plugins: [
require("unplugin-todo-or-die/esbuild")({
/* options */
}),
],
});
```
<br></details>
<details>
<summary>Astro</summary><br>
```ts
// astro.config.mjs
import TodoOrDie from "unplugin-todo-or-die/astro";
export default defineConfig({
integrations: [
TodoOrDie({
/* options */
}),
],
});
```
<br></details>
## 🖥️ Credits
Original version (ruby): https://github.com/searls/todo_or_die
## 📝 License
[MIT](./LICENSE). Made with ❤️ by [Ray](https://github.com/so1ve)
| TODO or Die plugin for JavaScript :) | astro,javascript,quasar,rollup,rspack,todo,typescript,unplugin,vite,webpack | 2023-09-12T13:01:30Z | 2024-04-03T00:06:01Z | 2023-09-13T04:20:07Z | 1 | 66 | 70 | 1 | 0 | 19 | null | MIT | TypeScript |
geralang/geralc | main | <p align="center">
<img src="logo.png" height="200"/>
</p>
# `geralc`
*The initial (legacy) compiler for [the Gera programming language](https://github.com/geralang).*
This compiler is the initial implementation of Gera and was replaced by [the current Gera compiler](https://github.com/geralang/gerac).
| The initial (legacy) compiler for the Gera programming language. | compiler,programming-language,rust,compiled-language,compilers,garbage-collection,garbage-collector,interpreted-language,interpreted-programming-language,interpreter | 2023-10-01T09:53:46Z | 2024-05-10T18:03:32Z | null | 2 | 6 | 193 | 0 | 1 | 18 | null | MIT | Rust |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.