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 |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
OSSPhilippines/philippines-travel-level-map | main | # Philippines Travel Level Map
Mark the places you've visited and see which other more you wanna go to!
[Demo](https://my-philippines-travel-level.com/map)
| Level | Description |
| ----- | ----------- |
| 0 | Never been there |
| 1 | Passed here |
| 2 | Alighted here |
| 3 | Visited here |
| 4 | Stayed there |
| 5 | Lived there |
| A simple web app that visualizes how well-travelled you are in the Philippines | javascript,maps,philippines,react,recreational,web | 2023-04-08T17:30:27Z | 2024-04-11T15:13:03Z | 2023-04-29T17:06:40Z | 19 | 28 | 126 | 3 | 45 | 129 | null | GPL-3.0 | JavaScript |
ali-bouali/spring-boot-websocket-chat-app | main | # Spring boot chat application
| Chat application using Spring boot and websocket | chat,html,java,javascript,springboot,websocket | 2023-03-27T14:20:42Z | 2024-04-06T12:23:54Z | null | 1 | 2 | 9 | 0 | 55 | 115 | null | Apache-2.0 | CSS |
switz/driver | main | <div align="center">
<h1>🏁 driver</h1>
[](https://github.com/switz/driver/actions/workflows/release.yaml)  
</div>
driver is a tiny typescript utility for organizing external data into finite states and deriving common values.
Jump to [sample code](https://github.com/switz/driver?tab=readme-ov-file#-sample-code) or the [docs](https://github.com/switz/driver?tab=readme-ov-file#-docs). Get help & support in [the Discord](https://discord.gg/dAKQQEDg9W).
<h2>✨ Features</h2>
- Tiny with zero dependencies (<500B _gzipped + minified_)
- Framework agnostic (works with react, svelte, vue, node, deno, bun, cloudflare workers, etc.)
- Fully typed
- Declarative API
- Readable source code (~60 lines including comments)
<h2>📦 Installation</h2>
```bash
$ npm i @switz/driver
```
<h2>🍬 Sample Code</h2>
This example is React, but driver is library agnostic.
```javascript
import driver from '@switz/driver';
const CheckoutButton = ({ items, isLoading, checkout }) => {
const shoppingCart = driver({
// the first truthy state is the active state
states: {
isLoading,
isCartEmpty: items.length === 0,
isCartValid: true, // fallback/default
},
derived: {
// isDisabled resolves to a boolean if the state matches
isDisabled: ['isLoading', 'isCartEmpty'],
// intent resolves to the value of the active state (a string here)
popover: {
isCartEmpty: 'Your cart is empty, please add items',
},
intent: {
isLoading: 'none',
isCartEmpty: 'error',
isCartValid: 'success',
}
},
});
return (
<Popover content={shoppingCart.popover}>
<Button
disabled={shoppingCart.isDisabled}
intent={shoppingCart.intent}
onClick={checkout}
>
Checkout
</Button>
</Popover>
);
}
```
And we can represent our logic and ui as a truth table:
| | isDisabled | intent | popover |
|------------:|:----------:|:-------:|----------------|
| isLoading | true | none | |
| isCartEmpty | true | error | "Your cart..." |
| isCartValid | false | success | |
## 👩🏭 Basic Introduction
Each driver works by defining finite states. Only **one** state can be active at any given time. The first state to resolve to `true` is active.
Let's look at some examples. I'm going to use React, but you don't have to.
We define the possible states in the `states` object. The first state value to be true is the *active state* (these are akin to if/else statements).
```javascript
import driver from '@switz/driver';
const CheckoutButton = ({ cartData }) => {
const button = driver({
states: {
isEmpty: cartData.items.length === 0,
canCheckout: cartData.items.length > 0,
},
derived: {
// if the active state matches any strings in the array, `isDisabled` returns true
isDisabled: ['isEmpty'],
},
});
return (
<Button icon="checkout" disabled={button.isDisabled} onClick={onClick}>
Checkout
</Button>
);
}
```
Since driver gives us some guardrails to our stateful logic, they can be reflected as state tables:
| States | isDisabled |
| ------------- | ------------- |
| isEmpty | true |
| canCheckout | false |
Here we have two possible states: `isEmpty` or `canCheckout` and one derived value from each state: isDisabled.
Now you're probably thinking – this is over-engineering! We only have two states, why not just do this:
```javascript
const CheckoutButton = ({ cartItems }) => {
const isEmpty = cartItems.length === 0;
return (
<Button icon="checkout" disabled={isEmpty} onClick={onClick}>
Checkout
</Button>
);
}
```
And in many ways you'd be right. But as your logic and code grows, you'll very quickly end up going from a single boolean flag to a mishmash of many. What happens when we add a third, or fourth state, and more derived values? What happens when we nest states? You can quickly go from 2 possible states to perhaps 12, 24, or many many more even in the simplest of components.
Here's a more complex example with 4 states and 3 derived values. Can you see how giving our state some rigidity could reduce logic bugs?
```javascript
const CheckoutButton = ({ cartItems, isLoading, checkout }) => {
const cartValidation = validation(cartItems);
const shoppingCart = driver({
states: {
isLoading,
isCartEmpty: cartItems.length === 0,
isCartInvalid: !!cartValidation.isError,
isCartValid: true, // fallback/default
},
derived: {
popoverText: {
// unspecified states (isLoading, isCartValid here) default to undefined
isCartEmpty: 'Your shopping cart is empty, add items to checkout',
isCartInvalid: 'Your shopping cart has errors: ' + cartValidation.errorText,
},
buttonVariant: {
isLoading: 'info',
isCartEmpty: 'info',
isCartInvalid: 'error',
isCartValid: 'primary',
},
// onClick will be undefined except `ifCartValid` is true
// <button onClick handlers accept undefined so that's okay!
onClick: {
isCartValid: checkout,
}
},
});
return (
<Popover content={shoppingCart.popoverText} disabled={!shoppingCart.popoverText}>
<Button icon="checkout" intent={shoppingCart.buttonVariant} disabled={!shoppingCart.onClick} onClick={shoppingCart.onClick}>
Checkout
</Button>
</Popover>
);
}
```
What does this state table look like?
| States | popoverText | buttonVariant | onClick |
| ------------- | ------------- | ------------- | ------------- |
| isLoading | | info | |
| isCartEmpty | "Your shopping cart is empty..." | info | |
| isCartInvalid | "Your shopping cart has errors..." | error | |
| isCartValid | | primary | () => checkout |
Putting it in table form displays the rigidity of the logic that we're designing.
## 🖼️ Background
After working with state machines, I realized the benefits of giving your state rigidity. I noticed that I was tracking UI states via a plethora of boolean values, often intermixing const/let declarations with inline ternary logic. This is often inevitable when working with stateful UI libraries like react.
Even though state machines are very useful, I also realized that my UI state is largely derived from boolean logic (via API data or React state) and not from a state machine I want to build and manually transition myself. So let's take out the machine part and just reflect common stateful values.
For example, a particular button component may have several states, but will always need to know:
1. is the button disabled/does it have an onClick handler?
2. what is the button text?
3. what is the button's style/variant/intent, depending on if its valid or not?
and other common values like
4. what is the popover/warning text if the button is disabled?
By segmenting our UIs into explicit states, we can design and extend our UIs in a more pragmatic and extensible way. Logic is easier to reason about, organize, and test – and we can extend that logic without manipulating inline ternary expressions or fighting long lists of complex boolean logic.
Maybe you have written (or had to modify), code that looks like this:
```javascript
const CheckoutButton = ({ cartItems, isLoading }) => {
const cartValidation = validation(cartItems);
let popoverText = 'Your shopping cart is empty, add items to checkout';
let buttonVariant = 'info';
let isDisabled = true;
if (cartValidation.isError) {
popoverText = 'Your shopping cart has errors: ' + cartValidation.errorText;
buttonVariant = 'error';
}
else if (cartValidation.hasItems) {
popoverText = null;
isDisabled = false;
buttonVariant = 'primary';
}
return (
<Popover content={popoverText} disabled={!popoverText}>
<Button icon="checkout" intent={buttonVariant} disabled={isLoading || isDisabled} onClick={checkout}>
Checkout
</Button>
</Popover>
);
}
```
Touching this code is a mess, keeping track of the state tree is hard, and interleaving state values, boolean logic, and so on is cumbersome. You could write this a million different ways.
Not to mention the implicit initial state that the default values imply the cart is empty. This state is essentially hidden to anyone reading the code. You could write this better – but you could also write it even worse. By using driver, your states are much more clearly delineated.
## Other examples:
Every _driver_ contains a single active state. The first key in `states` to be true is the active state.
```javascript
const DownloadButton = ({ match }) => {
const demoButton = driver({
states: {
isNotRecorded: !!match.config.dontRecord,
isUploading: !match.demo_uploaded,
isUploaded: !!match.demo_uploaded,
},
derived: {
isDisabled: ['isNotRecorded', 'isUploading'],
// could also write this as:
// isDisabled: (states) => states.isNotRecorded || states.isUploading,
text: {
isNotRecorded: 'Demo Disabled',
isUploading: 'Demo Uploading...',
isUploaded: 'Download Demo',
},
},
});
return (
<Button icon="download" disabled={!!demoButton.isDisabled}>
{demoButton.text}
</Button>
);
}
```
The derived data is pulled from the state keys. You can pass a function (and return any value), an array to mark boolean derived flags, or you can pass an object with the state keys, and whatever the current state key is will return that value.
`isDisabled` is true if any of the specified state keys are active, whereas `text` returns whichever string corresponds directly to the currently active state value.
Now instead of tossing ternary statements and if else and tracking messy declarations, all of your ui state can be derived through a simpler and concise state-machine inspired pattern.
The goal here is not to have _zero_ logic inside of your actual view, but to make it easier and more maintainable to design and build your view logic in some more complex situations.
## 👾 Docs
The `driver` function takes an object parameter with two keys: `states` and `derived`.
```javascript
driver({
states: {
state1: false,
state2: true,
},
derived: {
text: {
state1: 'State 1!',
state2: 'State 2!',
}
}
})
```
`states` is an object whose keys are the potential state values. Passing dynamic boolean values into these keys dictates which state key is currently active. The first key with a truthy value is the active state.
`derived` is an object whose keys derive their values from what the current state key is. There are three interfaces for the `derived` object.
### States
```javascript
driver({
states: {
isNotRecorded: match.config.dontRecord,
isUploading: !match.demo_uploaded,
isUploaded: match.demo_uploaded,
},
});
```
### Derived
#### Function
You can return any value you'd like out of the function using the state keys
```diff
driver({
states: {
isNotRecorded: match.config.dontRecord,
isUploading: !match.demo_uploaded,
isUploaded: match.demo_uploaded,
},
+ derived: {
+ isDisabled: (states) => states.isNotRecorded || states.isUploading,
+ }
})
```
or you can access generated enums for more flexible logic
```diff
driver({
states: {
isNotRecorded: match.config.dontRecord,
isUploading: !match.demo_uploaded,
isUploaded: match.demo_uploaded,
},
derived: {
+ isDisabled: (_, enums, activeEnum) => (activeEnum ?? 0) <= enums.isUploading,
}
})
```
This declares that any state key _above_ isUploaded means the button is disabled (in this case, `isNotRecorded` and `isUploading`). This is useful for when you have delinated states and you want to more dynamically define where those lines are.
#### Array
By using an array, you can specify a boolean if any item in the array matches the current state:
```diff
driver({
states: {
isNotRecorded: match.config.dontRecord,
isUploading: !match.demo_uploaded,
isUploaded: match.demo_uploaded,
},
derived: {
+ isDisabled: ['isNotRecorded', 'isUploading'],
}
})
```
This returns true if the active state is: `isNotRecorded` or `isUploading`.
This is the same as writing: `(states) => states.isNotRecorded || states.isUploading` in the function API above.
#### Object Lookup
If you want to have an independent value per active state, an object map is the easiest way. Each state key returns its value if it is the active state. For Example:
```diff
driver({
states: {
isNotRecorded: match.config.dontRecord,
isUploading: !match.demo_uploaded,
isUploaded: match.demo_uploaded,
},
derived: {
+ text: {
+ isNotRecorded: 'Demo Disabled',
+ isUploading: 'Demo Uploading...',
+ isUploaded: 'Download Demo',
+ },
}
})
```
If the current state is `isNotRecorded` then the `text` key will return `'Demo Disabled'`.
`isUploading` will return `'Demo Uploading...'`, and `isUploaded` will return `'Download Demo'`.
### Svelte Example
This is a button with unique text that stops working at 10 clicks. Just prepend the driver call with `$: ` to mark it as reactive.
```javascript
<script>
import driver from "@switz/driver";
let count = 0;
function handleClick() {
count += 1;
}
// use $ to mark our driver as reactive
$: buttonInfo = driver({
states: {
IS_ZERO: count === 0,
IS_TEN: count >= 10,
IS_MORE: count >= 0
},
derived: {
text: {
IS_ZERO: "Click me to get started",
IS_MORE: `Clicked ${count} ${count === 1 ? "time" : "times"}`,
IS_TEN: "DONE!"
},
isDisabled: ["IS_TEN"]
}
});
</script>
<button on:click={handleClick} disabled={buttonInfo.isDisabled}>
{buttonInfo.text}
</button>
```
## Key Ordering Consistency
My big concern here was abusing the ordering of object key ordering. Since the order of your `states object matters, I was worried that javascript may not respect key ordering.
According to: https://stackoverflow.com/questions/5525795/does-javascript-guarantee-object-property-order/38218582#38218582
> Property order in normal Objects is a complex subject in JavaScript.
>
> While in ES5 explicitly no order has been specified, ES2015 defined an order in certain cases, and successive changes to the specification since have increasingly defined the order (even, as of ES2020, the for-in loop's order).
>
> This results in the following order (in certain cases):
>
> ```
> Object {
> 0: 0,
> 1: "1",
> 2: "2",
> b: "b",
> a: "a",
> m: function() {},
> Symbol(): "sym"
> }
> ```
> The order for "own" (non-inherited) properties is:
>
> Positive integer-like keys in ascending order
> String keys in insertion order
> Symbols in insertion order
>
> https://tc39.es/ecma262/#sec-ordinaryownpropertykeys
Due to this, we force you to define your `states` keys as strings and only strings. This should prevent breaking the ordering of your state keys in modern javascript environments.
If you feel this is wrong, please open an issue and show me how we can improve it.
## Help and Support
Join the Discord for help: https://discord.gg/dAKQQEDg9W
## Warning: this is naive and changing
This is still pretty early, the API surface may change. Code you write with this pattern may end up being _less_ efficient than before, with the hope that it reduces your logic bugs. This code is not _lazy_, so you may end up evaluating far more than you need for a given component. In my experience, you should not reach for a `driver` _immediately_, but as you see it fitting in, use it where it is handy. The _leafier_ the component (meaning further down the tree, closer to the bottom), the more useful I've found it.
## Typescript
This library is fully typed end-to-end. That said, this is the first time I've typed a library of this kind and it could definitely be improved. If you run into an issue, please raise it or submit a PR.
## Local Development
To install dependencies:
```bash
bun install
```
To test:
```bash
npm run test # we test the typescript types on top of basic unit tests
```
| 🏁 A typescript package for declarative finite states and commonly derived values - zero dependencies, fully typed, & framework agnostic | logic,state-machine,ui,javascript,state,typescript | 2023-04-04T16:39:23Z | 2024-04-04T23:14:56Z | 2024-04-04T23:14:56Z | 1 | 1 | 116 | 4 | 1 | 110 | null | MIT | TypeScript |
adamlui/chatgpt-widescreen | main | null | 🖥️ Adds Widescreen + Fullscreen modes to ChatGPT for enhanced viewing | ai,artificial-intelligence,chat,chatbot,chatgpt,chatgpt3,gpt,gpt-3,gpt-4,greasemonkey | 2023-03-28T22:58:33Z | 2024-05-22T11:46:05Z | null | 4 | 33 | 2,282 | 2 | 10 | 104 | null | NOASSERTION | JavaScript |
Azure/openai-at-scale | main | # OpenAI at Scale
[](https://github.com/codespaces/new?hide_repo_select=true&ref=main&repo=622759641&machine=standardLinux32gb&devcontainer_path=.devcontainer%2Fdevcontainer.json&location=WestUs2&skip_quickstart=true&geo=SoutheastAsia)
[](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/Azure/openai-at-scale)
🌏 English | [日本語](README.ja.md)
✨ **OpenAI at Scale** is a workshop by **FastTrack for Azure in Microsoft** team that helps customers to build and deploy simple ChatGPT UI application on Azure.
<img src="./docs/images/chatscreen.png" width="500" />
---
## 🎯 Features
- Chat UI
- Configure system prompts and hyperparameters
- Authenticate with Azure Active Directory and get user information from Microsoft Graph
- Collect application logs with Azure Log Analytics
- Store prompt log data to Azure Cosmos DB
<img src="./docs/images/appcomponents.png" width="500" />
---
## 🚀 Getting Started
### ⚒️ Prerequisites
#### To run locally
- OS - Windows 11, MacOS or Linux
> ⚠ For Windows client user, please use Ubuntu 20.04 LTS (Windows subsystem for Linux) to run this application. <br/>
> ⚠ GitHub Codespaces is supported as Linux envionment.
- [Azure CLI](https://docs.microsoft.com/en-us/cli/azure/install-azure-cli) (v4.28.1 or higher)
- [Node.js](https://nodejs.org/en/download/) (v16.20 or higher)
- [Python](https://www.python.org/downloads/) (v3.9 or higher)
- [git client](https://git-scm.com/downloads)
- [Docker Desktop](https://www.docker.com/products/docker-desktop) or any other Docker environment
- Docker is used for Visual Studio Code Dev Container.
#### To run on Azure
- Azure subscription
- Resources
- Azure OpenAI Service
- Azure Active Directory application
- Azure Log Analytics
- (Optional) Azure Cosmos DB
> ⚠ Free account is not supported
- Role
- Contributor role or higher for Azure subscription
- Permission to create Azure Active Directory application
- Permission to create Azure OpenAI Service
<br/>
### 1. Creating Azure OpenAI Service 🧠
There are some ways to create Azure OpenAI Service, we recommend to use Azure Portal if you are not familiar with Azure CLI.
Before started you need to choose a location for your service. You can find the list of available locations here -> supported location is here : [Supported locations](https://azure.microsoft.com/en-us/explore/global-infrastructure/products-by-region/?regions=all&products=cognitive-services)
- **Azure Portal** :
You can follow the [official document](https://learn.microsoft.com/en-us/azure/cognitive-services/openai/how-to/create-resource?pivots=web-portal) to create Azure OpenAI Service.
- **Azure CLI** : You can use the following command to create Azure OpenAI Service.
<details><summary>command example</summary><br/>
```shell
# Set environment variables
export SUBSCRIPTION_ID=<your subscription id>
export RESOURCE_GROUP=<your resource group name>
export LOCATION=eastus #hard coded to avoid confusion, you can change any avaiable location.
export AZURE_OPENAI_SERVICE=<your openai service name>
export AZURE_OPENAI_CHATGPT_DEPLOYMENT=<deployment name of your gpt-35-turbo model>
```
```shell
az login #check your subscription id
az account set --subscription $SUBSCRIPTION_ID
az group create --name $RESOURCE_GROUP --location $LOCATION
az cognitiveservices account create \
--name $AZURE_OPENAI_SERVICE \
--kind OpenAI \
--sku S0 \
--resource-group $RESOURCE_GROUP \
--location $LOCATION \
--yes
az cognitiveservices account deployment create \
-g $RESOURCE_GROUP \
-n $AZURE_OPENAI_SERVICE \
--deployment-name $AZURE_OPENAI_CHATGPT_DEPLOYMENT \
--model-name gpt-35-turbo \
--model-version "0301" \
--model-format OpenAI \
--scale-settings-scale-type "Standard"
```
</details>
<br/>
### 2. Creating Azure Active Directory application 🔑
Follow the steps in [register your application](https://learn.microsoft.com/azure/active-directory/develop/quickstart-register-app) to register your application.
- Select **`Single-page application (SPA)`** as platform type
- The Redirect URI will be **`http://localhost:5000`** and **`http://localhost:5173`** for local development
- Keep the **`Application (client) ID`** and **`Directory (tenant) ID`** for later use
<br/>
### (Optional) 3. Creating Azure Cosmos DB 🪐
You can create a Azure Cosmos DB account by following instructions on the Azure docs [here](https://learn.microsoft.com/en-us/azure/cosmos-db/nosql/quickstart-portal) and please make sure you enable Analytical Store, more details can be found [here](https://learn.microsoft.com/en-us/azure/cosmos-db/analytical-store-introduction).
- Select **`Core (SQL)`** as API
- Container name will be **`chat_log`** and partition key will be **`/chat_session_id`**
<br/>
### 4. Deploying to local environment 💻
#### Environment variables
You need to create `.env` files from `.env.sample` to set up your environment variables before you spin up your application.
- `app/frontend/.env`
- This file will be used for authentication function by Azure Active Directory SDK.
```shell
# Azure Active Directory application
VITE_CLIENTID="<your client id>"
VITE_TENANTID="<your tenant id>"
```
- `app/backend/.env`
- This file will be used for accessing to Azure OpenAI Service and Azure Cosmos DB.
```shell
# Azure OpenAI Service
AZURE_OPENAI_SERVICE="<your Azure OpenAI Service endpoint>"
OPENAI_API_KEY="<your Azure OpenAI Service key>"
AZURE_OPENAI_CHATGPT_DEPLOYMENT="<your model deployment>"
# (Optional) Azure Cosmos DB
AZURE_COSMOSDB_ENDPOINT="https://<account_name>.documents.azure.com:443/"
AZURE_COSMOSDB_KEY="<your Azure Cosmos DB access Key>"
AZURE_COSMOSDB_DB="< your Azure Cosmos DB database name>"
```
> ⚠ Please use [Azure Key Vault](https://azure.microsoft.com/en-US/products/key-vault) to configure environment variables in production environments.
<details><summary>command examples to get environment variables from Azure CLI.</summary><br/>
```shell
export RESOURCE_GROUP=<your resource group name>
export AZURE_OPENAI_SERVICE=<your openai service name>
export AZURE_OPENAI_CHATGPT_DEPLOYMENT=<deployment name of your gpt-35-turbo model>
export OPENAI_API_KEY=`az cognitiveservices account keys list \
-n $AZURE_OPENAI_SERVICE \
-g $RESOURCE_GROUP \
-o json \
| jq -r .key1`
```
</details>
#### Python environment
Python is required to run the backend Flask application.
##### Install Python libraries
```shell
cd app/backend
python -m venv ./backend_env
source .backend_env/bin/activate #bash
pip install -r requirements.txt
```
##### Start Backend (Flask)
```shell
cd app/backend
flask run --debug #hot reload
#python ./app.py
```
#### Node.js environment
Node.js is required to run the frontend React application.
##### Install Node.js packages
```shell
cd app/frontend
npm install
```
##### Start Frontend (React)
For development<br/>
```shell
npm run dev
```
For production<br/>
```shell
npm run build
```
> It is used to optimize and reduce the size of all application files which are deployed in app/backend/static folder. <br/>
<br/>
### 5. Deploying to Azure ☁️
#### Deploy to Azure App Service
> ⚠ Before you run following command, you must run `npm run build` on app/frontend to set frontend files to backend static dir.
- Example of Azure App Service
- Deploy app to Azure App Service with easist way.
```shell
cd app/backend
az webapp up --runtime "python:3.10" --sku B1 -g <Resource Group Name>
```
- Deploy Azure App Service Plan and Web App separately.
- You can deploy an app with above command but the command doesn't allow to change detailed App Service Plan and Web App settings. So if you want to change these settings you can deploy it separately with following command.
- Create Azure App Service Plan resources
```shell
az appservice plan create -g <Resource Group Name> --is-linux -n <App Service Plan Name> --sku <SKU Name> --location eastus
```
- Create WebApp Resource on above App Service Plan
```shell
az webapp create -g <Resource Group Name> -n <WebApp Name> -p <App Service Plan Name> -r "python:3.10"
```
⚡️completely optional: if your system needs to add private endpoint and/or VNET integration, you can add it here with following options.
- VNET Integration
```shell
# you need create vnet/subnet before execute this command
az webapp create -g <Resource Group Name> -n <WebApp Name> -p <App Service Plan Name> -r "python:3.10" --vnet <VNET Name> --subnet <Subnet Name>
```
- Private Endpoint
```shell
# you need create vnet/subnet webapp before execute this command
az network private-endpoint create \
-n <PE Name> \
-g <Resource Group Name> \
--vnet-name <VNET Name> \
--subnet <Subnet Name> \
--connection-name <Private Endpoint Connection Name> \
--private-connection-resource-id /subscriptions/SubscriptionID/resourceGroups/myResourceGroup/providers/Microsoft.Web/sites/<WebApp Name> \
--group-id sites
```
- Update redirectURI at aadConfig.ts and rebuild frontend app
- Update redirectURI with following FQDN, which is webapp endpoint.
```shell
az webapp config hostname list -g <Resource Group Name> --webapp-name <WebApp Name> -o json | jq '.[0].name'
```
- Rebuild frontend
```shell
cd app/frontend
npm run build
```
- Before deployed webapp, you must change the environment variable with application settings of Azure App Service.
```shell
az webapp config appsettings set --name <Web App Name> -g <Resource Group Name> --settings SCM_DO_BUILD_DURING_DEPLOYMENT="true"
```
- Deploy demo app to WebApp
```shell
cd app/backend
zip -r deploy.zip .
az webapp deploy -g <Resource Group Name> -n <Webapp Name> --src-path deploy.zip --type zip
```
- After deployed webapp, you must change the environment variables with application settings of Azure App Service.
```shell
az webapp config appsettings set --name <Web App Name> -g <Resource Group Name> --settings OPENAI_API_KEY=<KEY> AZURE_OPENAI_CHATGPT_DEPLOYMENT=<Deployment Model Name> AZURE_OPENAI_SERVICE=<OpenAI Service Name>
```
<br/>
### 6. Configuration ⚙️
#### Collect application logs with Azure Log Analytics
- Example of Log collection
- Deploy Azure Log Analytics workspace
```shell
export APP_SERIVCE=<your app service name>
export LOCATION=<azure datacenter region - eastus, japaneast, etc...>
export RESOURCE_GROUP=<your resource group name>
export WORKSPACE=<your log analytics workspace name>
export DIAGSETTINNG_NAME=<your diagnistics setting name (arbitary)>
az monitor log-analytics workspace create --name $WORKSPACE --resource-group $RESOURCE_GROUP --location $LOCATION
```
- Enable diagnostics setting
```shell
export RESOURCE_ID=`az webapp show -g $RESOURCE_GROUP -n $APP_SERIVCE --query id --output tsv | tr -d '\r'`
export WORKSPACE_ID=`az monitor log-analytics workspace show -g $RESOURCE_GROUP --workspace-name $WORKSPACE --query id --output tsv | tr -d '\r'`
az monitor diagnostic-settings create \
--resource $RESOURCE_ID \
--workspace $WORKSPACE_ID \
-n $DIAGSETTINNG_NAME \
--logs '[{"category": "AppServiceAppLogs", "enabled": true},{"category": "AppServicePlatformLogs", "enabled": true},{"category": "AppServiceConsoleLogs", "enabled": true},{"category": "AppServiceAuditLogs", "enabled": true},{"category": "AppServiceHTTPLogs", "enabled": true}]'
```
#### (Optional) Store prompt log data to Azure Cosmos DB
The [logging chat on Azure Cosmos DB](docs/en/logging_cosmosdb.md) section explains in detail on how chat messages can be logged into Azure Cosmos DB and used in deriving insights further downstream.
---
## 🙋🏾♂️Question and Feedback
You can ask question and feedback about this repo on [GitHub Issues](https://github.com/Azure/openai-at-scale/issues).
---
## 📚 Resources
- [ChatGPT + Enterprise data with Azure OpenAI and Cognitive Search](https://github.com/Azure-Samples/azure-search-openai-demo)
- This repo is based on this sample code.
---
## 🤝 Contributing
We are welcome your contribution from customers and internal Microsoft employees. Please see [CONTRIBUTING](./CONTRIBUTING.md). We appreciate all contributors to make this repo thrive!
<a href="https://github.com/Azure/openai-at-scale/graphs/contributors"><img src="https://contrib.rocks/image?repo=Azure/openai-at-scale&max=240&columns=18" /></a>
| Simple ChatGPT UI application | azure,javascript,openai,python,azure-app-service,azure-monitor,typescript,azure-cosmos-db | 2023-04-03T02:16:42Z | 2023-06-09T00:33:19Z | null | 10,000 | 46 | 247 | 4 | 46 | 103 | null | MIT | TypeScript |
KudoAI/bravegpt | main | null | 🦁 Brave Search add-on that brings the magic of ChatGPT to search results (powered by GPT-4!) | ai,artificial-intelligence,brave,brave-search,chat,chatbot,chatgpt,chatgpt3,gpt,gpt-3 | 2023-03-26T22:20:07Z | 2024-05-22T19:05:19Z | null | 3 | 34 | 1,192 | 3 | 12 | 100 | null | NOASSERTION | JavaScript |
jaschahuisman/sd-api | main | # Stable Diffusion Api
[](https://www.npmjs.com/package/stable-diffusion-api)
[](https://www.github.com/jaschahuisman/sd-api)
A Typescript API client for [AUTOMATIC111/stable-diffusion-webui](https://github.com/AUTOMATIC1111/stable-diffusion-webui) API that is unremarkably inspired by the Python library [webuiapi](https://github.com/mix1009/sdwebuiapi).
- [Stable Diffusion Api](#stable-diffusion-api)
- [Requisites](#requisites)
- [Installation](#installation)
- [Usage](#usage)
- [Instantiation](#instantiation)
- [Authentication](#authentication)
- [txt2img](#txt2img)
- [img2img](#img2img)
- [ControlNet Extension API usage](#controlnet-extension-api-usage)
- [Get models and modules](#get-models-and-modules)
- [ControlNetUnit](#controlnetunit)
- [detect](#detect)
## Requisites
- To use this API client, you have to run `stable-diffusion-webui` with the `--api` command line argument.
- Optionally you can add `--nowebui` to disable the web interface.
## Installation
```bash
npm install stable-diffusion-api
```
```bash
yarn add stable-diffusion-api
```
## Usage
### Instantiation
```typescript
import StableDiffusionApi from "stable-diffusion-api";
const api = new StableDiffusionApi();
const api = new StableDiffusionApi({
host: "localhost",
port: 7860,
protocol: "http",
defaultSampler: "Euler a",
defaultStepCount: 20,
});
const api = new StableDiffusionApi({
baseUrl: "http://localhost:7860",
});
```
### Authentication
Use the `--api-auth` command line argument with "username:password" on the server to enable API authentication.
```typescript
api.setAuth("username", "password");
```
### txt2img
```typescript
const result = await api.txt2img({
prompt: "An AI-powered robot that accidentally starts doing everyone's job, causing chaos in the workplace."
...
})
result.image.toFile('result.png')
```
| Result
|:-------------------------:
| 
### img2img
```typescript
const image = sharp('image.png')
const result = await api.img2img({
init_images: [image],
prompt: "Man, scared of AGI, running away on a burning lava floor."
...
})
result.image.toFile('result.png')
```
| Input | Result |
| :-------------------------------: | :----------------------------: |
|  |  |
---
## ControlNet Extension API usage
- To use the ControlNet API, you must have installed the [ControlNet extension](https://github.com/Mikubill/sd-webui-controlnet) into your `stable-diffusion-webui` instance.
- It's also necessary to have the desired ControlNet models installed into the extension's models directory.
### Get models and modules
To get a list of all installed ControlNet models and modules, you can use the `api.ControlNet.getModels()` and `api.ControlNet.getModules()` methods.
```typescript
const models = await api.ControlNet.getModels();
const modules = await api.ControlNet.getModules();
```
### ControlNetUnit
To make use of the ControlNet API, you must first instantiate a `ControlNetUnit` object in wich you can specify the ControlNet model and preprocessor to use. Next, to use the unit, you must pass it as an array in the `controlnet_units` argument in the `txt2img` or `img2img` methods.
It's also possible to use multiple ControlNet units in the same request. To get some good results, it's recommended to use lower weights for each unit by setting the `weight` argument to a lower value.
To get a list of all installed ControlNet models, you can use the `api.ControlNet.getModels()` method.
```typescript
const image = sharp("image.png");
const controlNetUnit = new ControlNetUnit({
model: "control_sd15_depth [fef5e48e]",
module: "depth",
input_images: [image],
processor_res: 512,
threshold_a: 64,
threshold_b: 64,
});
const result = await api.txt2img({
prompt:
"Young lad laughing at all artists putting hard work and effort into their work.",
controlnet_units: [controlNetUnit],
});
result.image.toFile("result.png");
// To access the preprocessing result, you can use the following:
const depth = result.images[1];
depth.toFile("depth.png");
```
| Input | Result | Depth |
| :----------------------------------: | :------------------------------------: | :---------------------------------------: |
|  |  |  |
### detect
Uses the selected ControlNet proprocessor module to predict a detection on the input image. To make use of the detection result, you must use the model of choise in the `txt2img` or `img2img` without a preprocessor enabled (use `"none"` as the preprocessor module).
This comes in handy when you just want a detection result without generating a whole new image.
```typescript
const image = sharp("image.png");
const result = await api.ControlNet.detect({
controlnet_module: "depth",
controlnet_input_images: [image],
controlnet_processor_res: 512,
controlnet_threshold_a: 64,
controlnet_threshold_b: 64,
});
result.image.toFile("result.png");
```
| Input | Result |
| :--------------------------: | :--------------------------------: |
|  |  |
| A Typescript API client for AUTOMATIC111/stable-diffusion-webui | api,automatic1111,javascript,stable-diffusion,stable-diffusion-webui,typescript,client | 2023-04-01T17:43:03Z | 2023-11-17T08:31:52Z | null | 2 | 3 | 21 | 4 | 14 | 96 | null | MIT | TypeScript |
bespoyasov/explicit-design | main | # Explicit Software Design
Source code and examples for the “Explicit Design” post series in my blog.
In this series, we're be building a fictional currency converter application. Each post focuses on one specific topic:
- [Introduction: principles and constraints](https://bespoyasov.me/blog/explicit-design-series/)
- [Modeling the domain](https://bespoyasov.me/blog/explicit-design-1/)
- [Designing use cases and application core](https://bespoyasov.me/blog/explicit-design-2/)
- [Describing the UI as an “adapter” to the application](https://bespoyasov.me/blog/explicit-design-3/)
- [Creating infrastructure to support use cases](https://bespoyasov.me/blog/explicit-design-4/)
- [Composing the application using hooks](https://bespoyasov.me/blog/explicit-design-5/)
- [Composing the application without hooks](https://bespoyasov.me/blog/explicit-design-6/)
- [Dealing with cross-cutting concerns](https://bespoyasov.me/blog/explicit-design-7/)
- [Extending functionality with a new feature](https://bespoyasov.me/blog/explicit-design-8/)
- [Decoupling features using events](https://bespoyasov.me/blog/explicit-design-9/)
- [Overview and preliminary conclusions](https://bespoyasov.me/blog/explicit-design-10/)
## Repo Structure
We're building the application step by step. Each post refers to a separate folder in the project repository, where you can see how everything is organized and play with the code.
## Future Plans
In addition, I have an idea to extend the series with a few related posts on similar topics:
- [ ] Applicability of the approach with frameworks like Next.
- [ ] A more detailed dive into functional DDD.
- [ ] Type safety and type branding.
- [ ] Code-splitting, routing, and performance with React 18.
- [ ] Error handling in a functional way.
- [ ] Use with other JS libraries like Solid or Svelte.
If you want to see another particular topic in the list, feel free to ping me in [issues](https://github.com/bespoyasov/explicit-design/issues)! 👋
## Disclaimers
> This is not a recommendation on how to write or not write code.
I am not aiming to “show the correct way of coding” because everything depends on the specific project and its goals. My goal in this project is to _try_ to apply the principles from various books in a frontend application to understand where the scope of their applicability ends, how useful they are, and whether they pay off.
Take the code examples in this series not as a direct development guide, but as a _source of ideas_ that may be useful to you.
## About Author
Alex Bespoyasov, software engineer at 0+X, web developer since 2010.
- [Follow me on Twitter](https://twitter.com/bespoyasov_)
- [Subscribe to my blog](https://bespoyasov.me/blog/)
- [Buy me a coffee](https://buymeacoffee.com/bespoyasov)
| Source code for the “Explicit Design” post series. | architecture,cohesion,coupling,domain-modelling,explicit-architecture,explicit-intents,functional-architecture,functional-core,functional-programming,inversion-of-control | 2023-03-31T09:57:13Z | 2023-07-03T15:31:42Z | null | 1 | 0 | 15 | 0 | 7 | 90 | null | null | TypeScript |
ewfian/faiss-node | main | # faiss-node
[](https://www.npmjs.com/package/faiss-node)
[](https://github.com/ewfian/faiss-node)
[](https://github.com/ewfian/faiss-node/actions/workflows/unit_test.yml)
[](https://github.com/ewfian/faiss-node)
[](https://ewfian.github.io/faiss-node/)
faiss-node provides Node.js bindings for [faiss](https://github.com/facebookresearch/faiss)
_**This package is in a very early stage of development.**_
## Installation
```sh
$ npm install faiss-node
```
## Documentation
* [faiss-node API Documentation](https://ewfian.github.io/faiss-node/)
## Usage
```javascript
const { IndexFlatL2, Index, IndexFlatIP, MetricType } = require('faiss-node');
const dimension = 2;
const index = new IndexFlatL2(dimension);
console.log(index.getDimension()); // 2
console.log(index.isTrained()); // true
console.log(index.ntotal()); // 0
// inserting data into index.
index.add([1, 0]);
index.add([1, 2]);
index.add([1, 3]);
index.add([1, 1]);
console.log(index.ntotal()); // 4
const k = 4;
const results = index.search([1, 0], k);
console.log(results.labels); // [ 0, 3, 1, 2 ]
console.log(results.distances); // [ 0, 1, 4, 9 ]
// Save index
const fname = 'faiss.index';
index.write(fname);
// Load saved index
const index_loaded = IndexFlatL2.read(fname);
console.log(index_loaded.getDimension()); //2
console.log(index_loaded.ntotal()); //4
const results1 = index_loaded.search([1, 1], 4);
console.log(results1.labels); // [ 3, 0, 1, 2 ]
console.log(results1.distances); // [ 0, 1, 1, 4 ]
// Merge index
const newIndex = new IndexFlatL2(dimension);
newIndex.mergeFrom(index);
console.log(newIndex.ntotal()); // 4
// Remove items
console.log(newIndex.search([1, 2], 1)); // { distances: [ 0 ], labels: [ 1 ] }
const removedCount = newIndex.removeIds([0]);
console.log(removedCount); // 1
console.log(newIndex.ntotal()); // 3
console.log(newIndex.search([1, 2], 1)); // { distances: [ 0 ], labels: [ 0 ] }
// IndexFlatIP
const ipIndex = new IndexFlatIP(2);
ipIndex.add([1, 0]);
// Serialize an index
const index_buf = newIndex.toBuffer();
const deserializedIndex = Index.fromBuffer(index_buf);
console.log(deserializedIndex.ntotal()); // 3
// Factory index
const hnswIndex = Index.fromFactory(2, 'HNSW,Flat', MetricType.METRIC_INNER_PRODUCT);
const x = [1, 0, 0, 1];
hnswIndex.train(x);
hnswIndex.add(x);
```
## License
MIT | Node.js bindings for faiss | faiss,approximate-nearest-neighbor-search,javascript,machine-learning,nodejs,npm,similarity-search,typescript,underdevelopment | 2023-03-28T14:28:20Z | 2023-10-15T12:14:49Z | 2023-10-15T12:14:49Z | 3 | 27 | 104 | 10 | 8 | 90 | null | MIT | C++ |
PlanetHoster/time2fa | main | [](https://github.com/PlanetHoster/time2fa/actions/workflows/build.yml) [](https://www.npmjs.com/package/time2fa)
A comprehensive Node.js package that simplifies the implementation of One-Time Password (OTP) authentication using HMAC-based One-Time Password (HOTP) and Time-based One-Time Password (TOTP) algorithms.
## Features
- Support both HOTP and TOTP algorithms
- Easy-to-use API for generating and verifying OTPs
- Customizable OTP length, counters and time window
- Supports various hashing algorithms (SHA-1, SHA-256, SHA-512)
- Compatible with popular OTP generators like Google Authenticator and Authy
## Installation
Install the package using NPM:
```bash
npm i --save time2fa
```
## Usage/Examples
### TOTP
#### Generate key
```javascript
// Import Totp
import { Totp } from "time2fa";
const key = Totp.generateKey({ issuer: "N0C", user: "johndoe@n0c.com" });
console.log(key);
// GenerateKey {
// issuer: 'N0C',
// user: 'johndoe@n0c.com',
// config: { algo: 'sha1', digits: 6, period: 30, secretSize: 10 },
// secret: 'ABCDEFGHIJKLMN12',
// url: 'otpauth://totp/N0C:johndoe%40n0c.com?issuer=N0C&period=30&secret=ABCDEFGHIJKLMN12'
// }
```
#### Validate passcode
```javascript
// Import Totp
import { Totp } from "time2fa";
const valid = Totp.validate({ passcode: "123456", secret: "ABCDEFGHIJKLMN12" });
console.log(valid);
// true || false
```
#### Generate passcodes
```javascript
// Import Totp, and generateConfig for default configuration
import { Totp, generateConfig } from "time2fa";
const config = generateConfig();
const codes = Totp.generatePasscodes({ secret: "ABCDEFGHIJKLMN12" }, config);
console.log(codes);
// [ 123456 ]
```
#### QRCode generation
You must use an external library. For the example below we use [qrcode](https://github.com/soldair/node-qrcode).
```javascript
// Import Totp and qrcode
import { Totp } from "time2fa";
import * as qrcode from "qrcode";
const key = Totp.generateKey({ issuer: "N0C", user: "johndoe@n0c.com" });
console.log(key);
// GenerateKey {
// issuer: 'N0C',
// user: 'johndoe@n0c.com',
// config: { algo: 'sha1', digits: 6, period: 30, secretSize: 10 },
// secret: 'ABCDEFGHIJKLMN12',
// url: 'otpauth://totp/N0C:johndoe%40n0c.com?issuer=N0C&period=30&secret=ABCDEFGHIJKLMN12'
// }
qrcode.toDataURL(key.url, (err, url) => {
console.log(url); // Returns a Data URI containing a representation of the QR Code image.
});
```
### HOTP
#### Generate Passcode
```javascript
// Import Hotp, and generateConfig for default configuration and generateSecret
import { Hotp, generateConfig, generateSecret } from "time2fa";
const config = generateConfig();
const secret = generateSecret();
const code = Hotp.generatePasscode({ secret, counter: 1 }, config);
console.log(code);
// 123456
```
#### Validate passcode
```javascript
// Import Hotp
import { Hotp } from "time2fa";
const valid = Hotp.validate({
passcode: "123456",
secret: "ABCDEFGHIJKLMN12",
counter: 1,
});
console.log(valid);
// true || false
```
### Helpers
#### generateConfig()
Generate default configuration
```javascript
// Import generateConfig
import { generateConfig } from "time2fa";
const config = generateConfig();
console.log(config);
// { algo: 'sha1', digits: 6, period: 30, secretSize: 10 }
```
#### generateSecret()
Only support base32 at the moment
```javascript
// Import generateSecret
import { generateSecret } from "time2fa";
const secret = generateSecret();
console.log(secret);
// ABCDEFGHIJKLMN12
```
#### generateUrl()
```javascript
// Import generateSecret
import { generateUrl } from "time2fa";
const url = generateUrl({
issuer: "N0C",
user: "johndoe@n0c.com",
secret: "ABCDEFGHIJKLMN12",
});
console.log(url);
// otpauth://totp/N0C:johndoe%40n0c.com?issuer=N0C&period=30&secret=ABCDEFGHIJKLMN12
```
#### generateBackupCodes()
Backup code should only be used once
```javascript
// Import generateBackupCodes
import { generateBackupCodes } from "time2fa";
const backupCodes = generateBackupCodes();
console.log(backupCodes);
// [
// '810550', '236884',
// '979342', '815504',
// '835313', '529942',
// '263100', '882025',
// '204896', '516248'
// ]
```
## Documentation
### Functions
#### Helpers
generateConfig(config?: [TotpConfig](#TotpConfig)): `ValidTotpConfig`
generateSecret(secretSize: number = DEFAULT_TOTP_SECRET_SIZE): `string`
generateBackupCodes(numCodes = 10, codeLength = DEFAULT_TOTP_DIGITS): `string[]`
generateUrl(options: [UrlOptions](#UrlOptions), config: [ValidTotpConfig](#ValidTotpConfig)): `string`
#### Totp
Totp.generateKey(options: [TotpOptions](#TotpOptions), config?: [TotpConfig](#TotpConfig)): `GenerateKey`
Totp.generatePasscodes(options: [TotpCode](#TotpCode), config: [ValidTotpConfig](#ValidTotpConfig)): `string[]`
Totp.validate(options: [TotpValidateOptions](#TotpValidateOptions), config?: [TotpConfig](#TotpConfig)): `boolean`
#### Hotp
Hotp.generatePasscode(options: [HotpCode](#HotpCode), config: [ValidTotpConfig](#ValidTotpConfig)): `string`
Hotp.validate(options: [HotpValidateOptions](#HotpValidateOptions), config?: [TotpConfig](#TotpConfig)): `boolean`
### Interfaces / Parameters
#### `TotpConfig`
| Parameter | Type | default | Description |
| :----------- | :----------- | :------ | --------------------------------------------- |
| `secretSize` | `number` | 10 | **Optional** - Secret size |
| `period` | `number` | 30 | **Optional** - Period of time |
| `digits` | `number` | 6 | **Optional**- Code length |
| `algo` | `Algorithms` | sha1 | **Optional** - 'sha1' \| 'sha256' \| 'sha512' |
#### `ValidTotpConfig`
| Parameter | Type | default | Description |
| :----------- | :----------- | :------ | --------------------------------------------- |
| `secretSize` | `number` | - | **Required** - Secret size |
| `period` | `number` | - | **Required** - Period of time |
| `digits` | `number` | - | **Required**- Code length |
| `algo` | `Algorithms` | - | **Required** - 'sha1' \| 'sha256' \| 'sha512' |
#### `TotpOptions`
| Parameter | Type | default | Description |
| :-------- | :------- | :------ | -------------------------- |
| `issuer` | `string` | - | **Required** - Issuer name |
| `user` | `string` | - | **Required** - Username |
#### `UrlOptions`
| Parameter | Type | default | Description |
| :-------- | :------- | :------ | -------------------------- |
| `issuer` | `string` | - | **Required** - Issuer name |
| `user` | `string` | - | **Required** - Username |
| `secret` | `string` | - | **Required** - Secret |
#### `TotpCode`
| Parameter | Type | default | Description |
| :-------- | :------- | :------ | ----------------------------- |
| `secret` | `string` | - | **Required** - Secret |
| `drift` | `number` | 0 | **Optional** - Time tolerance |
#### `TotpValidateOptions`
| Parameter | Type | default | Description |
| :--------- | :------- | :------ | --------------------------------------- |
| `passcode` | `string` | - | **Required** - The passcode to validate |
| `secret` | `string` | - | **Required** - Secret |
| `drift` | `number` | 0 | **Optional** - Time tolerance |
#### `HotpCode`
| Parameter | Type | default | Description |
| :-------- | :------- | :------ | ----------------------------------- |
| `secret` | `string` | - | **Required** - Secret |
| `counter` | `number` | - | **Required** - Custom counter value |
#### `HotpValidateOptions`
| Parameter | Type | default | Description |
| :--------- | :------- | :------ | --------------------------------------- |
| `passcode` | `string` | - | **Required** - The passcode to validate |
| `secret` | `string` | - | **Required** - Secret |
| `counter` | `number` | - | **Required** - Custom counter value |
## Contributing
All PR's are welcome!
## Running Tests
To run tests, run the following command
```bash
npm run test
```
## License
[MIT](https://choosealicense.com/licenses/mit/)
| A comprehensive Node.js package that simplifies the implementation of One-Time Password (OTP). | 2fa,otp,qrcode,totp,two-factor-authentication,authentication,password,authy,google-authenticator,two-factor | 2023-03-30T14:30:57Z | 2024-05-23T10:04:46Z | 2024-01-03T15:11:40Z | 3 | 315 | 397 | 5 | 8 | 90 | null | MIT | TypeScript |
vidstack/captions | main | # Media Captions
[![package-badge]][package]
[![discord-badge]][discord]
Captions parsing and rendering library built for the modern web.
**Features**
- 🚯 0 dependencies.
- 💪 Built with TypeScript (TS 5 bundle mode ready).
- 🪶 5kB total + modular (parser/renderer split) + tree-shaking support.
- 💤 Parsers are lazy loaded on-demand.
- 🚄 Efficiently load and apply styles in parallel via CSS files.
- 🗂️ Supports VTT, SRT, and SSA/ASS.
- ⬆️ Roll-up captions via VTT regions.
- 🧰 Modern `fetch` and `ReadableStream` APIs.
- 📡 Chunked text and response streaming support.
- 📝 WebVTT spec-compliant settings and rendering.
- 🎤 Timed text-tracks for karaoke-style captions.
- 🛠️ Supports custom captions parser and cue renderer.
- 💥 Collision detection to avoid overlapping or out-of-bounds cues.
- 🏗️ Fixed and in-order cue rendering (including on font or overlay size changes).
- 🛑 Adjustable parsing error-tolerance with strict and non-strict modes.
- 🖥️ Works in the browser and server-side (string renderer).
- 🎨 Easy customization via CSS.
➕ Planning to also add a TTML, CEA-608, and CEA-708 parser that will map to VTT and render
correctly. In addition, custom font loading and text codes support is planned for SSA/ASS captions.
We don't have an exact date but most likely after the [Vidstack Player][vidstack-player] 1.0. If
urgent and you're willing to sponsor, feel free to email me at rahim.alwer@gmail.com.
🔗 **Quicklinks**
- **[Installation](#installation)**
- **[Demo](#demo)**
- **[Motivation](#motivation)**
- **[API](#api)**
## Demo
The StackBlitz link below showcases a simple example of how captions are fetched, parsed, and
rendered over a native video element. We plan on adding more examples for additional captions
formats and scenarios.
[][stackblitz-demo]
## Motivation
❓ **Are native captions not good enough?**
Simply put, no.
- Positioning, styling, and rendering of cues is interpreted differently across browsers (i.e.,
not consistent).
- Styling customization via pseudo `::cue` selector is inconsistent across browsers and severely
limited with respect to even basic movement and styles.
- Cues can not be easily or accurately moved which means they'll become hidden when custom controls
are active.
- Multiple active cues are not rendered in the correct order. This can also occur randomly on font
and overlay size changes (e.g., entering fullscreen).
- Failure in positioning and customizing styles correctly results in failing accessibility
guidelines.
- Text tracks cannot be removed in most browsers as there's no native API to do so. Captions need
to be managed externally and mapped to a generic text track.
- Karaoke-style captions are not supported out of the box in most browsers.
- Only VTT is natively supported by browsers.
- VTT Regions and roll-up captions are not fully supported in all browsers.
- Custom rendering of cues is not supported.
- Large caption files can not be streamed and aborted when no longer required.
- Obviously can not be used server-side.
Did you know closed-captions are governed by the Federal Communications Commission (FCC) under the
Communications and Video Accessibility Act (CVA)? Not providing captions and adequate
customization options on the web for content that was shown on TV doesn't meet guidelines 😱 Filed
law suits have dramatically increased in recent years! See the amazing
[Caption Me If You Can][caption-me-talk] talk at [Demuxed][demuxed] by Dan Sparacio to learn more.
❓ **What about [mozilla/vtt][mozilla-vtt]?**
The library is old, outdated, and unmaintained.
- Not packaged correctly by modern standards using Node exports with ES6, TS types, CJS/ESM,
and server bundles.
- Doesn't lazy load the parser.
- Doesn't cleanly work server-side out of the box.
- Doesn't split parser and renderer so they can be imported separately when needed.
- Not built with TypeScript so no types are shipped.
- Doesn't support a wide variety features that we support. Including streaming via modern APIs,
VTT regions, roll-up captions, custom renderers, alternative captions formats (SRT/SSA),
timed-text and more.
- In-lines all styles which means they can't be loaded in parallel with JS, makes it harder to
customize, and slower with respect to DOM updates.
- Doesn't include flexible error tolerance settings.
- Doesn't expose styling attrs for selecting nodes such as cues, voice nodes, and timed-text nodes.
## Installation
First, install the NPM package:
```bash
npm i media-captions
```
Next, include styles if you plan on rendering captions using the [`CaptionsRenderer`](#captionsrenderer):
```js
import 'media-captions/styles/captions.css';
// Optional - include if rendering VTT regions.
import 'media-captions/styles/regions.css';
```
Optionally, you can load the styles directly from a CDN using [JSDelivr](https://www.jsdelivr.com)
like so:
```html
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/media-captions/styles/captions.min.css" />
<!-- Optional - include if rendering VTT regions. -->
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/media-captions/styles/regions.min.css" />
```
## API
- **Parsing**
- [Parse Options](#parse-options)
- [Parse Result](#parse-result)
- [Parse Errors](#parse-errors)
- [`parseText`](#parsetext)
- [`parseTextStream`](#parsetextstream)
- [`parseResponse`](#parseresponse)
- [`parseByteStream`](#parsebytestream)
- [`CaptionsParser`](#captionsparser)
- **Rendering**
- [`createVTTCueTemplate`](#createvttcuetemplate)
- [`renderVTTCueString`](#rendervttcuestring)
- [`tokenizeVTTCue`](#tokenizevttcue)
- [`renderVTTTokensString`](#rendervtttokensstring)
- [`updateTimedVTTCueNodes`](#updatetimedvttcuenodes)
- [`CaptionsRenderer`](#captionsrenderer)
- [Styling](#styling)
- **Formats**
- [VTT](#vtt)
- [SRT](#srt)
- [SSA/ASS](#ssaass)
- [Streaming](#streaming)
- [Types](#types)
## Parse Options
All parsing functions exported from this package accept the following options:
- `strict`: Whether strict mode is enabled. In strict mode parsing errors will throw and cancel
the parsing process.
- `errors`: Whether errors should be collected and reported in the final
[parser result](#parse-result). By default, this value will be true in dev mode or if `strict`
mode is true. If set to true and `strict` mode is false, the `onError` callback will be invoked.
Do note, setting this to true will dynamically load error builders which will slightly increase
bundle size (~1kB).
- `type`: The type of the captions file format so the correct parser is loaded. Options
include `vtt`, `srt`, `ssa`, `ass`, or a custom [`CaptionsParser`](#captionsparser) object.
- `onHeaderMetadata`: Callback that is invoked when the metadata from the header block has been
parsed.
- `onCue`: Invoked when parsing a VTT cue block has finished parsing and a `VTTCue` has
been created. Do note, regardless of which captions file format is provided a `VTTCue` will
be created.
- `onRegion`: Invoked when parsing a VTT region block has finished and a `VTTRegion` has been
created.
- `onError`: Invoked when a loading or parser error is encountered. Do note, this is only invoked
in development, if the `strict` parsing option is true, or if the `errors` parsing option is
true.
Options can be provided to any parsing function like so:
```ts
import { parseText } from 'media-captions';
parseText('...', {
strict: false,
type: 'vtt',
onCue(cue) {
// ...
},
onError(error) {
// ...
},
});
```
## Parse Result
All parsing functions exported from this package return a `Promise` which will resolve a
`ParsedCaptionsResult` object with the following properties:
- `metadata`: An object containing all metadata that was parsed from the header block.
- `regions`: An array containing `VTTRegion` objects that were parsed and created during the
parsing process.
- `cues`: An array containing `VTTCue` objects that were parsed and created during the parsing
process.
- `errors`: An array containing `ParseError` objects. Do note, errors will only be collected if
in development mode, if `strict` parsing option is set to true, or the `errors` parsing option is
set to true.
```ts
import { parseText } from 'media-captions';
// `ParsedCaptionsResult`
const { metadata, regions, cues, errors } = await parseText('...');
for (const cue of cues) {
// ...
}
```
## Parse Errors
By default, parsing is error tolerant and will always try to recover. You can set strict mode
to ensure errors are not tolerated and are instead thrown. The text stream and parsing process
will also be cancelled.
```ts
import { parseText, type ParseError } from 'media-captions';
try {
// Any error will now throw and cancel parsing.
await parseText('...', { strict: true });
} catch (error: ParseError) {
console.log(error.code, error.message, error.line);
}
```
A more tolerant error collection option is to set the `errors` parsing option to true. This
will ensure the `onError` callback is invoked and also errors are reported in the final
result (this will add ~1kB to the bundle size):
```ts
import { parseText } from 'media-captions';
const { errors } = await parseText('...', {
errors: true, // Not required if you only want errors in dev mode.
onError(error) {
error; // `ParseError`
},
});
for (const error of errors) {
// ...
}
```
The `ParseError` contains a numeric error `code` that matches the following values:
```ts
const ParseErrorCode = {
LoadFail: 0,
BadSignature: 1,
BadTimestamp: 2,
BadSettingValue: 3,
BadFormat: 4,
UnknownSetting: 5,
};
```
The `ParseErrorCode` object can be imported from the package.
## `parseText`
This function accepts a text string as input to be parsed:
```ts
import { parseText } from 'media-captions';
const { cues } = await parseText('...');
```
## `parseTextStream`
This function accepts a text stream [`ReadableStream<string>`](https://developer.mozilla.org/en-US/docs/Web/API/ReadableStream) as input to be parsed:
```ts
import { parseTextStream } from 'media-captions';
const stream = new ReadableStream<string>({
start(controller) {
controller.enqueue('...');
controller.enqueue('...');
controller.enqueue('...');
// ...
controller.close();
},
});
// `ParsedCaptionsResult`
const result = await parseTextStream(stream, {
onCue(cue) {
// ...
},
});
```
## `parseResponse`
The `parseResponse` function accepts a [`Response`](https://developer.mozilla.org/en-US/docs/Web/API/Response) or `Promise<Response>` object. It can be seamlessly used with
[`fetch`](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API) to parse a response body stream like so:
```ts
import { ParseErrorCode, parseResponse } from 'media-captions';
// `ParsedCaptionsResult`
const result = await parseResponse(fetch('/media/subs/english.vtt'), {
onCue(cue) {
// ...
},
onError(error) {
if (error.code === ParseErrorCode.LoadFail) {
console.log(error.message);
}
},
});
```
The captions type will inferred from the response header `content-type` field. You can specify
the specific captions format like so:
```ts
parseResponse(..., { type: 'vtt' });
```
The text encoding will be inferred from the response header and forwarded to the underlying
[`TextDecoder`](https://developer.mozilla.org/en-US/docs/Web/API/TextDecoder/TextDecoder). You
can specify a specific encoding like so:
```ts
parseResponse(..., { encoding: 'utf8' });
```
## `parseByteStream`
This function is used to parse byte streams `ReadableStream<Uint8Array>`. It's used by the
`parseResponse` function to parse response body streams. It can be used like so:
```ts
import { parseByteStream } from 'media-captions';
const byteStream = new ReadableStream<Uint8Array>({
// ...
});
const result = await parseByteStream(byteStream, {
encoding: 'utf8',
onCue(cue) {
// ...
},
});
```
## `CaptionsParser`
You can create a custom caption parser and provide it to the `type` option on any parse function.
The parser can be created and provided like so:
```ts
import {
type CaptionsParser,
type CaptionsParserInit,
type ParsedCaptionsResult,
} from 'media-captions';
class CustomCaptionsParser implements CaptionsParser {
/**
* Called when initializing the parser before the
* parsing process begins.
*/
init(init: CaptionsParserInit): void | Promise<void> {
// ...
}
/**
* Called when a new line of text has been read and
* requires parsing. This includes empty lines which
* can be used to separate caption blocks.
*/
parse(line: string, lineCount: number): void {
// ...
}
/**
* Called when parsing has been cancelled, or has
* naturally ended as there are no more lines of
* text to be parsed.
*/
done(cancelled: boolean): ParsedCaptionsResult {
// ...
}
}
// Custom parser can be provided to any parse function.
parseText('...', {
type: () => new CustomCaptionsParser(),
});
```
## `createVTTCueTemplate`
This function takes a `VTTCue` and renders the cue text string into a HTML template element
and returns a `VTTCueTemplate`. The template can be used to efficiently store and clone
the rendered cue HTML like so:
```ts
import { createVTTCueTemplate, VTTCue } from 'media-captions';
const cue = new VTTCue(0, 10, '<v Joe>Hello world!');
const template = createVTTCueTemplate(cue);
template.cue; // original `VTTCue`
template.content; // `DocumentFragment`
// <span title="Joe" data-part="voice">Hello world!</span>
const cueHTML = template.content.cloneNode(true);
```
## `renderVTTCueString`
This function takes a `VTTCue` and renders the cue text string into a HTML string. This
function can be used server-side to render cue content like so:
```ts
import { renderVTTCueString, VTTCue } from 'media-captions';
const cue = new VTTCue(0, 10, '<v Joe>Hello world!');
// Output: <span title="Joe" data-part="voice">Hello world!</span>
const content = renderVTTCueString(cue);
```
The second argument accepts the current playback time to add the correct `data-past` and
`data-future` attributes to timed text (i.e., karaoke-style captions):
```ts
const cue = new VTTCue(0, 320, 'Hello my name is <5:20>Joe!');
// Output: Hello my name is <span data-part="timed" data-time="80" data-future>Joe!</span>
renderVTTCueString(cue, 310);
// Output: Hello my name is <span data-part="timed" data-time="80" data-past>Joe!</span>
renderVTTCueString(cue, 321);
```
## `tokenizeVTTCue`
This function takes a `VTTCue` and returns a collection of VTT tokens based on the cue
text. Tokens represent the render nodes for a cue:
```ts
import { tokenizeVTTCue, VTTCue } from 'media-captions';
const cue = new VTTCue(0, 10, '<b.foo.bar><v Joe>Hello world!');
const tokens = tokenizeVTTCue(cue);
// `tokens` output:
[
{
tagName: 'b',
type: 'b',
class: 'foo bar',
children: [
{
tagName: 'span',
type: 'v',
voice: 'Joe',
children: [{ type: 'text', data: 'Hello world!' }],
},
],
},
];
```
Nodes can be a `VTTBlockNode` which can have children (i.e., class, italic, bold, underline,
ruby, ruby text, voice, lang, timestamp) or a `VTTLeafNode` (i.e., text nodes). The tokens
can be used for custom rendering like so:
```ts
function renderTokens(tokens: VTTNode[]) {
for (const token of tokens) {
if (token.type === 'text') {
// Process text nodes here...
token.data;
} else {
// Process block nodes here...
token.tagName;
token.class;
token.type === 'v' && token.voice;
token.type === 'lang' && token.lang;
token.type === 'timestamp' && token.time;
token.color;
token.bgColor;
renderTokens(tokens.children);
}
}
}
```
All token types are listed below for use in TypeScript:
```ts
import type {
VTTBlock,
VTTBlockNode,
VTTBlockType,
VTTBoldNode,
VTTClassNode,
VTTextNode,
VTTItalicNode,
VTTLangNode,
VTTLeafNode,
VTTNode,
VTTRubyNode,
VTTRubyTextNode,
VTTTimestampNode,
VTTUnderlineNode,
VTTVoiceNode,
} from 'media-captions';
```
## `renderVTTTokensString`
This function takes an array of `VTToken` objects and renders them into a string:
```ts
import { renderVTTTokensString, tokenizeVTTCue, VTTCue } from 'media-captions';
const cue = new VTTCue(0, 10, '<v Joe>Hello world!');
const tokens = tokenizeVTTCue(cue);
// Output: <span title="Joe" data-part="voice">Hello world!</span>
const result = renderVTTTokensString(tokens);
```
## `updateTimedVTTCueNodes`
This function accepts a root DOM node to update all timed text nodes by setting the correct
`data-future` and `data-past` attributes.
```ts
import { updateTimedVTTCueNodes } from 'media-captions';
const video = document.querySelector('video')!,
captions = document.querySelector('#captions')!;
video.addEventListener('timeupdate', () => {
updateTimedVTTCueNodes(captions, video.currentTime);
});
```
This can be used when working with karaoke-style captions:
```ts
const cue = new VTTCue(300, 308, '<05:00>Timed...<05:05>Text!');
// Timed text nodes that would be updated at 303 seconds:
// <span data-part="timed" data-time="300" data-past>Timed...</span>
// <span data-part="timed" data-time="305" data-future>Text!</span>
```
## `CaptionsRenderer`
The captions overlay renderer is used to render captions over a video player. It follows the
[WebVTT rendering specification](https://www.w3.org/TR/webvtt1/#rendering) on how regions
and cues should be visually rendered. It includes:
- Correctly aligning and positioning regions and cues.
- Processing and applying all region and cue settings.
- Rendering captions top-down in-order (Cue 1, Cue 2, Cue 3).
- Rendering roll up captions in regions.
- Collision detection to avoid overlapping cues.
- Updating timed text nodes with `data-past` and `data-future` attributes.
- Updating when the overlay is resized.
- Applying SSA/ASS styles.
- Accepts native `VTTCue` objects.
> **Warning**
> The [styles files](#installation) need to be included for the overlay renderer to work correctly!
```html
<div>
<video src="..."></video>
<div id="captions"></div>
</div>
```
```ts
import 'media-captions/styles/captions.css';
import 'media-captions/styles/regions.css';
import { CaptionsRenderer, parseResponse } from 'media-captions';
const video = document.querySelector('video')!,
captions = document.querySelector('#captions')!,
renderer = new CaptionsRenderer(captions);
parseResponse(fetch('/media/subs/english.vtt')).then((result) => {
renderer.changeTrack(result);
});
video.addEventListener('timeupdate', () => {
renderer.currentTime = video.currentTime;
});
```
**Props**
- `dir`: Sets the text direction (i.e., `ltr` or `rtl`).
- `currentTime`: Updates the current playback time and schedules a re-render.
**Methods**
- `changeTrack(track: CaptionsRendererTrack)`: Resets the renderer and prepares new regions and cues.
- `addCue(cue: VTTCue)`: Add a new cue to the renderer.
- `removeCue(cue: VTTCue)`: Remove a cue from the renderer.
- `update(forceUpdate: boolean)`: Schedules a re-render to happen.
- `reset()`: Reset the renderer and clear all internal state including region and cue DOM nodes.
- `destroy()`: Reset the renderer and destroy internal observers and event listeners.
## Styling
Captions rendered with the [`CaptionOverlayRenderer`](#captionsoverlayrenderer) can be
easily customized with CSS. Here are all the parts you can select and customize:
```css
/* `#captions` assumes you set the id on the captions overlay element. */
#captions {
/* simple CSS vars customization (defaults below) */
--overlay-padding: 1%;
--cue-color: white;
--cue-bg-color: rgba(0, 0, 0, 0.8);
--cue-font-size: calc(var(--overlay-height) / 100 * 5);
--cue-line-height: calc(var(--cue-font-size) * 1.2);
--cue-padding-x: calc(var(--cue-font-size) * 0.6);
--cue-padding-y: calc(var(--cue-font-size) * 0.4);
}
#captions [data-part='region'] {
}
#captions [data-part='region'][data-active] {
}
#captions [data-part='region'][data-scroll='up'] {
}
#captions [data-part='cue-display'] {
}
#captions [data-part='cue'] {
}
#captions [data-part='cue'][data-id='...'] {
}
#captions [data-part='voice'] {
}
#captions [data-part='voice'][title='Joe'] {
}
#captions [data-part='timed'] {
}
#captions [data-part='timed'][data-past] {
}
#captions [data-part='timed'][data-future] {
}
```
## VTT
Web Video Text Tracks (WebVTT) is the natively supported captions format supported
by browsers. You can learn more about it on
[MDN](https://developer.mozilla.org/en-US/docs/Web/API/WebVTT_API) or by reading the
[W3 specification](https://www.w3.org/TR/webvtt1).
WebVTT is a plain-text file that looks something like this:
```text
WEBVTT
Kind: Language
Language: en-US
REGION id:foo width:100 lines:3 viewportanchor:0%,0% regionanchor:0%,0% scroll:up
1
00:00 --> 00:02 region:foo
Hello, Joe!
2
00:02 --> 00:04 region:foo
Hello, Jane!
```
```ts
parseResponse(fetch('/subs/english.vtt'), { type: 'vtt' });
```
> **Warning**
> The parser will throw in strict parsing mode if the WEBVTT header line is not present.
### VTT Regions
WebVTT supports regions for bounding/positioning cues and implementing roll up captions
by setting `scroll:up`.
<img
src="./assets/vtt-regions.png"
width="400px"
alt="Visual explanation of VTT regions"
/>
<img
src="./assets/vtt-region-scroll.png"
width="400px"
alt="Visual explanation of VTT region scroll up setting for roll up captions"
/>
### VTT Cues
WebVTT cues are used for positioning and displaying text. They can snap to lines or be
freely positioned as a percentage of the viewport.
```ts
const cue = new VTTCue(0, 10, '...');
// Position at line 5 in the video.
// Lines are calculated using cue line height.
cue.line = 5;
// 50% from the top and 10% from the left of the video.
cue.snapToLines = false;
cue.line = 50;
cue.position = 10;
// Align cue horizontally at end of line.
cue.align = 'end';
// Align top of the cue at the bottom of the line.
cue.lineAlign = 'end';
```
<img
src="./assets/vtt-cues.png"
width="400px"
alt="Visual explanation of VTT cues"
/>
## SRT
SubRip Subtitle (SRT) is a simple captions format that only contains cues. There are no
regions or positioning settings as found in [VTT](#vtt).
SRT is a plain-text file that looks like this:
```text
00:00 --> 00:02,200
Hello, Joe!
00:02,200 --> 00:04,400
Hello, Jane!
```
```ts
parseResponse(fetch('/subs/english.srt'), { type: 'srt' });
```
Note that SRT timestamps use a comma `,` to separate the milliseconds unit unlike VTT which uses
a dot `.`.
## SSA/ASS
SubStation Alpha (SSA) and its successor Advanced SubStation Alpha (ASS) are subtitle formats
commonly used for anime content. They allow for rich text formatting, including
color, font size, bold, italic, and underline, as well as more advanced features like karaoke and
typesetting.
SSA/ASS is a plain-text file that looks like this:
```text
[Styles]
Format: Name, Fontname, Fontsize, PrimaryColour, SecondaryColour, OutlineColour, BackColour, Bold, Italic, Underline, StrikeOut, ScaleX, ScaleY, Spacing, Angle, BorderStyle, Outline, Shadow, Alignment, MarginL, MarginR, MarginV, Encoding
Style: Default,Arial,36,&H00FFFFFF,&H000000FF,&H00000000,&H00000000,0,0,0,0,100,100,0,0,1,2,2,2,10,10,10,1
[Events]
Format: Layer, Start, End, Style, Name, MarginL, MarginR, MarginV, Effect, Text
Dialogue: 0,0:00:05.10,0:00:07.20,Default,,0,0,0,,Hello, world!
[Other Events]
Format: Start, End, Text
Dialogue: 0:00:04,\t0:00:07.20, One!
Dialogue: 0:00:05,\t0:00:08.20, Two!
Dialogue: 0:00:06,\t0:00:09.20, Three!
Continue dialogue on a new line.
```
```ts
parseResponse(fetch('/subs/english.ssa'), { type: 'ssa' });
```
The following features are supported:
- Multiple styles blocks and all format fields (e.g., PrimaryColour, Bold, ScaleX, etc.).
- Multiple events blocks and associating them with styles.
The following features are not supported yet:
- Layers
- Movie
- Picture
- Sound
- Command
- Font Loading
- Text Codes (stripped out for now)
It is very likely we will implement custom font loading, layers, and text codes in the
near future. The rest is unlikely for now. You can always try and implement custom transitions
or animations using CSS (see [Styling](#styling)).
We recommend using [SubtitlesOctopus](https://github.com/libass/JavascriptSubtitlesOctopus) for
SSA/ASS captions as it supports most features and is a performant WASM wrapper of
[libass](https://github.com/libass/libass). You'll need to fall back to this implementation on
iOS Safari (iPhone) as custom captions are not supported there.
## Streaming
You can split large captions files into chunks and use the [`parseTextStream`](#parsetextstream)
or [`parseResponse`](#parseresponse) functions to read and parse the stream. Files can be chunked
however you like and don't need to be aligned with line breaks.
Here's an example that chunks and streams a large VTT file on the server:
```ts
import fs from 'node:fs';
async function handle() {
const stream = new ReadableStream({
start(controller) {
const encoder = new TextEncoder();
const stream = fs.createReadStream('english.vtt');
stream.on('readable', () => {
controller.enqueue(encoder.encode(stream.read()));
});
stream.on('end', () => {
controller.close();
});
},
});
return new Response(stream, {
headers: {
'Content-Type': 'text/vtt; charset=utf-8',
},
});
}
```
## Types
Here's the types that are available from this package for use in TypeScript:
```ts
import type {
CaptionsFileFormat,
CaptionsParser,
CaptionsParserInit,
CaptionsRenderer,
CaptionsRendererTrack,
ParseByteStreamOptions,
ParseCaptionsOptions,
ParsedCaptionsResult,
ParseError,
ParseErrorCode,
ParseErrorInit,
TextCue,
VTTCue,
VTTCueTemplate,
VTTHeaderMetadata,
VTTRegion,
} from 'media-captions';
```
## 📝 License
Media Captions is [MIT licensed](./LICENSE).
[package]: https://www.npmjs.com/package/media-captions
[package-badge]: https://img.shields.io/npm/v/media-captions/next?style=flat-square
[discord]: https://discord.com/invite/7RGU7wvsu9
[discord-badge]: https://img.shields.io/discord/742612686679965696?color=%235865F2&label=%20&logo=discord&logoColor=white&style=flat-square
[stackblitz-demo]: https://stackblitz.com/edit/media-captions?embed=1&file=src/main.ts&hideNavigation=1&showSidebar=1
[demuxed]: https://demuxed.com
[caption-me-talk]: https://www.youtube.com/watch?v=Z0HqYQqdErE
[mozilla-vtt]: https://github.com/mozilla/vtt.js
[vidstack-player]: https://github.com/vidstack/player
| Modern media captions parser and renderer (~5kB). Supports VTT, SRT, and SSA. Works server side, supports text streams, rollup captions via VTT regions, customization via CSS, and more. | captions,vtt,srt,ssa,subtitles,parser,ssr,webvtt,typescript,javascript | 2023-03-26T11:24:46Z | 2024-03-16T05:16:14Z | null | 3 | 1 | 68 | 0 | 6 | 87 | null | MIT | TypeScript |
piyush-eon/dsa-with-javascript-course | master | # Data Structures and Algorithm in JavaScript Course
### Watch the Course here -
## [https://www.youtube.com/watch?v=0kafYiWEVpU&list=PLKhlp2qtUcSZtJefDThsXcsAbRBCSTgW4&index=1](https://www.youtube.com/playlist?list=PLKhlp2qtUcSZtJefDThsXcsAbRBCSTgW4)
### Download My Most Asked DSA Interview Question Sheet -
## https://topmate.io/roadsidecoder/491565
| Course Files for Data Structures and Algorithm Course with Javascript - By RoadsideCoder | dsa,dsa-algorithm,dsa-javascript,dsa-practice,javascript | 2023-04-08T05:37:22Z | 2023-10-20T05:43:47Z | null | 1 | 3 | 20 | 0 | 37 | 82 | null | null | JavaScript |
WAppAI/assistant | main | # WhatsApp AI Assistant
Welcome to the WhatsApp AI Assistant repository, where you'll find a remarkable WhatsApp chatbot designed to function as your very own AI-powered personal assistant. This chatbot leverages the power of Language Model (LLM) technology.
| Sydney | OpenRouter Models* |
| :----------------------------------------------------------------------------------------------------: | :----------------: |
| <video src="https://github.com/WAppAI/assistant/assets/50471205/5d300910-099d-4ceb-9f87-0852389a4c5b"> | <video src="https://github.com/WAppAI/assistant/assets/50471205/e8e8aabe-9ef7-4e3e-b0dc-156071c425f8"> |
## Feature Comparison
| Feature | Sydney (BingAI Jailbreak) | OpenRouter Models* |
| :-------------------------- | :-----------------------: | :----------------: |
| Google/Bing Searching | ✅ | ✅ |
| Google Calendar | ❌ | ✅ |
| Gmail | ❌ | ❌ |
| Communication Capability | ✅ | ✅ |
| Group Chat Compatibility | ✅ | ✅ |
| Voice Message Capability | ✅ | ✅ |
| Create Basic Text Reminders | ✅ | ❌ |
| Image Recognition | ✅ | ❌ |
| Image Generation | ❌ | ✅ |
| PDF Reading | ❌ | ❌ |
**NOTE:** We do not test every LLM that OpenRouter provides. Typically, we only test OpenAI GPT-3.5 and Google Gemini Pro.
## Getting Started
### Prerequisites
- Node.js >= 18.15.0
- Node.js version >= 20.x.x users you should use `node --loader ts-node/esm src/index.ts` instead of `pnpm start`
- A spare WhatsApp number
### Installation
<details>
<summary><b>Sydney/BingChat</b></summary>
<br>
1. Clone this repository
```
git clone https://github.com/WAppAI/assistant.git
```
2. Install the dependencies
```
pnpm install
```
3. Rename [.env.example](../master/.env.example) to `.env`
```
cp .env.example .env
```
4. Login with your Bing account and edit `.env`'s `BING_COOKIES` environment variable to the cookies string from [bing.com](https://bing.com). For detailed instructions [here](https://github.com/danny-avila/LibreChat/issues/370#issuecomment-1560382302).
**NOTE:** Occasionally, you might encounter an error stating, `User needs to solve CAPTCHA to continue.` To resolve this issue, please solve the captcha [here]https://www.bing.com/turing/captcha/challenge, while logged in with the same account associated with your BING_COOKIES.
5. Read and fill in the remaining information in the `.env` file.
6. Run
```
pnpm build
```
7. Start the bot
```
pnpm start
```
8. Connect your WhatsApp account to the bot by scanning the generated QR Code in the CLI.
9. Send a message to your WhatsApp account to start a conversation with Sydney!
</details>
<details>
<summary><b>OpenRouter</b></summary>
<br>
1. Clone this repository
```
git clone https://github.com/WAppAI/assistant.git
```
2. Install the dependencies
```
pnpm install
```
3. Rename [.env.example](../master/.env.example) to `.env`
```
cp .env.example .env
```
4. Read and fill in the remaining information in the `.env` file.
5. Instructions on how to use langchain tools like Google Calendar and search will be in the `.env`
6. Run
```
pnpm build
```
6. Start the bot
```
pnpm start
```
7. Connect your WhatsApp account to the bot by scanning the generated QR Code in the CLI.
8. Send a message to your WhatsApp account to start a conversation with the bot!
</details>
## Usage
The AI's are designed to respond to natural language queries from users. You can ask them questions, or just have a casual conversation.
### Voice Messages
When dealing with voice messages, you have two options for transcription: utilizing the Whisper API or the local method. Each option has its own considerations, including cost and performance.
<details>
<summary><strong>Whisper API:</strong></summary>
- **Cost:** Utilizing the Whisper API incurs a cost of US$0.06 per 10 minutes of audio.
- **Setup:**
1. Obtain an OpenAI API key and place it in the `.env` file under the `OPENAI_API_KEY` variable.
2. Set `TRANSCRIPTION_ENABLED` to `"true"` and `TRANSCRIPTION_METHOD` to `"whisper-api"`. While setting a language in `TRANSCRIPTION_LANGUAGE` is not mandatory, it is recommended for better performance.
</details>
<details>
<summary><strong>Local Mode:</strong></summary>
- **Cost:** The local method is free but may be slower and less precise.
- **Setup:**
1. Download a model of your choice from [here](https://huggingface.co/ggerganov/whisper.cpp/tree/main). Download any `.bin` file and place it in the `./whisper/models` folder.
2. Modify the `.env` file by changing `TRANSCRIPTION_ENABLED` to `"true"`, `TRANSCRIPTION_METHOD` to `"local"`, and `"TRANSCRIPTION_MODEL"` with the name of the model you downloaded. While setting a language in `TRANSCRIPTION_LANGUAGE` is not mandatory, it is recommended for better performance.
</details>
### Group Chat
To utilize it in a group chat, you will need to either mention it by using her username with the "@" symbol (e.g., @Sydney) or reply directly to her last message.
### Available commands
- `!help`: Displays a message listing all available commands.
- `!help` followed by a specific command, e.g., `!help reset`: Provides detailed information about the selected command.
- If you wish to customize the command prefix, you can do so in the `.env` file to better suit your preferences.
## Contribute
Your contributions to Sydney are welcome in any form. Whether you'd like to:
- Report Issues: If you come across bugs or have ideas for new features, please open an issue to discuss and track these items.
- Submit Pull Requests (PRs): Feel free to contribute directly by opening pull requests. Your contributions are greatly appreciated and help improve Sydney.
- If you want us to add a tool from the js langchain open an issue asking for it.
Your involvement is valued, and you're encouraged to contribute in the way that suits you best.
## Hire Us
Both creators of this project, [Veigamann](https://github.com/veigamann) and [Luisotee](https://github.com/Luisotee), are currently seeking new job opportunities.
If you have any job opportunities, please feel free to contact us through the emails provided in our GitHub profiles.
| A WhatsApp chatbot that leverages Bing AI's and others LLMs conversational capabilities. | bing-chat,javascript,nodejs,typescript,whatsapp,chatbot,gpt,langchain,openrouter,llm | 2023-04-02T22:36:36Z | 2024-05-18T03:48:25Z | 2024-04-30T15:42:43Z | 4 | 195 | 205 | 4 | 24 | 82 | null | MIT | TypeScript |
carboneio/rock-req | master |
<p align="center">
<img src="https://raw.githubusercontent.com/carboneio/rock-req/master/doc/rock-req-logo.svg" alt="rock-req logo" height="150"/>
</p>
<h1 align="center" style="border-bottom:none;">Rock-req</h1>
<p align="center">⭐️⭐️ Ensure your HTTP requests always reach their destination as <b>efficiently</b> as possible! ⭐️⭐️</p>
<p align="center">Tested on Mac, Linux, Windows with NodeJS 16, 18, 19, 20</p>
[![npm][npm-image]][npm-url] [![ci][ci-image]][ci-url] [![javascript style guide][standard-image]][standard-url]
[standard-image]: https://img.shields.io/badge/code_style-standard-brightgreen.svg
[standard-url]: https://standardjs.com
[npm-image]: https://img.shields.io/npm/v/rock-req.svg
[npm-url]: https://npmjs.org/package/rock-req
[ci-url]: https://github.com/carboneio/rock-req/actions
[ci-image]: https://img.shields.io/github/actions/workflow/status/carboneio/rock-req/ci.yml?branch=master
## 🔥 Why?
In most existing libraries (2023):
- Managing **reliable retries** is difficult, tricky with streams and not battle-tested
- Using **multiple forward proxies** has several benefits like **higher availability** and **increased bandwidth** but
**Intercepting retries** to use another Egress controller between two requests is not possible.
- Many request libraries are heavy: node-fetch, superagent, needle, got, axios, request
- Lightweight alternatives are not as light as they claim due to dependencies (simple-get, tiny-req, puny-req, phin, ...)
⚡️ **Rock-req** solves these problems with only **150 lines of code** and **zero dependencies**
It also supports many features:
- Follows redirects
- Handles **gzip/deflate/brotli** responses
- Modify defaults
- Extend and create new instances
- Automatically destroy input/output **stream** on error and premature close event
- **Advanced retries**
- URL Rewrite
- **Ultra-fast (> 20k req/s)**
- Keep Alive by default (3000ms)
- Composable
- Timeouts
- HTTPS / HTTP
- Composes well with npm packages for features like cookies, proxies, form data, & OAuth
- Keep 98% of the `simple-get` API (fork source)
When the callback is called, the request is 100% finished, even with streams.
## 🚀 Benchmark Rock-req vs got, axios, node-fetch, phin, simple-get, superagent, ...
Stop using "slow by-default" and "false-light" HTTP request libraries!
| Library | NodeJS 16 | NodeJS 18 | NodeJS 20* | Size deps inc. |
| ------------ |--------------:|--------------:| --------------:| --------------:|
| rock-req 🙋♂️ | 22816 req/s | 21797 req/s | 21964 req/s | 144 LOC |
| simple-get | 2937 req/s | 3260 req/s | 21258 req/s | 317 LOC |
| axios | 5090 req/s | 4910 req/s | 3196 req/s | 13983 LOC |
| got | 2163 req/s | 1762 req/s | 9961 req/s | 9227 LOC |
| fetch | 2101 req/s | 2102 req/s | 2020 req/s | 13334 LOC |
| request | 2249 req/s | 1869 req/s | 15815 req/s | 46572 LOC |
| superagent | 2776 req/s | 2100 req/s | 2895 req/s | 16109 LOC |
| phin | 3178 req/s | 1164 req/s | 21299 req/s | 331 LOC |
| _undici_* | 24095 req/s | 24378 req/s | 24191 req/s | 16225 LOC |
> NodeJS 20 activates HTTP keep-alive by default, like `rock-req`
> `undici` is a low-level API, faster alternative to the native NodeJS http module. It is the glass ceiling limit for NodeJS.
> `rock-req` uses only the native NodeJS http module and provides many high-level features, a lot more than `phin` and `simple-get` with fewer lines of code.
> Tested on Macbook Pro M1 Max
## Install
```bash
npm install rock-req
```
## Documentation
[The full documentation is here](doc/api.md) to reduce Node package file size.
## Supporters
This packaged in maintained by Carbone:
<p>
<a href="https://carbone.io" alt="Carbone.io - Efficient PDF / DOCX / XLSX / CSV / HTML / XML generator with templates and JSON">
<img src="https://raw.githubusercontent.com/carboneio/rock-req/master/doc/carbone-logo.svg" alt="Carbone.io logo" height="60"/>
</a>
</p>
Thank you [Feross Aboukhadijeh](https://github.com/feross), creator of `simple-get`
| ⚡️ Ultra-light (150 LOC, zero dep.) & Ultra-fast NodeJS request library with reliable retry on failure, http/https, redirects, gzip/deflate/brotli, extensible, proxy, streams, JSON mode, forms, timeout | http,http-client,https,javascript,node-fetch,nodejs,request,simple-get,superagent | 2023-03-30T07:50:25Z | 2023-05-15T10:56:41Z | null | 17 | 0 | 239 | 3 | 3 | 80 | null | MIT | JavaScript |
zubyj/leetcode-explained | main | # Leetcode Explained
[](https://opensource.org/licenses/MIT)
A free, open source browser extension that enhances Leetcode problems with code solutions, video explanations, and GPT code analysis.
[<img src="https://user-images.githubusercontent.com/3750161/214147732-c75e96a4-48a4-4b64-b407-c2402e899a75.PNG" height="40" alt="Chrome">](https://chrome.google.com/webstore/detail/leetcode-explained/cofoinjfjcpgcjiinjhcpomcjoalijbe)
[<img src="https://user-images.githubusercontent.com/3750161/214148610-acdef778-753e-470e-8765-6cc97bca85ed.png" height="40" alt="Firefox">](https://addons.mozilla.org/en-US/firefox/addon/leetcode-explained/)
[<img src="https://user-images.githubusercontent.com/3750161/233201810-d1026855-0482-44c8-b1ec-c7247134473e.png" height="40" alt="Chrome">](https://chrome.google.com/webstore/detail/leetcode-explained/cofoinjfjcpgcjiinjhcpomcjoalijbe)
### Features
1️⃣ Solution videos: Adds the top 5 youtube solution videos into each [problem](https://leetcode.com/problems/two-sum/solutions)
2️⃣ Complexity Analysis
Reads your code and gets the time & space complexity using GPT
3️⃣ Code Generation
Reads your code, fixes bugs, and generates the optimal solution code for the given problem using GPT. For more accurate results, open the description tab so GPT can read the problem's description and constraints.
4️⃣ Elo ratings
Adds difficulty ratings into weekly/biweekly contest problems (~1500 added)
5️⃣ Hard Mode
Hide the Leetcode problem examples to simulate a real coding interview environment. Available through the extension's settings.
### ⚙️ Installation
1. ``` git clone https://github.com/zubyj/leetcode-explained.git ```
2. ``` cd leetcode-explained ```
3. ``` npm install && tsc```
4. Open Google Chrome and navigate to ```chrome://extensions``` in the search bar.
5. Enable "Developer mode" (top right corner).
6. Click on "Load unpacked" and navigate to the extension directory, then click "Select".
7. Pin the extension. You should now see the extension icon next to the address bar.
Now you can test the latest dev version and contribute new features! After you make changes, remember to run tsc to compile the TS files into javascript.
### 📚 Tutorial
For solution videos open a Leetcode problem's
[solutions tab](https://leetcode.com/problems/two-sum/solutions)
If you pin the extension in the toolbar & login into ChatGPT in your browser, you can use the following 2 GPT buttons:
- Get your code complexity using ChatGPT
- Fix bugs in your code and return the optimal solution
Please ensure your Leetcode solution is open so the extension can read your code from the page.
### Contributing
We welcome contributions! Please see the [CONTRIBUTING.md](docs/CONTRIBUTING.md) for details on how to contribute to the project.
### Screenshots
<img src="src/assets/images/screenshots/add-video.png" alt="Add Video" width="600"/>
<img src="src/assets/images/screenshots/get-complexity.png" alt="Code Complexity" width="600"/>
<img src="src/assets/images/screenshots/fix-code.png" alt="Fix Code" width="600"/>
### Code of Conduct
We aim to foster an inclusive and respectful environment. Please read the [CODE_OF_CONDUCT.md](docs/CODE_OF_CONDUCT.md) for more information.
### License
Leetcode Explained is [MIT licensed](docs/LICENSE).
### Support
If you encounter any issues or have any questions, please open an issue on this repository.
### Privacy
This extension doesn't collect any personal data. All the code analysis and generation happens on your local machine.
If you like the extension, please leave a review in the Reviews tab. For questions or bugs, feel free to open an issue on Github.
### References
Check out these cool datasets used in Leetcode Explained
[Problem elo ratings](https://github.com/zerotrac/leetcode_problem_rating) | Browser extension that adds video solutions, company tags, and GPT code analysis into Leetcode problems | chrome-extension,javascript,leetcode,neetcode,open-source,leetcode-solutions,openai-api,browser-extension,leetcode-questions,typescript | 2023-03-29T07:59:50Z | 2024-02-03T05:18:54Z | 2023-08-15T21:14:09Z | 1 | 9 | 479 | 10 | 11 | 77 | null | MIT | TypeScript |
codrops/PixelTransition | main | # Pixel Transition Effects
Ideas for pixel page transitions based on an [animation](https://twitter.com/niccolomiranda/status/1628359949972819968) by [Niccolò Miranda](https://www.instagram.com/niccolomiranda/).
[Article on Codrops](https://tympanus.net/codrops/?p=71437)
[Demo](http://tympanus.net/Development/PixelTransition/)
## Installation
Run this demo on a [local server](https://developer.mozilla.org/en-US/docs/Learn/Common_questions/Tools_and_setup/set_up_a_local_testing_server).
## Credits
- Images from [Pexels](https://www.pexels.com/)
## Misc
Follow Codrops: [Twitter](http://www.twitter.com/codrops), [Facebook](http://www.facebook.com/codrops), [GitHub](https://github.com/codrops), [Instagram](https://www.instagram.com/codropsss/)
## License
[MIT](LICENSE)
Made with :blue_heart: by [Codrops](http://www.codrops.com)
| Ideas for pixel page transitions based on an animation by Niccolò Miranda. | animation,gsap,javascript | 2023-04-05T09:52:45Z | 2023-04-05T09:48:35Z | null | 2 | 0 | 2 | 0 | 15 | 72 | null | MIT | HTML |
XaviaTeam/facebook-bot-chatgpt | main | # facebook-bot-chatgpt
## Table of Contents
1. [Installation](#installation)
2. [Setup](#setup)
3. [Usage](#usage)
4. [Screenshots](#screenshots)
+ [Ai command](#ai-command)
+ [Image generator](#image-generator)
## Installation
clone the repository
```bash
$ git clone https://github.com/XaviaTeam/facebook-bot-chatgpt.git
```
install dependencies
```bash
$ npm install
```
<hr/>
## Setup
Open .env.example, add your appstate (base64) using [c3c-fbstate](https://github.com/c3cbot/c3c-fbstate), openaikey, and change prefix to your liking, then save it as .env
```bash
$ mv .env.example .env
```
## Usage
```bash
$ npm start
```
<hr/>
## Screenshots
### Ai command
### Image generator
| ChatGPT bot in Facebook Messenger | bot,chatgpt,chatgpt-bot,javascript,messenger,nodejs | 2023-03-28T15:53:26Z | 2023-03-30T13:46:22Z | null | 1 | 0 | 7 | 0 | 40 | 68 | null | MIT | JavaScript |
Anandsg/Hungry-hero | master | ## 👋 Introducing Hungry-Hero
The `Hungry Hero` is a modern web application that lets you check out restaurants, see how good they are, look at pictures of delicious food, and find specific types of cuisine. It's easy to use, with a nice design, helping you discover where to eat
Yes, it's an `open-source` web app!
Is that all? Nope. You can also create your feature and share them with the world. The best part is that the ReactJS developer will `review` your project code before it gets part of the `Hungry-Hero` app.
## Table of Contents
- [Quick Start](#quick-start-)
- [Want to Contribute](#want-to-contribute-)
- [Guidelines](#guidelines-)
- [Contributors](#contributors-)
## Quick start :
Follow these steps to install and set up the project on your local machine.
First, clone the project repository to your local machine using Git.
Open your terminal or command prompt and run the following command:
```sh
$ git clone [repository URL]
```
Change your current directory to the newly cloned project folder:
```sh
$ cd [project folder]
```
Install the project dependencies using npm (Node Package Manager) or yarn.
Choose one of the following commands based on your preference:
```sh
$ npm install (or) yarn install
```
Once the installation is complete, you can start the project.
```sh
$ npm start (or) yarn run
```
## Want to Contribute 🔥:
When contributing to this repository, please first discuss the change you wish to make via [issue](https://github.com/Anandsg/Hungry-hero/issues),
[email](mailto:anandgadugin@gmail.com), or any other method with the owners of this repository before making a change.
- [Pull Request Process](#prp)
- [Code of Conduct](#coc)
### <a name="prp"></a> Pull Request Process
1. Ensure any install or build dependencies are removed before the end of the layer when doing a build.
### <a name="coc"></a> Code of Conduct
##### Our Pledge
We, as contributors and maintainers, are dedicated to ensuring that everyone can participate in our project and community without facing harassment or discrimination. We welcome individuals of all backgrounds, including but not limited to age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, sexual identity, and orientation.
##### Our Duties
As project maintainers, we have the responsibility to define the guidelines for acceptable conduct within our community. We are also entrusted with the task of taking fair and appropriate actions when any form of unacceptable behavior occurs.
Project maintainers possess the authority and obligation to:
- Remove, edit, or decline comments, commits, code, wiki edits, issues, and other contributions that do not adhere to this Code of Conduct.
- Temporarily or permanently ban contributors who engage in behaviors that we consider inappropriate, threatening, offensive, or harmful.
##### Summary
Use the summary field to provide a succinct description of the change:
- Use the imperative, present tense: "change" not "changed" nor "changes"
- Don't capitalize the first letter
- Don't use dot (.) at the end
## Guidelines 🚦:
Before pushing code please go through our guidelines:
1. Use clear and specific titles when pushing your code changes.
2. Make sure to name your Pull Requests appropriately.
3. Avoid submitting multiple Pull Requests with the same code; it will be considered spam.
4. Help everyone understand your code by adding helpful comments.
Don't forget to follow [@Anandsg](https://github.com/Anandsg) ⭐😊
#### All the best 🙌🏼
<!-- readme: contributors -start -->
## Contributors :
#### Big Thanks to our amazing contributors 🚀
<a href="https://github.com/Anandsg/Hungry-hero/graphs/contributors">
<img src="https://contrib.rocks/image?repo=Anandsg/Hungry-hero" />
</a> | The app is designed to be user-friendly, making it easy for people to discover, choose, and manage their favourite dining spots and food orders ⚡️ | react,javascript,nextjs,open-source,opensource,react-open-source | 2023-04-03T04:23:56Z | 2024-03-15T07:35:59Z | null | 56 | 160 | 428 | 14 | 103 | 65 | null | MIT | JavaScript |
K-RT-Dev/VGT | master | null | Program to translate Japanese text through image recognition and GPT 3.5 | japanese,manga,ocr,translator,visual-recognition,davinci-003,gpt-3,visual-novel,python,antd | 2023-03-26T02:52:07Z | 2023-05-14T00:44:35Z | 2023-03-27T23:09:38Z | 1 | 2 | 29 | 9 | 5 | 58 | null | MIT | JavaScript |
John-Weeks-Dev/linktree-clone | master | # Linktree Clone / PWA (linktree-clone)
### Learn how to build this!
If you'd like a step by step guide on how to build this just **CLICK THE IMAGE BELOW**
[](https://www.youtube.com/watch?v=NtsbjB8QD3Y)
Come and check out my YOUTUBE channel for lots more tutorials -> https://www.youtube.com/@johnweeksdev
**LIKE**, **SUBSCRIBE**, and **SMASH THE NOTIFICATION BELL**!!!
## NOTE
### For this Linktree Clone to work you'll need the API/Backend:
Linktree Clone API: https://github.com/John-Weeks-Dev/linktree-clone-api
## App Setup (localhost)
```
git clone https://github.com/John-Weeks-Dev/linktree-clone.git
npm i
npm run dev
```
Inside Plugins/axios.js make sure the baseUrl is the same as your API.
<img width="443" alt="Screenshot 2023-03-15 at 00 14 21" src="https://user-images.githubusercontent.com/108229029/225085615-529afbca-8cb8-4ed4-bf5b-54ba6f827f36.png">
You should be good to go!
## Extra Info
In the tutorial I show you what you need to edit in your Nginx config file.
This example is in Laravel Forge:
1. In the frontend open the "Edit Nginx Configuration"
<img width="600" src="https://user-images.githubusercontent.com/108229029/229151201-f9d1fe83-ca68-496e-9a1e-3ef031ce8271.png">
<img width="400" src="https://user-images.githubusercontent.com/108229029/229151378-986b62d3-aab4-451d-8c65-029a3f2ec8a7.png">
2. Update the location section to this.
<img width="400" src="https://user-images.githubusercontent.com/108229029/229151891-46be485f-57e7-4bb9-9bac-6a1686e2c653.png">
<img width="600" src="https://user-images.githubusercontent.com/108229029/229152382-358daed2-6c7f-4cbb-b367-c17351a37b2d.png">
# Application Images
<img width="1439" src="https://user-images.githubusercontent.com/108229029/228939676-4f229e2a-96b7-4bfd-9926-91c203e1448e.png">
<img width="1439" src="https://user-images.githubusercontent.com/108229029/228939788-e2064606-4abc-478f-b6b0-8bb80ef29b86.png">
<img width="1439" src="https://user-images.githubusercontent.com/108229029/228939898-46b3d07e-a621-4969-ac84-d52f7a28150c.png">
<img width="1439" src="https://user-images.githubusercontent.com/108229029/228940125-68978815-d8c0-4ccc-a422-ff9b39afed39.png">
<img width="1439" src="https://user-images.githubusercontent.com/108229029/228940234-08eff6c7-1d77-4992-9813-e1e1584100c5.png">
<img width="1439" src="https://user-images.githubusercontent.com/108229029/228940314-45580c79-10c1-440e-a9b0-3f3a554b4a47.png">
<img width="1439" src="https://user-images.githubusercontent.com/108229029/228940489-69cf84fc-5f6c-4dd8-a94a-568af290e00e.png">
<img width="1439" src="https://user-images.githubusercontent.com/108229029/228940597-8dcaef65-266a-4cd0-b0ef-1f0715159f1a.png">
<img width="1439" src="https://user-images.githubusercontent.com/108229029/228940672-b4a1c33c-ffe5-4346-a47a-dcfedf01090e.png">
<img width="1439" src="https://user-images.githubusercontent.com/108229029/228940742-c1c1b786-e212-448e-87d8-60d4d66945fd.png">
<img width="1439" src="https://user-images.githubusercontent.com/108229029/228940845-2d863b6f-67f7-4221-801d-d433265584e9.png">
<img width="1439" src="https://user-images.githubusercontent.com/108229029/228940930-53cac8bf-30ba-4e4c-993d-b0007c1601cb.png">
<img width="1439" src="https://user-images.githubusercontent.com/108229029/228941007-efe23396-b189-4ce3-85c5-53d1bd8fc983.png">
<img width="1439" src="https://user-images.githubusercontent.com/108229029/228941097-3de7b664-023f-48e6-beff-1810791f45ff.png">
# PWA Images
<img width="1439" src="https://user-images.githubusercontent.com/108229029/228941385-ba10b505-0522-4493-95e6-2214cba4ed0a.png">
<img width="1439" src="https://user-images.githubusercontent.com/108229029/228941510-24b39533-c93c-48fe-aa0d-ca6b140eef75.png">
<img width="1439" src="https://user-images.githubusercontent.com/108229029/228941606-74b3b422-a4f3-4973-834d-f3e152c3e71e.png">
<img width="800" src="https://user-images.githubusercontent.com/108229029/228941671-b521f9fa-b764-418e-9e97-e3cdcba08a7b.png">
<div>
<img width="333" src="https://user-images.githubusercontent.com/108229029/228942219-5712d33c-dfa7-4d8f-846d-c2449ebcb01c.png">
<img width="333" src="https://user-images.githubusercontent.com/108229029/228942317-12756e75-bac0-4715-9c77-b00efde31937.png">
<img width="333" src="https://user-images.githubusercontent.com/108229029/228942370-f8bef7e5-2e62-4da8-9ea8-f806d8a7b3d3.png">
</div>
<div>
<img width="333" src="https://user-images.githubusercontent.com/108229029/228942477-44a16a82-e2cd-4546-bb4b-461b492d6812.png">
<img width="333" src="https://user-images.githubusercontent.com/108229029/228942526-89dc5f45-dc15-4508-9353-eeb90e90059d.png">
<img width="333" src="https://user-images.githubusercontent.com/108229029/228942612-dea08e4d-69d7-4622-ba70-a2378d91ab04.png">
</div>
<div>
<img width="333" src="https://user-images.githubusercontent.com/108229029/228942915-1f036606-5705-43d8-ad63-888346b6af42.png">
<img width="333" src="https://user-images.githubusercontent.com/108229029/228942980-a3acc437-2bda-4500-9cee-d79c3ffda773.png">
<img width="333" src="https://user-images.githubusercontent.com/108229029/228943033-5f0f911f-712e-4352-a85d-886a503c0508.png">
</div>
<div>
<img width="333" src="https://user-images.githubusercontent.com/108229029/228943152-93e08fbb-ad95-47e9-9b8b-e9dae9484cd5.png">
<img width="333" src="https://user-images.githubusercontent.com/108229029/228943200-b38238ef-d4bc-4703-881a-71fe498bbfa9.png">
<img width="333" src="https://user-images.githubusercontent.com/108229029/228943242-cffc88a7-7211-4f43-bbe4-4fa89aae1f3a.png">
</div>
<div>
<img width="333" src="https://user-images.githubusercontent.com/108229029/228943303-3aaddfc4-9c55-40c4-8a8d-c4d52fcc20d7.png">
<img width="333" src="https://user-images.githubusercontent.com/108229029/228943392-e84c29d0-9262-4d07-a2c2-a96aec9c546d.png">
<img width="333" src="https://user-images.githubusercontent.com/108229029/228943453-4757ed61-0857-4894-be5c-f8447fb56ee4.png">
</div>
<div>
<img width="333" src="https://user-images.githubusercontent.com/108229029/228943520-8f10ffa2-b936-4383-863a-50262984712f.png">
<img width="333" src="https://user-images.githubusercontent.com/108229029/228943657-698c06c8-ab4b-41ec-8585-de27f1e63d78.png">
</div>
| This is a Linktree Clone PWA with Camera made with Nuxt 3, Vue JS, Laravel (API), Tailwind CSS, Pinia and Axios | cropper,file-upload,image,image-upload,javascript,linktree,linktree-clone,nuxt,nuxt3,nuxtjs | 2023-03-29T09:37:03Z | 2023-04-25T15:04:56Z | null | 1 | 0 | 33 | 0 | 16 | 50 | null | null | Vue |
cemtatli/lugat | master | # 📖 Lugat
<img src='og-image.png'/>
Lugat, frontend geliştiricilerin bilmesi gereken terimleri Türkçe anlamlarıyla birlikte sunan ayrıca terimleri kod örnekleriyle destekleyen açık kaynaklı bir sözlük projesidir. Proje, React ve Tailwind CSS teknolojileri kullanılarak oluşturulmuştur ve tamamen ücretsiz ve açık kaynak kodlu olarak yayınlanmaktadır.
Bu sözlük, frontend dünyasında yolunu kaybetmiş veya daha yeni başlayan geliştiricilerin işlerini kolaylaştırmayı hedeflemektedir. Proje içerisinde yer alan terimler, açıklamalar ve örnekler sayesinde frontend geliştiricileri, terimlerin anlamlarını daha iyi anlayabilir ve projelerinde bu terimleri daha verimli bir şekilde kullanabilirler.
[🔗 Lugat'a hemen göz atmak için bağlantıya tıklayın!](https://lugat.website)
### 🧰 Kullanılan Teknolojiler
Lugat, React ve Tailwind CSS teknolojilerini kullanarak oluşturulmuştur.
### 🪄 Nasıl Katkı Sağlayabilirim?
Lugat projesine katkı sağlamak istiyorsanız,
- Projeyi forklayabilir ve yeni terimleri `data/data.json` dosyasına ekleyebilirsiniz. Bu dosya, terimlerin ve açıklamaların bulunduğu JSON formatındadır. Formata uygun şekilde yeni terimleri ekledikten sonra pull request açarak projeye katkıda bulunabilirsiniz.
- Görmek istediğiniz, eksik veya hatalı bulduğunuz özellikleri `issue`bölümünden belirtip projeye katkı sağlayabilirsiniz.
### 🚀 Projeyi Nasıl Çalıştırabilirim?
Projeyi çalıştırmak için bilgisayarınızda Node.js ve Git kurulu olması gerekmektedir. Aşağıdaki adımları takip ederek projeyi kolayca çalıştırabilirsiniz:
```bash
# Projeyi klonla
git clone
# Proje dizinine gir
cd lugat
# Bağımlılıkları yükle
npm install
# Projeyi çalıştır
npm run dev
```
### 📧 İletişim
Lugat hakkında herhangi bir sorunuz veya öneriniz varsa, [buradan](https://twitter.com/iltatmec) bana ulaşabilirsiniz. Ayrıca, projeyle ilgili herhangi bir konuda yardıma ihtiyacınız varsa, GitHub üzerinden issue açabilirsiniz.
| Frontend dünyasında yolunu kaybetmiş veya daha yeni başlayan geliştiricilerin işlerini kolaylaştırmayı hedeflemektedir. | css,dictionary,frontend,html,javascript,react,sozluk,vue,git,internet | 2023-04-03T10:06:24Z | 2024-05-21T06:20:08Z | null | 12 | 14 | 113 | 0 | 17 | 48 | null | null | JavaScript |
shohan-pherones/euphoria-ecommerce | main | # Euphoria E-commerce Website Built with Next.js: Redefining Online Shopping
Welcome to Euphoria E-commerce, your one-stop destination for all your online shopping needs. Our platform is built on a powerful technology stack, including Next.js, React, Prisma, Tailwind, Redux Toolkit, and Stripe, to deliver a seamless shopping experience. With a wide range of products available for browsing and purchase, our website is designed to be easy to use and navigate. You can add products to your cart and complete your purchase securely and efficiently through our integration with Stripe. At Euphoria E-commerce, we are committed to providing our customers with the highest level of service and satisfaction. Thank you for choosing us as your go-to online shopping destination.
## Features
Euphoria E-commerce comes packed with a variety of useful features, including:
- **Browsing:** Users can easily browse through the various products available on the platform, organized by categories and subcategories.
- **Search** Users can search for products using keywords, and the platform will return relevant results.
- **Product Details:** Users can view detailed information about each product, including descriptions, images, pricing, and availability.
- **Cart:** Users can add products to their cart and view the contents of their cart before proceeding to checkout.
- **Checkout:** Users can securely complete their purchases using our integrated Stripe payment gateway.
- **User Authentication:** Users can create an account, log in, and save their shipping and payment details for faster checkout in the future.
- **Order Tracking:** Users can track the status of their orders and receive notifications when their orders are shipped.
- **Order Tracking:** Users can track the status of their orders and receive notifications when their orders are shipped.
## Tools
Euphoria E-commerce is built on a powerful technology stack that includes the following tools:
- **Next.js:** A popular React framework that provides server-side rendering, automatic code splitting, and other performance optimizations.
- **React:** A JavaScript library for building user interfaces that allows developers to create reusable UI components.
- **Redux Toolkit:** A set of tools and best practices for building Redux applications, including a powerful and opinionated "slice" reducer API.
- **Next Auth:** A complete open-source authentication solution for Next.js applications. It provides a set of pre-built sign-in pages, as well as a customizable API for authentication and authorization.
- **Prisma:** A modern database toolkit that simplifies database access in your application. It provides an ORM that allows you to interact with your database using a type-safe API.
- **MongoDB:** A popular NoSQL database that provides high performance, scalability, and flexibility.
- **Tailwind CSS:** A utility-first CSS framework that allows developers to rapidly build custom user interfaces by composing pre-built CSS classes. It provides a comprehensive set of design primitives that can be combined to create any design.
## Installation
To install Euphoria E-commerce, follow these simple steps:
1. Clone the repository using `git clone https://github.com/shohan-pherones/euphoria-ecommerce.git`
2. Install the required dependencies by running `npm install` or `npm i`.
3. Create a `.env` file in the root directory and add the following variables:
- `DATABASE_URL`
- `NEXT_PUBLIC_STRIPE_PUBLISHABLE_KEY`
- `STRIPE_SECRET_KEY`
- `HOST`
4. Start the application by running `npm run dev`.
## Contribution
At Euphoria E-commerce, we welcome contributions from the open-source community to help improve and enhance our platform. Here are a few ways you can contribute:
- **Bug Reports:** If you come across any issues or bugs while using our platform, please report them using our issue tracker on GitHub. This will help us identify and fix the issues quickly.
- **Feature Requests:** If you have ideas for new features or improvements that could enhance our platform, please submit them through our issue tracker. We welcome all feedback and suggestions!
- **Pull Requests:** If you're interested in contributing code to our platform, you can submit pull requests on GitHub. We ask that you follow our coding conventions and submit tests with your code changes.
- **Documentation:** We welcome contributions to our documentation, including updating existing documentation or adding new documentation as needed.
- **Spread the Word:** If you enjoy using our platform, please help spread the word by sharing it on social media or with your network. This will help us reach more users and grow our community.
We appreciate all contributions and look forward to collaborating with the open-source community to make Euphoria E-commerce the best it can be!
## Community
At Euphoria E-commerce, we value community and believe that collaboration and communication are key to building a successful platform. We invite you to join our community and get involved in discussions, share your feedback, and contribute to the platform.
To join our community, you can connect with us on our Discord server at (https://discord.gg/aFwmyMUeRt). Here, you can chat with other members of the community, ask questions, and get help from our team.
We also encourage you to follow us on social media, including Twitter and Instagram, where we regularly share updates and news about the platform.
Thank you for being a part of our community, and we look forward to growing together!
| Welcome to Euphoria E-commerce, your one-stop destination for all your online shopping needs. Our platform is built on a powerful technology stack, including Next.js, React, Prisma, Tailwind, Redux Toolkit, and Stripe, to deliver a seamless shopping experience. | ecommerce,javascript,mongodb,nextjs,open-source,prisma,reactjs,redux-toolkit,ssr,tailwindcss | 2023-04-06T08:08:01Z | 2023-05-31T23:33:57Z | null | 4 | 49 | 160 | 0 | 25 | 44 | null | MIT | JavaScript |
indexooor/indexooor-stack | main | # 🤖 Indexooor Stack
📚 indexooor stack: the next gen dev tool for indexing smart contract data 🫶
### 📄 Repository Setup
To fetch all modules use `git submodule update --init --recursive`. If you want to use modules seperately, use the equivivalent git command.
To update submodules to remote use `git submodule update --remote`
## 😃 About
Welcome to the Indexooor Stack, an open-source project for indexing and querying smart contract data. Our unique database schema allows for complex join queries and fetching full arrays and mappings from smart contracts, without the need for smart contracts to emit events.
Refer [our comparison with the graph](https://github.com/indexooor/indexooor-stack#-indexooor-vs-the-graph) to get a better idea of what we can do and why!
The stack is composed of several submodules, each serving a specific purpose:
- 🚀 [Core](https://github.com/indexooor/core): Our core indexing service, written in Go, indexes smart contract slot data using a lightweight algorithm that detects slot changes for a contract in each block. All slot data is stored in a PostgreSQL database.
- 🔍 [Queriooor](https://github.com/indexooor/queriooor): Our querying service, written in Python using FastAPI, allows developers to upload a storage layout for their contract address and query variables by their name. The service finds the slot and data type of the variable, fetches data, and decodes it before returning it to the user.
- 🖥️ [Goooi-queriooor](https://github.com/indexooor/goooi-queriooor): Our UI web-app, built using Vite, simplifies querying by allowing developers to query in the browser instead of calling a REST API.
- 🎮 [Simulatooor](https://github.com/indexooor/simulatooor): Our simulator service, written in Go, simulates all our services and demonstrates the workings of the Indexooor Stack.
- 🐘 [Op-geth](https://github.com/indexooor/op-geth): Our version of the Optimism Go Ethereum, which has the Indexooor Core integrated into the node for indexing smart contract data. This makes things easier for developers, who can then run an extra querier connecting their database with it for users to query data!
Our stack is lightweight and easy to run, making it accessible for developers of all levels. In this README, we'll explain how to set up and use each submodule of the stack. Let's get started!
## 🛠️ Setup
### Core
To set up the Core submodule, follow these steps:
- Install Go and PostgreSQL on your machine.
- Clone the Indexooor Stack repository and navigate to the core directory.
Once this is done refer [core-setup](https://github.com/indexooor/core/blob/main/README.md)
### Queriooor
To setup the Queriooor submodel, follow there steps:
- Have `python3` and PostgreSQL installed on your machine
Once this is done refer [queriooor-setup](https://github.com/indexooor/queriooor)
### Goooi-querioor
This is a vanilla vite project, follow the instruction for the same or use our [deployment](https://goooi-queriooor.vercel.app/)
### Simulatooor
Add instructions
### Op-geth
Refer [Op-Geth Readme](https://github.com/indexooor/op-geth#modifications-for-supporting-indexooor)
## 🚀 Getting Started
Now that you've set up each submodule of the Indexooor Stack, let's learn how to use them.
### Indexing with Core
1. Start the indexer giving `rpc`, `contractAddresses` and `startBlock`, where `rpc` is the rpc url of your node, `contractAddresses` is `,` delimited list of your contracts and `startBlock` is the block number where you want to start indexing from.
### Querying with Qeuriooor
To query a variable in a smart contract using the Queriooor submodule, follow these steps:
1. Upload the storage layout for the smart contract you want to query by making a POST request to `/queriooor/setStorageLayout` with the contract's address and the storage layout as the body of the request.
2. To query a variable, make a POST request to ``/queriooor/getVariable` with the contract's address, the variable name, and key/deep key information.
3. Other API calls can be viewed in the swagger doc at `/docs`
Queriooor will find the slot and data type of the variable, fetch its data from the PostgreSQL database, and return the decoded value.
### Querying with Goooi-queriooor
To query a variable in a smart contract using the Goooi-queriooor web-app, follow these steps:
1. Start the Queriooor service
2. Start the Goooi-Queriooor after doing the setup using `npm run dev` or visit our [hosted webapp](https://goooi-queriooor.vercel.app/).
3. Add queriooor url, contract address, variable name and key information.
### Running Indexooor with OP-Geth Node
Add instructions
## 📚 Documentation
If you're looking for more detailed information on how to use the Indexooor Stack, check out our documentation. We have comprehensive guides on each submodule as well as a glossary of terms.
- [Indexooor Core documentation](https://github.com/indexooor/core/blob/main/README.md)
- [Queriooor documentation](https://github.com/indexooor/queriooor)
- [Goooi-queriooor documentation]()
- [Simulatooor documentation]()
- [Indexooor Stack glossary]()
If you have any questions or issues while using the Indexooor Stack, feel free to open an issue on our GitHub repository. We're happy to help!
## 🤝 Contributing
We welcome contributions from the community! If you'd like to contribute to the Indexooor Stack, please take a look at our [contributing guidelines](https://github.com/indexooor/indexooor-stack/blob/main/README.md#-contributing-guidelines) to get started.
We use GitHub issues and pull requests for all contributions. If you'd like to report a bug or suggest a feature, please open an issue on our GitHub repository. If you'd like to submit a code change, please fork our repository and submit a pull request.
All contributions are appreciated, no matter how small. We're grateful for any help in making the Indexooor Stack even better!
## 📞 Contact
If you have any questions or feedback about the Indexooor Stack, you can reach us through the following channels:
- Email: kaushalpatil10@gmail.com
- Twitter: Coming Soon
- Discord: Coming Soon
We'd love to hear from you and answer any questions you may have about the Indexooor Stack. Don't hesitate to reach out!
## 🙏 Acknowledgements
We would like to thank the following people and organizations for their contributions to the Indexooor Stack:
- The developers of [Solc](https://github.com/ethereum/solidity), [Geth](https://github.com/ethereum/go-ethereum), [PostgreSQL](https://www.postgresql.org/), [FastAPI](https://fastapi.tiangolo.com/), and [Vite](https://vitejs.dev/) for creating and maintaining the tools we use in our stack.
- Special thanks to developers of projects such as [slither](https://github.com/crytic/slither) and [heimdall-rs](https://github.com/Jon-Becker/heimdall-rs) which were refered heavily during this build.
- The contributors to the open source community for providing valuable feedback and contributions to the projects we depend on.
- Our users for providing feedback and support as we continue to develop and improve the Indexooor Stack.
- The entire Ethereum community for advancing the state of the art in blockchain technology and inspiring us to build better tools.
Thank you all for your support and contributions!
## 📢 Spread the Word
If you find the Indexooor Stack useful, we encourage you to share it with others in the blockchain development community. Here are some ways you can help spread the word:
- Star our [GitHub repository](https://github.com/indexooor/indexooor-stack) and [follow us](https://github.com/orgs/indexooor/people) on GitHub.
- Tweet about the Indexooor Stack and mention us [`@kau5hal10`](https://twitter.com/kau5hal10), [`@manav24_`](https://twitter.com/manav24_), [`@MeetModi_`](https://twitter.com/MeetModi_), [`@PARAMS704`](https://twitter.com/PARAMS704), [`@nisarg1499`](https://twitter.com/nisarg1499)
- Share the Indexooor Stack with your friends and colleagues who are interested in blockchain development.
- Write a blog post or tutorial about how you've used the Indexooor Stack in your own projects.
By helping us spread the word, you'll be helping us reach more developers and grow the Indexooor Stack community. Thank you for your support!
## 🚀 Contributing Guidelines
We welcome contributions to the Indexooor Stack! If you're interested in contributing, please follow these guidelines:
1. Fork the repository and create a new branch for your contribution.
1. Make your changes and write tests to ensure that they work as expected.
1. Run the existing tests to make sure you didn't break anything.
1. Commit your changes and push them to your fork.
1. Open a pull request to our repository with a clear description of your changes.
1. We'll review your changes and work with you to get them merged into the main repository. By contributing to the Indexooor Stack, you'll be helping to make blockchain development easier and more accessible for everyone.
Thank you for your interest in contributing to the Indexooor Stack!
## 🤝 Indexooor vs The Graph
The Graph is a popular indexing and querying solution for Ethereum and IPFS, but how does it compare to Indexooor? Let's take a look:
| Feature | Indexooor | The Graph |
|--------------------------------|-----------|-----------|
| Can query all contract variables?| Yes | No, only emitted data is indexed|
| Stack weight | Light | Heavy |
| Smart contract indexing | Yes | Yes |
| Querying smart contract data | Yes | Yes |
| Full array and mapping support | WIP (Simple types work) | Yes |
| Complex join queries | WIP (No as of today) | Yes |
| No need for smart contract events | Yes | No |
| Language support | Go, Python| TypeScript, AssemblyScript |
| Web UI | Yes | Yes |
| Simulating services | Yes | N/A |
| Integrated indexing in node | Yes | Yes |
| Community-driven | Yes | Yes |
| Limitations | Requires storage layout<br>Cannot index complex types as of today | Requires subgraph deployment<br>Higher learning curve |
As you can see, Indexooor is a lighter weight solution that offers many of the same features as The Graph, but with some important differences. While The Graph requires developers to deploy and manage a subgraph, Indexooor allows developers to simply upload the storage layout of their contracts and start indexing immediately. Additionally, Indexooor does not require smart contracts to emit events, making it easier to use with legacy contracts. On the other hand, The Graph offers more language support, including TypeScript and AssemblyScript, and has a more established community and learning resources.
Ultimately, the choice between Indexooor and The Graph will depend on your specific needs and preferences. We encourage you to try both solutions and see which one works best for you.
| 📚 indexooor stack: the next gen dev tool for indexing smart contract data 🫶 | blockchain,indexer,ethereum,golang,javascript,optimism,python,smart-contracts | 2023-03-26T09:48:27Z | 2023-03-26T16:15:00Z | null | 3 | 0 | 18 | 0 | 2 | 40 | null | GPL-3.0 | null |
mm0hammadi/playwright-ts-redux-toolkit | master | # React App
### CI, tests and linter status:
[](https://github.com/bogdan-ho/todo-list/actions/workflows/CI.yml)
[](https://codeclimate.com/github/bogdan-ho/todo-list/maintainability)
## About
✅React Todo application built with React (with hooks), Redux (@redux/toolkit) with adaptive layout using Bootstrap + Formik + Playwright tests + Docker
## Getting Started
- Clone a repository
- Go to the working directory of the project `cd playwright-ts-redux-toolkit`
- Run `make app-setup`
- Run tests `make app-test`
- Start the server `make up`
## Features
- Adding, Editing, Deleting and marking Completed tasks
- Filter tasks by All, Active, Completed
- Clear all completed tasks by one click
- Displaying the remaining tasks counter
## Demo
Check out the demo project for a quick example of how React Todo application works.
| sample app with react and redux toolkit and playwright test tool | bootstrap5,javascript,playwright,playwright-typescript,reactjs,test,test-automation,testing,testing-tools,docker | 2023-04-02T15:28:35Z | 2023-08-07T21:51:19Z | null | 1 | 3 | 14 | 0 | 1 | 38 | null | MIT | JavaScript |
adamlui/autoclear-chatgpt-history | main | null | 🕶️ Adds chat auto-clear functionality to ChatGPT for more privacy | artificial-intelligence,chat,chatbot,chatgpt,chatgpt3,gpt,gpt-3,gpt-4,greasemonkey,javascript | 2023-03-28T23:06:42Z | 2024-05-20T18:32:28Z | null | 4 | 34 | 906 | 1 | 7 | 37 | null | NOASSERTION | JavaScript |
John-Weeks-Dev/linktree-clone-api | master | # Linktree Clone API / PWA (linktree-clone-api)
### Learn how to build this!
If you'd like a step by step guide on how to build this just **CLICK THE IMAGE BELOW**
[](https://www.youtube.com/watch?v=CHSL0Btbj_o)
Come and check out my YOUTUBE channel for lots more tutorials -> https://www.youtube.com/@johnweeksdev
**LIKE**, **SUBSCRIBE**, and **SMASH THE NOTIFICATION BELL**!!!
## NOTE
### For this Linktree Clone to work you'll need the API/Backend:
Linktree Clone (frontend): https://github.com/John-Weeks-Dev/linktree-clone
## App Setup (localhost)
```
git clone https://github.com/John-Weeks-Dev/tiktok-clone-api.git
```
Then
```
composer install
cp .env.example .env
php artisan cache:clear
composer dump-autoload
php artisan key:generate
composer require laravel/breeze --dev
php artisan breeze:install (FOR THIS SELECT THE API INSTALL)
php artisan serve
```
Create a DATABASE. Make sure the DB_DATABASE in the .env is the same and then run this command
```
php artisan migrate
```
You should be good to go!
# Application Images
<img width="1439" src="https://user-images.githubusercontent.com/108229029/228939676-4f229e2a-96b7-4bfd-9926-91c203e1448e.png">
<img width="1439" src="https://user-images.githubusercontent.com/108229029/228939788-e2064606-4abc-478f-b6b0-8bb80ef29b86.png">
<img width="1439" src="https://user-images.githubusercontent.com/108229029/228939898-46b3d07e-a621-4969-ac84-d52f7a28150c.png">
<img width="1439" src="https://user-images.githubusercontent.com/108229029/228940125-68978815-d8c0-4ccc-a422-ff9b39afed39.png">
<img width="1439" src="https://user-images.githubusercontent.com/108229029/228940234-08eff6c7-1d77-4992-9813-e1e1584100c5.png">
<img width="1439" src="https://user-images.githubusercontent.com/108229029/228940314-45580c79-10c1-440e-a9b0-3f3a554b4a47.png">
<img width="1439" src="https://user-images.githubusercontent.com/108229029/228940489-69cf84fc-5f6c-4dd8-a94a-568af290e00e.png">
<img width="1439" src="https://user-images.githubusercontent.com/108229029/228940597-8dcaef65-266a-4cd0-b0ef-1f0715159f1a.png">
<img width="1439" src="https://user-images.githubusercontent.com/108229029/228940672-b4a1c33c-ffe5-4346-a47a-dcfedf01090e.png">
<img width="1439" src="https://user-images.githubusercontent.com/108229029/228940742-c1c1b786-e212-448e-87d8-60d4d66945fd.png">
<img width="1439" src="https://user-images.githubusercontent.com/108229029/228940845-2d863b6f-67f7-4221-801d-d433265584e9.png">
<img width="1439" src="https://user-images.githubusercontent.com/108229029/228940930-53cac8bf-30ba-4e4c-993d-b0007c1601cb.png">
<img width="1439" src="https://user-images.githubusercontent.com/108229029/228941007-efe23396-b189-4ce3-85c5-53d1bd8fc983.png">
<img width="1439" src="https://user-images.githubusercontent.com/108229029/228941097-3de7b664-023f-48e6-beff-1810791f45ff.png">
# PWA Images
<img width="1439" src="https://user-images.githubusercontent.com/108229029/228941385-ba10b505-0522-4493-95e6-2214cba4ed0a.png">
<img width="1439" src="https://user-images.githubusercontent.com/108229029/228941510-24b39533-c93c-48fe-aa0d-ca6b140eef75.png">
<img width="1439" src="https://user-images.githubusercontent.com/108229029/228941606-74b3b422-a4f3-4973-834d-f3e152c3e71e.png">
<img width="800" src="https://user-images.githubusercontent.com/108229029/228941671-b521f9fa-b764-418e-9e97-e3cdcba08a7b.png">
<div>
<img width="333" src="https://user-images.githubusercontent.com/108229029/228942219-5712d33c-dfa7-4d8f-846d-c2449ebcb01c.png">
<img width="333" src="https://user-images.githubusercontent.com/108229029/228942317-12756e75-bac0-4715-9c77-b00efde31937.png">
<img width="333" src="https://user-images.githubusercontent.com/108229029/228942370-f8bef7e5-2e62-4da8-9ea8-f806d8a7b3d3.png">
</div>
<div>
<img width="333" src="https://user-images.githubusercontent.com/108229029/228942477-44a16a82-e2cd-4546-bb4b-461b492d6812.png">
<img width="333" src="https://user-images.githubusercontent.com/108229029/228942526-89dc5f45-dc15-4508-9353-eeb90e90059d.png">
<img width="333" src="https://user-images.githubusercontent.com/108229029/228942612-dea08e4d-69d7-4622-ba70-a2378d91ab04.png">
</div>
<div>
<img width="333" src="https://user-images.githubusercontent.com/108229029/228942915-1f036606-5705-43d8-ad63-888346b6af42.png">
<img width="333" src="https://user-images.githubusercontent.com/108229029/228942980-a3acc437-2bda-4500-9cee-d79c3ffda773.png">
<img width="333" src="https://user-images.githubusercontent.com/108229029/228943033-5f0f911f-712e-4352-a85d-886a503c0508.png">
</div>
<div>
<img width="333" src="https://user-images.githubusercontent.com/108229029/228943152-93e08fbb-ad95-47e9-9b8b-e9dae9484cd5.png">
<img width="333" src="https://user-images.githubusercontent.com/108229029/228943200-b38238ef-d4bc-4703-881a-71fe498bbfa9.png">
<img width="333" src="https://user-images.githubusercontent.com/108229029/228943242-cffc88a7-7211-4f43-bbe4-4fa89aae1f3a.png">
</div>
<div>
<img width="333" src="https://user-images.githubusercontent.com/108229029/228943303-3aaddfc4-9c55-40c4-8a8d-c4d52fcc20d7.png">
<img width="333" src="https://user-images.githubusercontent.com/108229029/228943392-e84c29d0-9262-4d07-a2c2-a96aec9c546d.png">
<img width="333" src="https://user-images.githubusercontent.com/108229029/228943453-4757ed61-0857-4894-be5c-f8447fb56ee4.png">
</div>
<div>
<img width="333" src="https://user-images.githubusercontent.com/108229029/228943520-8f10ffa2-b936-4383-863a-50262984712f.png">
<img width="333" src="https://user-images.githubusercontent.com/108229029/228943657-698c06c8-ab4b-41ec-8585-de27f1e63d78.png">
</div>
| This is a Linktree Clone (API) PWA with Camera made with Nuxt 3, Vue JS, Laravel (API), Tailwind CSS, Pinia and Axios | axios,cropper,file-upload,image,image-upload-php,javascript,laravel-api,linktree,linktree-clone,nuxt | 2023-03-29T09:39:20Z | 2023-03-31T08:02:21Z | null | 1 | 0 | 7 | 0 | 13 | 37 | null | null | PHP |
feast107/linqes | master | <div align="center">
<h1>
linqes
</h1>
[LINQ](https://learn.microsoft.com/en-us/dotnet/csharp/linq/) in ES
</div>
<p align="center">
<img alt="dotnet-version" src="https://img.shields.io/badge/JavaScript-ES6-EEEE00.svg"/>
<img alt="dotnet-version" src="https://img.shields.io/badge/TypeScript-Declare-blue.svg"/>
<img alt="npm" src="https://img.shields.io/badge/npm-v1.1.1-FF3300.svg"/>
<img alt="license" src="https://img.shields.io/badge/license-MIT-FF00FF.svg"/>
</p>
---
## Installation
```shell
npm i linqes
```
or load through html
```html
<script type="text/javascript" src="https://github.com/feast107/linqes/blob/master/index.min.js" />
```
## Example
```ts
import 'linqes'
let enumerable : IEnumerable<number> = new List<number>();
enumerable = enumerable
.where(x => x > 3)
.append(1)
.concat([1, 2, 3, 4])
.prepend(3)
.select(x => x * 2)
.reverse()
.chunk(3)
.selectMany(x => x)
const list : List<number> = enumerable.toArray()
for (const item of enumerable) {
console.log(item) // => 8,6,4,2,2,6
}
let chars : IEnumerable<string> = 'This is a string';
chars.select(x => x + ' ').toArray()
```
## Iterable types
```ts
String
Array
Int8Array
Uint8Array
Uint8ClampedArray
Int16Array
Uint16Array
Int32Array
Uint32Array
Float32Array
Float64Array
BigInt64Array
BigUint64Array
Map
```
## IEnumerable
```ts
interface IEnumerable<T> {
/**
* Applies an accumulator function over a sequence. The specified seed value is used as the initial accumulator value.
* @param seed The initial accumulator value.
* @param accumulator An accumulator function to be invoked on each element.
*/
aggregate<TSeed, TReturn>(
seed : TSeed,
accumulator : (seed : TSeed, item : T) => TReturn) : TReturn;
/**
* Determines whether all elements of a sequence satisfy a condition.
* @param predicate
*/
all(predicate : (item : T) => boolean) : boolean;
/**
* Determines whether a sequence contains any elements.
*/
any() : boolean;
/**
* Determines whether any element of a sequence satisfies a condition.
* @param predicate A function to test each element for a condition.
*/
any(predicate : (item : T) => boolean) : boolean;
/**
* Appends a value to the end of the sequence.
* @param element The value to append to
*/
append(element : T) : IEnumerable<T>;
/**
* Returns the input typed as enumerable.
*/
asEnumerable() : IEnumerable<T>;
/**
* Splits the elements of a sequence into chunks of size at most
* @param size The maximum size of each chunk.
*/
chunk(size : number) : IEnumerable<Array<T>>;
/**
* Concatenates two sequences.
* @param source The sequence to concatenate to the current.
*/
concat(source : IEnumerable<T>) : IEnumerable<T>;
/**
* Determines whether a sequence contains a specified element by using the default equality comparer.
* @param value The value to locate in the sequence.
*/
contains(value : T) : boolean;
/**
* Determines whether a sequence contains a specified element by using a specified comparer.
* @param value The value to locate in the sequence.
* @param comparer An equality comparer to compare values.
*/
contains(
value : T,
comparer? : (left : T, right : T) => boolean) : boolean;
/**
* Returns the number of elements in a sequence.
*/
count() : number;
/**
* Returns a number that represents how many elements in the specified sequence satisfy a condition.
* @param predicate A function to test each element for a condition.
*/
count(predicate : (item : T) => boolean) : number;
/**
* Returns distinct elements from a sequence by using the default equality comparer to compare values.
*/
distinct() : IEnumerable<T>;
/**
* Returns distinct elements from a sequence by using a specified comparer to compare values.
* @param comparer An comparer to compare values.
*/
distinct(comparer : (left : T, right : T) => boolean) : IEnumerable<T>;
/**
* Returns distinct elements from a sequence according to a specified key selector function.
* @param keySelector A function to extract the key for each element.
*/
distinctBy<TKey>(keySelector : (item : T) => TKey) : IEnumerable<T>;
/**
* Returns distinct elements from a sequence according to a specified key selector function and using a specified
* comparer to compare keys.
* @param keySelector A function to extract the key for each element.
* @param comparer An comparer to compare keys.
*/
distinctBy<TKey>(
keySelector : (item : T) => TKey,
comparer? : (left : TKey, right : TKey) => boolean) : IEnumerable<T>;
/**
* Returns the element at a specified index in a sequence.
* @param index The zero-based index of the element to retrieve.
*/
elementAt(index : number) : T;
/**
* Returns the element at a specified index in a sequence.
* @param index The index of the element to retrieve, which is either from the beginning or the end of the sequence.
*/
elementAtOrDefault(index : number) : T | null;
/**
* Produces the set difference of two sequences by using the default equality comparer to compare values.
* @param source An array whose elements that also occur in the first sequence will cause those elements to be
* removed from the returned sequence.
*/
except(source : Array<T> | IEnumerable<T>) : IEnumerable<T>;
/**
* Produces the set difference of two sequences by using the specified comparer to compare values.
* @param source An array whose elements that also occur in the first sequence will cause those elements to be
* removed from the returned sequence.
* @param comparer An comparer to compare values.
*/
except(
source : Array<T> | IEnumerable<T>,
comparer? : (left : T, right : T) => boolean) : IEnumerable<T>;
/**
* Produces the set difference of two sequences according to a specified key selector function.
* @param source An source whose keys that also occur in the first sequence will cause those elements to be removed
* from the returned sequence.
* @param keySelector A function to extract the key for each element.
*/
exceptBy<TKey>(
source : Array<T> | IEnumerable<T>,
keySelector : (item : T) => TKey) : IEnumerable<T>;
/**
* Produces the set difference of two sequences according to a specified key selector function.
* @param source An source whose keys that also occur in the first sequence will cause those elements to be removed
* from the returned sequence.
* @param keySelector A function to extract the key for each element.
* @param comparer The comparer to compare values.
*/
exceptBy<TKey>(
source : Array<T> | IEnumerable<T>,
keySelector : (item : T) => TKey,
comparer? : (left : TKey, right : TKey) => boolean) : IEnumerable<T>;
/**
* Returns the first element of a sequence.
*/
first() : T;
/**
* Returns the first element in a sequence that satisfies a specified condition.
* @param predicate A function to test each element for a condition.
*/
first(predicate : (item : T) => boolean) : T;
/**
* Returns the first element of a sequence, or a default value if the sequence contains no elements.
*/
firstOrDefault() : T | null;
/**
* Returns the first element of a sequence, or a specified default value if the sequence contains no elements.
* @param defaultValue The default value to return if the sequence is empty.
*/
firstOrDefault(defaultValue : T) : T | null;
/**
* Returns the first element of a sequence, or a default value if the sequence contains no elements.
* @param predicate A function to test each element for a condition.
*/
firstOrDefault(predicate : (item : T) => boolean) : T | null;
/**
* Returns the first element of the sequence that satisfies a condition, or a specified default value if no such element is found.
* @param predicate A function to test each element for a condition.
* @param defaultValue The default value to return if the sequence is empty.
*/
firstOrDefault(
predicate : (item : T) => boolean,
defaultValue : T) : T | null;
/**
* Groups the elements of a sequence according to a specified key selector function.
* @param keySelector A function to extract the key for each element.
*/
groupBy<TKey>(keySelector : (item : T) => TKey) : IEnumerable<Array<T> & { key : TKey }>;
/**
* Groups the elements of a sequence according to a specified key selector function and compares the keys by using a specified comparer.
* @param keySelector A function to extract the key for each element.
* @param comparer An comparer to compare keys.
*/
groupBy<TKey>(
keySelector : (item : T) => TKey,
comparer : (left : TKey, right : TKey) => boolean) : IEnumerable<Array<T> & { key : TKey }>;
/**
* Groups the elements of a sequence according to a specified key selector function and projects the elements for
* each group by using a specified function.
* @param keySelector A function to extract the key for each element.
* @param elementSelector A function to map each source element to an element in the source.
*/
groupBy<TKey, TElement>(
keySelector : (item : T) => TKey,
elementSelector : (item : T) => TElement) : IEnumerable<Array<TElement> & { key : TKey }>;
/**
* Groups the elements of a sequence according to a key selector function. The keys are compared by using a comparer
* and each group's elements are projected by using a specified function.
* @param keySelector A function to extract the key for each element.
* @param elementSelector A function to map each source element to an element in the source.
* @param comparer An comparer to compare keys.
*/
groupBy<TKey, TElement>(
keySelector : (item : T) => TKey,
elementSelector : (item : T) => TElement,
comparer : (left : TKey, right : TKey) => boolean) : IEnumerable<Array<TElement> & { key : TKey }>;
/**
* Returns the last element of a sequence.
*/
last() : T;
/**
* Returns the last element of a sequence that satisfies a specified condition.
* @param predicate A function to test each element for a condition.
*/
last(predicate : (item : T) => boolean) : T;
/**
* Returns the last element of a sequence, or a default value if the sequence contains no elements.
*/
lastOrDefault() : T | null;
/**
* Returns the last element of a sequence, or a specified default value if the sequence contains no elements.
* @param defaultValue The default value to return if the sequence is empty.
*/
lastOrDefault(defaultValue : T) : T | null;
/**
* Returns the last element of a sequence that satisfies a condition or a default value if no such element is found.
* @param predicate A function to test each element for a condition.
*/
lastOrDefault(predicate : (item : T) => boolean) : T | null;
/**
* Returns the last element of a sequence that satisfies a condition, or a specified default value if no such element is found.
* @param predicate A function to test each element for a condition.
* @param defaultValue The default value to return if the sequence is empty.
*/
lastOrDefault(
predicate : (item : T) => boolean,
defaultValue : T) : T | null;
/**
* Sorts the elements of a sequence in ascending order.
*/
order() : IEnumerable<T>;
/**
* Sorts the elements of a sequence in ascending order.
* @param comparer An comparer to compare keys.
*/
order(comparer : (current : T, exist : T) => number) : IEnumerable<T>;
/**
* Sorts the elements of a sequence in ascending order according to a key.
* @param keySelector A function to extract a key from an element.
*/
orderBy<TKey>(keySelector : (item : T) => TKey) : IEnumerable<T>;
/**
* Sorts the elements of a sequence in ascending order according to a key.
* @param keySelector A function to extract a key from an element.
* @param comparer An comparer to compare keys.
*/
orderBy<TKey>(
keySelector : (item : T) => TKey,
comparer : (current : TKey, exist : TKey) => number) : IEnumerable<T>;
/**
* Sorts the elements of a sequence in descending order.
*/
orderDescending() : IEnumerable<T>;
/**
* Sorts the elements of a sequence in descending order.
* @param comparer An comparer to compare keys.
*/
orderDescending(comparer : (current : T, exist : T) => number) : IEnumerable<T>;
/**
* Sorts the elements of a sequence in descending order according to a key.
* @param keySelector A function to extract a key from an element.
*/
orderByDescending<TKey>(keySelector : (item : T) => TKey) : IEnumerable<T>;
/**
* Sorts the elements of a sequence in descending order according to a key.
* @param keySelector A function to extract a key from an element.
* @param comparer An comparer to compare keys.
*/
orderByDescending<TKey>(
keySelector : (item : T) => TKey,
comparer : (current : TKey, exist : TKey) => number) : IEnumerable<T>;
/**
* Adds a value to the beginning of the sequence.
* @param element The value to prepend to
*/
prepend(element : T) : IEnumerable<T>;
/**
* Inverts the order of the elements in a sequence.
*/
reverse() : IEnumerable<T>;
/**
* Projects each element of a sequence into a new form by incorporating the element's index.
* @param selector A transform function to apply to each element.
*/
select<TReturn>(selector : ((item : T) => TReturn) | ((item : T, index : number) => TReturn))
: IEnumerable<TReturn>;
/**
* Projects each element of a sequence to an array and flattens the resulting sequences into one sequence.
* @param selector A transform function to apply to each element.
*/
selectMany<TReturn>(selector : (item : T) => IEnumerable<TReturn>) : IEnumerable<TReturn>;
/**
* Returns the only element of a sequence that satisfies a specified condition, and throws an exception if more than
* one such element exists.
*/
single() : T;
/**
* Returns the only element of a sequence that satisfies a specified condition, and throws an exception if more than
* one such element exists.
* @param predicate A function to test an element for a condition.
*/
single(predicate : (item : T) => boolean) : T;
/**
* Returns the only element of a sequence, or a default value if the sequence is empty; this method throws an exception
* if there is more than one element in the sequence.
*/
singleOrDefault() : T | null;
/**
* Returns the only element of a sequence, or a specified default value if the sequence is empty; this method throws
* an exception if there is more than one element in the sequence.
* @param defaultValue The default value to return if the sequence is empty.
*/
singleOrDefault(defaultValue : T) : T | null;
/**
* Returns the only element of a sequence, or a specified default value if the sequence is empty; this method throws
* an exception if there is more than one element in the sequence.
* @param predicate A function to test an element for a condition.
*/
singleOrDefault(predicate : (item : T) => boolean) : T | null;
/**
* Returns the only element of a sequence that satisfies a specified condition, or a specified default value if no
* such element exists; this method throws an exception if more than one element satisfies the condition.
* @param predicate A function to test an element for a condition.
* @param defaultValue The default value to return if the sequence is empty.
*/
singleOrDefault(
predicate : (item : T) => boolean,
defaultValue : T) : T | null;
/**
* Bypasses a specified number of elements in a sequence and then returns the remaining elements.
* @param count The number of elements to skip before returning the remaining elements.
*/
skip(count : number) : IEnumerable<T>;
/**
* Returns a new enumerable collection that contains the elements from source with the last count elements of the
* source collection omitted.
* @param count The number of elements to omit from the end of the collection.
*/
skipLast(count : number) : IEnumerable<T>;
/**
* Bypasses elements in a sequence as long as a specified condition is true and then returns the remaining elements.
* @param predicate A function to test each element for a condition.
*/
skipWhile(predicate : (item : T) => boolean) : IEnumerable<T>;
/**
* Returns a specified number of contiguous elements from the start of a sequence.
* @param count The number of elements to return
*/
take(count : number) : IEnumerable<T>;
/**
* Returns a specified number of contiguous elements from the start of a sequence.
* @param range The range of elements to return, which has start and end indexes either from the beginning or the
* end of the sequence.
*/
take(range : [start : number, end : number]) : IEnumerable<T>;
/**
* Returns a new enumerable collection that contains the last count elements from source.
* @param count The number of elements to take from the end of the collection.
*/
takeLast(count : number) : IEnumerable<T>;
/**
* Returns elements from a sequence as long as a specified condition is true.
* @param predicate A function to test each element for a condition.
*/
takeWhile(predicate : ((item : T) => boolean) | ((item : T, index : number) => boolean)) : IEnumerable<T>;
/**
* Creates an array from an enumerable.
*/
toArray() : Array<T>;
/**
* Creates a Map from an enumerable according to specified key selector and element selector functions.
* @param keySelector A function to extract a key from each element.
* @param valueSelector A transform function to produce a result element value from each element.
*/
toDictionary<K, V>(keySelector : (item : T) => K, valueSelector : (item : T) => V) : Map<K, V>;
/**
* Produces the set union of two sequences by using a specified comparer.
* @param source An enumerable whose distinct elements form the second set for the union.
* @param comparer The comparer to compare values.
*/
union(source : Array<T>, comparer? : (left : T, right : T) => boolean) : IEnumerable<T>;
/**
* Produces the set union of two sequences according to a specified key selector function.
* @param source An enumerable whose distinct elements form the second set for the union.
* @param keySelector A function to extract the key for each element.
* @param comparer The comparer to compare values.
*/
unionBy<TKey>(
source : Array<T>, keySelector : (item : T) => TKey,
comparer? : (left : TKey, right : TKey) => boolean) : IEnumerable<T>;
/**
* Filters a sequence of values based on a predicate. Each element's index is used in the logic of the predicate function.
* @param predicate A function to test each source element for a condition; the second parameter of the function
* represents the index of the source element.
*/
where(predicate : ((item : T) => boolean) | ((item : T, index : number) => boolean)) : IEnumerable<T>;
}
```
| Aggressive extensions of LINQ in ES on prototype of Array | extension,javascript,linq,es,fluent,generator,iterator,typescript | 2023-04-07T10:18:50Z | 2024-01-16T05:10:51Z | 2024-01-16T05:00:06Z | 2 | 1 | 53 | 0 | 2 | 35 | null | MIT | TypeScript |
kiki-le-singe/tell-me-a-story-ai | develop | # Tell me a story...
## Introduction
I started this project mainly to play with [ChatGPT](https://chat.openai.com/) from [OpenAI](https://openai.com/). It's a small app that allows you to write a story using the [OpenAI API](https://platform.openai.com/docs/api-reference). There are some predefined stories to help your inspiration, and you can also write your own story.
This app uses these following API:
- [Create image](https://platform.openai.com/docs/api-reference/images/create)
- [Create completion](https://platform.openai.com/docs/api-reference/completions/create)
- [Create transcription](https://platform.openai.com/docs/api-reference/audio/create)
Enjoy it! :)
<br />
This app has four screens:
- A tutorial interface that introduces the app.
- A simple screen that displays the users who have created pictures and illustrations.
- The screen that allows you to write a predefined story.
- The screen that allows you to write your own story.
<img src="./docs/app.gif" alt="Tell me a story app" />
<br />
<img src="./docs/own-story.gif" alt="Own Story" />
<br />
<img src="./docs/story.gif" alt="Story" />
<br />
<br />
> You can use an audio file, from your device, to write a story. Before you have to record an audio (Tell me a story about an alien who loves to swim and eat chocolate very much.), and then the app will transcribe it. After that, you can use the transcription to write a story.
<img src="./docs/transcription.gif" alt="Transcription" />
<br />
## Requirements
In order to use the API of ChatGPT, you have to create an account [Explore the OpenAI API](https://platform.openai.com/overview). After that, just create a new secret key [API keys](https://platform.openai.com/account/api-keys).
## Installation
```shell
$ git clone https://github.com/kiki-le-singe/tell-me-a-story-ai.git <name>
$ cd <name>
$ yarn | npm install
$ npx pod-install
```
> Create a .env file at the root of the project and set this env variable `OPENAI_API_KEY=<YOUR_SECRET_KEY>`
```shell
$ npm run ios
```
## Resources
All the images are taken from [Freepik](http://www.freepik.com). Those I have chosen have a free license. I just use them to illustrate this app.
They are designed by these authors:
<br />
<img src="./docs/authors.gif" alt="authors" />
<br />
- [freepik](https://www.freepik.com/author/freepik)
- [ddraw](https://www.freepik.com/author/ddraw)
- [vectorjuice](https://www.freepik.com/author/vectorjuice)
- [pikisuperstar](https://www.freepik.com/author/pikisuperstar)
- [pch.vector](https://www.freepik.com/author/pch-vector)
- [catalyststuff](https://www.freepik.com/author/catalyststuff)
- [rawpixel-com](https://www.freepik.com/author/rawpixel-com)
- [upklyak](https://www.freepik.com/author/upklyak)
- [brgfx](https://www.freepik.com/author/brgfx)
- [storyset](https://www.freepik.com/author/stories)
All the icons are taken from [unDraw](https://undraw.co/).
A big thanks to them for their awesome work!
| "Tell me a story" is a small app that allows you to write a story using ChatGPT and React Native. | chatgpt,chatgpt-api,javascript,openai-api,openapi,react-native,reactjs,typescript,android,ios | 2023-03-30T15:52:38Z | 2023-05-30T17:13:17Z | null | 1 | 0 | 64 | 0 | 1 | 34 | null | null | TypeScript |
tamalCodes/Literally-Learning | main | # Website
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
### Installation
```
$ yarn
```
### Local Development
```
$ yarn start
```
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
### Build
```
$ yarn build
```
This command generates static content into the `build` directory and can be served using any static contents hosting service.
### Deployment
Using SSH:
```
$ USE_SSH=true yarn deploy
```
Not using SSH:
```
$ GIT_USER=<Your GitHub username> yarn deploy
```
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
<head>
<meta charset="utf-8" />
<link rel="icon" href="/favicon.ico" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta
name="description"
content="Welcome to Milan, we are a hub to connect NGOs, Charities, and the world to collaborate and build a better tommorow."
data-rh="true"
/>
<meta
name="google-site-verification"
content="ISkkPcMaQwANRR5_0CPjjxQJ3SyWzUt94nSP7wc1JdA"
/>
<meta name="title" content="Milan" />
<meta name="language" content="en" />
<meta name="author" content="Tamal Das" />
<meta name="robots" content="index, follow" />
<meta name="revisit-after" content="7 days" />
<meta
name="keywords"
content="Milan, hub, connect, user collaboration, charities, NGO, support, social impact,community"
/>
<meta property="og:type" content="website" />
<meta property="og:url" content="https://milanhub.org/" />
<meta property="og:title" content="Milan" />
<meta
property="og:description"
content="Welcome to Milan, we are a hub to connect NGOs, Charities, and the world to collaborate and build a better tommorow."
/>
<meta
property="og:image"
content="https://raw.githubusercontent.com/MilanCommunity/Milan/main/src/assets/pictures/Banner/MilanSEO.svg"
/>
<meta name="twitter:card" content="summary_large_image" />
<meta property="twitter:url" content="https://milanhub.org/" />
<meta property="twitter:title" content="Milan" />
<meta
property="twitter:description"
content="Welcome to Milan, we are a hub to connect NGOs, Charities, and the world to collaborate and build a better tommorow."
/>
<meta
property="twitter:image"
content="https://raw.githubusercontent.com/MilanCommunity/Milan/main/src/assets/pictures/Banner/MilanSEO.svg"
/>
<title>Milan</title>
</head>
| I store whatever i learn in this website. | java,javascript,lld,oops,sql,css,html,interviews,react | 2023-04-05T16:45:54Z | 2024-05-12T15:52:26Z | null | 2 | 0 | 80 | 0 | 8 | 34 | null | null | MDX |
richardhbtz/soundcloud-rpc | main | # soundcloud-rpc - a SoundCloud Client with Discord Rich Presence, Dark Mode, and Adblocking Support
## Preview
## Installation
### Release
For the latest version of soundcloud-rpc, download the installer or executable file from the [latest release](https://github.com/richardhbtz/soundcloud-rpc/releases) page.
### Manual
Before installing and running this app, you must have [Node.js](https://nodejs.org/) installed on your machine.
1. Clone this repository to your local machine
2. Run `npm install` to install the required dependencies.
3. Run `npm start` to launch the application.
## Configuration
- The application settings are stored locally using Electron's `electron-store` module.
- Dark mode and adblocker settings can be toggled using keybinds.
## Keybinds
| Keybinding | Description |
| -------------------- | ---------------------------------------------------------------------- |
| F1 | Toggles dark mode |
| F2 | Toggles adblocker |
## Credits
- The Discord Rich Presence integration is implemented using the [discord-rpc](https://www.npmjs.com/package/discord-rpc) package.
- The Electron window is created using the [Electron](https://www.electronjs.org/) framework.
- The executable is packed using [electron-builder](https://www.electron.build/).
## Contributing
Contributions to this project are welcome. If you find a bug or would like to suggest a new feature, please open an issue on this repository.
## License
This project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for details.
| 🎵 a SoundCloud client with Discord Rich Presence, Dark Mode, and AdBlock support | discord,javascript,nodejs,rich-presence,typescript,adblock,electron | 2023-03-30T00:43:59Z | 2024-05-04T18:15:59Z | 2024-05-03T20:22:31Z | 3 | 2 | 19 | 0 | 5 | 33 | null | MIT | TypeScript |
net2devcrypto/MidJourney-AI-Image-Generator-API-NodeJS | main | # MidJourney-AI-Image-Generator-API-NodeJS
An API NodeJS script to automate image generation using MidJourneyV4 model in Stable Diffusion.
##
<h3>Subscribe to my Youtube! Net2Dev</h3>
<a href="http://youtube.net2dev.io" target="_blank"><img src="https://github.com/net2devcrypto/misc/blob/main/ytlogo2.png" width="150" height="40"></a>
<img src="https://raw.githubusercontent.com/net2devcrypto/misc/main/Midjourney_Emblem.png" width="350" height="350">
** THE FILES ATTACHED TO THIS REPO ARE FOR EDUCATIONAL PURPOSES ONLY **
** USE IT AT YOUR OWN RISK** **I'M NOT RESPONSIBLE FOR ANY USE, ISSUES ETC.. **
## Step 1
Download midjourneyapi folder from this repo.
## Step 2
Extract and navigate to project folder then install dependencies: npm i
```shell
cd midjourneyapi
npm i
```
## Step 3
Create your Account in Stablediffusion: https://stablediffusionapi.com/
## Step 4
Create API key then copy it.
Update midjourneyapi.js and add your api key:
```shell
const apiKey = 'REPLACE-WITH-YOUR-API-KEY';
```
## Step 5
Add your prompt description of what you want to generate.
```shell
const prompt = 'a dog walking on the beach with sunglasses, portrait, ultra realistic, futuristic background , concept art, intricate details, highly detailed';
```
## Step 6
Add how many pics you want to generate:
```shell
const numberOfPics = '3'
```
## Step 7
- Save and execute in your terminal:
```shell
node midjourneyapi.js
```
Pictures will be inside the "pics" folder once generated.
Follow me in Youtube @Net2Dev!!
| An API NodeJS Script to automate image generation using MidJourneyV4 model in Stable Diffusion | ai,api,javascript,midjourney,nextjs,reactjs,stable-diffusion | 2023-03-31T20:51:35Z | 2023-04-01T01:22:10Z | null | 1 | 0 | 9 | 0 | 7 | 32 | null | null | JavaScript |
TheBeyondGroup/shopify-rich-text-renderer | main | ## Shopify Rich Text Renderer
This package converts the rich text schema returned by Shopify's Storefront API to an HTML string. In particular, this package is useful when dealing with the rich text field type for _MetaObjects_ and _Metafields_ when using the Storefront API.
### Usage
- Install `yarn add @thebeyondgroup/shopify-rich-text-renderer`
- Then import the `convertSchemaToHtml()` function
```javascript
import { convertSchemaToHtml } from '@thebeyondgroup/shopify-rich-text-renderer'
/* this is an example of the rich text Shopify returns
const richTextResponse = {\"type\":\"root\",\"children: [{\"type\":\"heading\"
\"level\":1,\"children\":[{\"type\":\"text\",\"value\":\
"Test Heading\"}]},{\"listType\":\"ordered\",\"type\":\"list\",
\"children\":[{\"type\":\"list-item\",\"children\":..." */
convertSchemaToHtml(richTextResponse)
```
```html
<!-- Output: -->
<h1>Test Heading</h1>
<ol>
...
</ol>
...
```
To get scoped HTML pass either true or the name of a class(es) to use in your scoped css selectors. This allows for the rich text HTML to be easily styled.
```javascript
// scoped html
convertSchemaToHtml(richTextResponse, true)
```
```html
<!-- Output: -->
<div class="rte">
<h1>Test Heading</h1>
<ol>
...
</ol>
...
</div>
```
You can also pass in a custom class name to be used as the scoped class instead of the default `rte`
```javascript
//scoped w/ custom class name
convertSchemaToHtml(richTextResponse, 'rich-text-wrap')
```
```html
<!-- Output: -->
<div class="rich-text-wrap">
<h1>Test Heading</h1>
<ol>
...
</ol>
...
</div>
```
React/Hydrogen example:
```javascript
export default RenderedHTML(){
const richTextResponse = await getRichTextFromShopify()
return (
<>
<div
className="html"
dangerouslySetInnerHTML={{
__html: convertSchemaToHtml(richTextResponse),
}}
/>
<div>
</>
)
}
```
Here is a [JSFiddle Demo](https://jsfiddle.net/psmzrojd/) that shows a working example.
| A package to convert Shopify's rich text schema to an HTML string | javascript,metaobject,shopify,rich-text-to-html,rich-text,rich-text-serializer,metafields | 2023-03-29T06:34:54Z | 2024-05-22T00:49:07Z | 2023-08-08T20:49:21Z | 3 | 16 | 45 | 0 | 4 | 32 | null | MIT | JavaScript |
CodeWithMohaimin/Get-Started-With-Strapi | master | # Learn Strapi Js with Fun 🥳
## 𝙏𝙪𝙢𝙞 - 𝘼𝙢𝙞 ( সিরিজ - 01 ) 𝑾𝒉𝒂𝒕 𝒊𝒔 𝑺𝒕𝒓𝒂𝒑𝒊?
𝙏𝙪𝙢𝙞 - Strapi কি ?
𝘼𝙢𝙞 - Strapi হলো একটি Headless CMS.
𝙏𝙪𝙢𝙞 - Headless CMS মানে বুঝলাম না?
𝘼𝙢𝙞 - আচ্ছা আগে তোমাকে আমি CMS সম্পর্কে বোঝায় নিই, তারপরে Headless সম্পর্কে বুঝাবো | CMS হল একটি Content Management System বা কন্টেন্ট ম্যানেজমেন্ট সিস্টেম | Content মানে হল “বিষয়বস্তু” অর্থাৎ এখানে বলা যায় একটা ওয়েবসাইটের সমস্ত বিষয়বস্তু যেমন image, video, Text, button and etc হল Content | আর আমরা CMS ব্যবহার করে ওয়েবসাইটের সমস্ত কনটেন্ট ম্যানেজ করতে পারি | অর্থাৎ Create, Read, Update and Delete করতে পারি | আমরা এগুলো Strapi ব্যবহার করে খুব সহজে করতে পারি | তাই Strapi হল একটি কন্টেন্ট ম্যানেজমেন্ট সিস্টেম | বুঝতে পেরেছ ?
𝙏𝙪𝙢𝙞 - হ্যাঁ বুঝতে পেরেছি আলহামদুলিল্লাহ |
𝘼𝙢𝙞 - আচ্ছা তাহলে এবার আসি Headless কি এই বিষয়টাতে | Wordpress হলো একটি খুবই জনপ্রিয় CMS যেটা আমরা সবাই জানি | কিন্তু ওয়ার্ডপ্রেস কিন্তু Strapi এর মত Headless CMS না | তুমি কি জানো এটার কারণ কি?
𝙏𝙪𝙢𝙞 - না! আপনি বলে দেন |
𝘼𝙢𝙞 - কারণ হলো, কেউ যখন Wordpress দিয়ে কনটেন্ট ম্যানেজ করে তখন সেটা ওয়েবসাইটের Backend ডাটা তৈরি করার পাশাপাশি Frontend ও তৈরি করে দিবে | অথচ Headless Strapi তোমাকে শুধুমাত্র json ফরমেটে ডাটা দিয়ে দিবে তোমাকে নিজে নিজে Frontend বানিয়ে নিতে হবে|এখানে তুমি বলতে পারো Strapi এর মাথা নেই অর্থাৎ Headless. Frontend কে এখানে মাথার সাথে তুলনা করা হয়েছে |
## Wordpress
## Strapi
𝙏𝙪𝙢𝙞 - হুমমমম
𝘼𝙢𝙞 - এবার কি তাহলে ক্লিয়ার হয়েছো Headless CMS কি?
𝙏𝙪𝙢𝙞 - হ্যাঁ ভাইয়া ধন্যবাদ|এরপরে বলুন তাহলে |
𝘼𝙢𝙞 - না আজ এ পর্যন্ত, অন্যদিন আবার এ বিষয়ে কথা হবে | টাটা বাই বাই |
𝙏𝙪𝙢𝙞 - ওকে ভাইয়া ঠিক আছে |
| Strapi is a headless CMS that is used to develop websites, mobile applications, eCommerce sites, and APIs. It allows you to create an API without knowing anything about the backend or databases. The system builds APIs based on content models automatically, making it easy to view data in the CMS with Strapi examples. | javascript,strapi,strapi-cms | 2023-04-05T16:17:24Z | 2023-10-05T14:09:28Z | null | 1 | 0 | 7 | 0 | 2 | 30 | null | null | JavaScript |
VelzckC0D3/To_Do_List_ES6 | main | <a name="readme-top"></a>
<div align="center">
</div>
<!-- TABLE OF CONTENTS -->
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#deployment)
- [👥 Author](#author)
- [👥 Collaborator](#collaborator)
- [🔭 Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ (OPTIONAL)](#faq)
- [📝 License](#license)
<!-- PROJECT DESCRIPTION -->
# 📖 [To Do List!] `ES6` `WebPack` <a name="about-project"></a>
Introducing my first Javascript app where you are able to manage the books using the local storage.
## 🛠 Built With <a name="built-with"></a>
### Tech Stack <a name="tech-stack"></a>
<details>
<summary>Client</summary>
<ul>
<li><a href="https://developer.mozilla.org/en-US/docs/Web/HTML">HTML</a></li>
<li><a href="https://developer.mozilla.org/en-US/docs/Web/CSS">CSS</a></li>
<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript">JavaScript</a></li>
<li><a href="https://webpack.js.org/">WebPack</a></li>
<li><a href="https://262.ecma-international.org/6.0/">ES6 (EcmaScript 6)</a></li>
</ul>
</details>
<details>
<summary>Server</summary>
<ul>
<li><a href="https://webpack.js.org/guides/development/#using-webpack-dev-server">WebPack-dev-server</a></li>
</ul>
</details>
<details>
<summary>Database</summary>
<ul>
<li><a>local storage used in order to keep the library content</a></li>
</ul>
</details>
<!-- Features -->
### Key Features <a name="key-features"></a>
- **[ES6 updated, WebPack, Dynamic Content]**
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- LIVE DEMO -->
## 🚀 Live Demo <a name="live-demo"></a>
- _You can visit the live demo [here](https://velzck-list.netlify.app/)_
https://user-images.githubusercontent.com/92229666/229024483-0ad01eee-3542-42e6-aa53-daae6f202bbf.mp4
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- GETTING STARTED -->
## 💻 Getting Started <a name="getting-started"></a>
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
```sh
To have a computer, Internet, Keyboard and Mouse
```
### Setup
Clone this repository to your desired folder:
```sh
Open it with Visual Studio Code, and open a server with "LiveServer".
```
### Install
Install this project with:
```sh
Installation is not necessary
```
### Usage
To run the project, execute the following command:
```sh
npm run start
```
### Run tests
To run tests, run the following command:
```sh
First install all the required dependencies with the command 'npm install -y'
```
```sh
To run the add and remove unit test with Jest, execute the command: 'npm test'
```
### Deployment
You can deploy this project following these steps:
```sh
On the console run: 'npm run build'
```
```sh
Then: 'npm run start'
```
```sh
The website will be deployed
```
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- AUTHOR -->
## 👥 Author <a name="author"></a>
- GitHub: [@VelzckC0D3](https://github.com/VelzckC0D3)
- LinkedIn: [VelzckC0D3](https://www.linkedin.com/in/velzckcode/)
<!-- COLLABORATOR -->
## 👥 Collaborator <a name="collaborator"></a>
- GitHub: [@smunoz1998](https://github.com/smunoz1998)
- LinkedIn: [SantiagoMunoz](https://www.linkedin.com/in/santiago-munoz-0b2b1a260/)
<!-- FUTURE FEATURES -->
## 🔭 Features <a name="future-features"></a>
- [ ] **[Shows correct functionality]**
- [ ] **[WebPack Correctly Used]**
- [ ] **[ES6 Optimized]**
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- CONTRIBUTING -->
## 🤝 Contributing <a name="contributing"></a>
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- SUPPORT -->
## ⭐️ Show your support <a name="support"></a>
If you like this project, be pending on my profile since I'll be doing much more!
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- ACKNOWLEDGEMENTS -->
## 🙏 Acknowledgments <a name="acknowledgements"></a>
I would like to thanks my Microverse Team for helping me to get this done.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- FAQ (optional) -->
## ❓ FAQ<a name="faq"></a>
- **[What was the most difficult thin to achieve here?]**
- [The implementation of the function itsefl was quite a challenge for me since I'm not familiarized with it]
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- LICENSE -->
## 📝 License <a name="license"></a>
This project is [MIT](./LICENSE) licensed.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
| In this new app I was able to correctly apply all the new things I learned, such as Webpack, ES6, exporting or importing classes, DOM manipulation, dynamic website generation, and sorting items, among other technologies that I've been learning since the beginning of my practice. | classes,es6,javascript,modules,to-do-app,to-do-list,webpack | 2023-03-28T18:22:50Z | 2023-06-07T14:56:46Z | null | 2 | 5 | 38 | 0 | 0 | 29 | null | MIT | JavaScript |
arjuncvinod/arjuncvinod.github.io | main |
# Portfolio Website
### Languages used :   
### Live Demo:
### www.arjuncvinod.me
### https://arjuncvinod.github.io/
### https://arjuncvinod.netlify.app/
### https://arjuncvinod.vercel.app/
### Screenshots :
**Desktop View** <br>
<br>
**Mobile View** <br>
<table>
<tr>
<td> <img src="https://github.com/arjuncvinod/arjuncvinod.github.io/assets/68469520/e12a1d7d-f1f2-4cea-a18f-6ee3bef4845b"/> </td>
<td> <img src="https://github.com/arjuncvinod/arjuncvinod.github.io/assets/68469520/1a216aac-c674-4882-9149-de083ffe8fb9"/> </td>
</tr>
</table>
<p align=center> Made with ❤️ by Arjun </p>
| Personal Portfolio website | css,html,javascript,hacktoberfest | 2023-04-08T04:27:23Z | 2024-05-17T12:06:37Z | null | 1 | 23 | 237 | 1 | 3 | 28 | null | MIT | CSS |
CarlosIgreda/Awesome-Books | main | <a name="readme-top"></a>
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ (OPTIONAL)](#faq)
- [📝 License](#license)
# 📖 Awesome books <a name="about-project"></a>
In this project, We will take the Awesome books application and convert it into a fully functional website. We will refactor the project to add three new sections on top of the two sections you have already completed: Books list (done), Add book form (done), a new Contact info section, a Navigation bar, and a Footer. We will be using them in all Microverse projects and most likely in my future job as well, so it is important to know them!
## 🛠 Built With <a name="built-with"></a>
### Tech Stack <a name="tech-stack"></a>
<details>
<summary>Client</summary>
<ul>
<li><a href="https://www.hostinger.com/tutorials/what-is-html">HTML</a></li>
<li><a href="https://www.hostinger.com/tutorials/what-is-css">CSS</a></li>
<li><a href="https://www.hostinger.com/tutorials/what-is-javascript">JAVASCRIPT</a></li>
</ul>
</details>
<details>
<summary>Server</summary>
<ul>
<li>N/A</li>
</ul>
</details>
<details>
<summary>Database</summary>
<ul>
<li>N/A</li>
</ul>
</details>
### Key Features <a name="key-features"></a>
- **Follow a correct Gitflow**
- **Comply with linters**
- **DOM events with Javascript**
- **Javascript events**
- **Use objects to store and access data**
- **Use localStorage**
- **Create class methods to add and remove books**
- **Use a navigation bar**
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 🚀 Live Demo <a name="live-demo"></a>
- [Live Demo Link](https://carlosigreda.github.io/Awesome-Books)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 💻 Getting Started <a name="getting-started"></a>
To get a local copy up and running, follow these steps:
### Prerequisites
In order to run this project you need:
✅ Github account <br>
✅ Visual Studio Code installed <br>
✅ Node.js installed <br>
✅ Git Bash installed (optional)
### Setup
Clone this repository to your desired folder:
```sh
cd [my-folder]
git clone git@github.com:CarlosIgreda/AwesomeBooks.git
```
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 👥 Authors <a name="authors"></a>
**Carlos Igreda**
- GitHub: [@CarlosIgreda](https://github.com/CarlosIgreda)
- Twitter: [@carlosigreda](https://twitter.com/carlosigreda)
- LinkedIn: [@carlosigreda](https://www.linkedin.com/in/carlosigreda)
**Damian Dib Bustros**
- GitHub: [@DamianDib9](https://github.com/DamianDib9)
- LinkedIn: [@DamianDib9](https://ar.linkedin.com/in/damian-dib-bustros-953577261?original_referer=https%3A%2F%2Fwww.google.com%2F)
**Adeyemi Olusola**
- GitHub: [@Emarkees](https://github.com/emarkees)
- LinkedIn: [@Emarkees](https://www.linkedin.com/in/adeyemi-olusola-1a3ab1141)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 🔭 Future Features <a name="future-features"></a>
- [ ] **Use libraries and frameworks**
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 🤝 Contributing <a name="contributing"></a>
## 👤 Collaboration:
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## ⭐️ Show your support <a name="support"></a>
If you like this project you can follow me on Github.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 🙏 Acknowledgments <a name="acknowledgements"></a>
I would like to thank all Microverse staff and my coding partners as well.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## ❓ FAQ <a name="faq"></a>
- **What is a Linter?**
- Linter is a tool that analyzes source code to flag programming errors, bugs, stylistic errors, and suspicious constructs.
- **What is meant by Gitflow?**
- Gitflow is an alternative Git branching model that involves the use of feature branches and multiple primary branches.
- **What is DOM?**
- The Document Object Model (DOM) is the data representation of the objects that comprise the structure and content of a document on the web.
<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>
| In this project, I will build a basic website that allows users to add/remove books from a list. I will achieve that by using JavaScript objects and arrays. I will also need to dynamically modify the DOM and add basic events. | css,dom-manipulation,flexbox,grid-layout,html,javascript,media-queries | 2023-03-29T17:31:21Z | 2023-04-19T17:58:26Z | null | 3 | 3 | 43 | 0 | 0 | 27 | null | MIT | JavaScript |
dmitryberesten/filmoteka | main | <h1 align="center"> 👨💻 GOIT Team Project 👩💻 </h1>
<h2 align="center"> FILMOTEKA 🎥 </h2>
<h3 align="center"> Group 68 | Team 4 </h3>
<span align="center">
</span>
<h3 align="center"> ℹ️ Browser Bosses Team 🚀 <h3>
<span align="center">
<a align="center" href="https://github.com/dmitryberesten"></a>
<a align="center" href="https://github.com/MaksymMyhulia"></a>
<a align="center" href="https://github.com/Inna-Mykytiuk"></a>
<a align="center" href="https://github.com/AlexandrHaiduk"></a>
<a align="center" href="https://github.com/IrynaBondarenko7"></a>
<a align="center" href="https://github.com/Crash-afftar"></a>
<a align="center" href="https://github.com/yulka-pulka"></a>
<a align="center" href="https://github.com/VladyslavaDvorovenko"></a>
<a align="center" href="https://github.com/Universe2022"></a>
<a align="center" href="https://github.com/YuliyaBondG"></a>
<a align="center" href="https://github.com/YanaKholod"></a>
<a align="center" href="https://github.com/MisterF1x"></a>
<a align="center" href="https://github.com/MihailLeontev"></a>
<a align="center" href="https://github.com/Sheluvboog"></a>
</span>
## Description
The project is implemented in Vanilla JavaScript and working with:
🛠 [the Movie Database TMDB](https://www.themoviedb.org/);
🛠 responsive design for use on phone 📱, tablet 📟 and desktop 💻.
We are students of the FullStack Developer course [<img src="https://img.shields.io/badge/Go-IT-orange" />](https://goit.ua), the project is written at the end of the study of JavaScript.
## How to use Filmoteka?
📽 It is the site for searching and collecting movies.
**The Web App provides the following functions:**
🎞 search movie by a key word;
🎞 manage your film database by adding or deleting chosen movie to WATCHED or to QUEUE;
🎞 pagination allows you to easily navigate between movies;
🎞 in LIBRARY you can see your database of movies divided by 2 categories: WATCHED and QUEUE. | Filmoteka team project on JS. Students of GOIT, group 68, team 4. | api,javascript,parsel,swiper-js,animate-css,basiclightbox,localstorage,scss,pagination,filmoteka | 2023-03-29T17:46:06Z | 2023-04-05T14:29:04Z | null | 16 | 99 | 347 | 0 | 2 | 26 | null | null | JavaScript |
CarlosIgreda/To-Do-list | main | <a name="readme-top"></a>
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ (OPTIONAL)](#faq)
- [📝 License](#license)
# 📖 To Do list <a name="about-project"></a>
In this project I will write unit tests for the To Do list application. The testing project has been divided into two parts. In part 1 I will test functions responsible for adding and deleting list items. In part 2 I will test the status and content updates as well as the order re-position of items in the list.
## 🛠 Built With <a name="built-with"></a>
### Tech Stack <a name="tech-stack"></a>
<details>
<summary>Client</summary>
<ul>
<li><a href="https://www.hostinger.com/tutorials/what-is-html">HTML</a></li>
<li><a href="https://www.hostinger.com/tutorials/what-is-css">CSS</a></li>
<li><a href="https://www.hostinger.com/tutorials/what-is-javascript">JAVASCRIPT</a></li>
</ul>
</details>
<details>
<summary>Server</summary>
<ul>
<li>N/A</li>
</ul>
</details>
<details>
<summary>Database</summary>
<ul>
<li>N/A</li>
</ul>
</details>
### Key Features <a name="key-features"></a>
- **Follow a correct Gitflow**
- **Comply with linters**
- **DOM events with Javascript**
- **Javascript events**
- **Use objects to store and access data**
- **Use proper ES6 syntax**
- **Use npm as software packages system**
- **Use webpack to bundle JavaScript**
- **Use ES6 modules to write modular JavaScript**
- **Write unit tests for a JavaScript app.**
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 🚀 Live Demo <a name="live-demo"></a>
- [Live Demo Link](https://carlosigreda.github.io/To-Do-list/dist)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 💻 Getting Started <a name="getting-started"></a>
To get a local copy up and running, follow these steps:
### Prerequisites
In order to run this project you need:
✅ Github account <br>
✅ Visual Studio Code installed <br>
✅ Node.js installed <br>
✅ Git Bash installed (optional)
### Setup
Clone this repository to your desired folder:
```sh
cd [my-folder]
git clone git@github.com:CarlosIgreda/To-Do-list.git
```
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 👥 Authors <a name="authors"></a>
**Carlos Igreda**
- GitHub: [@CarlosIgreda](https://github.com/CarlosIgreda)
- Twitter: [@carlosigreda](https://twitter.com/carlosigreda)
- LinkedIn: [@carlosigreda](https://www.linkedin.com/in/carlosigreda/)
**Abiola Arobieke**
- GitHub: [@abiola-arobieke](https://github.com/abiola-arobieke)
- Linkedin: [@abiola-arobieke](https://linkedin.com/in/abiola-arobieke)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 🔭 Future Features <a name="future-features"></a>
- [ ] **Dragging items**
- [ ] **Frameworks**
- [ ] **Test the status with jest**
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 🤝 Contributing <a name="contributing"></a>
## 👤 Collaboration:
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## ⭐️ Show your support <a name="support"></a>
If you like this project you can follow me on Github.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 🙏 Acknowledgments <a name="acknowledgements"></a>
I would like to thank all Microverse staff and my coding partners as well.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## ❓ FAQ <a name="faq"></a>
- **What is a Linter?**
- Linter is a tool that analyzes source code to flag programming errors, bugs, stylistic errors, and suspicious constructs.
- **What is meant by Gitflow?**
- Gitflow is an alternative Git branching model that involves the use of feature branches and multiple primary branches.
- **What is DOM?**
- The Document Object Model (DOM) is the data representation of the objects that comprise the structure and content of a document on the web.
<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>
| In this project, I will build a simple HTML list of To Do tasks. The list will be styled according to the specifications listed later in this lesson. This simple web page will be built using webpack and served by a webpack dev server. | babel,css,html,javascript,jest,testing,webpack | 2023-04-04T21:34:02Z | 2023-04-19T16:44:44Z | null | 3 | 7 | 56 | 0 | 0 | 25 | null | MIT | JavaScript |
sikelio/plexmanager | main |
# Plex Manager
A cross-platform app build in [React Native](https://reactnative.dev/), based on the [Plex API](https://www.plexopedia.com/plex-media-server/api/) for managing Plex Media Servers from a phone.
| Labels | Version | Branch |
|-------------|-------------|----------------------------------------------------------------------|
| Current | v0.0.4-beta | [0.0.4-beta](https://github.com/sikelio/plexmanager/tree/0.0.4-beta) |
| Development | v0.0.5-beta | [dev](https://github.com/sikelio/plexmanager/tree/dev) |
## Install
- Play Store : Deleted from the Play Store. Download it on the [release page](https://github.com/sikelio/plexmanager/releases)
- App Store : [One day may be...](#ios)
## Run in dev mode
Clone the project
```
$ git clone https://github.com/sikelio/plexmanager
```
Go to the project directory
```
$ cd plex-manager
```
Install dependencies
```
$ yarn install
```
Start the app
- Android :
```
$ yarn android
```
- iOS (make sure to link the dependencies before)
I didn't test the app on iOS so don't be surprised if it don't work
```
$ yarn ios
```
## Documentation
Under construction
- [Getting Plex Media Server Access Token](https://github.com/sikelio/plexmanager/wiki/Getting-Plex-Media-Server-Access-Token)
## Features
- Server
- [X] [Server Capabilities](https://github.com/sikelio/plexmanager/issues/1)
- [X] [Server Identity](https://github.com/sikelio/plexmanager/issues/2)
- [X] [Server Preferences](https://github.com/sikelio/plexmanager/issues/3)
- [X] [Get Accounts](https://github.com/sikelio/plexmanager/issues/4)
- [X] [Get a Single Account](https://github.com/sikelio/plexmanager/issues/4)
- [X] [Get Devices](https://github.com/sikelio/plexmanager/issues/5)
- [~~Get a Single Device~~ (No additional infos)](https://github.com/sikelio/plexmanager/issues/6)
- [X] [Get All Activities](https://github.com/sikelio/plexmanager/issues/7)
- [X] [Stop an Activity](https://github.com/sikelio/plexmanager/issues/8)
- [ ] [Get Transient Token](https://github.com/sikelio/plexmanager/issues/60)
- [ ] [Perform Search](https://github.com/sikelio/plexmanager/issues/61)
- Session
- [X] [Get Active Sessions](https://github.com/sikelio/plexmanager/issues/9)
- [X] [Get All Transcode Sessions](https://github.com/sikelio/plexmanager/issues/10)
- [ ] [Terminate a Session](https://github.com/sikelio/plexmanager/issues/11)
- [X] [Get Session History](https://github.com/sikelio/plexmanager/issues/62)
- Library
- [X] [Get Libraries](https://github.com/sikelio/plexmanager/issues/12)
- [X] [Scan All Libraries](https://github.com/sikelio/plexmanager/issues/45)
- [X] [Scan a Single Library](https://github.com/sikelio/plexmanager/issues/46)
- [X] [Refresh Metadata for a Library](https://github.com/sikelio/plexmanager/issues/12)
- Media
- [X] [Get All Movies](https://github.com/sikelio/plexmanager/issues/13)
- [X] [Get Newest Movies](https://github.com/sikelio/plexmanager/issues/14)
- [ ] [Update Movie Details](https://github.com/sikelio/plexmanager/issues/15)
- [X] [Get All TV Shows](https://github.com/sikelio/plexmanager/issues/16)
- [X] [Get All TV Show Seasons](https://github.com/sikelio/plexmanager/issues/17)
- [X] [Get All TV Show Episodes](https://github.com/sikelio/plexmanager/issues/18)
- [X] [Get All Music Artists](https://github.com/sikelio/plexmanager/issues/19)
- [X] [Get All Photos](https://github.com/sikelio/plexmanager/issues/20)
- [X] [Get All Videos](https://github.com/sikelio/plexmanager/issues/21)
- [ ] [Update Media Play Progress](https://github.com/sikelio/plexmanager/issues/22)
- Playlists
- [ ] [Create a Playlist for a User](https://github.com/sikelio/plexmanager/issues/63)
- [ ] [View Playlists for a User](https://github.com/sikelio/plexmanager/issues/23)
- [ ] [View a Single Playlist](https://github.com/sikelio/plexmanager/issues/24)
- [ ] [View Items in a Playlist](https://github.com/sikelio/plexmanager/issues/25)
- Maintenance
- [X] [Empty trash](https://github.com/sikelio/plexmanager/issues/26)
- [X] [Clean Bundles](https://github.com/sikelio/plexmanager/issues/27)
- [X] [Optimize Database](https://github.com/sikelio/plexmanager/issues/28)
- Scheduled Tasks
- [X] [Get All Scheduled Tasks](https://github.com/sikelio/plexmanager/issues/29)
- [X] [Run Backup Database Task](https://github.com/sikelio/plexmanager/issues/30)
- [X] [Stop Backup Database Task](https://github.com/sikelio/plexmanager/issues/66)
- [X] [Stop All Scheduled Tasks](https://github.com/sikelio/plexmanager/issues/64)
- [X] [Run Optimize Database Task](https://github.com/sikelio/plexmanager/issues/67)
- [X] [Stop Optimize Database Task](https://github.com/sikelio/plexmanager/issues/68)
- [X] [Run Clean Old Bundles Task](https://github.com/sikelio/plexmanager/issues/69)
- [X] [Stop Clean Old Bundles Task](https://github.com/sikelio/plexmanager/issues/70)
- [X] [Run Clean Old Cache Files Task](https://github.com/sikelio/plexmanager/issues/71)
- [X] [Stop Clean Old Cache Files Task](https://github.com/sikelio/plexmanager/issues/72)
- [X] [Run Refresh Libraries Task](https://github.com/sikelio/plexmanager/issues/73)
- [X] [Stop Refresh Libraries Task](https://github.com/sikelio/plexmanager/issues/74)
- Troubleshooting
- [X] [Download the Databases](https://github.com/sikelio/plexmanager/issues/31)
- [X] [Download the Logs](https://github.com/sikelio/plexmanager/issues/32)
## Author
- [@sikelio](https://www.github.com/sikelio)
## Supports
### Android
The app is configured to be installed on Android >= 5.0 (SDK 21) but the app is currently tested on an Android 33 version. Some tests, will be done in the future. If you are getting trouble to install the app, please open an issue.
### iOS
I don't own an Apple device and an Apple developer licence for publishing the app on the App Store. For this reason the app is currently not available for iOS devices.
## License
[GLP v3](https://github.com/sikelio/plexmanager/blob/main/LICENCE.md)
| A cross platform app build in React Native, based on the Plex API for managing Plex Media Servers from a phone. | react-native,android,ios,plex,plex-media-server,plex-server,react-native-app,remote-tool,javascript,jsx | 2023-04-03T10:52:42Z | 2024-03-02T18:09:24Z | null | 1 | 30 | 193 | 17 | 2 | 25 | null | GPL-3.0 | JavaScript |
Naledi-Dikgale/todo-list | master | <a name="readme-top"></a>
<div align="center">
<h3><b>Todo-list</b></h3>
</div>
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ (OPTIONAL)](#faq)
- [📝 License](#license)
# 📖 Todo-list <a name="about-project"></a>
**Todo-list-project** is a project to showcase my html,CSS and javascript skills applied in bulding a todo-list
## 🛠 Built With <a name="built-with"></a>
### Tech Stack <a name="tech-stack"></a>
<details>
<summary>Client</summary>
<ul>
<li>HTML</li>
<li>CSS</li>
<li>JavaScript</li>
</ul>
</details>
### Key Features <a name="key-features"></a>
- **[Add_header]**
- **[Add_styling]**
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 🚀 Live Demo <a name="live-demo">https://naledi-dikgale.github.io/todo-list/dist/</a>
- [Live Demo Link](https://naledi-dikgale.github.io/todo-list/dist/)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 💻 Getting Started <a name="getting-started"></a>
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
web browser
### Setup
Clone this repository to your desired folder:
```sh
cd my-folder
git clone https://github.com/Naledi-Dikgale/todo-list.git
```
### Install
Install this project with:
```sh
cd todo-list
npm install
```
### Usage
To run the project, follow the instruction below:
open index.html in your browser
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 👥 Authors <a name="Naledi Dikgale"></a>
👤 **Naledi Dikgale**
- GitHub: [@Naledi-Dikgale](https://github.com/Naledi-Dikgale)
- LinkedIn: [naledi-dikgale-068423159](https://www.linkedin.com/in/naledi-dikgale-068423159/)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 🔭 Future Features <a name="future-features"></a>
- [ ] **[Add_footer]**
- [ ] **[Add_navbar]**
- [ ] **[Add_images]**
<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](project/issues).
<p align="right">(<a href="#reahttps://github.com/Naledi-Dikgale">back to top</a>)</p>
## ⭐️ Show your support <a name="support"></a>
If you like this project Please star it in my github page.
<p align="right">(<a href="https://github.com/Naledi-Dikgale">back to top</a>)</p>
## 🙏 Acknowledgments <a name=""></a>
I would like to thank my teammates.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 📝 License <a name="license"></a>
This project is [LICENSE](/LICENSE.md) licensed.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
| This Todo-list app was created using JavaScript, HTML and CSS, Items can be added, edited, stored and deleted from the list depending on the user. | css,html,javascript | 2023-03-28T02:23:24Z | 2023-10-17T19:16:17Z | null | 2 | 6 | 48 | 4 | 0 | 24 | null | NOASSERTION | JavaScript |
CarlosIgreda/Awesome-Books-ES6 | main | <a name="readme-top"></a>
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [👥 Author](#author)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ (OPTIONAL)](#faq)
- [📝 License](#license)
# 📖 Awesome books <a name="about-project"></a>
In this project, I will restructure your Awesome books app code. The goal is to make it more organized by using modules. I will also practice the ES6 syntax that I have learned.
## 🛠 Built With <a name="built-with"></a>
### Tech Stack <a name="tech-stack"></a>
<details>
<summary>Client</summary>
<ul>
<li><a href="https://www.hostinger.com/tutorials/what-is-html">HTML</a></li>
<li><a href="https://www.hostinger.com/tutorials/what-is-css">CSS</a></li>
<li><a href="https://www.hostinger.com/tutorials/what-is-javascript">JAVASCRIPT</a></li>
</ul>
</details>
<details>
<summary>Server</summary>
<ul>
<li>N/A</li>
</ul>
</details>
<details>
<summary>Database</summary>
<ul>
<li>N/A</li>
</ul>
</details>
### Key Features <a name="key-features"></a>
- **Follow a correct Gitflow**
- **Comply with linters**
- **DOM events with Javascript**
- **Javascript events**
- **Use objects to store and access data**
- **Use localStorage**
- **Create class methods to add and remove books**
- **Use a navigation bar**
- **Use ES6 modules to write modular JavaScript**
- **Use proper ES6 syntax**
- **Use npm as software packages system**
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 🚀 Live Demo <a name="live-demo"></a>
- [Live Demo Link](https://carlosigreda.github.io/Awesome-Books-ES6)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 💻 Getting Started <a name="getting-started"></a>
To get a local copy up and running, follow these steps:
### Prerequisites
In order to run this project you need:
✅ Github account <br>
✅ Visual Studio Code installed <br>
✅ Node.js installed <br>
✅ Git Bash installed (optional)
### Setup
Clone this repository to your desired folder:
```sh
cd [my-folder]
git clone git@github.com:CarlosIgreda/Awesome-Books-ES6.git
```
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 👥 Author <a name="author"></a>
**Carlos Igreda**
- GitHub: [@CarlosIgreda](https://github.com/CarlosIgreda)
- Twitter: [@carlosigreda](https://twitter.com/carlosigreda)
- LinkedIn: [@carlosigreda](https://www.linkedin.com/in/carlosigreda)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 🔭 Future Features <a name="future-features"></a>
- [ ] **Use frameworks for JavaScript**
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 🤝 Contributing <a name="contributing"></a>
## 👤 Collaboration:
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## ⭐️ Show your support <a name="support"></a>
If you like this project you can follow me on Github.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 🙏 Acknowledgments <a name="acknowledgements"></a>
I would like to thank all Microverse staff and my coding partners as well.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## ❓ FAQ <a name="faq"></a>
- **What is a Linter?**
- Linter is a tool that analyzes source code to flag programming errors, bugs, stylistic errors, and suspicious constructs.
- **What is meant by Gitflow?**
- Gitflow is an alternative Git branching model that involves the use of feature branches and multiple primary branches.
- **What is DOM?**
- The Document Object Model (DOM) is the data representation of the objects that comprise the structure and content of a document on the web.
<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>
| In this project, I will restructure your Awesome books app code. The goal is to make it more organized by using modules. I will also practice the ES6 syntax that I have learned. | css,html,javascript,es6,media-queries,dom-manipulation | 2023-04-03T15:37:47Z | 2023-04-19T17:45:26Z | null | 1 | 1 | 19 | 0 | 1 | 24 | null | MIT | JavaScript |
sonyarianto/jogja | main | <a href="https://paypal.me/sonyarianto" target="_blank">
<img alt="Sponsor" src="https://img.shields.io/badge/donate-Paypal-fd8200.svg" />
</a>
<a href="https://github.com/sponsors/sonyarianto" target="_blank">
<img alt="GitHub Sponsors" src="https://img.shields.io/github/sponsors/sonyarianto">
</a>
<a href="https://discord.gg/5Xj7HRMC34" target="_blank">
<img alt="Discord" src="https://img.shields.io/discord/1089563520988893306">
</a>
<a href="https://www.npmjs.com/package/jogja" target="_blank">
<img alt="npm" src="https://img.shields.io/npm/dt/jogja">
</a>
<a href="https://www.npmjs.com/package/jogja" target="_blank">
<img alt="npm" src="https://img.shields.io/npm/v/jogja">
</a>
# jogja
Project generator for web frameworks. It provides scaffolding for your apps. Still for busy and lazy people.
## Overview
I know there are so many web frameworks outhere. How about we have centralized tools to trigger create project for those frameworks? That's why I created `jogja`.
## How it works?
Every web framework has their own cli to create project. Jogja will trigger the cli to create project for you. So you don't need to install every cli for every framework. After you choose specific framework, `jogja` will trigger the cli to create project for you along with more options.
## Features
- Trigger create project for AdonisJS, Alpine.js, Analog, Angular, Astro, Aurelia, Docusaurus, Ember.js, Expo, Express.js, Fastify, Gatsby, Gridsome, Hexo, Hono, Inferno, Medusa, NestJS, Next.js, Nitro, Nuxt.js, Nx, Preact, Qwik, React (creact-react-app/CRA), React Redux, RedwoodJS, Remix, Sails, SolidJS, SolidStart, Stencil, SvelteKit, Vite, VitePress, Vue.js, VuePress, Vuetify.
- Navigate using keyboard (up and down key).
## Installation
Install it globally.
```
npm i -g jogja
```
Now you can call it by type `jogja` on your computer. Use keyboard (up, down and enter key) to select options.
## Screenshot
## FAQs
- **How to update?** Just run `npm i -g jogja` again. It will update the package to the latest version.
- **How to add new framework?** You can create PR to add new framework. Or you can create issue to request new framework.
- **I want to install non-JavaScript framework. Can I?** You can't at the moment. Support for other languages/frameworks will be added in the future.
- **Why the name is `jogja`?** Jogja a.k.a Yogyakarta is the name of city in Indonesia. I want to make this project as a tribute to the city.
## Contributing
Contributions are welcome! Open a pull request to fix a bug, or open an issue to discuss new feature or changes.
## How to look into the code?
File `src/index.ts` is the entry point of this software. So usually to run locally I am doing this.
```bash
npx jiti ./src/index.ts
// or npm run start
```
`jiti` is runtime TypeScript and ESM support for Node.js. I use that and I love it.
## License
MIT
Copyright © 2023 Sony Arianto Kurniawan <<sony@sony-ak.com>> and contributors.
| Project generator for web frameworks. It provides scaffolding for your apps. Still for busy and lazy people. | frameworks,generator,javascript,web-framework,project-generator,scaffolding,typescript | 2023-03-31T11:33:29Z | 2023-09-10T16:27:28Z | 2023-09-10T10:23:32Z | 1 | 0 | 140 | 0 | 2 | 24 | null | MIT | TypeScript |
lichengyuan2020/huihu-garbage-sort-miniprogram | main | # 基于深度学习的垃圾分类小程序（慧湖垃圾通）
* 东南大学&中国高科 2023年研究生实训获奖项目（新闻报道链接：https://mp.weixin.qq.com/s/_pjG0R7sbOoHmjvwxjLbSg)
## 项目简介：
## 项目演示视频：
1. 慧湖垃圾通-vue管理员端演示视频
2. 慧湖垃圾通-小程序端演示视频
百度网盘链接: https://pan.baidu.com/s/1iJ7U9V0fYmlQl3okDjiXAA?pwd=55b7 提取码: 55b7
## 项目文档：
### 文档包含：
1. 慧湖垃圾通-测试方案.docx
2. 慧湖垃圾通-测试报告.docx
3. 慧湖垃圾通-需求分析文档.docx
4. 慧湖垃圾通-概要设计文档.docx
5. 慧湖垃圾通-详细设计文档.docx
6. 慧湖垃圾通-接口文档.docx
7. 慧湖垃圾通-产品手册.pdf
8. 慧湖垃圾通-任务跟踪表
9. 慧湖垃圾通-里程碑计划
百度网盘链接: https://pan.baidu.com/s/1WVD9wYCLb8Ab72NCOhvEHQ?pwd=ec9t 提取码: ec9t
## 代码文件夹：
1. huihu-garbage-sort_app 小程序前端代码
2. admin-front-end-final 后台管理系统（vue）前端代码
3. rubbish_flask_server 后端代码
## 项目组长：[李程远](https://github.com/lichengyuan2020)
## 项目组员：[张旭升](https://github.com/zxs20000)、[罗胜](https://github.com/rolsheng)、[汤迪](https://github.com/DannyTangDi)
| 基于深度学习的垃圾分类小程序（慧湖垃圾通） | deep-learning,flask,pytorch,vue,wechat-mini-program,javascript | 2023-04-03T16:24:45Z | 2023-05-23T13:43:53Z | null | 4 | 0 | 17 | 0 | 1 | 24 | null | MIT | Python |
dawiidio/pli | main | # pli
<img src="https://github.com/dawiidio/pli/blob/main/static/logo.jpg?raw=true" width="500" height="500" style='margin: auto;display: block;'>
create CLI for any project within a few minutes with **Pli**!
## Installation and usage
Global installation is recommended
```shell
npm install -g @dawiidio/pli
# or
yarn global add @dawiidio/pli
```
```shell
npm install @dawiidio/pli
# or
yarn add @dawiidio/pli
```
You can use it also via npx
```shell
npx @dawiidio/pli
```
## Usage
init pli in current directory
```shell
# by default pli init will produce templates directory with sample template file
pli init
# config file is optional, but if you want to create
# more complex templates it may be useful
# to generate it run
pli init -c
# by default pli init will produce typescript config file and examples, if you prefer js use
pli init -c -t js
```
the above command creates `templates` directory and sample template file in it,
which looks like this:
```javascript
export function hello() {
return 'Hello $NAME$';
}
```
as you can see we have `$NAME$` which defines pli's variable. This variable will
be extracted and prompted to fill with value after selecting template,
you can now run `pli` command in current directory, pli will prompt you with below message:
```text
? Select template (Use arrow keys)
❯ hello.js
```
select template `hello.js` by pressing enter
```text
? Select template hello.js
? Output directory <-- type directory where file should be saved or leave it empty to save in current
? Insert value for NAME : <-- type value for name, e.g. David
```
when last variable is filled with value pli starts its magic and produces result file,
after successful creation process you will see summary like below:
```text
Following structure was created inside directory /your/current/working/directory
├─ hello.js
```
That's it! You can see the results by opening file. For example
```shell
cat hello.js
```
should return
```javascript
export function hello() {
return 'Hello David';
}
```
# cli
```text
pli run
runs cli, default command
Commands:
pli run runs cli, default command [default]
pli init initializes pli in current directory
Options:
--help Show help [boolean]
--version Show version number [boolean]
-c, --config path to config file [string]
-d, --dry dry run, results will not be saved [boolean]
-l, --logLevel log level. Available options: error, warn, info,
debug. Multiple options separated by pipe sign "|"
[string] [default: "error"]
-o, --allowOverwriting allow overwriting output files while committing data
to storage [boolean]
-t, --templatesDirectory override templates directory
[boolean] [default: "templates"]
```
# Examples
The above example is just the simplest one, you can create more sophisticated
templates with many directories, variables and files. See [examples](https://github.com/dawiidio/pli/tree/main/examples) for more
# Config file
to create more powerful tools and templates the config file may be needed, run
```shell
# for javascript config file run
pli init -c -t js
# for typescript config file run
pli init -c
```
the above command creates `pli.config.js` or `pli.config.ts` file in current directory,
now this is the time to create more complex templates, we will create a React
component template with support for css modules.
run
```shell
mkdir templates/$NAME$
touch templates/$NAME$/$NAME$.tsx
touch templates/$NAME$/$NAME$.module.css
```
in `templates/$NAME$/$NAME$.tsx` file add
```tsx
import React, { FunctionComponent } from "react";
import styles from './$NAME$.module.css';
interface $NAME$Props {
}
export const $NAME$:FunctionComponent<$NAME$Props> = ({ }) => {
return (
<div className={styles.$NAME$Root}>
Component $NAME$
</>
)
};
```
now we have a template for React component, but we want to have
support for css modules, so we need to add css file for it.
in `templates/$NAME$/$NAME$.module.css` file add
```css
.$NAME$Root {
}
```
now we have a template files for React component with css module support,
and it will work just fine now, but we can make it even better.
in `pli.config.ts` file add
```typescript
import { Template, IConfig, TemplateVariable, ITemplateVariable, IVariableScope } from '@dawiidio/pli';
const config: IConfig = {
templates: [
new Template({
// readable name, instead of "$NAME$" you will see "React Component" in cli
name: 'React Component',
// if you want to extend from existing template in templates directory you need to provide its name
id: '$NAME$',
// all will be generated relative to src/components directory
defaultOutputDirectoryPath: 'src/components',
variables: [
new TemplateVariable({
// variable name, it will be replaced with value in template files
name: 'NAME',
// you can pass default value for our variable
defaultValue: 'MyComponent',
// let's add some validation for our variable
validate: (value: string) => {
if (value.length < 3) {
throw new Error('Name must be at least 3 characters long');
}
}
}),
new TemplateVariable({
// variable name, it will be replaced with value in template files
name: 'DIRNAME',
// this variable will subscribe from NAME variable, so it will be updated when NAME is updated
defaultValue: '$NAME$',
ui: {
// you can also hide variables from user, so it will be used only for internal purposes
hidden: true
}
}).pipe(
// you can pipe variable value and trnasform it as you want,
// in this case we will replace all spaces with dashes
// and then we will convert all letters to lowercase
// so if we type "My Component" as NAME variable value
// DIRNAME will be "my-component"
(value: string, variable: ITemplateVariable, scope: IVariableScope) => value.replace(/\s/g, '-').toLowerCase()
)
],
})
]
}
export default config;
```
after adding config file we can run `pli`, if you set `$NAME$` to e.g. `TestFilters` you will see below message:
```text
Following structure was created inside directory /myProject/src/components
├─ TestFilters/
│ ├─ TestFilters.module.css
│ ├─ TestFilters.tsx
```
### Variables
You can create variables in your templates by using notation with dollars `$MY_VAR$`.
Variable name is case-sensitive, so `$my_var$` and `$MY_VAR$` are different variables.
Variable name can contain only letters, numbers and underscores.
Variables can be used in any file, or directory name,
or in other variable `defaultValue` field which means that variable will
subscribe to changes of variables passed in `defaultValue`.
You can use variables also in `outputMapping` in template config.
### Scopes
Variables are organised in scopes, so you can have variables with the same name
in different scopes. It is useful when you want to access variables from different
template. For example if you want to add template as an entry to another template
you can use variables from parent template i child. Also, variables from child
will be extracted and prompted to fill with value when selecting parent template.
Example:
```typescript
import { Template, IConfig, TemplateVariable } from '@dawiidio/pli';
const childTemplate = new Template({
name: 'Child',
id: 'child.ts',
variables: [
new TemplateVariable({
name: 'CHILD_VAR',
defaultValue: 'child'
})
]
});
// parent template will prompt for PARENT_VAR and CHILD_VAR
const parentTemplate = new Template({
name: 'Parent',
id: 'parent.ts',
variables: [
new TemplateVariable({
name: 'PARENT_VAR',
defaultValue: 'parent'
}),
],
entries: [
childTemplate
]
});
const config: IConfig = {
templates: [
parentTemplate,
]
}
export default config;
```
### Output mapping
You can map output of template which allows you to create more complex templates,
for example you can create template which will remap child template output to
different directory or filename.
```typescript
import { Template, IConfig, TemplateVariable } from '@dawiidio/pli';
const childTemplate = new Template({
name: 'Child',
id: 'child.ts',
variables: [
new TemplateVariable({
name: 'CHILD_VAR',
defaultValue: 'child'
})
]
});
const parentTemplate = new Template({
name: 'Parent',
id: 'parent.ts',
variables: [
new TemplateVariable({
name: 'PARENT_VAR',
defaultValue: 'parent'
}),
],
entries: [
childTemplate
],
outputMapping: {
// note thath you can not use CHILD_VAR in this scope
'child.ts': '$PARENT_VAR$.ts',
'parent.ts': '$PARENT_VAR$_somePostfix.ts',
}
});
const config: IConfig = {
templates: [
parentTemplate,
]
}
export default config;
```
| Create CLI for any project within a few minutes with Pli! | javascript,react,tooling,typescript | 2023-04-05T14:06:56Z | 2024-02-28T23:57:09Z | null | 1 | 0 | 33 | 1 | 0 | 24 | null | null | TypeScript |
VelzckC0D3/Books_App_ES6 | main | <a name="readme-top"></a>
<div align="center">
</div>
<!-- TABLE OF CONTENTS -->
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#deployment)
- [👥 Author](#author)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ (OPTIONAL)](#faq)
- [📝 License](#license)
<!-- PROJECT DESCRIPTION -->
# 📖 [Awesome Books!] `(ES6)` <a name="about-project"></a>
Introducing my first Javascript app where you are able to manage the books using the local storage.
## 🛠 Built With <a name="built-with"></a>
### Tech Stack <a name="tech-stack"></a>
<details>
<summary>Client</summary>
<ul>
<li><a href="https://developer.mozilla.org/en-US/docs/Web/HTML">HTML</a></li>
<li><a href="https://developer.mozilla.org/en-US/docs/Web/CSS">CSS</a></li>
<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript">JavaScript</a></li>
</ul>
</details>
<details>
<summary>Server</summary>
<ul>
<li><a>N/A</a></li>
</ul>
</details>
<details>
<summary>Database</summary>
<ul>
<li><a>local storage used in order to keep the library content</a></li>
</ul>
</details>
<!-- Features -->
### Key Features <a name="key-features"></a>
- **[ES6 updated, used modules and Luxon library in order to display the date & time]**
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- LIVE DEMO -->
## 🚀 Live Demo <a name="live-demo"></a>
https://user-images.githubusercontent.com/92229666/230481477-09592315-6ff0-428c-a746-d2a6de205eb9.mp4
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- GETTING STARTED -->
## 💻 Getting Started <a name="getting-started"></a>
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
```sh
To have a computer, Internet, Keyboard and Mouse
```
### Setup
Clone this repository to your desired folder:
```sh
Open it with Visual Studio Code, and open a server with "LiveServer".
```
### Install
Install this project with:
```sh
Installation is not necessary
```
### Usage
To run the project, execute the following command:
```sh
Open Live Server
```
### Run tests
To run tests, run the following command:
```sh
To check the HTML functionality use: 'HTML npx hint .'
```
```sh
To check the CSS functionality use: 'npx stylelint "**/*.{css,scss}"'
```
```sh
To check the JavaScript functionality use: 'npx eslint."'
```
### Deployment
You can deploy this project using:
```sh
Your software of preference
```
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- AUTHOR -->
## 👥 Author <a name="author"></a>
- GitHub: [@VelzckC0D3](https://github.com/VelzckC0D3)
- LinkedIn: [VelzckC0D3](https://www.linkedin.com/in/velzckcode/)
<!-- FUTURE FEATURES -->
## 🔭 Future Features <a name="future-features"></a>
- [ ] **[Shows correct functionality]**
- [ ] **[It can be used to create any object for a website, not just books]**
- [ ] **[ES6 Optimized]**
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- CONTRIBUTING -->
## 🤝 Contributing <a name="contributing"></a>
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- SUPPORT -->
## ⭐️ Show your support <a name="support"></a>
If you like this project, be pending on my profile since I'll be doing much more!
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- ACKNOWLEDGEMENTS -->
## 🙏 Acknowledgments <a name="acknowledgements"></a>
I would like to thanks my Microverse Team for helping me to get this done.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- FAQ (optional) -->
## ❓ FAQ<a name="faq"></a>
- **[What was the most difficult thin to achieve here?]**
- [The implementation of the function itsefl was quite a challenge for me since I'm not familiarized with it]
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- LICENSE -->
## 📝 License <a name="license"></a>
This project is [MIT](./LICENSE) licensed.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
| JavaScript app for a basic Books Library, which stores all the books in local storage and dynamically displays them on the website. The project was designed without any external styles or libraries, making it a pure demonstration of my JavaScript skills. and only using ES6 (Ecma Script 6) | bookstack,es6,es6-javascript,javascript,microverse | 2023-03-27T21:06:45Z | 2023-06-07T14:57:16Z | null | 1 | 1 | 12 | 0 | 0 | 23 | null | MIT | JavaScript |
wirayuda299/Instafam | main | # Instafam - Connect with people around the world
Welcome to Instafam!, This is my first nextjs project. Please if you have suggesstion for this project don't hesitate to let me know> And about this project,This is a social media app that allows you to connect with people around the world. You can post pictures, like and comment on other people's posts, and follow other users. You can also search for users by their username.
## Features
- Login/Log out
- Like and comment on posts
- Follow and unFollow other users
- Search for users by username or name
- View your profile
- Crop photo before upload
- View other users' profiles
- Save posts to your profile
- View your saved posts
- Create, read, update delete and report a post
- Simple detection of nudity in images while create a post
- Navigate to spesific post,
- Copy post link
- Share post
- Responsive design
- Dark mode switch
- Send messages to other users
Other features is comming soon.
## Technologies Used
- React
- Nextjs 13 (pages directory)
- Tailwind CSS
- Firebase
- NextAuth
| Welcome to Instafam! This is a social media app that allows you to connect with people around the world. You can post pictures, like and comment on other people's posts, and follow other users. You can also search for users by their username. | firebse,next-auth,nextjs,reactjs,tailwindcss,full-stack,javascript,social-media | 2023-03-27T15:22:30Z | 2023-07-27T07:47:01Z | null | 1 | 41 | 329 | 1 | 0 | 23 | null | null | TypeScript |
ChristianChiarulli/nostr.nvim | master | # nostr.nvim
A neovim plugin for interacting with the Nostr social network.
## Install (Lazy)
```lua
local M = {
"ChristianChiarulli/nostr.nvim",
dependencies = {
"MunifTanjim/nui.nvim",
},
build ={ "cd rplugin/node/nostr && npm i", ":UpdateRemotePlugins", }
}
function M.config()
require("nostr").setup {}
end
return M
```
## Getting started
Before you are able to post any content you will first need to generate a public and private key pair by running:
```lua
require("nostr").generate_keys()
```
This will create a JSON file in the `~/.config/nostr.nvim/` directory called `keys.json`. You can share your public key with anyone but make sure to keep your private key safe.
If you have already generated a public and private key pair you can skip this step, but make sure to add the keypair to `~/.config/nostr.nvim/keys.json`. The file should look like this:
```json
{
"privateKey": "your private key",
"publicKey": "your public key"
}
```
### Posting a blog
To post a blog make sure to have a markdown file open in your current buffer and run:
```lua
require("nostr").publish_blog()
```
You will then be prompted for a summary, an image URL and be asked one final time if you would like to post the blog.
After posting you can head over to [NeoTweet](https://neotweet.com) and view your blog post.
## Functions
```lua
require("nostr").generate_keys()
require("nostr").add_relay()
require("nostr").remove_relay()
require("nostr").list_relays()
require("nostr").set_active_relay()
require("nostr").publish_note()
require("nostr").publish_blog()
require("nostr").decode()
require("nostr").encode()
```
## Neovim Node Client
https://github.com/neovim/node-client
## Check if functions are registered
remote/host: node host registered plugins ['nostr']
remote/host: generated rplugin manifest: /Users/cam/.local/share/nvim/rplugin.vim
## NOTE
I have not implemented removing or editing posts yet.
## TODO
- [ ] private DMs
- [ ] collaborative editing
- [ ] note feed
- [ ] note tags
- [ ] note search
- [ ] edit posts
- [ ] remove posts
| 📡 Social network for Neovim | javascript,lua,neovim,neovim-plugin,nostr | 2023-04-04T21:09:34Z | 2023-10-13T23:38:35Z | null | 1 | 0 | 16 | 1 | 0 | 23 | null | GPL-3.0 | JavaScript |
jjgouveia/maestro-express-async-errors | master | 
[](https://standardjs.com)
[](https://github.com/jjgouveia/maestro-express-async-errors/actions/workflows/ci.yml)
[](https://github.com/jjgouveia/maestro-express-async-errors/actions)
# Maestro for ExpressJS Async Errors
### 🏆 The async/await heaven!
<hr>
## Maestro is a slightly layer of code that acts as a wrapper, without any dependencies, for async middlewares. Its purpose is to ensure that all errors occurring in async operations are properly passed to your stack of error handlers. By doing so, Maestro helps to improve the readability and cleanliness of your code.
### Installation:
```
npm install --save maestro-express-async-errors
```
or
```
yarn add maestro-express-async-errors
```
<br>
> **Note**
> The minimum supported `Node` version for Maestro is `7.6.0`.
## How to use it
**With maestro:**
```javascript
const { maestro } = require('maestro-express-async-errors');
express.get('/', maestro(async (req, res, next) => {
const bar = await foo.findAll();
res.send(bar)
}))
```
**Without maestro:**
```javascript
express.get('/',(req, res, next) => {
foo.findAll()
.then ( bar => {
res.send(bar)
} )
.catch(next); // error passed on to the error handling route
})
```
### So Easy right? 😉
**Now let I show you more exemples and functionalities:**
* `maestro` insures thrown errors are passed to `next` callback:
```js
const { maestro } = require('maestro-express-async-errors');
app.get('/:id', maestro(async (req, res, next) => {
const user = await repository.getById(req.params.id)
if (!user) {
throw new UserNotFoundError
}
res.status(200)
.json(user)
}))
```
* `maestro.from` allows you to handle a specific error which is helpful for handling domain driven errors.
```js
app.use(maestro.from(UserNotFoundError, (err, req, res, next) => {
res.status(404)
.json({ error: 'these are not the droids you\'re looking for'})
})
/**
Your error handlers still works as expected. If an error doesn't match your `maestro.from` criteria, it will find its way to the next error handler.
*/
app.use((err, req, res, next) => {
res.status(500)
.json({ error: 'i have a bad feeling about this'})
})
```
* There's a helper function `maestro.all([...])` in case you want to wrap several functions with `maestro`. With `maestro.all`, doing `[maestro(fn1), maestro(fn2)]` can be shortened to `maestro.all([fn1, fn2])`.
```js
const maestro = require('maestro-express-async-errors')
// Doing it like this
app.post('/products', maestro.all([
validationFn,
createProductFn
]))
// Is equivalent to this
app.post('/products', [
maestro(validationFn),
maestro(createProductFn)
])
```
#### Import in Typescript:
```javascript
import { maestro } from "maestro-express-async-errors"
```
<br>
## Test Cases
```txt
> maestro-express-async-errors@1.2.5 test
> mocha --require ts-node/register test/**/*.ts
Try maestro(async (req, res, next) => { next() or Error }) :
Basic functionality:
✔ Maestro is a function.
✔ Maestro returns a function.
✔ Maestro returns a function that returns a promise.
✔ When an asynchronous function passed into it throws an error, it is expected that the calls next with that error.
✔ When a non-asynchronous function passed into it throws an error, it is expected that calls next with that error.
✔ Should invoke `next` when passing a non-async function.
✔ Thenables are not guaranteed to have a `catch` method. This test refers to this.
Should invoke `next` with the thrown error:
✔ If an async function is passed as an argument, the next function should be called with the provided arguments.
✔ Works like a charm if all arguments are passed to the callback function.
✔ Raises a TypeError if next args it's not a function.
✔ A valid call works for routes and middlewares.
✔ A valid call works for error handler middlewares.
Try maestro.from(RealProblems, (err) => { }) :
✔ Handles the error when error is instance of given constructor.
✔ It call `next` function if error is not an instance of given constructor.
Try maestro.all([...args]) :
✔ Raises a TypeError when `next` it's not function.
✔ Should return an array.
✔ Should return an array of functions
✔ Should return an array of functions that returns a promise.
✔ Should return an array of functions that returns a promise that calls next.
✔ Should return an array of functions that returns a promise that calls next with the error.
20 passing (75ms)
```
| Maestro is a layer of code that acts as a wrapper, without any dependencies, for async middlewares. | error,error-handler,express,express-middleware,nodejs,typescript,async,expressjs,javascript,node | 2023-04-03T04:14:18Z | 2023-04-16T04:06:16Z | 2023-04-16T04:06:16Z | 1 | 3 | 151 | 0 | 0 | 22 | null | MIT | TypeScript |
statofu/statofu | main | <h1 align="center">
<img src="./assets/d9606fc3fb1f3abc2505a5856412c87b8cce3679.jpg" alt="Statofu" />
</h1>
[](https://codecov.io/gh/statofu/statofu)
[](https://github.com/statofu/statofu/actions/workflows/verify-and-release.yml)
[](https://npmjs.com/package/statofu)
[](https://bundlephobia.com/package/statofu)
[](./LICENSE)
English | [中文](./README.zh-Hans.md)
## Why Statofu?
One big problem with today's widely accepted state management libraries is that predictable state changes have to come at a high cost. [A detailed article](https://github.com/statofu/statofu-blog/blob/main/20230525/README.en.md) was written for the explanation:
> ...
>
> Though, Redux is not perfect and has a drawback. If we take a closer look at its unidirectional data flow, `event -> action -> reducer -> state`, it's lengthy. No matter how simple a state change is, always at least one action and at least one reducer are involved. In comparison, a state change in either Recoil or MobX goes much easier. The lengthiness dramatically increases the cost of use in Redux.
>
> ...
Statofu is a state management library built to achieve **predictable state changes at a low cost** 🌈. It's framework-agnostic, small and fast.
## Framework Integrations
Statofu provides integrations with mainstream frameworks, including React, Vue, and more. The naming convention of the integration libraries is `statofu-{{framework}}`. Currently, [the React integration, `statofu-react`](https://github.com/statofu/statofu-react), has become available, and please check it out if React is in use. Below is a framework-agnostic guide.
## Installation
Statofu can be installed by `npm` or any preferred package manager:
```sh
npm i -S statofu # yarn or pnpm also works
```
Or, the UMD format can be loaded from an npm CDN instead:
```html
<script src="https://unpkg.com/statofu/dist/statofu.umd.min.js"></script>
```
The UMD name is `statofu`.
## Essentials
In Statofu, each kind of state change directly involves a different reducer that accepts one or multiple old states along with zero or more payloads and produces one or multiple new corresponding states. As reducers are pure functions, state changes are predictable. As reducers are directly involved, state changes come at a low cost. The usage is described as follows.
### Creating the store
First of all, a Statofu store needs to be created, for which `createStatofuStore` is used:
```ts
import { createStatofuStore } from 'statofu';
const store = createStatofuStore();
```
### Defining states
Next, states need to be defined, which is simply done by Plain Old JavaScript Object(POJO)s. A POJO, as a state definition, simultaneously, for a state, (1) holds the default state value, (2) declares the state type, and (3) indexes the current state value in a store. Here are two example state definitions, one for a selectable item panel, and the other for a hideable text editor:
```tsx
interface ItemPanelState {
itemList: { id: string; text: string }[];
selectedItemId: string | undefined;
}
const $itemPanelState: ItemPanelState = {
itemList: [],
selectedItemId: undefined,
};
interface TextEditorState {
text: string;
visible: boolean;
}
const $textEditorState: TextEditorState = {
text: '',
visible: false,
};
```
Usually, to distinguish state definitions from state values by names, `$` is prefixed to state definition names.
### Getting states
Then, to get state values, `store.snapshot` is used. It accepts one or multiple state definitions and returns the current one or multiple corresponding state values indexed by the state definitions:
```ts
const { itemList, selectedItemId } = store.snapshot($itemPanelState);
const { text, visible } = store.snapshot($textEditorState);
const [itemPanelState, textEditorState] = store.snapshot([$itemPanelState, $textEditorState]);
```
By the way, before a state is changed, its state value is the shallow copy of the default state value held by its state definition.
### Changing states
Now, let's dive into state changes. In Statofu, each kind of state change directly involves a different reducer. For changing one state, a reducer that accepts one old state along with zero or more payloads and produces one new corresponding state is involved. Here are three example reducers, two for changing `$itemPanelState`, and one for changing `$textEditorState`:
```tsx
function selectItem(state: ItemPanelState, itemIdToSelect: string): ItemPanelState {
return { ...state, selectedItemId: itemIdToSelect };
}
function unselectItem(state: ItemPanelState): ItemPanelState {
return { ...state, selectedItemId: undefined };
}
function setText(state: TextEditorState, text: string): TextEditorState {
return { ...state, text };
}
```
For changing multiple states, a reducer that accepts multiple old states along with zero or more payloads and produces multiple new corresponding states is involved. Here is an example reducer for changing `$itemPanelState` and `$textEditorState`:
```tsx
function submitTextForSelectedItem([textEditor, itemPanel]: [TextEditorState, ItemPanelState]): [
TextEditorState,
ItemPanelState
] {
return [
{ ...textEditor, visible: false },
{
...itemPanel,
itemList: itemPanel.itemList.map((item) => {
if (item.id === itemPanel.selectedItemId) {
return { ...item, text: textEditor.text };
} else {
return item;
}
}),
selectedItemId: undefined,
},
];
}
```
With reducers ready, to involve them to change states, `store.operate` is used:
```ts
store.operate($itemPanelState, selectItem, 'ed3a06a1');
store.operate($itemPanelState, unselectItem);
store.operate($textEditorState, setText, 'Nulla fermentum aliquet ornare.');
store.operate([$textEditorState, $itemPanelState], submitTextForSelectedItem);
```
Inside a call of an operating function, the current state values indexed by the state definitions are passed into the reducer to produce the next state values which are, in turn, saved to the store.
### Subscribing
Thereafter, to respond when states change, `store.subscribe` is used. It accepts one state definition along with a one-state change listener, multiple state definitions along with a multiple-state change listener, or no state definition but an any-state change listener and returns the corresponding unsubscribing function:
```ts
// #1, subscribing to the changes of `$itemPanelState`.
const unsubscribeNo1 = store.subscribe($itemPanelState, (newState, oldState) => {});
// #2, subscribing to the changes of `$textEditorState`.
const unsubscribeNo2 = store.subscribe($textEditorState, (newState, oldState) => {});
// #3, subscribing to the changes of `$itemPanelState` and `$textEditorState`.
const unsubscribeNo3 = store.subscribe(
[$itemPanelState, $textEditorState],
([newItemPanel, newTextEditor], [oldItemPanel, oldTextEditor]) => {}
);
// #4, subscribing to the changes of any states.
const unsubscribeNo4 = store.subscribe((newStates, oldStates) => {});
```
When certain states go referentially different by a call of `store.operate`, one-state change listeners on one of them, multi-state change listeners on the states intersecting with them, and all any-state change listeners get called:
```ts
// As $itemPanelState changes, listeners of #1, #3, #4 get called.
store.operate($itemPanelState, selectItem, itemId);
// As $textEditorState and $itemPanelState change, listeners of #1, #2 #3, #4 get called.
store.operate([$textEditorState, $itemPanelState], submitTextForSelectedItem);
```
### Deriving data
Furthermore, to derive data from states, a selector that accepts one or multiple states along with zero or more payloads and calculates a value can be used in combination with `store.snapshot` or `store.subscribe`. Selectors can be named functions:
```ts
function getSelectedItem(state: ItemPanelState): ItemPanelState['itemList'][number] | undefined {
return state.itemList.find(({ id }) => id === state.selectedItemId);
}
function getRelatedItems([itemPanel, textEditor]: [
ItemPanelState,
TextEditorState
]): ItemPanelState['itemList'] {
return itemPanel.itemList.filter(({ text }) => text.includes(textEditor.text));
}
function getTextWithFallback(state: TextEditorState, fallback: string): string {
return state.text || fallback;
}
function isVisible(state: TextEditorState): boolean {
return state.visible;
}
const selectedItem = store.snapshot($itemPanelState, getSelectedItem);
const relatedItems = store.snapshot([$itemPanelState, $textEditorState], getRelatedItems);
const textWithFallback = store.snapshot($textEditorState, getTextWithFallback, 'Not Available');
const visible = store.snapshot($textEditorState, isVisible);
store.subscribe([$itemPanelState, $textEditorState], ([itemPanel, textEditor]) => {
const selectedItem = getSelectedItem(itemPanel);
const relatedItems = getRelatedItems([itemPanel, textEditor]);
const textWithFallback = getTextWithFallback(textEditor, 'Not Available');
const visible = isVisible(textEditor);
});
```
Also, selectors can be anonymous functions:
```ts
const selectedItemId = store.snapshot($itemPanelState, (state) => state.selectedItemId);
```
## Recipes
### Code Structure
In Statofu, the management of a state consists of (1) a state definition, (2) zero or more reducers, and (3) zero or more selectors. So, a recommended practice is to place the three parts of a state sequentially into one file, which leads to good maintainability. (In addition, as there are only POJOs and pure functions in each file, this code structure also leads to good portability.) Let's reorganize the states in Essentials for an example:
```tsx
// states/ItemPanelState.ts
import type { TextEditorState } from './TextEditorState';
export interface ItemPanelState {
itemList: { id: string; text: string }[];
selectedItemId: string | undefined;
}
export const $itemPanelState: ItemPanelState = {
itemList: [],
selectedItemId: undefined,
};
export function selectItem(state: ItemPanelState, itemIdToSelect: string): ItemPanelState {
// ...
}
export function unselectItem(state: ItemPanelState): ItemPanelState {
// ...
}
export function getSelectedItem(
state: ItemPanelState
): ItemPanelState['itemList'][number] | undefined {
// ...
}
export function getRelatedItems([itemPanel, textEditor]: [
ItemPanelState,
TextEditorState
]): ItemPanelState['itemList'] {
// ...
}
```
```tsx
// states/TextEditorState.ts
import type { ItemPanelState } from './ItemPanelState';
export interface TextEditorState {
text: string;
visible: boolean;
}
export const $textEditorState: TextEditorState = {
text: '',
visible: false,
};
export function setText(state: TextEditorState, text: string): TextEditorState {
// ...
}
export function submitTextForSelectedItem([textEditor, itemPanel]: [
TextEditorState,
ItemPanelState
]): [TextEditorState, ItemPanelState] {
// ...
}
export function getTextWithFallback(state: TextEditorState, fallback: string): string {
// ...
}
export function isVisible(state: TextEditorState): boolean {
// ...
}
```
### Server-side rendering(SSR)
In general, SSR needs 2 steps. (1) On the server side, states are prepared as per a page request, an HTML body is rendered with the states, and the states are serialized afterward. Then, the two are piped into the response. (2) On the client side, the server-serialized states are deserialized, then components are rendered with the states to properly hydrate the server-rendered HTML body.
To help with SSR, Statofu provides helpers of bulk reading to-serialize states from a store and bulk writing deserialized states to a store. But, serialization/deserialization is beyond the scope because it's easily doable via a more specialized library such as `serialize-javascript` or some built-in features of a full-stack framework such as data fetching of `next`.
Here is a semi-pseudocode example for SSR with Statofu. Firstly, `serialize-javascript` is installed for serialization/deserialization:
```sh
npm i -S serialize-javascript
```
Next, on the server side:
```tsx
import { renderToString } from 'react-dom/server';
import serialize from 'serialize-javascript';
import { createStatofuState } from 'statofu';
import { StoreProvider } from 'statofu-react';
import { foldStates } from 'statofu/ssr';
app.get('/some-page', (req, res) => {
const store = createStatofuState();
const itemPanelState = prepareItemPanelState(req);
store.operate($itemPanelState, itemPanelState);
const textEditorState = prepareItemPanelState(req);
store.operate($textEditorState, textEditorState);
const htmlBody = renderHtmlBodyAsString(store);
const stateFolder = foldStates(store, { $itemPanelState, $textEditorState });
res.send(`
...
<script>window.SERIALIZED_STATE_FOLDER='${serialize(stateFolder)}'</script>
...
<div id="root">${htmlBody}</div>
...`);
});
```
Afterward, on the client side:
```tsx
import { createStatofuState } from 'statofu';
import { unfoldStates } from 'statofu/ssr';
// ...
const stateFolder = eval(`(${window.SERIALIZED_STATE_FOLDER})`);
delete window.SERIALIZED_STATE_FOLDER;
const store = createStatofuState();
unfoldStates(store, { $itemPanelState, $textEditorState }, stateFolder);
hydrateServerRenderedHtmlBody(store);
```
Note that, this example can be optimized in different ways like rendering the HTML body as a stream. When using it in the real world, we should tailor it to real-world needs.
## APIs
### `createStatofuStore`
The function to create a store:
```ts
const store = createStatofuStore();
```
#### `store.snapshot`
The method to get state values:
```ts
const { itemList, selectedItemId } = store.snapshot($itemPanelState);
const { text, visible } = store.snapshot($textEditorState);
const [itemPanelState, textEditorState] = store.snapshot([$itemPanelState, $textEditorState]);
```
It can accept selectors:
```ts
const selectedItem = store.snapshot($itemPanelState, getSelectedItem);
const relatedItems = store.snapshot([$itemPanelState, $textEditorState], getRelatedItems);
const textWithFallback = store.snapshot($textEditorState, getTextWithFallback, 'Not Available');
const visible = store.snapshot($textEditorState, isVisible);
const selectedItemId = store.snapshot($itemPanelState, (state) => state.selectedItemId);
```
### `store.operate`
The method to change states by involving reducers:
```ts
store.operate($itemPanelState, selectItem, 'ed3a06a1');
store.operate($itemPanelState, unselectItem);
store.operate($textEditorState, setText, 'Nulla fermentum aliquet ornare.');
store.operate([$textEditorState, $itemPanelState], submitTextForSelectedItem);
```
### `store.subscribe`
The method to subscribe to state changes. It returns the corresponding unsubscribing function:
```ts
// #1, subscribing to the changes of `$itemPanelState`.
const unsubscribeNo1 = store.subscribe($itemPanelState, (newState, oldState) => {});
// #2, subscribing to the changes of `$textEditorState`.
const unsubscribeNo2 = store.subscribe($textEditorState, (newState, oldState) => {});
// #3, subscribing to the changes of `$itemPanelState` and `$textEditorState`.
const unsubscribeNo3 = store.subscribe(
[$itemPanelState, $textEditorState],
([newItemPanel, newTextEditor], [oldItemPanel, oldTextEditor]) => {}
);
// #4, subscribing to the changes of any states.
const unsubscribeNo4 = store.subscribe((newStates, oldStates) => {});
```
### `store.unsubscribe`
The method to unsubscribe from state changes. The more params are specified, the more limited the effect is:
```ts
// All listeners on the changes of `$itemPanelState` go detached.
store.unsubscribe($itemPanelState);
// All listeners on the changes of `$itemPanelState` and `$textEditorState` go detached.
store.unsubscribe([$itemPanelState, $textEditorState]);
// Only the specified listener on the changes of `$itemPanelState` goes detached.
store.unsubscribe($itemPanelState, handleItemPanelStateChange);
// Only the specified listener on the changes of any states goes detached.
store.unsubscribe(handleAnyStateChange);
// All listeners on one, multiple, or any states go detached.
store.unsubscribe();
```
### `store.clear`
The function to clear everything in the store:
```ts
store.clear();
```
## About the name
Since the early days of modern frontend development, state management has been a pain. But in nature, it is just reading and writing data for some specific needs in a frontend app. It shouldn't be so frustrating but should be fun.
The name "Statofu" means bringing **state** management back **to** **fu**n, which is also the ultra goal of Statofu. Having fun in state management helps us do it better. In return, better-done state management leads to a better frontend app.
The name "Statofu" is pronounced as a concatenation of the words state and tofu, which is [ˈsteitəʊfu]. By the way, tofu, a food with a history of over 2000 years, tastes smooth and benefits health, which accords with Statofu, too.
## Contributing
For any bugs or any thoughts, welcome to [open an issue](https://github.com/statofu/statofu-react/issues), or just DM me on [Twitter](https://twitter.com/licg9999) / [Wechat](./assets/ed0458952a4930f1aeebd01da0127de240c85bbf.jpg).
## License
MIT, details in the [LICENSE](./LICENSE) file.
| Predictable state changes at a low cost. Framework-agnostic, fast, and small. | functional,mobx,predictable,react,recoil,redux,state,statofu,javascript,state-management | 2023-04-05T12:29:31Z | 2023-07-07T08:42:09Z | 2023-07-07T08:42:09Z | 1 | 16 | 28 | 2 | 76 | 21 | null | MIT | TypeScript |
rumon5h/full-stack-interview-questions-for-busy-software-engineer | main | # Full Stack Interview Questions For Busy Software Engineer
#### [MERN Stack Interview questions](MERN.md)
#### [HTML Interview Questions](HTML.md)
#### [CSS Interview questions](CSS.md)
#### [JavaScript Interview questions](JavaScript.md)
#### [TypeScript Interview questions](TYPESCRIPT.md)
#### [MongoDB Interview questions](MONGODB.md)
#### [Express.js Interview questions](EXPRESS.md)
#### [React.js Interview questions](REACT.md)
#### [Node.js Interview questions](NODE.md)
#### [Next.js Interview questions](NEXT.md)
#### [SQL Interview questions](SQL.md)
#### [Python Interview questions](PYTHON.md)
#### [DJANGO Interview questions](DJANGO.md)
## HTML Interview Questions
### Q1. What is HTML?
##### HTML stands for HyperText Markup Language. It is a standard markup language used for creating web pages and web applications.
### Q2. What are the basic elements of HTML?
##### The basic elements of HTML are:
* <html>: Defines the start and end of an HTML document.
* <head>: Contains meta information about the document such as title, keywords, etc.
* <body>: Contains the content of the document that is visible to the user.
* <title>: Defines the title of the document that appears in the browser's title bar.
### Q3. What is the difference between HTML and XHTML?
##### HTML and XHTML are both markup languages used for creating web pages. The main difference between the two is that HTML is an SGML-based language, whereas XHTML is an XML-based language. This means that XHTML is stricter and requires all elements to be properly closed, while HTML allows for some flexibility in this regard.
### Q4. What is the difference between <div> and <span>?
##### Both <div> and <span> are used as containers for other HTML elements. The main difference between the two is that <div> is a block-level element, while <span> is an inline element. This means that <div> creates a new line and takes up the full width of its parent element, while <span> does not create a new line and only takes up as much space as its contents require.
### Q5. What is the purpose of the alt attribute in an `<img>` tag?
##### The alt attribute in an `<img>` tag is used to provide alternative text for the image in case it cannot be displayed. This can be due to a slow internet connection, a broken image link, or for accessibility purposes for users with visual impairments. The alt text should describe the content of the image in a concise and meaningful way.
### Q6. What is the difference between a class and an ID in HTML?
##### Both classes and IDs are used to identify specific HTML elements. The main difference between the two is that a class can be used to apply styles to multiple elements, while an ID should only be used to identify a single unique element. Additionally, an ID must be unique within the document, while a class can be used multiple times.
### Q7. What is the purpose of the `<form>` element in HTML?
##### The `<form>` element is used to create a form on a web page that allows users to input data. It can contain various types of input elements such as text boxes, checkboxes, radio buttons, and submit buttons. The data entered by the user can be sent to a server-side script for processing using the action attribute.
### Q8. What is the purpose of the `<meta>` element in HTML?
##### The `<meta>` element is used to provide metadata about the HTML document. This includes information such as the document's author, keywords, description, and character encoding. This metadata is used by search engines to better index the page, and by browsers to display the page correctly.
### Q9. What is the purpose of the `<link>` element in HTML?
##### The `<link>` element is used to link to external resources such as stylesheets, scripts, and other web pages. It can be used to define the relationship between the current document and the linked resource using the rel attribute.
### Q10. What is the purpose of the target attribute in an `<a>` tag?
### The target attribute in an `<a>` tag is used to specify where the linked document should be displayed when clicked. It can be
# CSS Interview Questions
### 1. What is CSS?
##### Answer: CSS stands for Cascading Style Sheets. It is a style sheet language that is used to describe the look and formatting of a document written in HTML.
### What are the advantages of using CSS?
##### Answer: CSS allows for a separation of presentation and content, making it easier to maintain and update styles across a website. It also allows for greater control over the layout and design of a website, making it more user-friendly and accessible.
### 2. What is the syntax of a CSS rule?
##### Answer: A CSS rule consists of a selector and a declaration block. The selector identifies the HTML element that the rule applies to, and the declaration block contains one or more declarations, which specify the style properties and values for the selected element.
### What are selectors in CSS?
##### Answer: Selectors are used to target specific HTML elements in order to apply styling rules. They can be based on element type, class, ID, attribute, or any combination of these.
### What is the box model in CSS?
##### Answer: The box model is a way of representing an HTML element as a rectangular box with content, padding, borders, and margins. The width and height of the box are determined by the content, and the padding, borders, and margins are added to the outside of the content box.
### What is the difference between margin and padding in CSS?
##### Answer: Margin refers to the space between an element and its neighboring elements, while padding refers to the space between an element's content and its borders.
### What is the difference between inline and block elements in CSS?
##### Answer: Inline elements flow within the text of a document and do not create line breaks, while block elements create a new line and take up the full width of their parent container.
### What is the "float" property in CSS?
##### Answer: The float property is used to specify whether an element should be floated to the left or right of its container. It is commonly used for creating multi-column layouts.
### What is a CSS framework?
##### Answer: A CSS framework is a pre-written set of CSS styles and rules that can be used to quickly and easily build websites or web applications. It typically includes a grid system, pre-built UI components, and other useful features.
### What are media queries in CSS?
##### Answer: Media queries are used to apply different styles to a document based on the device or screen size that it is being viewed on. They allow for responsive design, which can adapt to different screen sizes and resolutions.
# JavaScript Interview Questions and Answers
### 1. What is JavaScript?
##### JavaScript is a high-level programming language that is often used in web development to create interactive and dynamic websites. It is an object-oriented language that supports a wide range of features such as functions, arrays, objects, and loops.
### 2. What is the difference between == and === operators in JavaScript?
##### The '==' operator compares two values for equality, but it does not take into account their data types. On the other hand, the '===' operator compares two values for equality and also checks their data types.
```javascript
console.log(1 == '1'); // true
console.log(1 === '1'); // false
```
### 3. What are closures in JavaScript?
##### Closures are functions that have access to the variables defined in their outer function, even after the outer function has returned. Closures are often used to create private variables in JavaScript.
```javascript
function outerFunction() {
var outerVariable = 'I am outer';
function innerFunction() {
console.log(outerVariable);
}
return innerFunction;
}
var innerFunctionRef = outerFunction();
innerFunctionRef(); // Output: I am outer
```
### 4. What is the difference between null and undefined in JavaScript?
##### In JavaScript, 'null' is a value that represents the intentional absence of any object value, whereas 'undefined' is a value that represents the absence of any value.
```javascript
var variable1; // undefined
var variable2 = null; // null
```
### 5. What is the 'this' keyword in JavaScript?
##### The 'this' keyword in JavaScript refers to the object that is currently executing the code. The value of 'this' can change depending on how a function is called.
```javascript
var person = {
firstName: 'Md. Rumon',
lastName: 'Khan',
fullName: function() {
console.log(this.firstName + ' ' + this.lastName);
}
};
person.fullName(); // Output: Md. Rumon Khan
```
### 6. What is a callback function in JavaScript?
##### A callback function is a function that is passed as an argument to another function and is called when the parent function has finished executing. Callback functions are often used to handle asynchronous operations in JavaScript.
```javascript
function fetchData(callback) {
// Simulate an asynchronous operation
setTimeout(function() {
var data = { name: 'Rumon', age: 21 };
callback(data);
}, 1000);
}
fetchData(function(data) {
console.log(data); // Output: { name: 'Rumon', age: 21 }
});
```
### 7. What is the difference between let and var in JavaScript?
##### The 'let' keyword was introduced in ES6 and is used to declare variables with block scope. On the other hand, the 'var' keyword is used to declare variables with function scope.
```javascript
if (true) {
var variable1 = 'I am var';
let variable2 = 'I am let';
}
console.log(variable1); // Output: I am var
console.log(variable2); // Throws ReferenceError: variable2 is not defined
```
### 8. What is the use of the 'use strict' directive in JavaScript?
##### The 'use strict' directive is used to enforce stricter parsing and error handling in JavaScript. When used, it enables a stricter mode of execution and disallows certain actions that are allowed in non-strict mode.
```javascript
'use strict';
x = 3.14; // Throws ReferenceError
```
# MongoDB Interview Questions
### Question 1: What is MongoDB?
##### Answer: MongoDB is a popular open-source NoSQL document-oriented database program. It stores data in flexible, JSON-like documents, meaning fields can vary from document to document and data structure can be changed over time.
### Question 2: What are the advantages of using MongoDB?
##### Answer:
* High Performance and Scalability
* Dynamic Schema
* High Availability and Automatic Sharding
* Rich Query Language
* Indexing Support
* Document-Oriented Storage
* Flexible Data Model
### Question 3: What is a replica set in MongoDB?
##### Answer: A replica set is a group of MongoDB servers that maintain the same data set. It provides redundancy and high availability, allowing for automatic failover and recovery in case of server failure. In a replica set, one server is designated as the primary node, and the others are secondary nodes.
### Question 4: What is sharding in MongoDB?
##### Answer: Sharding is a technique used to horizontally scale MongoDB databases across multiple servers. It divides a large collection into smaller, more manageable chunks called shards, which are distributed across multiple servers. This helps to improve performance, scalability and availability of the database.
### Question 5: How do you connect to MongoDB using Node.js?
##### Answer: To connect to MongoDB using Node.js, you need to use a MongoDB driver. Here's an example of how to connect to a MongoDB server using the mongodb driver in Node.js:
``` javascript
const MongoClient = require('mongodb').MongoClient;
const uri = 'mongodb://localhost:27017/mydb';
MongoClient.connect(uri, function(err, client) {
if (err) throw err;
const db = client.db('mydb');
console.log('Connected to MongoDB!');
client.close();
});
In this example, we're connecting to a MongoDB server running on localhost on port 27017 and opening a database called mydb. We then log a message to the console and close the connection.
```
### Question 6: How do you create a collection in MongoDB?
##### Answer: To create a collection in MongoDB, you can use the createCollection method. Here's an example:
``` javascript
const MongoClient = require('mongodb').MongoClient;
const uri = 'mongodb://localhost:27017/mydb';
MongoClient.connect(uri, function(err, client) {
if (err) throw err;
const db = client.db('mydb');
db.createCollection('customers', function(err, res) {
if (err) throw err;
console.log('Collection created!');
client.close();
});
});
In this example, we're creating a collection called customers in the mydb database. If the collection already exists, the createCollection method will not create a new collection.
```
### Question 7: How do you insert documents into a collection in MongoDB?
##### Answer: To insert documents into a collection in MongoDB, you can use the `insertOne` or `insertMany` method.
# Express Interview Questions
### Question 1: What is Express.js?
##### Answer: Express.js is a popular web application framework for Node.js that provides a set of robust features for building web and mobile applications. It is built on top of Node.js and offers a simple, yet powerful set of tools for building HTTP servers, handling routes, middleware, and much more.
### Question 2: What is middleware in Express.js?
##### Answer: Middleware in Express.js is a series of functions that are executed sequentially during the request-response cycle of an HTTP request. Each middleware function can modify the request and response objects, and can pass control to the next middleware function in the chain.
### Question 3: How to handle routing in Express.js?
##### Answer: Routing in Express.js is handled using the express.Router() method. This method returns an instance of a router, which can be used to define routes for the application. Here's an example of how to define a simple route using the router:
```javascript
const express = require('express')
const router = express.Router()
router.get('/', (req, res) => {
res.send('Hello, World!')
})
module.exports = router
```
### Question 4: How to handle errors in Express.js?
##### Answer: Errors in Express.js can be handled using middleware functions that have four arguments instead of the usual three. The additional argument is an error object that contains information about the error that occurred. Here's an example of an error handling middleware:
```javascript
app.use((err, req, res, next) => {
console.error(err.stack)
res.status(500).send('Something broke!')
})
```
### Question 5: How to use templates in Express.js?
##### Answer: Templates in Express.js can be used to generate HTML dynamically on the server-side. Popular templating engines for Express.js include EJS, Handlebars, and Pug. Here's an example of how to use EJS in Express.js:
```javascript
const express = require('express')
const app = express()
app.set('view engine', 'ejs')
app.get('/', (req, res) => {
res.render('index', { name: 'John' })
})
app.listen(3000, () => {
console.log('Server listening on port 3000')
})
This code sets the view engine to EJS, defines a route that renders an EJS template called index, and passes an object with the property name set to 'John' to the template.
```
# React Interview Questions
### What is React.js and why is it used?
##### React.js is an open-source JavaScript library used for building user interfaces or UI components. It is used because it allows developers to create reusable UI components and update the UI components in real-time without having to reload the entire web page.
```javascript
Code Example:
A simple React component that renders a button:
import React from 'react';
function Button(props) {
return <button onClick={props.onClick}>{props.text}</button>;
}
```
### What is JSX in React?
##### JSX stands for JavaScript XML, which is an extension to the JavaScript language syntax that allows developers to write HTML-like code in their JavaScript files. JSX makes it easier to create and manipulate UI elements in React.
```javascript
Code Example:
A simple example of JSX syntax:
import React from 'react';
function Hello() {
return (
<div>
<h1>Hello, world!</h1>
<p>Welcome to my React app.</p>
</div>
);
}
```
### What is the virtual DOM in React?
##### The virtual DOM is a JavaScript representation of the actual DOM (Document Object Model) that React uses to optimize rendering performance. When a change is made to the virtual DOM, React compares the new virtual DOM with the old virtual DOM and only updates the parts that have changed, which makes the process faster and more efficient.
```javascript
Code Example:
A simple example of updating the virtual DOM in React:
import React, { useState } from 'react';
function Counter() {
const [count, setCount] = useState(0);
function handleClick() {
setCount(count + 1);
}
return (
<div>
<p>You clicked {count} times.</p>
<button onClick={handleClick}>Click me!</button>
</div>
);
}
```
### What is the difference between a class component and a functional component in React?
##### A class component is a React component that extends the React.Component class and defines a render method that returns a React element. A functional component is a React component that is defined as a function that returns a React element.
```javascript
Code Example:
A simple class component and functional component in React:
import React from 'react';
// Class Component
class Greeting extends React.Component {
render() {
return <h1>Hello, {this.props.name}!</h1>;
}
}
// Functional Component
function Greeting(props) {
return <h1>Hello, {props.name}!</h1>;
}
```
### What is Redux in React and why is it used?
##### Redux is a state management library for React that allows developers to manage application state in a predictable way. It is used to store the global state of an application and makes it easier to share state between different components.
# Node Interview Questions
### Q1: What is Node.js?
##### A: Node.js is an open-source, cross-platform JavaScript runtime environment that allows developers to run JavaScript on the server-side. It is built on top of the V8 JavaScript engine from Google Chrome and provides an event-driven, non-blocking I/O model that makes it lightweight and efficient.
### Q2: What is the difference between Node.js and other server-side frameworks like Ruby on Rails and Django?
##### A: Node.js differs from traditional server-side frameworks like Ruby on Rails and Django in several ways:
* Node.js is built on top of the V8 JavaScript engine, while Ruby on Rails is built on top of the Ruby language and Django is built on top of Python. This means that Node.js is much faster and more efficient than these frameworks.
* Node.js is event-driven and non-blocking, while Ruby on Rails and Django are blocking frameworks. This means that Node.js can handle large amounts of I/O operations without slowing down or blocking the server.
* Node.js is designed to handle real-time, data-intensive applications like chat apps and streaming services, while Ruby on Rails and Django are better suited for building traditional web applications.
### Q3: What is callback hell in Node.js and how can it be avoided?
##### A: Callback hell is a common issue in Node.js where nested callbacks can become difficult to read and maintain. It can be avoided by using promises, async/await, or a library like Async.js.
```javascript
Here's an example of using promises to avoid callback hell:
function getUsers() {
return new Promise((resolve, reject) => {
db.query('SELECT * FROM users', (err, result) => {
if (err) {
reject(err);
} else {
resolve(result);
}
});
});
}
function getUserById(id) {
return new Promise((resolve, reject) => {
db.query('SELECT * FROM users WHERE id = ?', [id], (err, result) => {
if (err) {
reject(err);
} else {
resolve(result);
}
});
});
}
getUsers()
.then((users) => {
return getUserById(users[0].id);
})
.then((user) => {
console.log(user);
})
.catch((err) => {
console.error(err);
});
```
### Q4: What is middleware in Node.js and how is it used?
##### A: Middleware in Node.js is a function that receives the request and response objects, and the next middleware function in the application's request-response cycle. It can be used to modify the request or response objects, or to perform other tasks like logging, authentication, and error handling.
```javascript
Here's an example of a middleware function that logs the request method and URL:
function logMiddleware(req, res, next) {
console.log(`[${req.method}] ${req.url}`);
next();
}
app.use(logMiddleware);
```
### Q5: How can you handle errors in Node.js?
##### A: Errors in Node.js can be handled using try-catch blocks, or by using the error handling middleware function in Express.
```javascript
Here's an example of using try-catch blocks to handle errors:
try {
const result = someFunction();
console.log(result);
} catch (err) {
console.error(err);
}
```
# MEEN Stack Interview Questions
### What is MERN stack?
##### MERN stack is a popular web development stack that consists of four main components: MongoDB, Express.js, React.js, and Node.js. MongoDB is used as the database, Express.js is used as the web application framework, React.js is used for the user interface, and Node.js is used as the server-side runtime environment.
### What is the difference between React and Angular?
##### React is a JavaScript library for building user interfaces, while Angular is a full-fledged framework for building complex web applications. React relies on a component-based architecture, whereas Angular relies on a modular architecture.
### What is JSX in React?
##### JSX stands for JavaScript XML, and it is a syntax extension for JavaScript that allows you to write HTML-like code in your JavaScript files. JSX is used in React to define the structure of the user interface.
### What is a virtual DOM in React?
##### The virtual DOM is a lightweight representation of the actual DOM in memory. It is used by React to optimize the performance of updates to the user interface. When a change is made to the virtual DOM, React compares it to the previous version of the virtual DOM and only updates the parts that have changed, rather than re-rendering the entire user interface.
### What is Express.js?
##### Express.js is a popular web application framework for Node.js. It provides a simple and flexible way to handle HTTP requests and responses, as well as middleware for handling common tasks such as authentication and error handling.
### What is middleware in Express.js?
##### Middleware is a function that sits between the client and the server in an Express.js application. It can perform tasks such as authentication, logging, and error handling, and it can modify the request and response objects before they are sent back to the client.
### What is Node.js?
##### Node.js is a server-side runtime environment for JavaScript. It allows you to run JavaScript on the server, which enables you to build scalable and high-performance web applications.
### What is MongoDB?
##### MongoDB is a popular NoSQL database that uses a document-oriented data model. It stores data in flexible JSON-like documents, which makes it easy to work with data that has a complex and dynamic structure.
### What is the difference between SQL and NoSQL databases?
##### SQL databases use a structured data model, which means that data is stored in tables with predefined columns and rows. NoSQL databases use a document-oriented data model, which means that data is stored in flexible JSON-like documents.
### What is RESTful API?
##### A RESTful API is an architectural style for building web APIs. It uses HTTP methods such as GET, POST, PUT, and DELETE to perform CRUD (create, read, update, delete) operations on resources, and it uses URLs to identify the resources. A RESTful API is stateless, which means that each request contains all the information necessary to complete the request.
```
I hope these answers help you prepare for your MERN stack web developer interview! Good luck!
``` | Master Your Full Stack Interview with Hand-Picked Questions, Answers, and Examples! Boost Your Confidence, Sharpen Your Skills, and Ace Your Interview. Perfect for Busy Software Engineers Looking to Learn, Practice, and Conquer Their Interviews! | css,html,javascript,nodejs,reatctjs | 2023-03-27T14:20:22Z | 2023-08-13T16:29:01Z | null | 1 | 0 | 50 | 0 | 3 | 21 | null | MIT | null |
codingstella/starbuck-landing-page | main | <html>
<head> </head> <body> <h1 align = center> Display</h1> <img src = "img/Display.png"> </body>
</html>
| null | html,starbucks-landing-page,css,cssprojects,htmlproject,javascript,javascriptprojects,starbucks-clone | 2023-04-07T12:54:14Z | 2023-04-07T12:58:50Z | null | 1 | 0 | 1 | 0 | 7 | 20 | null | null | CSS |
Silent-Watcher/dictionary | master |
# Dictionary Web Application
This is a dictionary web application that allows users to search for word definitions. The application is built using HTML, CSS, and JavaScript, and utilizes the Vite bundler and Yarn as the package manager. The application is hosted on Netlify.
<p dir="auto"><a href="https://github.com/sindresorhus/awesome"><img src="https://camo.githubusercontent.com/abb97269de2982c379cbc128bba93ba724d8822bfbe082737772bd4feb59cb54/68747470733a2f2f63646e2e7261776769742e636f6d2f73696e647265736f726875732f617765736f6d652f643733303566333864323966656437386661383536353265336136336531353464643865383832392f6d656469612f62616467652e737667" alt="Awesome" data-canonical-src="https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg" style="max-width: 100%;"></a> <a href="https://github.com/chetanraj/awesome-github-badges"><img src="https://camo.githubusercontent.com/ff817852f0d676a36eaa3108d380e0052e689d9e0bc3eb42818fb21008708420/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4d616465253230576974682d4c6f76652d6f72616e67652e737667" alt="Made With Love" data-canonical-src="https://img.shields.io/badge/Made%20With-Love-orange.svg" style="max-width: 100%;"></a></p>
## Table of Contents
- [Features](https://github.com/Silent-Watcher/dictionary#features)
- [demo](https://github.com/Silent-Watcher/dictionary#demo)
- [preview](https://github.com/Silent-Watcher/dictionary#preview)
- [Prerequisites](https://github.com/Silent-Watcher/dictionary#Prerequisites)
- [Installation](https://github.com/Silent-Watcher/dictionary#Installation)
- [usage](https://github.com/Silent-Watcher/dictionary#usage)
- [Deployment](https://github.com/Silent-Watcher/dictionary#deployment)
- [Acknowledgements](https://github.com/Silent-Watcher/dictionary#Acknowledgements)
- [Feedback](https://github.com/Silent-Watcher/dictionary#Feedback)
- [License](https://github.com/Silent-Watcher/dictionary#License)
## Features
- User-friendly interface for searching word definitions.
- Quick and responsive search results.
- Intuitive navigation for browsing multiple definitions.
- Clean and modern design.
- Fully responsive on all devices.
## Demo
### netlify
https://dictionary-app-dev.netlify.app/
### GitHub pages
https://silent-watcher.github.io/dictionary/
<p>
[](https://stackblitz.com/github/Silent-Watcher/dictionary)
</p>
## Preview
<img src='https://iili.io/HSvabx2.png'>
## Prerequisites
In order to run this project, you will need to have the following installed on your computer:
- nodejs
- yarn | npm
## Installation
To install the application, follow these steps:
1. Clone the repository to your local machine:
```bash
git clone https://github.com/Silent-Watcher/dictionary
```
2. Navigate to the project directory in your terminal.
```bash
cd dictionary
```
3. Run `yarn` to install the necessary packages.
```bash
yarn
```
## usage
To start the application, run `yarn dev`. This will start the application on `http://localhost:5173`.
```bash
yarn dev
```
## Deployment
To deploy the application, follow these steps:
1. Create an account on Netlify.
2. Create a new site in Netlify.
3. Link the site to your GitHub repository.
4. Set the build command to `yarn build`.
5. Set the publish directory to `dist`.
6. Deploy the site.
## Acknowledgements
- [The build tool and development server.](https://vitejs.dev/)
- [ The API used in the project.](https://dictionaryapi.dev/)
- [The package manager used in the project.](https://yarnpkg.com/)
## Feedback
If you have any feedback, please reach out to us at alitabatabaee20@gmail.com
## License
[MIT](https://choosealicense.com/licenses/mit/)
This project is licensed under the MIT License. See the LICENSE file for details.
<a target="_blank" rel="noopener noreferrer nofollow" href="https://camo.githubusercontent.com/6038c8f1fd8f60de75477470e5a87210e9256202e01dfba9986446304a0f0254/68747470733a2f2f63617073756c652d72656e6465722e76657263656c2e6170702f6170693f747970653d776176696e6726636f6c6f723d6772616469656e74266865696768743d36302673656374696f6e3d666f6f746572"><img src="https://camo.githubusercontent.com/6038c8f1fd8f60de75477470e5a87210e9256202e01dfba9986446304a0f0254/68747470733a2f2f63617073756c652d72656e6465722e76657263656c2e6170702f6170693f747970653d776176696e6726636f6c6f723d6772616469656e74266865696768743d36302673656374696f6e3d666f6f746572" data-canonical-src="https://capsule-render.vercel.app/api?type=waving&color=gradient&height=60&section=footer" style="max-width: 100%;"></a>
| 👻 This is a dictionary web application that allows users to search for word definitions. Leave a star before you leave ⭐ | css,html-css-javascript,html5,dictionary,dictionary-application,javascript,kursorjs,vite,vitejs,yarn | 2023-03-27T13:17:53Z | 2023-10-08T14:02:23Z | 2023-04-17T13:50:07Z | 2 | 9 | 49 | 0 | 3 | 20 | null | MIT | JavaScript |
Mohamad-Khalid/Resume-Creator | main | # Resume-Creator
### About the Project
This is web application to create a resume easily by filling forms and preview the output and you can download as a pdf file.
### Tech stack
- `JavaScript`
- `Bootstrap`
- `CSS`
- `HTML`
### How to use
- To add section click on the button and fill the form.
- Submit the form and show the info in the preview section.
- If you want to edit anything click on it and edit in the form then submit.
- You can preview and Download as PDF file.
- To download click on preview and download pdf button.
- Choose save as pdf.
- You can customize PDF output properties such as margin and scale.
- You can use the website on different devices
### Screenshots
https://user-images.githubusercontent.com/61889578/230498211-1f729212-d171-4260-982e-d833ea314b9d.mp4
#### This is an example
### Live Preview
Feel free to visit [Resume Creator website](https://mohamad-khalid.github.io/Resume-Creator/) , try it and send me feedback.
### Updates
- Update #1
- Reorder the sections as you want.
- Edit anything you entered , just click on it.
- Prevent page reload while typing or editing.
- Fixed preview and download on mobile issue.
- Improved user interface.
### Future work
- Make the application more interactive with the user.
- Working on server side.
- Make real time writing preview.
- Add extra features
| This is Resume Creator | bootstrap,css3,html5,javascript | 2023-04-06T11:33:15Z | 2023-07-09T11:37:08Z | null | 1 | 0 | 28 | 0 | 4 | 19 | null | null | JavaScript |
jooonathann/playlistShuffle | main | Live at: https://shuffle-playlist.vercel.app/
# Playlist Shuffle - A web application to Shuffle your Youtube Playlist
Playlist Shuffle - A web application with a better algorithm than YouTube's for playlist shuffling. Shuffle your music and videos in a smarter way and enjoy an improved listening experience.
## How to combine multiple playlist
The maximum playlist size is "12000"
To combine multiple playlist you need to separate the playlist with a comma and add ", name:" at the end with the name you want the playlist to be called.
These are valid ways to mix playlists on the Search Bar:
# With the full playlist URL
https://www.youtube.com/playlist?list=PLH9twT5faHZX6hcW5fl-_WtsV2lMWbtjX, https://www.youtube.com/playlist?list=PL_dT1kMRpJEQyewQehX8LWYxve3iktijD, https://www.youtube.com/playlist?list=PLi06ybkpczJBvFfOhfqDyKMl1Lp2tDkTb, name:new playlist MIX with URL's
# With playlist ID's.
PLH9twT5faHZX6hcW5fl-\_WtsV2lMWbtjX, PL_dT1kMRpJEQyewQehX8LWYxve3iktijD, PLi06ybkpczJBvFfOhfqDyKMl1Lp2tDkTb, name:new playlist MIX with ID's
# Or with ID's and URL's
- After that you can shuffle the playlist
- If you put the wrong ID or URL it will ignore it and combine the others, so check the URL or ID
- If you sort the playlist by default the first video of each playlist will go first, PLA1, PLB1, PLC1, PLA2, PLB2, PLC3 and so on
## Key shortcuts
- "1", "2", "3", "4", "5", "6", "7", "8", "9" keys to seek at a different percentage of the video.
- "S" toggle to activate and deactivate shuffle on a playlist.
- "R" toggle to repeat the video until is deactivated again.
- "M" toggle to mute and unmute the video
- "Space" to pause and play the video.
- "ArrowLeft" to play the previous video.
- "ArrowRight" to play the next video.
- "ArrowUp" to turn the volume up by a 1/20
- "ArrowDown" to turn the volume down by a 1/20
## Uses mersenne-twister to randomize the videos
https://www.npmjs.com/package/mersenne-twister
| A web application to shuffle/randomize playlist of Youtube | playlist,algorithm,javascript,persist,randomizer,react,redux,shuffle,videos,youtube | 2023-03-31T11:18:50Z | 2024-05-14T01:29:04Z | null | 1 | 2 | 268 | 1 | 0 | 19 | null | null | JavaScript |
lacegiovanni17/dk-js-portfolio-website | main | # dk-js-portfolio-website
### [Live Site](https://dk-js-portfolio-website.vercel.app/)
https://user-images.githubusercontent.com/30509335/229765023-376c0127-713b-43f0-95dc-1acbe28a86a5.mov
## About
* 👋 Hi, I’m Chidike Henry
* 😎 I’m a web developer
* 💻 This is a personal portfolio website made with HTML, CSS and JS.
* 🌍 Website: https://dk-js-portfolio-website.vercel.app/
* 💞️ I’m looking to collaborate on JS projects
* 📫 How to reach me chidike.henry@gmail.com
## Technologies Used
* CSS
* HTML
* GitHub
* JavaScript
## Author
#### 👤 Author1
- GitHub: [@lacegiovanni17]https://github.com/lacegiovanni17
- Twitter: [@ChidikeC] https://twitter.com/ChidikeC
- LinkedIn: [LinkedIn]https://www.linkedin.com/in/chidike-chizoba-25628a40/
## Contributing
Contributions, issues, and feature requests are welcome!
## Show your support
Please give a ⭐️ if you like this project!
## Acknowledgments
- Hat tip to anyone contributed one way or the other.
- Inspiration
- etc
| 💻 This is a personal portfolio website made with HTML, CSS and JS. | animation,css,html,icons,javascript,portfolio,portfolio-website,scrollreveal-js | 2023-03-28T17:05:07Z | 2023-04-09T15:41:31Z | null | 1 | 32 | 74 | 0 | 1 | 19 | null | null | HTML |
toshydev/inspot | main | 
# inSpot
## What is inSpot?
**inSpot** is a nearby event finder which can filter events by genres and tags and informs the user about the distance as well as the time left until the start of events.
### The idea of inSpot
Whether you're going to a __concert__, an __exhibition__, a __sports__ game or a __theater__ play, you need to know the venue address, when the event starts and where to get the tickets. Instead of looking for the information on the corresponding websites, check **inSpot**. It will give you the most important details to keep you posted on the event in just a few clicks.
## How to use
**inSpot** is easy to use and optimized for mobile devices.
1. Click on the location 
icon in the upper right corner and set your location by entering a place or let **inSpot** use the GPS function of your device.
2. Let **inSpot** recommend events near you on by clicking on the __home__ 
icon in the bottom nav bar.
3. If you're looking for venues, click the __venues__ 
icon in the bottom nav bar to see a list of venues or to search for venues by keywords in the top search bar.
4. You want to filter events by categories or keywords? Click the __events__ 
icon to get to the __explore__ page where you can set filters and/or tags in the top filter section.
5. Found an event or venue you like? Save it by clicking the heart 
. Your saved items will appear in the __Saved__ section which you can find by clicking the upper right __bookmark__ 
icon. Filter this list by events or venues.
6. See your next upcoming events in your __profile__ section by clicking on the __profile__ 
icon in the right corner of the bottom nav bar.
7. If you want to personalise your **inSpot** experience, log in with your favorite provider on the __profile__ page by As a logged in user you can rate venues by writing reviews. Are you unhappy with your review? Edit or delete it.
8. What about my data? **inSpot** only saves the data it needs to verify who you are and will never share this data with anyone. Like a blackbox! Still not safe enough? Delete your login data and reviews by clicking on the `Delete data` button in the __profile__ section.
## Development
**inSpot** uses the following Tech Stack:
- React
- Next.js
- TypeScript
- styled-components
- Jest
- React Testing Library
- Auth.js
- Node.js
- MongoDB Atlas
- mongoose
- SWR
- zustand
- Rest API
- Ticketmaster API
- Google Maps API
### Getting Started
- Clone this repository
- Set up a MongoDB server
- Get your Ticketmaster API key from [Ticketmaster API](https://developer.ticketmaster.com/products-and-docs/apis/getting-started/)
- Get your Google Maps API key from [Google API Explorer](https://developers.google.com/apis-explorer)
- Set up your own .env.local file with your API keys
- Install all dependencies with `npm install`
- Run your development server with `npm run dev`
- Server: [http://localhost:3000/](http://localhost:3000/)
- Run tests via `npm run test`
### How do I contribute?
There are many ways to contribute to **inSpot**:
- Share your thoughts in the [inSpot Discussions](https://github.com/toshydev/inspot/discussions) to share your ideas about how **inSpot** can be improved!
- Submit a typo/bug or your feature idea in [inSpot Issues](https://github.com/toshydev/inspot/issues).
- Submit a Pull Request for an existing Issue.
Whether you are a code newbie or a seasoned hacker, there's something for you!
Please read through the [Contribution Guide](https://github.com/toshydev/inspot/blob/main/CODE_OF_CONDUCT.md) ✨. There you'll find a write-up of our content standards and templates for creating your entries.
| Nearby event finder which can filter events by genres and tags and informs the user about the distance as well as the time left until the start of events. | events,finder,google-maps-api,javascript,jest,mongodb-atlas,mongoose,next-auth,nextjs,nodejs | 2023-03-31T07:58:58Z | 2023-08-18T13:35:24Z | 2023-05-02T12:46:09Z | 3 | 26 | 185 | 4 | 1 | 19 | null | GPL-3.0 | TypeScript |
alexjdean/type-scriptor | main | # type-scriptor
`type-scriptor` is an NPM package CLI tool that uses ChatGPT to improve your JavaScript and TypeScript code. It helps you write better code by automatically generating documentation, refactoring code to improve performance and maintainability, adding unit tests using Jest, and converting JavaScript code to TypeScript.
All the unit tests for this project were generated using this very tool!
## Table of Contents
- [Features](#features)
- [Installation](#installation)
- [Setting Up Your API Key](#setting-up-your-api-key)
- [Usage](#usage)
- [Generate Documentation](#generate-documentation)
- [Convert to TypeScript](#convert-to-typescript)
- [Refactor Code](#refactor-code)
- [Generate Unit Tests](#generate-unit-tests)
- [Display Help](#display-help)
- [Display Version](#display-version)
- [Examples](#examples)
- [Documentation](#documentation)
- [JavaScript to TypeScript](#javascript-to-typescript)
- [Refactoring](#refactoring)
- [Unit Tests](#unit-tests)
- [Contributing](#contributing)
- [License](#license)
## Features
`type-scriptor` provides the following features:
- Automatically generate documentation for your JavaScript or TypeScript code using ChatGPT.
- Refactor your code to improve performance, code quality, modularity, and maintainability.
- Convert JavaScript code to TypeScript.
- Generate unit tests using Jest.
## Installation
`type-scriptor` only supports Node versions 16 and 18. If you're using version 16, run the following command:
```bash
npm install -g type-scriptor
```
If you're using Node version 18, run the following command:
```bash
npm install -g type-scriptor@1.1.0
```
This will install `type-scriptor` globally on your system, making it available as a command-line tool.
## Setting Up Your API Key
Before using type-scriptor, you need to save your OpenAI API key. If you don't have an API key, get one from [OpenAI's API key page](https://platform.openai.com/account/api-keys).
To save your API key, run:
```bash
type-scriptor -k API_KEY
```
Replace `API_KEY` with your actual OpenAI API key.
## Usage
In all examples below, replace `FILE_PATH` with the relative path to the file you want to use.
### Generate Documentation
To generate documentation and type annotations for a given file, run:
```bash
type-scriptor -f FILE_PATH -d
```
### Convert to TypeScript
To convert a file to TypeScript and generate documentation, run:
```bash
type-scriptor -f FILE_PATH --to-ts
```
### Refactor Code
To refactor a file, add documentation, and improve code performance, run:
```bash
type-scriptor -f FILE_PATH -r
```
### Generate Unit Tests
To generate unit tests for a given file using Jest, run:
```bash
type-scriptor -f FILE_PATH -t
```
### Display Help
To display help instructions, run:
```bash
type-scriptor -h
```
### Display Version
To display the current version of `type-scriptor`, run:
```bash
type-scriptor -v
```
## Examples
### Documentation
Suppose you have the following spaceship-themed codebase:
```javascript
// spaceship.js
class Spaceship {
constructor(name, crewSize) {
this.name = name;
this.crewSize = crewSize;
this.speed = 0;
this.fuel = 100;
}
accelerate(amount) {
this.speed += amount;
this.consumeFuel(amount);
}
decelerate(amount) {
this.speed = Math.max(this.speed - amount, 0);
this.consumeFuel(amount);
}
consumeFuel(amount) {
this.fuel = Math.max(this.fuel - (amount / 10), 0);
}
refuel(amount) {
this.fuel = Math.min(this.fuel + amount, 100);
}
boardCrew(crewMembers) {
this.crewSize += crewMembers;
}
disembarkCrew(crewMembers) {
this.crewSize = Math.max(this.crewSize - crewMembers, 0);
}
}
function createSpaceship(name, crewSize) {
return new Spaceship(name, crewSize);
}
function distanceBetweenPlanets(planetA, planetB) {
const distance = Math.sqrt(Math.pow((planetB.x - planetA.x), 2) + Math.pow((planetB.y - planetA.y), 2));
return distance;
}
function calculateTravelTime(distance, speed) {
return distance / speed;
}
module.exports = {
Spaceship,
createSpaceship,
distanceBetweenPlanets,
calculateTravelTime
};
```
Using the `type-scriptor -f spaceship.js -d` command, our code becomes well-documented and clear to understand. We make it easier for new engineers to get up to speed on the functionality of a given codebase.
```javascript
/**
* Spaceship class representing a spaceship object.
* @class
*/
class Spaceship {
/**
* Creates a Spaceship object.
* @constructor
* @param {string} name - The name of the spaceship.
* @param {number} crewSize - The number of crew members in the spaceship.
*/
constructor(name, crewSize) {
this.name = name;
this.crewSize = crewSize;
this.speed = 0;
this.fuel = 100;
}
/**
* Increases the speed of the spaceship and consumes fuel.
* @param {number} amount - The amount by which to increase the speed.
* @returns {void}
*/
accelerate(amount) {
this.speed += amount;
this.consumeFuel(amount);
}
/**
* Decreases the speed of the spaceship and consumes fuel.
* The spaceship speed can't go below 0.
* @param {number} amount - The amount by which to decrease the speed.
* @returns {void}
*/
decelerate(amount) {
this.speed = Math.max(this.speed - amount, 0);
this.consumeFuel(amount);
}
/**
* Reduces the fuel of the spaceship by a calculated amount.
* @param {number} amount - The amount of speed by which to reduce the fuel.
* @returns {void}
*/
consumeFuel(amount) {
this.fuel = Math.max(this.fuel - (amount / 10), 0);
}
/**
* Refuels the spaceship with the given amount of fuel.
* The maximum fuel allowed is 100.
* @param {number} amount - The amount of fuel to refuel.
* @returns {void}
*/
refuel(amount) {
this.fuel = Math.min(this.fuel + amount, 100);
}
/**
* Increases the crew size of the spaceship.
* @param {number} crewMembers - The number of crew members to add.
* @returns {void}
*/
boardCrew(crewMembers) {
this.crewSize += crewMembers;
}
/**
* Decreases the crew size of the spaceship.
* Cannot go below 0 crew members.
* @param {number} crewMembers - The number of crew members to remove.
* @returns {void}
*/
disembarkCrew(crewMembers) {
this.crewSize = Math.max(this.crewSize - crewMembers, 0);
}
}
/**
* Creates a new instance of Spaceship.
* @param {string} name - The name of the spaceship.
* @param {number} crewSize - The number of crew members in the spaceship.
* @returns {Spaceship} A new instance of Spaceship.
*/
function createSpaceship(name, crewSize) {
return new Spaceship(name, crewSize);
}
/**
* Calculates the distance between two planets.
* @param {Object} planetA - Object representing the coordinates of planetA.
* @param {number} planetA.x - The x-coordinate of planetA.
* @param {number} planetA.y - The y-coordinate of planetA.
* @param {Object} planetB - Object representing the coordinates of planetB.
* @param {number} planetB.x - The x-coordinate of planetB.
* @param {number} planetB.y - The y-coordinate of planetB.
* @returns {number} The distance between the two planets.
*/
function distanceBetweenPlanets(planetA, planetB) {
const distance = Math.sqrt(Math.pow((planetB.x - planetA.x), 2) + Math.pow((planetB.y - planetA.y), 2));
return distance;
}
/**
* Calculates the travel time between two planets.
* @param {number} distance - The distance between the two planets.
* @param {number} speed - The speed of the spaceship.
* @returns {number} The travel time in seconds.
*/
function calculateTravelTime(distance, speed) {
return distance / speed;
}
module.exports = {
Spaceship,
createSpaceship,
distanceBetweenPlanets,
calculateTravelTime
};
```
### JavaScript to TypeScript
Continuing with our spaceship-themed codebase, suppose we decided to migrate to TypeScript. Using the `type-scriptor -f spaceship.js --to-ts` command, our codebase can now use type annotations to prevent potential errors and be even clearer to understand.
```typescript
/**
* Represents a spaceship object.
*/
class Spaceship {
/**
* Creates an instance of Spaceship.
* @param name - The name of the spaceship.
* @param crewSize - The number of crew members in the spaceship.
* @param speed - The current speed of the spaceship.
* @param fuel - The current fuel level of the spaceship.
*/
constructor(public name: string, public crewSize: number, public speed: number = 0, public fuel: number = 100) {}
/**
* Increases the speed of the spaceship and consumes fuel.
* @param amount - The amount by which to increase the speed.
*/
accelerate(amount: number): void {
this.speed += amount;
this.consumeFuel(amount);
}
/**
* Decreases the speed of the spaceship and consumes fuel.
* The spaceship speed can't go below 0.
* @param amount - The amount by which to decrease the speed.
*/
decelerate(amount: number): void {
this.speed = Math.max(this.speed - amount, 0);
this.consumeFuel(amount);
}
/**
* Reduces the fuel of the spaceship by a calculated amount.
* @param amount - The amount of speed by which to reduce the fuel.
*/
consumeFuel(amount: number): void {
this.fuel = Math.max(this.fuel - amount / 10, 0);
}
/**
* Refuels the spaceship with the given amount of fuel.
* The maximum fuel allowed is 100.
* @param amount - The amount of fuel to refuel.
*/
refuel(amount: number): void {
this.fuel = Math.min(this.fuel + amount, 100);
}
/**
* Increases the crew size of the spaceship.
* @param crewMembers - The number of crew members to add.
*/
boardCrew(crewMembers: number): void {
this.crewSize += crewMembers;
}
/**
* Decreases the crew size of the spaceship.
* Cannot go below 0 crew members.
* @param crewMembers - The number of crew members to remove.
*/
disembarkCrew(crewMembers: number): void {
this.crewSize = Math.max(this.crewSize - crewMembers, 0);
}
}
/**
* Creates a new instance of Spaceship.
* @param name - The name of the spaceship.
* @param crewSize - The number of crew members in the spaceship.
* @returns A new instance of Spaceship.
*/
function createSpaceship(name: string, crewSize: number): Spaceship {
return new Spaceship(name, crewSize);
}
interface Planet {
x: number;
y: number;
}
/**
* Calculates the distance between two planets.
* @param planetA - Object representing the coordinates of planetA.
* @param planetA.x - The x-coordinate of planetA.
* @param planetA.y - The y-coordinate of planetA.
* @param planetB - Object representing the coordinates of planetB.
* @param planetB.x - The x-coordinate of planetB.
* @param planetB.y - The y-coordinate of planetB.
* @returns The distance between the two planets.
*/
function distanceBetweenPlanets(planetA: Planet, planetB: Planet): number {
const distance = Math.sqrt(Math.pow(planetB.x - planetA.x, 2) + Math.pow(planetB.y - planetA.y, 2));
return distance;
}
/**
* Calculates the travel time between two planets.
* @param distance - The distance between the two planets.
* @param speed - The speed of the spaceship.
* @returns The travel time in seconds.
*/
function calculateTravelTime(distance: number, speed: number): number {
return distance / speed;
}
export { Spaceship, createSpaceship, distanceBetweenPlanets, calculateTravelTime };
```
### Refactoring
We can go further. Suppose we wanted to improve the performance of our codebase. Using the `type-scriptor -f spaceship.ts -r` command, we can improve the performance and organization of our code, making it faster to run and easier to debug.
```typescript
/**
* Represents a spaceship object.
*/
class Spaceship {
/**
* Creates an instance of Spaceship.
* @param name - The name of the spaceship.
* @param crewSize - The number of crew members in the spaceship.
* @param speed - The current speed of the spaceship.
* @param fuel - The current fuel level of the spaceship.
*/
constructor(public name: string, public crewSize: number, public speed = 0, public fuel = 100) {}
/**
* Increases the speed of the spaceship and consumes fuel.
* @param amount - The amount by which to increase the speed.
*/
accelerate(amount: number) {
this.speed += amount;
this.consumeFuel(amount);
}
/**
* Decreases the speed of the spaceship and consumes fuel.
* The spaceship speed can't go below 0.
* @param amount - The amount by which to decrease the speed.
*/
decelerate(amount: number) {
this.speed = Math.max(this.speed - amount, 0);
this.consumeFuel(amount);
}
/**
* Reduces the fuel of the spaceship by a calculated amount.
* @param amount - The amount of speed by which to reduce the fuel.
*/
consumeFuel(amount: number) {
this.fuel = Math.max(this.fuel - amount / 10, 0);
}
/**
* Refuels the spaceship with the given amount of fuel.
* The maximum fuel allowed is 100.
* @param amount - The amount of fuel to refuel.
*/
refuel(amount: number) {
this.fuel = Math.min(this.fuel + amount, 100);
}
/**
* Increases the crew size of the spaceship.
* @param crewMembers - The number of crew members to add.
*/
boardCrew(crewMembers: number) {
this.crewSize += crewMembers;
}
/**
* Decreases the crew size of the spaceship.
* Cannot go below 0 crew members.
* @param crewMembers - The number of crew members to remove.
*/
disembarkCrew(crewMembers: number) {
this.crewSize = Math.max(this.crewSize - crewMembers, 0);
}
}
/**
* Creates a new instance of Spaceship.
* @param {string} name - The name of the spaceship.
* @param {number} crewSize - The number of crew members in the spaceship.
* @returns {Spaceship} - A new instance of Spaceship.
*/
function createSpaceship(name: string, crewSize: number): Spaceship {
return new Spaceship(name, crewSize);
}
interface Planet {
x: number;
y: number;
}
/**
* Calculates the distance between two planets.
* @param {Planet} planetA - Object representing the coordinates of planetA.
* @param {number} planetA.x - The x-coordinate of planetA.
* @param {number} planetA.y - The y-coordinate of planetA.
* @param {Planet} planetB - Object representing the coordinates of planetB.
* @param {number} planetB.x - The x-coordinate of planetB.
* @param {number} planetB.y - The y-coordinate of planetB.
* @returns {number} - The distance between the two planets.
*/
function distanceBetweenPlanets(planetA: Planet, planetB: Planet): number {
const dx = planetB.x - planetA.x;
const dy = planetB.y - planetA.y;
return Math.sqrt(dx ** 2 + dy ** 2);
}
/**
* Calculates the travel time between two planets.
* @param {number} distance - The distance between the two planets.
* @param {number} speed - The speed of the spaceship.
* @returns {number} - The travel time in seconds.
*/
function calculateTravelTime(distance: number, speed: number): number {
if (speed === 0) {
return Infinity;
}
return distance / speed;
}
export { Spaceship, createSpaceship, distanceBetweenPlanets, calculateTravelTime };
```
### Unit Tests
To top it off, we need solid unit tests to check the funtionality of our spaceship codebase. Using the `type-scriptor -f spaceship.ts -t`, we generate unit tests in about 10 seconds to ensure the exepected behavior of our code.
```typescript
const { Spaceship, createSpaceship, distanceBetweenPlanets, calculateTravelTime } = require('./spaceship.ts');
describe('Spaceship', () => {
let spaceship;
beforeEach(() => {
spaceship = createSpaceship('Test', 1);
});
it('should create a new Spaceship instance', () => {
expect(spaceship instanceof Spaceship).toBe(true);
});
it('should set the name, crewSize, speed and fuel properties', () => {
expect(spaceship.name).toEqual('Test');
expect(spaceship.crewSize).toEqual(1);
expect(spaceship.speed).toEqual(0);
expect(spaceship.fuel).toEqual(100);
});
it('should increase the speed of the spaceship and reduce the fuel when accelerating', () => {
const initialSpeed = spaceship.speed;
const initialFuel = spaceship.fuel;
spaceship.accelerate(10);
expect(spaceship.speed).toEqual(initialSpeed + 10);
expect(spaceship.fuel).toEqual(initialFuel - 1);
});
it('should decrease the speed of the spaceship and reduce the fuel when decelerating', () => {
spaceship.accelerate(10);
const initialSpeed = spaceship.speed;
const initialFuel = spaceship.fuel;
spaceship.decelerate(5);
expect(spaceship.speed).toEqual(initialSpeed - 5);
expect(spaceship.fuel).toEqual(initialFuel - 0.5);
});
it('should not decrease the speed below 0 when decelerating', () => {
spaceship.accelerate(5);
spaceship.decelerate(10);
expect(spaceship.speed).toEqual(0);
});
it('should reduce the fuel when consuming fuel', () => {
const initialFuel = spaceship.fuel;
spaceship.consumeFuel(10);
expect(spaceship.fuel).toEqual(initialFuel - 1);
});
it('should not reduce the fuel below 0 when consuming fuel', () => {
const initialFuel = spaceship.fuel;
spaceship.consumeFuel(110);
expect(spaceship.fuel).toEqual(0);
});
it('should increase the fuel level when refueling', () => {
const initialFuel = spaceship.fuel;
spaceship.refuel(25);
expect(spaceship.fuel).toEqual(initialFuel + 25);
});
it('should not increase the fuel level above 100 when refueling', () => {
const initialFuel = spaceship.fuel;
spaceship.refuel(150);
expect(spaceship.fuel).toEqual(100);
});
it('should increase the crew size when boarding crew members', () => {
const initialCrewSize = spaceship.crewSize;
spaceship.boardCrew(2);
expect(spaceship.crewSize).toEqual(initialCrewSize + 2);
});
it('should decrease the crew size when disembarking crew members', () => {
const initialCrewSize = spaceship.crewSize;
spaceship.disembarkCrew(1);
expect(spaceship.crewSize).toEqual(initialCrewSize - 1);
});
it('should not decrease the crew size below 0 when disembarking crew members', () => {
spaceship.disembarkCrew(2);
expect(spaceship.crewSize).toEqual(0);
});
});
describe('distanceBetweenPlanets', () => {
it('should calculate the distance between two planets', () => {
const planetA = { x: 10, y: 20 };
const planetB = { x: 30, y: 40 };
const expectedDistance = 28.284271247461902;
expect(distanceBetweenPlanets(planetA, planetB)).toEqual(expectedDistance);
});
});
describe('calculateTravelTime', () => {
it('should calculate the travel time when speed is greater than 0', () => {
const distance = 100;
const speed = 50;
const expectedTime = 2;
expect(calculateTravelTime(distance, speed)).toEqual(expectedTime);
});
it('should return infinity when speed is 0', () => {
const distance = 100;
const speed = 0;
expect(calculateTravelTime(distance, speed)).toEqual(Infinity);
});
});
```
## Contributing
We welcome contributions to improve `type-scriptor`! To contribute, please follow these steps:
1. Fork the repository on GitHub.
2. Clone your forked repository and make your changes.
3. Commit your changes, and push them to your forked repository on GitHub.
4. Create a pull request against the original repository, describing your changes and the reasoning behind them.
Please ensure that your code is properly formatted, and all tests pass before submitting a pull request.
## License
`type-scriptor` is licensed under the MIT License. See the [LICENSE](LICENSE) file for more information.
| Write better JavaScript and TypeScript code, using ChatGPT. | chatgpt,chatgpt-api,javascript,jest-tests,tests,typescript | 2023-03-30T18:40:03Z | 2023-04-13T13:36:06Z | null | 2 | 1 | 16 | 1 | 1 | 18 | null | MIT | TypeScript |
arpittyagi102/Humari-Dukan | master | # Humari Dukaan - E-Commerce Website
Humari Dukaan is a fully functional e-commerce website built using React.js, Redux, React Router, Bootstrap, and Bootstrap Icons. The project aims to provide users with a seamless shopping experience and incorporates various features such as image carousel, scroll animations, search functionality, category-wise shopping, and a robust checkout system.
## Table of Contents
- [Features](#features)
- [Installation](#installation)
- [Usage](#usage)
- [Technologies Used](#technologies-used)
- [Contributing](#contributing)
- [License](#license)
## Features
### 1. Image Carousel
Humari Dukaan showcases a visually appealing image carousel on the homepage, allowing users to view featured products or promotions in an interactive and engaging manner.
### 2. Scroll Animations
The website incorporates scroll animations to enhance the user experience. These animations bring attention to important sections, such as product categories, special offers, or testimonials, as the user scrolls through the page.
### 3. Search Functionality
Users can easily search for products using the integrated search functionality. This feature enables quick and efficient product discovery, ensuring that users can find their desired items with ease.
### 4. Category-Wise Shopping
Humari Dukaan organizes products into different categories, making it convenient for users to browse and shop according to their preferences. Each category presents a curated selection of products relevant to the user's interests.
### 5. Data Flow to Checkout System
The project implements a robust data flow from product selection to the checkout system. Users can add items to their cart, review their selections, update quantities, and proceed to the secure checkout process seamlessly.
## Installation
To run the Humari Dukaan project locally, follow these steps:
1. Clone the repository to your local machine:
```bash
git clone https://github.com/your-username/humari-dukaan.git
```
2. Navigate to the project directory:
```bash
cd humari-dukaan
```
3. Install the dependencies using npm:
```bash
npm install
```
## Usage
To start the development server and view the Humari Dukaan website, run the following command:
```bash
npm start
```
This will launch the application on a local development server, typically at [http://localhost:3000](http://localhost:3000).
## Technologies Used
The Humari Dukaan project utilizes the following technologies and libraries:
- React.js: A JavaScript library for building user interfaces.
- Redux: A predictable state container for managing application state.
- React Router: A routing library for declarative navigation and routing in React applications.
- Bootstrap: A popular CSS framework for building responsive and mobile-first websites.
- Bootstrap Icons: A library of free, open-source icons for Bootstrap.
## Contributors
<a href="https://github.com/arpittyagi102">
<img src="https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/94587985?v=4&h=300&w=300&fit=cover&mask=circle&maxage=7d" width="120px"/>
</a>
<a href="https://github.com/Pulkitxm">
<img src="https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/65671483?v=4&h=300&w=300&fit=cover&mask=circle&maxage=7d" width="120px"/>
</a>
<a href="https://github.com/Akash1965">
<img src="https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/115504480?v=4&h=300&w=300&fit=cover&mask=circle&maxage=7d" width="120px"/>
</a>
<a href="https://github.com/avinashji1302">
<img src="https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/91355822?v=4&h=300&w=300&fit=cover&mask=circle&maxage=7d" width="120px"/>
</a>
<a href="https://github.com/roc102">
<img src="https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/100594349?v=4&h=300&w=300&fit=cover&mask=circle&maxage=7d" width="120px"/>
</a>
<a href="https://github.com/aasimtaif">
<img src="https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/83891519?v=4&h=300&w=300&fit=cover&mask=circle&maxage=7d" width="120px"/>
</a>
<a href="https://github.com/MRodriguez-M">
<img src="https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/41445895?v=4&h=300&w=300&fit=cover&mask=circle&maxage=7d" width="120px"/>
</a>
<a href="https://github.com/shm-dsgn">
<img src="https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/77527904?v=4&h=300&w=300&fit=cover&mask=circle&maxage=7d" width="120px"/>
</a>
<a href="https://github.com/Silent-Watcher">
<img src="https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/91375198?v=4&h=300&w=300&fit=cover&mask=circle&maxage=7d" width="120px"/>
</a>
<a href="https://github.com/sid12701">
<img src="https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/78287897?v=4&h=300&w=300&fit=cover&mask=circle&maxage=7d" width="120px"/>
</a>
<a href="https://github.com/sohaibaumer">
<img src="https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/120295412?v=4&h=300&w=300&fit=cover&mask=circle&maxage=7d" width="120px"/>
</a>
<a href="https://github.com/VIVEKIITdelhi">
<img src="https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/114601400?v=4&h=300&w=300&fit=cover&mask=circle&maxage=7d" width="120px"/>
</a>
<a href="https://github.com/aharonYK">
<img src="https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/87654852?v=4&h=300&w=300&fit=cover&mask=circle&maxage=7d" width="120px"/>
</a>
<br class="br"/>
## Contributing
Contributions to Humari Dukaan are welcome! If you would like to contribute to the project, please follow these steps:
1. Fork the repository on GitHub.
2. Create a new branch with a descriptive name.
3. Make your changes and commit them to your branch.
4. Push your changes to your forked repository.
5. Submit a pull request explaining your changes and their purpose.
6. Please give this repository a star 🌟
## License
The Humari Dukaan project is licensed under the [MIT License](LICENSE). Feel free to use, modify, and distribute the code as per the terms of the license.
| Humari Dukan is a E-Commerce website using React with Redux and Bootstrap | e-commerce,react,react-redux,react-router,reactjs,e-commerce-website,bootstrap,css,ecommerce,javascript | 2023-04-03T15:05:00Z | 2024-03-25T09:50:21Z | null | 17 | 24 | 111 | 16 | 25 | 18 | null | MIT | JavaScript |
gabrysia694/MyPetSpotlight | main | <p align="center">
<img src="https://github.com/its-your-invi/MyPetSpotlight/assets/95538354/842908b8-39e4-4290-a757-5e2c568b6753" height="400px" width="750px" >
</p>
<h2 align="center">
A website to showcase and celebrate our beloved pets!
</h2>
<h3 align="center">
Owner: <a href="https://github.com/gabrysia694">Gabrysia</a>
</h3>
## 🐾 Description
Welcome to **My Pet Spotlight**! This website allows pet owners to create profiles for their beloved pets and showcase them to the world. Our mission is to provide *a fun and interactive platform* for pet owners to connect with each other and celebrate their furry friends. 🌟🐶🐱
A pet lovers community where you can showcase your furry friends and their *unique personalities*. Our website allows you to submit your pet's name, age, and favorite toy, giving them the *spotlight they deserve*. Whether you have a playful pup or a lazy feline, we want to see them all! Join us in celebrating the **love and joy** that our pets bring into our lives.🐾❤️
## ⭐ Features
- **Submit** your pet's information, including name, age, personality traits, and favorite toy, to be featured on the website. 🐾🌐
- **Browse** through a collection of pets from around the world and read their unique stories. 📸🐕
- **Share** your pet's story with the world and connect with other pet owners.💌❤️
## 🚀 Getting Started
To get started with My Pet Spotlight, simply visit our [website](https://mypetspotlight.netlify.app/). From there, you can browse through existing pet profiles or create your own.
To create a pet profile, click the "Add your pet" button and contribute with your pet's information, including their name, breed, age, and a photo.
Once your profile is created, you can share it with your friends and family through social media. You can also view and interact with other pet profiles on our website.
## 🔧 Used Technologies
- 
- 
- 
- 
- 
## 💡 Contributing
We welcome contributions from the community to help improve My Pet Spotlight. If you have any ideas for new features or would like to report a bug, please submit an [issue](https://github.com/gabrysia694/MyPetSpotlight/issues) on our GitHub [repository](https://github.com/gabrysia694/MyPetSpotlight).
<ins> **How to Contribute** : <ins>
1. 🍴 Fork this [repository](https://github.com/gabrysia694/MyPetSpotlight).
2. 🌿 Create a new branch for your feature or bug fix.
3. 🔍 Read [CONTRIBUTING.md](https://github.com/gabrysia694/MyPetSpotlight/blob/main/CONTRIBUTING.md) carefully.
4. 🚀 Make your changes and test them thoroughly.
5. 📩 Submit a [pull request](https://github.com/gabrysia694/MyPetSpotlight/pulls) with a clear description of your changes.
## 📞 Support
If you have any questions or need help with My Pet Spotlight, please contact us at support@mypetspotlight.com.
We are always happy to assist you and answer any questions you may have.
## 👥 Contributors
[](https://github.com/gabrysia694/MyPetSpotlight/graphs/contributors)
## 📝 License
My Pet Spotlight is licensed under the MIT License. See the [LICENSE file](https://github.com/gabrysia694/MyPetSpotlight/blob/main/LICENSE) for more information.
Thank you for using My Pet Spotlight! We hope you and your furry friends enjoy using our website.
| This is a website that allows pet owners to create profiles for their beloved pets and showcase them to the world. We would greatly appreciate it if you could give a star to our project ⭐ | opensource,beginner-friendly,contributions-welcome,css,html,javascript | 2023-04-04T21:34:09Z | 2023-07-31T11:44:32Z | 2023-06-07T18:47:42Z | 46 | 67 | 85 | 3 | 53 | 18 | null | MIT | JavaScript |
gjha133/stackoverflow-clone-mern | main | # Stackoverflow-Clone-MERN
## Updates:
- **Integrated AI chatbot using OpenAI**
- ***Chatbot won't give response as the free trial got expired on 1 June 2023***
### How to run the application locally:
1. Clone the project.
1. Install dependencies in both **client** and **server** folder by using <br> command `npm install` or `npm i`
1. Complete the .env file in **server** folder.
- Connect to MongoDB.
- Enter remaining fields.
1. To run the application,
- move to **server** folder using command `cd server` <br> Then use command `npm start` to start the server.
- move to **client** folder using command `cd client` <br> Then use command `npm start` to start the application.
### Give it a star if helpful!
| Stack Overflow Clone with AI Chatbot integration using Open AI API. Check README for update. | chatgpt,javascript,openai,expressjs,mongodb,nodejs,reactjs,redux | 2023-04-02T14:08:11Z | 2023-06-03T16:29:12Z | null | 1 | 1 | 45 | 0 | 2 | 18 | null | null | JavaScript |
hafiz1379/Portfolio | main | <a name="readme-top"></a>
<div align="center">
<img src="./77.png" alt="logo" width="140" height="auto" />
<br/>
<h3><b>Portfolio Desktop Version</b></h3>
</div>
<!-- TABLE OF CONTENTS -->
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#triangular_flag_on_post-deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ (OPTIONAL)](#faq)
- [📝 License](#license)
<!-- PROJECT DESCRIPTION -->
# 📖 Portfolio Desktop Version <a name="about-project"></a>
> This is my First Portfolio project! created it by using HTML and CSS.
## 🛠 Built With <a name="built-with"></a>
1- HTML
2- CSS
3- Linters
4- JavaScript
### Tech Stack <a name="tech-stack"></a>
>
<details>
<summary>Client</summary>
<ul>
<li><a href="https://html.spec.whatwg.org/multipage//">HTML</a></li>
<li><a href="https://www.w3.org/TR/CSS/#css/">CSS</a></li>
</ul>
</details>
<!-- Features -->
### Key Features <a name="key-features"></a>
- Added index.html file.
- Added style.css file.
- Added script.js file.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- LIVE DEMO -->
## 🚀 Live Demo <a name="live-demo"></a>
This is the [live demo link](https://hafiz1379.github.io/Portfolio-desktop-version/)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- GETTING STARTED -->
## 💻 Getting Started <a name="getting-started"></a>
>
### Prerequisites
In order to run this project you need:
1. Web browser.
2. Code editor.
3. Git-smc.
### Setup
Clone this repository to your desired folder:
Run this command:
```sh
cd my-folder
git clone https://github.com/hafiz1379/Hello-Microverse.git
```
### Install
Install this project with:
Run command:
```sh
cd my-project
npm install
```
### Usage
To run the project, execute the following command:
Open index.html using live server extension.
### Run tests
To run tests, run the following command:
> Coming soon
### Deployment
You can deploy this project using:
> Coming soon
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- AUTHORS -->
## 👥 Authors <a name="authors"></a>
👤 Hafizullah Rasa
- GitHub: [@githubhandle](https://github.com/hafiz1379)
- Twitter: [@twitterhandle](https://twitter.com/Hafizrasa1379?s=35)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/hafizullah-rasa-8436a1257/)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- FUTURE FEATURES -->
## 🔭 Future Features <a name="future-features"></a>
- [] add new tags.
- [] add new styles.
- [] add new features using JavaScript.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- CONTRIBUTING -->
## 🤝 Contributing <a name="contributing"></a>
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- SUPPORT -->
## ⭐️ Show your support <a name="support"></a>
If you like this project just give it a star.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- ACKNOWLEDGEMENTS -->
## 🙏 Acknowledgments <a name="acknowledgements"></a>
I would like to thank Microverse,
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- LICENSE -->
## 📝 License <a name="license"></a>
This project is [MIT](./LICENSE) licensed.
<p align="right">(<a href="#readme-top">back to top</a>)</p> | Presenting my professional portfolio, a stunning web application showcasing my skills and achievements. Crafted with HTML, CSS, and JavaScript, this dynamic platform offers an immersive experience for visitors. Explore my projects, experience my expertise, and get in touch to collaborate on exciting opportunities. | css,html,javascript | 2023-04-06T06:47:30Z | 2024-02-25T11:11:12Z | null | 3 | 9 | 135 | 0 | 0 | 17 | null | MIT | CSS |
warioddly/text-particleizer | main | # text-particleizer
The TextParticleizer class, which makes the text destructible into particles, using the PIXI library and the usual javascript
<p align="center">
<img src="https://user-images.githubusercontent.com/53710487/229506306-96498205-b1a6-4ef1-a3cf-73b0d127f309.gif" alt="w-example-gif" />
</p>
| The TextParticleizer class🌌, which makes the text destructible into particles🔥, using the PIXI library and the usual javascript☄️ | canvas,javascript,pixijs,website,community,github,learn-to-code,learning,communityexchange,educative | 2023-04-01T12:13:27Z | 2023-04-15T08:20:49Z | null | 1 | 4 | 20 | 0 | 1 | 17 | null | BSD-3-Clause | CSS |
mercymugambi/to-do-list-webpack-project | main | # to-do-list-webpack-project
This simple web page is built using webpack and served by a webpack dev server.
<a name="readme-top"></a>
<!--
REQUIRED SECTIONS:
- Table of Contents
- About the Project
- Built With
- Live Demo
- Getting Started
- Authors
- Future Features
- Contributing
- Show your support
- Acknowledgements
- License
OPTIONAL SECTIONS:
- FAQ
After you're finished please remove all the comments and instructions!
-->
<div align="center">
<!-- You are encouraged to replace this logo with your own! Otherwise you can also remove it. -->
<h3><b>Hello</b></h3>
</div>
<!-- TABLE OF CONTENTS -->
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#triangular_flag_on_post-deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ (OPTIONAL)](#faq)
- [📝 License](#license)
<!-- PROJECT DESCRIPTION -->
# 📖 To-do list<a name="To-do list"></a>
> "To-do list" is a tool that helps to organize your day. It simply lists the things that you need to do and allows you to mark them as complete. This simple web page is built using webpack, es6 and served by a webpack dev server.
**To-do list** is a project where i test my javascript and webpack programming skills.
## 🛠 Built With <a name="built-with"></a>
>VScode
>Javascript
### Tech Stack <a name="tech-stack"></a>
> This is a web project.
<details>
<summary>Client</summary>
<ul>
<li><a href="https://javascript.info/">index.js</a>Javascript</li>
</ul>
<ul>
<li><a href="https://css.org/">style.html</a>CSS</li>
</ul>
</details>
<!-- Features -->
### Key Features <a name="key-features"></a>
> The key features are:
- **Visualize the template**
- **implemt more features for days activity**
<!-- LIVE DEMO -->
## 🚀 Live Demo <a name="live-demo"></a>
- [Live Demo Link](https://to-do-list-p2a8.onrender.com/)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- GETTING STARTED -->
## 💻 Getting Started <a name="getting-started"></a>
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
### Setup
Clone this repository to your desired folder:
```sh
cd my-folder
git clone this repo link
```
### Usage
To run the project, execute the following command:
```sh
vscode server
```
### Run tests
To run tests, run the following command:
Example command:
```sh
configure linter.yml file
open on your browser
```
### Deployment
You can deploy this project using:
Example:
```sh
github pages
```
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- AUTHORS -->
## 👥 Authors <a name="authors"></a>
👤 **Mercy Mugambi**
- GitHub: [@mercymugambi](https://github.com/mercymugambi)
- Twitter: [@mercymugambi](https://twitter.com/MercyMugambi15)
- LinkedIn: [@mercymugambi](https://www.linkedin.com/in/mercymugambi/)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- FUTURE FEATURES -->
## 🔭 Future Features <a name="future-features"></a>
> Below are future features to be added.
- **more_days_features**
- **Add alerts and time schedule**
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- CONTRIBUTING -->
## 🤝 Contributing <a name="contributing"></a>
Contributions, issues, and feature requests are welcome!
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- SUPPORT -->
## ⭐️ Show your support <a name="support"></a>
If you like this project, follow and contact me back.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- ACKNOWLEDGEMENTS -->
## 🙏 Acknowledgments <a name="acknowledgements"></a>
I would like to thank microverse community and my coding partner for their dedicated time to encourage me achieve the best.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- FAQ (optional) -->
## ❓ FAQ (OPTIONAL) <a name="faq"></a>
- **Question_1: Have you used linters to check for bugs?**
- yes
- **Question_2: Do the project use database?**
- Answer_2: not at the moment. To be used as we scale the project
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- LICENSE -->
## 📝 License <a name="license"></a>
This project is [MIT](./LICENSE) licensed.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
| "To-do list" is a tool that helps to organize your day. It simply lists the things that you need to do and allows you to mark them as complete. This simple web page is built using webpack, es6 and served by a webpack dev server. | css,javascript,webpack | 2023-03-30T09:23:31Z | 2023-06-08T12:27:35Z | null | 3 | 6 | 35 | 2 | 0 | 17 | null | MIT | JavaScript |
zhixuan2333/group-tab-ai-extension | main | # Group Tab AI extension
<img src="./assets/icon.png" width="32">
Group Tab AI is a browser extension that uses advanced AI technology powered by ChatGPT to group your browser tabs into logical categories. With Group Tab AI, you can easily organize your tabs based on topics, projects, or any other criteria you choose, making it easier to find the information you need and stay focused on your tasks.
## Installation
To install Group Tab AI, follow these steps:
1. Download the [latest release](https://github.com/zhixuan2333/group-tab-ai-extension/releases/latest).
2. Unzip the downloaded file to a folder on your computer.
3. Open your web browser and navigate to the extensions page.
4. Enable developer mode by toggling the switch in the top right corner of the page.
5. Click the "Load unpacked" button and select the folder where you unzipped the extension files.
## Development
To develop Group Tab AI, you'll need to have `Node.js` and `PNPM` installed on your computer. Follow these steps to get started:
```bash
git clone https://github.com/zhixuan2333/group-tab-ai-extension.git
cd group-tab-ai-extension
pnpm install
# To start development server
pnpm dev
# For edge
pnpm dev:edge
# To build extension
pnpm build
# For edge
pnpm build:edge
```
Open your browser and load the appropriate development build. For example, if you are developing for the chrome browser, using manifest v3, use: `build/chrome-mv3-dev`. If you are developing for the edge browser, using manifest v2, use: `build/edge-mv2-dev`.
## Contributing
Contributions to Group Tab AI are always welcome!
## License
Group Tab AI is licensed under the [GPL-3.0 license](LICENSE).
| A browser extension that uses ChatGPT to group your browser tabs into logical categories. | chatgpt,extension,javascript,react,typescipt,browser,chrome,chrome-extension | 2023-03-26T22:58:02Z | 2024-01-02T11:25:33Z | 2023-08-25T05:19:07Z | 2 | 11 | 53 | 1 | 2 | 16 | null | GPL-3.0 | TypeScript |
DevBubba/Bookmarklets | main | <img src="Img/PrimaryBanner.png" width="100%" height="100%" />
<div align="center">
<img src="https://img.shields.io/github/languages/top/DevBubba/devbubba.github.io?color=%23000000">
<img src="https://img.shields.io/github/stars/DevBubba/devbubba.github.io?color=%23000000&logoColor=%23000000">
<br>
<img src="https://img.shields.io/github/commit-activity/w/DevBubba/devbubba.github.io?color=%23000000">
<img src="https://img.shields.io/github/last-commit/DevBubba/devbubba.github.io?color=%23000000&logoColor=%23000000">
<br>
</div>
<hr style="border-radius: 2%; margin-top: 60px; margin-bottom: 60px;" noshade="" size="20" width="100%">
# <a id="description"></a> 🔖 〢 Bookmarklets
### The Baddest, Absolute Best, And The Biggest Collection Of Bookmarklets Out There!
## <a id="content"></a>🌐 〢 Table Of Contents
- **[📖 〢 Description](#description)**
- **[🔰 〢 Features](#features)**
- **[🔗 〢 Discord](https://discord.gg/6qAvAephsW)**
- **[📷 〢 Preview](#preview)**
- **[🧾 〢 Lisence](#lisence)**
## <a id="features"></a> 🔰 〢 Features
- `Bookmarklet Catigories`🟢
- `Github Repo Link`🟢
- `Replit Source Link`🟢
- `Over 75 Bookmarklets`🟢
- `Bookmarklet Discription`🟢
- `Add A Copy Code Button For Easy Accses To Bookmarklets`🟡
- `Allow Drop Downs To View The Code`🟡
- `Make A Search Bar To Find Any Bookmarklet`🟡
- `Bookmarklet Preview`🔴
🟢 = Working | 🟡 = To Do | 🔴 = Not Working
## <a id="preview"></a> 📷 〢 Preview
<div align="center">
<hr style="border-radius: 2%; margin-top: 60px; margin-bottom: 60px;" noshade="" size="20" width="75%">
<img style="border-radius: 15px; display: block; margin-left: auto; margin-right: auto; margin-bottom:20px;" width="70%" src="Img/MainPagePreview.png"></img>
<img style="border-radius: 15px; display: block; margin-left: auto; margin-right: auto; margin-bottom:20px;" width="70%" src="Img/ScreenPagePreview.png"></img>
<img style="border-radius: 15px; display: block; margin-left: auto; margin-right: auto; margin-bottom:20px;" width="70%" src="Img/ToolsPagePreview.png"></img>
<img style="border-radius: 15px; display: block; margin-left: auto; margin-right: auto; margin-bottom:20px;" width="70%" src="Img/GamesPagePreview.png"></img>
<img style="border-radius: 15px; display: block; margin-left: auto; margin-right: auto; margin-bottom:20px;" width="70%" src="Img/HacksPagePreview.png"></img>
<hr style="border-radius: 2%; margin-top: 60px; margin-bottom: 60px;" noshade="" size="20" width="75%">
</div>
## 🧾 <a id="lisence"></a> License
### Bookmarklets is licensed under the <a href="https://mit-license.org/.">MIT License</a>
<hr style="border-radius: 2%; margin-top: 60px; margin-bottom: 60px;" noshade="" size="20" width="100%">
| The Baddest, Absolute Best, And The Biggest Collection Of Bookmarklets Out There! | bookmarklets,bookmarks,js,javascript,bookmarklet,code,css,html,website,css3 | 2023-03-31T14:20:01Z | 2023-05-08T14:14:48Z | null | 1 | 0 | 168 | 0 | 6 | 16 | null | MIT | CSS |
jollytoad/deno_http_fns | main | # HTTP Functions for Deno
This is a collection of functions to aid building of a HTTP service in Deno.
They can be used instead of a monolithic router framework, or in tandem with
one.
## The bullet points
- A library of composable functions rather than a monolithic router class
- Based on web standard [Request] => [Response] functions, aka
[Fetch handlers](https://blog.val.town/blog/the-api-we-forgot-to-name/)
- Works with [`Deno.serve`][deno_serve]
- Routing based on various criteria
- URLPattern
- Method
- Media Type
- Request and Response helper functions
- Generate router module from filesystem based handlers
- Static or dynamic imports
- Build time or runtime discovery
- Request/Response interceptor function chains
- Logging
- CORS
- `Deno.serve` options helper fns for various hosting scenarios
- Development on localhost (including https support)
- Deno Deploy
[Request]: https://developer.mozilla.org/en-US/docs/Web/API/Request
[Response]: https://developer.mozilla.org/en-US/docs/Web/API/Response
[deno_serve]: https://deno.land/api?s=Deno.serve
## An Example
Let's start with a really simple example, a router for `GET /hello`...
```ts
import { handle } from "@http/route/handle";
import { byPattern } from "@http/route/by_pattern";
import { byMethod } from "@http/route/by_method";
Deno.serve(handle([
byPattern(
"/hello",
byMethod({
GET: () => {
return new Response("Hello world");
},
}),
),
]));
```
As you can see this is a fairly difference approach to the routers you may be
used to.
The main idea is to compose your router from simple `Request` => `Response`
functions.
Let's take a look at each part of the example, starting with `byPattern` (we'll
come back to `handle` later):
```ts
byPattern(
"/hello",
...
)
```
This function actually creates a handler function, which attempts to match the
request URL against the given pattern, and if it matches calls the handler given
in its 2nd arg, in this case...
```ts
byMethod({
GET: ...
})
```
Again this creates another handler function, which attempts to match the request
HTTP method against a key in the given record of method => handlers. If it
matches the HTTP method, the associated handler is called...
<!-- deno-fmt-ignore-start -->
```ts
() => {
return new Response("Hello world");
}
```
<!-- deno-fmt-ignore-end -->
So, this will be the handler function for `GET /hello`, the function is passed
the `Request` and returns a `Response`.
But what if the user hits `GET /other`, and `byPattern` doesn't match the
pattern?
Well the function can return `null` to indicate that this request cannot be
handled, and this is where `handle` comes in. It can take an array of handlers,
and try each one until a non-null response is returned, and if no response comes
a fallback handler is invoked. By default returning a `404 Not Found`, but a
different fallback function can be supplied where necessary.
Although `handle` itself is just a convenience function for a common combination
of `cascade` and `withFallback` functions, which can be used independently for a
more flexible approach. See below for the full documentation of these.
You can read more about the concepts in the [blog], although it may not remain
totally up to date with the state of this library.
[blog]: https://jollytoad.deno.dev/blog/http_fns
## Common handler concepts
### Response or null
Although based on `Request` => `Response` functions, there is a little more to
it than that, for example, many functions produced by the `by*` helpers may also
return `null` instead of a `Response`, and where a regular handler is required
the `withFallback` function can be used to catch the `null` and return a
concrete `Response`. The `Response` or `null` may also be as a promise.
### Additional arguments
Also, many handlers may also accept additional arguments beyond the first
`Request`, for example, in the case of `byPatten(pattern, handler)`, the
`handler` is given the request and the pattern match result as arguments...
```ts
((request: Request, match: URLPatternResult) => Awaitable<Response | null>);
```
### Argument shunting
Most of the `by*` helpers will pass arguments on as is, or shunt the arguments
along if they want to introduce their own, so for example,
`byPattern(pattern, handler)` returns a handler with the type:
```ts
(request: Request, ...additionalArgs: SomeArgsType) => ...
```
but the actual `handler` you pass to it is actually...
```ts
(request: Request, match: URLPatternResult, ...additionalArgs: SomeArgsType) => ...
```
It has the extra `match` argument insert before all other arguments that are
just passed along.
This allows the handlers created via `by*` helpers to work with a wide variety
of other frameworks, as it's totally agnostic to the extra arguments beyond the
`Request`. So when you use these functions with `Deno.serve` for example, your
pattern handler function will actually have the signature:
```ts
(request: Request, match: URLPatternResult, info: Deno.ServeHandlerInfo) => ...
```
So you still have this extra context available to you in your handler.
## Take a look inside
This is just a library of functions, and these are kept as simple a possible
with the intention that it is easy to take a look inside of each function and
see exactly what it does, the documentation below links to the source of each
function and an example of it's usage, and I encourage you follow these and take
a good look at the code.
Also, in general each module represents a single function, intended to be
imported individually, so you only import exactly what you need, not a mountain
of unused features. You'll find no `mod.ts` or `deps.ts` around here.
## Examples
There are many [examples](./packages/examples) that can be executed directly,
and many tests for these examples.
You can run them after cloning this repo, for example:
```sh
deno task example packages/examples/logging.ts
```
or directly from jsr:
```sh
deno run -A jsr:@http/examples/logging
```
Many of the examples have accompanying tests, which I hope to improve coverage
of as time permits. I'd encourage you to take a look at the tests to see how
each example can be exercised. You can also run the whole test suite simply
with:
```sh
deno task test
```
## Functions
- Routing
- [Criteria](./docs/routing_criteria.md)
- `byPattern`
- `bySubPattern`
- `byMethod`
- `byMediaType`
- [Delegation](./docs/routing_delegation.md)
- `handle`
- `cascade`
- `withFallback`
- `lazy`
- [Handlers](./docs/handlers.md)
- `staticRoute`
- [Filesystem](./docs/routing_filesystem.md)
- `discoverRoutes`
- `dynamicRoute`
- `generateRoutesModule`
- Fresh compatibility (_TODO_)
- [Interceptors](./docs/interceptors.md)
- `intercept`
- `interceptResponse`
- `skip`
- `byStatus`
- `logging`
- `cors`
- Utilities
- [Request](./docs/request_utils.md)
- [Response](./docs/response_utils.md)
- Hosting (_TODO_)
| A bunch of functions for building HTTP servers | deno,http,http-server,functions,javascript,server,typescript,utility-library | 2023-03-30T15:18:49Z | 2024-05-14T16:35:30Z | 2024-01-03T11:45:54Z | 1 | 5 | 91 | 5 | 1 | 16 | null | MIT | TypeScript |
oovillagran/AwesomeBooks-ES6 | main | <a name="readme-top"></a>
<div align="center">
<h3><b>Awesome Books ES6</b></h3>
</div>
<!-- TABLE OF CONTENTS -->
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#triangular_flag_on_post-deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ (OPTIONAL)](#faq)
- [📝 License](#license)
<!-- PROJECT DESCRIPTION -->
# 📖 Awesome Books<a name="about-project"></a>
**Awesome Books ES6** is a reestructured website from the original [Awesome Books](https://github.com/oovillagran/AwesomeBooks) that allows users to add/remove books from a list. We achieved that by using JavaScript objects and arrays. We also needed to dynamically modify the DOM and added basic events.
## 🛠 Built With <a name="built-with"></a>
### Tech Stack <a name="tech-stack"></a>
<details>
<summary>HTML</summary>
<ul>
<li>HTML</li>
</ul>
</details>
<details>
<summary>CSS</summary>
<ul>
<li>CSS</li>
</ul>
</details>
<details>
<summary>JavaScript</summary>
<ul>
<li>JavaScript</li>
</ul>
</details>
<!-- Features -->
### Key Features <a name="key-features"></a>
- Creating branches on repositories.
- Use of linter on HTML&CSS&JavaScript project.
- Correct use of GitHub flow.
- Follow Microverse's list of best practices for JavaScript projects.
- Implement a basic UI with plain HTML for a basic webpage.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- LIVE DEMO -->
## 🚀 Live Demo <a name="live-demo"></a>
- Here is the [live-demo](https://oovillagran.github.io/AwesomeBooks/)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- GETTING STARTED -->
## 💻 Getting Started <a name="getting-started"></a>
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
- Create a repo on your repositores files.
- Clone or make a copy of this repo on your local machine.
- Follow GitHub flow.
- A carefully reading of this README.md is required.
### Setup
Clone this repository to your desired folder:
```bash
cd my-folder
git clone git@github.com:oovillagran/AwesomeBooks.git
```
### Install
Install this project with:
```bash
npm install
```
### Usage
To run the project, you can use your favorite browser.
### Run tests
To run tests, execute the following command:
```bash
npx hint .
```
### Deployment
-Follow GitHub pages guideliness.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- AUTHORS -->
## 👥 Authors <a name="authors"></a>
👤 **Oscar Villagran**
- GitHub: [@oovillagran](https://github.com/oovillagran)
- Twitter: [@oovillagran](https://twitter.com/oovillagran)
- LinkedIn: [Oscar Villagran](https://www.linkedin.com/in/oovillagran/)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- FUTURE FEATURES -->
## 🔭 Future Features <a name="future-features"></a>
- [ ] **Use of linter in HTML&CSS projects**
- [ ] **Use README template file**
- [ ] **Ask for a code review****
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- CONTRIBUTING -->
## 🤝 Contributing <a name="contributing"></a>
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- SUPPORT -->
## ⭐️ Show your support <a name="support"></a>
If you like this project feel free to make any comment, all contributions are welcome!.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- ACKNOWLEDGEMENTS -->
## 🙏 Acknowledgments <a name="acknowledgements"></a>
We would like to thank Microverse comunity, they do an excellent job.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 📝 License <a name="license"></a>
This project is [MIT](LICENSE.md) licensed.
_NOTE: we recommend using the [MIT license]<a href="LICENSE.md">
<p align="right">(<a href="#readme-top">back to top</a>)</p>
| This is a new version of the Awesome books using ES6 sintax, using of modules into javascript code, and use of arrow functions. | css,html,javascript | 2023-04-03T15:48:24Z | 2023-04-04T02:50:52Z | null | 1 | 1 | 14 | 0 | 0 | 16 | null | MIT | JavaScript |
patrick-kw-chiu/activity-calendar-widget | main | # Activity Calendar Widget
A "GitHub Contribution/Activity" like calendar widget, that can be used as native components of [React](https://stackblitz.com/edit/react-ts-pjkx7k), [Vue](https://stackblitz.com/edit/vue-at6pyy), [Svelte](https://stackblitz.com/edit/vitejs-vite-r7rxjt?terminal=dev), [Solid](https://stackblitz.com/edit/solidjs-templates-mjote1) and [Qwik](https://stackblitz.com/edit/qwik-starter-due4dq). You can used it with the [GitHub activity API](https://docs.github.com/en/rest/activity/events?apiVersion=2022-11-28#list-public-events-for-a-user) or to display any activity data.
<p align="center">
<img src="https://user-images.githubusercontent.com/42149082/231084223-c334f434-26e1-45b0-b707-9548d29013a1.png">
<img src="https://user-images.githubusercontent.com/42149082/231084227-6bee6da3-e5c8-4485-8921-399428acfb35.png">
</p>
<!--
<p align="center">
Quick Start With...
</p>
<p align="center">
<a href="./react/README.md">React</a> |
<a href="./vue/README.md">Vue</a> |
<a href="./svelte/README.md">Svelte</a> |
<a href="./solid/README.md">Solid</a> |
<a href="./qwik/README.md">Qwik</a>
</p>
-->
## About
**Activity Calendar Widget** is built with [Mitosis](https://github.com/BuilderIO/mitosis) (with a little modifications), which aims to "Write components once, compile to every framework". Interested to learn more? Here is a [walkthrough of building a "simplied" Activity Calendar Widget](https://medium.com/@patrick-kw-chiu/write-components-once-compile-to-every-framework-with-mitosis-9330411d21e4).
_Credits: The API of **Activity Calendar Widget** is highly influenced by [React Activity Calendar](https://github.com/grubersjoe/react-activity-calendar). React Activity Calendar is a great component library, which provides more granular options in certain areas._
## Installation
`npm i activity-calendar-widget`
It can then be imported in various frameworks like...
```javascript
// React
import ActivityCalendarWidget from 'activity-calendar-widget/react';
// Vue
import ActivityCalendarWidget from 'activity-calendar-widget/vue';
// Svelte
import ActivityCalendarWidget from 'activity-calendar-widget/svelte';
// Solid
import ActivityCalendarWidget from 'activity-calendar-widget/solid';
// Qwik
import ActivityCalendarWidget from 'activity-calendar-widget/qwik';
```
### Basic Usage
```
<ActivityCalendarWidget
daysToRender={150}
data={[
{ date: '2023-04-05', activities: [{}, {}, {}, {}] },
{ date: '2023-04-07', activities: [{}] },
{ date: '2023-04-08', activities: [{}, {}, {}] },
]}
/>
```
## API
### Props
| Props name | Type | Default | Description |
| ----------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| data | array of [`Data`](https://github.com/patrick-kw-chiu/activity-calendar-widget/edit/main/README.md#data) | [] | The activity `data` array. It accepts the `date` and `activities` fields. |
| clickHandler | Function<br>`(dateInfo: `[`DateInfo`](https://github.com/patrick-kw-chiu/activity-calendar-widget/edit/main/README.md#dateinfo)`) => {}` | undefined | The activity `data` array. It accepts the `date` and `activities` fields. |
| daysToRender | number | 365 (+ 0 to 6 days more). See more the description | When `daysToRender` isn't specified, at least 365 days from today will be rendered, while the leftmost (oldest) column will also be filled up entirely.<br><br>When `daysToRender` is specified, `activity-calendar-widget` will render the exact number of `daysToRender` from today. |
| mode | string | `'day'` | Options: `'day'` / `'week'` / `'month'`.<br><br>**Note: Only `day` is supported currently.** See roadmap for more info. |
| showSummary | boolean | true | If set to `true`, a summary of "26 activities in this period" will be displayed in the bottom left of the component. |
| summaryText | string | `'{{count}} activities in this period'` | The customized summary text with placeholder `{{count}}` |
| showLevels | boolean | true | If set to `true`, a level legend will be displayed in the bottom right of the component. |
| levelColorMode | string | `'light'` | Options: `'light'` / `'dark'`. It changes the color palette of the level legend, like the screenshots at the top.<br><br>If `levelColorMode` is used together with `levelColors`, `levelColorMode` will be ignored and **ONLY** `levelColor` will be used. |
| levelColors | array of string | `undefined` | If `levelColors` is used together with `levelColorMode`, `levelColorMode` will be ignored and **ONLY** `levelColor` will be used. E.g. `['white', 'rgba(0, 0, 0, 0.2'), '#a6a6a6']` |
| levelLabelLess | string | `'Less'` | The "Less" label of the level legend |
| levelLabelMore | string | `'More'` | The "More" label of the level legend |
| showTooltip | boolean | true | If set to `true`, when users hover the date box, a tooltip of "2 activities on Apr 11, 2023" will be displayed. |
| tooltipBgColor | string | `'rgba(0, 0, 0, 0.8)'` | The tooltip background color |
| tooltipTextColor | string | `'#e4e8ec'` | The tooltip text color |
| weekStart | number | 0 | Options: `0` / `1` / `2` / `3` / `4` / `5` / `6`<br><br>The week start with:<br>`0`: Sun<br>`1`: Mon<br>`2`: Tue<br>`3`: Wed<br>`4`: Thu<br>`5`: Fri<br>`6`: Sat |
| showWeekdayLabels | boolean | true | If set to `true`, the left weekday labels will be displayed. |
| weekdayLabel | [`WeekdayLabel`](https://github.com/patrick-kw-chiu/activity-calendar-widget/edit/main/README.md#weekdaylabel) | {} | By default, the widget only displays `Mon`, `Wed` and `Fri`. If the allowed keys in `weekdayLabel` is provided e.g. `{ 0: '日曜日' }`, the week value will be overwritten.<br><br>**Note**: To provide custom value for **Sunday**, provide value to **`0`** e.g. `{ 0: '日曜日' }`. |
| showMonthLabels | boolean | true | If set to `true`, the top month labels will be displayed. |
| monthLabel | [`MonthLabel`](https://github.com/patrick-kw-chiu/activity-calendar-widget/edit/main/README.md#monthlabel) | {} | By default, all months will be displayed. If the allowed keys in `monthLabel` is provided e.g. `{ 1: '1월' }`, the month value will be overwritten. |
## Event Handlers
### clickHandler(dateInfo: DateInfo)
#### DateInfo
| Fields | Type | Format | Description |
| ---------------- | -------------- | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| id | string | `yyyy-MM-dd` | The date being clicked |
| year | number | `yyyy` | The year of the date box being clicked |
| month | number | `MM` | The month of the date box being clicked |
| day | number | `dd` | The day of the date box being clicked |
| dayOfWeek | number | `0-6` | The day of week of the date box being clicked<br><br>`0`: Sun<br>`1`: Mon<br>`2`: Tue<br>`3`: Wed<br>`4`: Thu<br>`5`: Fri<br>`6`: Sat |
| dayDiffFromToday | number | `>= 0` | Numebrs of days from today |
| activities | array of `any` | `[]` | Each item inside the `activities` array will count as 1 activity. The format is arbitary here. You can pass `{ "type": "PushEvent" }` or `'PullRequestEvent'` or **anything**. |
| level | number | `>= 0` | If no custom `levelColors` is passed, level will be `0-4`. `0` means no activities and `4` means the tier of having the most activities.<br><br>If custom `levelColors` is passed, level will be `0` to `length of levelColors - 1`. |
#### Usage
```JSX
<ActivityCalendarWidget
clickHandler={(dateInfo) => console.log({ dateInfo })}
/>
```
#### DateInfo Example
```json
{
"id": "2023-04-16",
"year": 2023,
"month": 4,
"day": 16,
"dayOfWeek": 0,
"dayDiffFromToday": 0,
"activities": [
...
],
"level": 2
}
```
## Types
### Data
| Field | Type | Format | Description |
| ---------- | -------------- | ------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| date | string | `yyyy-MM-dd` | The date which contains 0 or more activities.<br>E.g. `'2023-04-05'` |
| activities | array of `any` | `[]` | Each item inside the `activities` array will count as 1 activity. The format is arbitary here. You can pass `{ "type": "PushEvent" }` or `'PullRequestEvent'` or **anything**.<br><br>If you pass a `clickHandler` and you clicked the date box, the `clickHandler` callback will be executed with the `activities`. |
#### Example
```
[
{ date: '2023-04-05', activities: [{}, {}, {}, {}] },
{ date: '2023-04-07', activities: [{}] },
{ date: '2023-04-08', activities: [{}, {}, {}] }
]
```
### WeekdayLabel
```typescript
type WeekdayKey = 0 | 1 | 2 | 3 | 4 | 5 | 6;
export type WeekdayLabel = Record<WeekdayKey, string>;
```
#### Example:
```
{
0: '日曜日',
1: '月曜日',
2: '火曜日',
3: '水曜日',
4: '木曜日',
5: '金曜日',
6: '土曜日',
}
```
### MonthLabel
```typescript
type MonthKey = 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12;
export type MonthLabel = Record<MonthKey, string>;
```
#### Example:
```
{
1: '1월',
2: '2월',
3: '3월',
// ...
10: '10월',
11: '11월',
12: '12월',
}
```
## Roadmap
- Support `mode={'month'}`
- Support `mode={'week'}`
<img width="420" alt="Screenshot 2023-04-13 at 1 12 12 AM" src="https://user-images.githubusercontent.com/42149082/231660200-3b92e315-44b5-4568-b6f8-87150e9d1ff6.png">
| A GitHub Activity Calendar built on Mitosis, which generates React, Vue, Svelte, and other components | github-calendar,javascript,mitosis,react,reactjs,svelte,vue,vuejs | 2023-04-07T05:40:32Z | 2023-04-17T03:39:06Z | null | 1 | 0 | 12 | 1 | 2 | 15 | null | MIT | TypeScript |
gftf2011/clean-node-todolist | main | <div align="center">
<h1>CLEAN Node.JS TODOLIST • :ledger: :computer:</h1>
</div>
<br/>
<div align="center">
<img src='https://coveralls.io/repos/github/gftf2011/clean-todolist/badge.svg?branch=main' alt='Coverage Status' />
<img src='https://sonarcloud.io/api/project_badges/measure?project=gftf2011_clean-node-todolist&metric=alert_status' alt='Quality Gate Status' />
</div>
<br/>
<div align="center">
<a href="#page_facing_up-about">About</a> •
<a href="#hammer_and_wrench-supported-os">Supported OS</a> •
<a href="#large_blue_diamond-design-patterns">Design Patterns</a> •
<a href="#blue_book-principles">Principles</a> •
<a href="#building_construction-business-rules">Business Rules</a> •
<a href="#clipboard-required-tools">Required Tools</a> •
<a href="#racing_car-running-project">Running Project</a> •
<a href="#test_tube-running-tests">Running Tests</a> •
<a href="#memo-license">License</a>
</div>
<br/>
<div align="center">
<img src="https://github.com/gftf2011/clean-node-todolist/blob/main/.github/images/background.png" />
</div>
<br/>
## :page_facing_up: About
This a backend from a TODO LIST typescript project.
The objective from this project is to show how to create an API with a well-defined and decoupled architecture, using Clean Architecture concepts, dividing the layers responsibility and exploring the usage of several design patterns !
<br/>
## :hammer_and_wrench: Supported OS
- [x] Mac OS
- [x] Linux
- [x] Windows - WSL
<br/>
## :large_blue_diamond: Design Patterns
### Creational
- [Abstract Factory](https://refactoring.guru/design-patterns/abstract-factory)
- [Factory Method](https://refactoring.guru/design-patterns/factory-method)
- [Builder](https://refactoring.guru/design-patterns/builder)
- [Singleton](https://refactoring.guru/design-patterns/singleton)
### Structural
- [Adapter](https://refactoring.guru/design-patterns/adapter)
- [Composite](https://refactoring.guru/design-patterns/composite)
- [Decorator](https://refactoring.guru/design-patterns/decorator)
- [Proxy](https://refactoring.guru/design-patterns/proxy)
### Behavioral
- [Chain of responsability](https://refactoring.guru/design-patterns/chain-of-responsibility)
- [Command](https://refactoring.guru/design-patterns/command)
- [Mediator](https://refactoring.guru/design-patterns/mediator)
- [Strategy](https://refactoring.guru/design-patterns/strategy)
- [Template method](https://refactoring.guru/design-patterns/template-method)
### Non GOF - Gang of Four - Official
- [Monad Either](https://itnext.io/either-monad-a-functional-approach-to-error-handling-in-js-ffdc2917ab2)
<br/>
## :blue_book: Principles
- [Single Responsibility Principle (SRP)](https://en.wikipedia.org/wiki/Single-responsibility_principle)
- [Open Closed Principle (OCP)](https://en.wikipedia.org/wiki/Open%E2%80%93closed_principle)
- [Liskov Substitution Principle (LSP)](https://en.wikipedia.org/wiki/Liskov_substitution_principle)
- [Interface Segregation Principle (ISP)](https://en.wikipedia.org/wiki/Interface_segregation_principle)
- [Dependency Inversion Principle (DIP)](https://en.wikipedia.org/wiki/Dependency_inversion_principle)
- [Separation of Concerns (SOC)](https://en.wikipedia.org/wiki/Separation_of_concerns)
- [Don't Repeat Yourself (DRY)](https://en.wikipedia.org/wiki/Don%27t_repeat_yourself)
- [You Aren't Gonna Need It (YAGNI)](https://en.wikipedia.org/wiki/You_aren%27t_gonna_need_it)
- [Keep It Simple, Stupid (KISS)](https://en.wikipedia.org/wiki/KISS_principle)
- [Composition Over Inheritance](https://en.wikipedia.org/wiki/Composition_over_inheritance)
<br/>
## :building_construction: Business Rules
- [Sign-Up](https://github.com/gftf2011/clean-node-todolist/tree/main/requirements/sign-up.md)
- [Sign-In](https://github.com/gftf2011/clean-node-todolist/tree/main/requirements/sign-in.md)
- [Find Note](https://github.com/gftf2011/clean-node-todolist/tree/main/requirements/find-note.md)
- [Find Note By User ID](https://github.com/gftf2011/clean-node-todolist/tree/main/requirements/find-notes-by-user-id.md)
- [Create Note](https://github.com/gftf2011/clean-node-todolist/tree/main/requirements/create-note.md)
- [Update Note](https://github.com/gftf2011/clean-node-todolist/tree/main/requirements/update-note.md)
- [Update Note Finishing Status](https://github.com/gftf2011/clean-node-todolist/tree/main/requirements/update-finished-note.md)
- [Delete Note](https://github.com/gftf2011/clean-node-todolist/tree/main/requirements/delete-note.md)
<br/>
## :clipboard: Required Tools
- [x] Node - [https://nodejs.org/](https://nodejs.org/)
- Node version: 18.x.x
- npm version: 9.x.x
- [x] Docker - [https://www.docker.com/](https://www.docker.com/)
<br/>
## :racing_car: Running Project
```sh
$ npm i
$ npm run start:dev
```
### OBS.: Ensure to install all dependencies in <a href="#clipboard-required-tools">Required Tools</a>
<br/>
## :test_tube: Running Tests
> ### Unit Tests
```sh
$ npm run test:unit
```
> ### Integration Tests
```sh
$ npm run test:integration
```
> ### E2E Tests
```sh
$ npm run test:e2e
```
> ### Full Test Coverage Report
```sh
$ npm run test
```
<br/>
## :memo: License
This project is under MIT license. See the [LICENSE](https://github.com/gftf2011/clean-node-todolist/blob/main/LICENSE) file for more details.
---
Made with lots of :heart: by [Gabriel Ferrari Tarallo Ferraz](https://www.linkedin.com/in/gabriel-ferrari-tarallo-ferraz/)
| Node.Js API built with Clean Architecture and Design Patterns that runs in REST and Graphql at the same time | javascript,nodejs,clean-architecture,clean-code,graphql,rest,test,typescript,coveralls,design-patterns | 2023-03-31T03:05:57Z | 2023-10-01T22:29:01Z | null | 1 | 0 | 140 | 0 | 1 | 15 | null | MIT | TypeScript |
net2devcrypto/Stable-Diffusion-API-NodeJS-AI-ImageGenerator | main | # Stable-Diffusion-API-NodeJS-AI-ImageGenerator
An API NodeJS script to automate image generation using Stable Diffusion AI Image Generator
##
<h3>Subscribe to my Youtube! Net2Dev</h3>
<a href="http://youtube.net2dev.io" target="_blank"><img src="https://github.com/net2devcrypto/misc/blob/main/ytlogo2.png" width="150" height="40"></a>
<img src="https://raw.githubusercontent.com/net2devcrypto/misc/main/stablediffusion.png" width="350" height="70">
** THE FILES ATTACHED TO THIS REPO ARE FOR EDUCATIONAL PURPOSES ONLY **
** USE IT AT YOUR OWN RISK** **I'M NOT RESPONSIBLE FOR ANY USE, ISSUES ETC.. **
## Step 1
Download stablediffusionapi folder from this repo.
## Step 2
Extract and navigate to project folder then install dependencies: npm i
```shell
cd stablediffusionapi
npm i
```
## Step 3
Create your Account in Stablediffusion: https://stablediffusionapi.com/
## Step 4
Create API key then copy it.
Update stablegenerate.js and add your api key:
```shell
const apiKey = 'REPLACE-WITH-YOUR-API-KEY';
```
## Step 5
Add your prompt description of what you want to generate.
```shell
const prompt = 'a dog walking on the beach with sunglasses, portrait, ultra realistic, futuristic background , concept art, intricate details, highly detailed';
```
## Step 6
Add how many pics you want to generate:
```shell
const numberOfPics = '3'
```
## Step 7
- Save and execute in your terminal:
```shell
node stablegenerate.js
```
Pictures will be inside the "pics" folder once generated.
Follow me in Youtube @Net2Dev!!
| An API NodeJS script to automate image generation using Stable Diffusion AI Image Generator | ai,generator,image,javascript,midjourney,nextjs,nodejs,reactjs,stable-diffusion | 2023-03-31T23:51:17Z | 2023-04-01T01:21:37Z | null | 1 | 0 | 5 | 0 | 2 | 15 | null | null | JavaScript |
lilycyf/chatgpt-rpg | master | # Chatbot RPG using OpenAI's gpt models
[中文](https://github.com/lilycyf/chatgpt-rpg/blob/master/README_zh.md) | English
The objective of this project is to utilize OpenAI's API to create a chatbot that possesses unique characteristics and integrate it into an RPG game.
Currently, the project features two built characters, Li Ming and Avery Kim, whom you can interact with under the roleplay section of the demo. To participate, make sure to obtain your own OpenAI KPI and input it in the provided field at the bottom left. It's essential to note that the demo is a silent website without a backend, so your OpenAI API won't be transmitted to anyone. In addition to the two characters, you can also communicate with the basic chatgpt via the chat section.
Note: You can sign up for an API key from OpenAI. Generate an API key for OpenAI's service by following the instructions on the [OpenAI website](https://platform.openai.com/account/api-keys) for free.
🔗 [demo](https://lilycyf.github.io/chatgpt-rpg/chatchatchat/demo.html)
## Screenshots
<img src="image/README/1681363147175.png" alt="1681363147175" width="33%"/><img src="image/README/1681363512437.png" alt="1681363512437" width="33%"/><img src="image/README/1681363557274.png" alt="1681363557274" width="33%"/>
## Getting Started
1. Clone this repository to your local machine.
2. (optional) Create a virtual environment:
1. Run the command `python3 -m venv venv` to create a new virtual environment named "venv".
2. Activate the virtual environment by running the command `source venv/bin/activate`. On Windows, use `.\venv\Scripts\activate` instead.
3. Install the required packages listed in the `requirements.txt` file using `pip install -r requirements.txt` in your terminal.
4. Make a copy of `config.py` under the `chatbot` folder with name `mine_config.py`.
5. Generate your own secret key in Django by running the command `python manage.py generate_secret_key` in your terminal. Replace the `SECRET_KEY` in `mine_config.py` under the `chatbot` folder with the key that you generated.
6. Sign up for an API key from OpenAI. Generate an API key for OpenAI's service by following the instructions on the [OpenAI website](https://platform.openai.com/account/api-keys) and replace the `OPENAI_API_KEY` in `mine_config.py` under the `chatbot` folder with your own key.
## Running the Chatbot
Note: If you set up a virtual environment in step 2 you will need to activate it before running any commands related to the project. To activate the virtual environment, run `source env/bin/activate`. To deactivate it, simply run the `deactivate` command.
Before start the server, navigate to the root folder of the project in your terminal and run the command `python manage.py migrate` to apply the database migrations.
To run the chatbot, run the command `python manage.py runserver`. Then open your web browser and go to `http://localhost:8000` to access the chatbot application.
## Conclusion
This project provides an example of how to build a chatbot application using OpenAI's gpt-3.5-turbo. Feel free to modify the code to suit your needs, and don't forget to create your own secret key and API key when running the application.
## License
This project is released under the [MIT License](./LICENSE).
| A project that utilize OpenAI's API to create role-play chatbots with unique characteristics | ai,chatbot,css,django,django-framework,django-project,html,javascript,openai,openai-api | 2023-03-28T03:39:21Z | 2023-04-21T12:27:58Z | null | 1 | 2 | 109 | 0 | 2 | 15 | null | MIT | HTML |
meowrain/doc-for-cs | main | <div align="center">
<h1>doc-for-cs</h1>
一份为计算机专业学弟学妹们的指南与资料文档<br><br>
[](https://github.com/meowrain/doc-for-sxau)
<img src="https://counter.seku.su/cmoe?name=meowrain&theme=r34" /><br>
</div>
## 前言
[cs.meowrain.cn](https://cs.meowrain.cn)
## 贡献指南
> 如果你想贡献内容，请看贡献指南！
[贡献指南](./docs//贡献指南/index.md)
## Star History
[](https://star-history.com/#meowrain/doc-for-cs&Date)
---
## ✨ 鸣谢
> 感谢下面的这些小伙伴们的支持，我们的这个文档才得以完善！
> <a href="https://github.com/meowrain/doc-for-sxau/graphs/contributors">
> <img src="https://contrib.rocks/image?repo=meowrain/doc-for-cs" />
> </a>
---
## 许可
[CC-BY-SA-4.0 license](./LICENSE)
| 一份为计算机专业学弟学妹们的指南与资料文档 | java,javascript,documentation,sxau | 2023-03-28T12:39:50Z | 2023-12-09T11:26:53Z | 2023-07-01T03:32:37Z | 4 | 13 | 111 | 5 | 4 | 15 | null | CC-BY-SA-4.0 | HTML |
toshusai/one | master | # One
## What is One?
https://toshusai.github.io/one-docs/
One is a lightweight, easy-to-use framework for building web applications that is simple, transparent, and fast. It consists of a single class contained in a single file of 1.7KB and requires zero dependencies and no build step.
## Overview
One is a lightweight framework that makes it easy to build web applications with its focus on simplicity and transparency. The entire framework is contained within a single class, making it easy to use and understand. At only 11KB TypeScript in size (1.7KB JavaScript when gzip compressed), the class includes implementation of basic features found in modern frameworks, such as if statements, for loops, slots, and props. With zero dependencies and no build step required, One is a great choice for building small to medium-sized web applications.
## How to use
Installation
```bash
npm install @toshusai/one
```
## Usage
To use One, simply inherit the One class and implement the template method.
```ts
import { One } from "@toshusai/one";
export class BasicComponent extends One {
render() {
return `<div>Hello World!</div>`;
}
mounted() {
console.log("Can you see me in the console?");
}
}
```
To initialize the application, create an instance and pass the root HTMLElement as an argument to the mount method.
```ts
const element = document.getElementById("app")!;
new BasicComponent().mount(element);
```
## Features
One supports the following features:
- `-if` for if statements
- `-for` for for loops
- `<slot></slot>` for multiple slots
- `:value="value"` for two-way binding
- `@click="onClick"` for event listeners
## Documentation
documentation is available on the GitHub Pages site.
https://toshusai.github.io/one-docs/
documentation source code is available on GitHub
https://github.com/toshusai/one-docs
## License
MIT License
| a JavaScript framework in a 1.7KB one class | framework,frontend,javascript,typescript | 2023-04-08T04:17:00Z | 2023-11-23T15:09:17Z | null | 1 | 0 | 27 | 0 | 0 | 15 | null | MIT | TypeScript |
Alejandroq12/my-books-ES6 | dev | <a name="readme-top">My Books</a>
<div align="center">
<img src="./assets/img/logo/logo-readme.png" alt="logo" width="600" height="auto" />
<br/>
<h3><b>My Books</b></h3>
</div>
<!-- TABLE OF CONTENTS -->
# 📗 Table of Contents
- [� Table of Contents](#-table-of-contents)
- [📖 My Books ](#-my-books-)
- [🛠 Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Key Features ](#key-features-)
- [🚀 Live Demo ](#-live-demo-)
- [💻 Getting Started ](#-getting-started-)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#deployment)
- [👥 Authors ](#-authors-)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [❓ FAQ (OPTIONAL) ](#-faq-optional-)
- [📝 License ](#-license-)
<!-- PROJECT DESCRIPTION -->
# 📖 My Books <a name="about-project"></a>
"My Books" is an intuitive web application that showcases a dynamic list of books, offering the ability to add and remove books seamlessly. Throughout the development process, I have honed my skills in managing data with JavaScript, resulting in a highly interactive user experience. By adhering to a medium-fidelity wireframe, the application's user interface has been meticulously crafted to meet modern design standards. This project not only showcases my adeptness in web development but also demonstrates my ability to create user-friendly applications."
## 🛠 Built With <a name="built-with"></a>
### Tech Stack <a name="tech-stack"></a>
<details>
<summary>Client</summary>
<ul>
<li><a href="https://developer.mozilla.org/es/docs/Learn/HTML">HTML</a></li>
<li><a href="https://developer.mozilla.org/es/docs/Web/CSS">CSS</a></li>
<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript">JavaScript</a></li>
</ul>
</details>
<!-- Features -->
### Key Features <a name="key-features"></a>
- **A fully functional website**
- **Modular JavaScript: The application is built using JavaScript modules, resulting in a well-organized, maintainable, and scalable codebase.**
- **Semantic HTML: By utilizing semantic HTML elements, the website's structure is meaningful and accessible, improving both search engine optimization and the user experience for individuals using assistive technologies.**
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- LIVE DEMO -->
## 🚀 Live Demo <a name="live-demo"></a>
- [Live Demo Link](https://alejandroq12.github.io/my-books-ES6/)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- GETTING STARTED -->
## 💻 Getting Started <a name="getting-started"></a>
To get a local copy up and running, follow these steps:
### Prerequisites
To work with this project, you need:
1. A modern web browser to view the website (e.g., Google Chrome, Firefox, Safari, or Microsoft Edge).
2. A code editor for editing the code, such as Visual Studio Code, Atom, or Sublime Text.
3. Node.js installed on your machine. You can download the latest version [here](https://nodejs.org/en/download/).
4. npm (Node Package Manager) installed, which comes bundled with Node.js.
5. After cloning the project, make sure to run npm install to install all the necessary dependencies, including Luxon and linters, specified in the package.json file.
### Setup
Clone this repository to your desired folder:
1. Clone it using your terminal:
```
git clone https://github.com/Alejandroq12/my-books-ES6.git
```
2. If the previous method does not work you may also download the repo as a .zip file and once you decompress the .zip file you are ready to use it.
Important: do not forget to clone the repo in the correct folder, probably you will use the following commands to achieve that in your terminal:
1. To navigate a certain folder:
```
cd <folder name>
```
2. To navigate to the previous folder:
```
cd ..
```
### Install
Install this project with:
1. To view this project, no additional installation is required.
2. However, if you want to test the linter configured for detecting errors or use Luxon library, complete the following steps:
```
npm init -y
npm install
```
3. If you run npm install, remember to create a .gitignore file to prevent the node_modules folder from being uploaded to GitHub:
```
.gitignore
node_modules/
```
### Usage
To use this project locally on your computer, follow these steps:
1. Clone the repository or download the project files.
2. Navigate to the project directory where the index.html file is located.
3. Open the index.html file with a web browser.
- Optional: You can also use the Live Server extension for Visual Studio Code to view the website with live reloading.
-- Install the Live Server extension in Visual Studio Code.
-- Open the project folder in Visual Studio Code.
-- Right-click on the index.html file and select "Open with Live Server".
The website should now be displayed in your browser, and you can interact with the application as intended.
### Run tests
1. Make sure all the linters and their configurations are installed and set up correctly in your project. If you haven't installed them yet, run `npm install` in your project directory to install the packages listed in your `package.json` file.
2. Run each linter with the following commands:
- For ESLint:
```
npx eslint .
```
- For Stylelint:
```
npx stylelint "**/*.{css,scss}"
```
- For hint:
```
npx hint .
```
3. Review the output of each linter and fix any issues reported.
### Deployment
You can deploy this project using GitHub pages:
1. Log in to your GitHub account and navigate to the repository that contains your website files.
2. Make sure that your website files are located in the main branch and in the root directory of the repository.
3. If your website is not already live, make sure that the index.html file is the main page of your website.
4. Click on the "Settings" tab in your repository.
5. Scroll down to the "GitHub Pages" section.
6. In the "Source" dropdown menu, select the branch where your website files are located. For a simple website with only HTML and CSS, this is typically the main branch.
7. In the "Path" field, make sure that the root directory is specified (i.e., "/").
8. Click "Save" to generate your website.
9. Wait a few minutes for GitHub to build and deploy your website.
10. Once the website is deployed, visit the GitHub Pages URL to view your site.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- AUTHORS -->
## 👥 Authors <a name="authors"></a>
👤 **Julio Quezada**
- GitHub: [Alejandroq12](https://github.com/Alejandroq12)
- Twitter: [@JulioAle54](https://twitter.com/JulioAle54)
- LinkedIn: [Julio Quezada](https://www.linkedin.com/in/quezadajulio/)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- FUTURE FEATURES -->
## 🔭 Future Features <a name="future-features"></a>
- [ ] **I will add media queries for larger screens**
- [ ] **I will use JavaScript to add more interactivity**
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- CONTRIBUTING -->
## 🤝 Contributing <a name="contributing"></a>
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- SUPPORT -->
## ⭐️ Show your support <a name="support"></a>
If you like this project please give a star.
Thanks in advance.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- ACKNOWLEDGEMENTS -->
## 🙏 Acknowledgments <a name="acknowledgements"></a>
I would like to thank Wes Bos because I learned how to implement flexbox with his free tutorial:
- Wes Bos: [Wes Bos](https://flexbox.io/)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- FAQ (optional) -->
## ❓ FAQ (OPTIONAL) <a name="faq"></a>
- **Are you going to use React in the future?**
- Yes! I will transform this website into a React App.
- **Did you create this website from scratch?**
- Yes! From zero, and I will improve it a lot.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- LICENSE -->
## 📝 License <a name="license"></a>
This project is [MIT](./MIT.md) licensed.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
| My Books: A fully functional website that allows you to add and remove books from a list. Built with ES6 modules and semantic HTML, and using the Luxon library for date handling. Check it out now! | arrow-functions,css3,es6-javascript,html5,javascript,luxonjs,modules,npm-package,solid-principles,webpack | 2023-03-27T03:30:53Z | 2023-06-05T05:41:10Z | null | 1 | 1 | 23 | 0 | 0 | 15 | null | null | JavaScript |
ikennarichard/ToDo | main | <a name="readme-top"></a>
<div align="center">
<br/>
<h3><b>ToDo List</b></h3>
</div>
<!-- TABLE OF CONTENTS -->
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#triangular_flag_on_post-deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ (OPTIONAL)](#faq)
- [📝 License](#license)
<!-- PROJECT DESCRIPTION -->
# 📖 ToDo List <a name="about-project"></a>
This project is a web page that lets user list To Do tasks. Built using HTML, CSS, JavaScript and webpack.
## 🛠 Built With <a name="built-with"></a>
- HTML, CSS, JavaScript
- Technologies: Webpack for code bundling
### Tech Stack <a name="tech-stack"></a>
<details>
<summary>Client</summary>
<ul>
<li><a href="https://www.w3schools.com/html/">HTML</a></li>
<li><a href="https://www.w3schools.com/css/">CSS</a></li>
<li><a href="https://www.w3schools.com/js/">JavaScript</a></li>
</ul>
</details>
<details>
<summary>Server</summary>
<ul>
<li><a href="https://webpack.js.org/guides/development/#using-webpack-dev-server">Webpack dev server</a></li>
</ul>
</details>
<details>
<summary>Database</summary>
<ul>
<li><a href="#/">Not applicable for this project</a></li>
</ul>
</details>
<!-- Features -->
### Key Features <a name="key-features"></a>
- **Homepage**
- **Todo Tasks section**
- **Add and Remove Tasks**
- **Manage tasks with local storage**
- **Drag and Drop Tasks**
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- LIVE DEMO -->
## 🚀 Live Demo <a name="live-demo"></a>
[Live Demo Link](https://todo-list-mv.netlify.app/)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- GETTING STARTED -->
## 💻 Getting Started <a name="getting-started"></a>
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
- You need a VS code text editor.
- [Node](https://nodejs.org/en/download)
### Setup
Clone this repository to your desired folder:
```sh
cd my-folder
git clone git@github.com:ikennarichard/ToDo.git
```
### Install
Install this project with:
```sh
cd my-project
npm install
```
### Usage
To run the project, execute the following command:
```sh
npm run build
npm start
```
### Run tests
To run tests, run the following command at the root of the folder:
- Stylint (CSS)
```sh
npx stylelint "**/*.{css,scss}"
```
- ES lint (Javascript)
```sh
npx eslint .
```
### Deployment
Not Available
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- AUTHORS -->
## 👥 Authors <a name="authors"></a>
👤 **Author1**
- GitHub: [@githubhandle](https://github.com/ikennarichard)
- LinkedIn: [LinkedIn](https://linkedin.com/in/ikenna-oguejiofor-38076a237)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- FUTURE FEATURES -->
## 🔭 Future Features <a name="future-features"></a>
- **Update user interface to make be more interactive**
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- CONTRIBUTING -->
## 🤝 Contributing <a name="contributing"></a>
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/ikennarichard/ToDo/issues).
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- SUPPORT -->
## ⭐️ Show your support <a name="support"></a>
If you like this project please drop a ⭐️ or give feedback on areas that can be improved.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- ACKNOWLEDGEMENTS -->
## 🙏 Acknowledgments <a name="acknowledgements"></a>
- Everyone whose code was an inspiration
- The code reviewers
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- LICENSE -->
## 📝 License <a name="license"></a>
This project is [MIT](https://github.com/ikennarichard/ToDo/blob/main/LICENSE) licensed.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
| ToDo is a web app that helps you organize daily tasks. It sorts out tasks that need to be completed and lets you mark them as complete or not. Built using HTML, CSS, JavaScript and webpack | css,html,javascript,microverse,webpack | 2023-03-27T21:17:57Z | 2023-04-06T10:10:01Z | null | 2 | 6 | 114 | 0 | 0 | 15 | null | MIT | JavaScript |
fpsapc/awesome-book-withES6 | master | <a name="readme-top">Awesome Books With ES6</a>
<div align="center">
<h3><b>Awesome Books With ES6 README</b></h3>
</div>
<!-- TABLE OF CONTENTS -->
# 📗 Table of Contents
- [📖 About the Project](#awesome-booksES6)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#triangular_flag_on_post-deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)
<!-- PROJECT DESCRIPTION -->
# 📖 [awesome-books] <a name="awesome-books"></a>
**[awesome-books]** is a project in which user can add new books and it displays the list of books collection and also user can remove the book from the list by using the remove button.
## 🛠 Built With <a name="built-with"></a>
HTML
CSS
Java Script
Java Script Modules
### Tech Stack <a name="tech-stack"></a>
<details>
<summary>PC</summary>
<ul>
<li><a href="#">My PC</a></li>
</ul>
</details>
<details>
<summary>Local Server</summary>
<ul>
<li><a href="#">Web browser</a></li>
</ul>
</details>
<details>
<summary>Github</summary>
<ul>
<li><a href="https://www.github.com/">Github</a></li>
</ul>
</details>
<!-- Features -->
### Key Features <a name="key-features"></a>
- **[User can add new book]**
- **[Use can see all collection]**
- **[User can remove a book]**
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- LIVE DEMO -->
## 🚀 Live Demo <a name="live-demo"></a>
- [Live Demo Link](https://fpsapc.github.io/awesome-book-withES6)
<p>Desktop Version:</p>
<img src="./Assets/mobile.gif" alt="mobile live"/>
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- GETTING STARTED -->
## 💻 Getting Started <a name="getting-started"></a>
You can easily use this project by using following steps
### Prerequisites
In order to run this project you need:
A PC or A Laptop
### Setup
Clone this repository to your desired folder:
You can clone this repository in your PC by using following command or you can use github desktop to clone it easliy
git clone git@github.com:fpsapc/AppleChemicals.git
<!-- AUTHORS -->
## 👥 Author <a name="authors"></a>
👤 **Salman Ahmad Khan**
- GitHub: [@githubhandle](https://github.com/fpsapc)
- Twitter: [@twitterhandle](https://twitter.com/salmanahmadkhan)
- LinkedIn: [LinkedIn](https://linkedin.com/in/salmanahmad1987)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- FUTURE FEATURES -->
## 🔭 Future Features <a name="future-features"></a>
- [ ] **[I will add some feature in future]**
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- CONTRIBUTING -->
## 🤝 Contributing <a name="contributing"></a>
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- SUPPORT -->
## ⭐️ Show your support <a name="support"></a>
If you like this project give me star please.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- ACKNOWLEDGEMENTS -->
## 🙏 Acknowledgments <a name="acknowledgements"></a>
I would like to thank Hernan for his cooperation in this project.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- LICENSE -->
## 📝 License <a name="license"></a>
This project is [MIT](./LICENSE) licensed.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
| In this project you can add new book and remove existing books, it looks like a library. HTML/CSS and JavaScript best practices are used to make this project. | css,html,javascript | 2023-03-27T14:36:43Z | 2023-03-27T20:43:41Z | null | 1 | 1 | 6 | 0 | 0 | 15 | null | NOASSERTION | JavaScript |
Ajeet1606/Namaste-React | master | # Namaste-React
This repository contains all the learnings and notes I created while learning React JS from #Namaste-React Course, food studio is a project, built while learning the concepts.
## Food-Studio
Order food from the confort of your home, we show the latest restaurants available in your city, with all the details.
Pick a dish, add to cart, place order, get delivered.
## Tech - Stack
1. Frontend Library: React JS
2. Styling: Tailwind CSS
3. Database: Firebase
4. Bundler: Parcel
5. Authentication: Firebase-Auth
6. State Management: Redux Toolkit
## Working of project
1. We fetch the restaurants of your city from Swiggy API, getting the live data.
2. Display them with Area name, Cuisines Category and Ratings.
3. Search Restaurants by Name.
4. For any restaurant, you can checkout all the different type of dishes available with details and prices per quantity.
5. Add to cart
6. Authenticate yourself
7. Place Order.
## Improvements to make
1. Not responsive for Mobile phones
2. Cart data is not stored anywhere, it should be in local storage for not logged in users to avoid losing on refresh page.
3. While Signing up, user name is not displayed in the profile point instantly, needs a refresh. It doesn't happen in logging in process.
4. Improve the design, take user address and payment details.
5. Add feature to search different cities, currently working for Prayagraj only.
## How to run on your local
1. Clone the repository
2. Run ```npm init```
3. Run ```npm start```.
4. Make sure you've allow CORS extension installed in your browser.
Drop a 💫 if you liked it.
| Food ordering application built in React, shows you the latest restaurants of your city. | firebase,firebase-auth,firebase-realtime-database,javascript,jsx,parcel-bundler,react-router-dom,reactjs,redux,redux-toolkit | 2023-04-07T04:27:14Z | 2024-01-09T08:47:03Z | null | 2 | 2 | 27 | 0 | 5 | 14 | null | null | JavaScript |
shrudra/gitgittu | main | # GitGittu
[](https://opensource.org/licenses/MIT)
GitGittu is a simple tool that allows users to view their GitHub repositories, gists, followers, and following. The tool is built with JavaScript and utilizes the GitHub REST API.
## Usage
To use the tool, simply visit the [GitGittu website](https://shrudra.github.io/gitgittu/) and enter your GitHub username in the input field. Then click on the button for the information you want to view: Repositories, Gists, Followers, or Following. The information will be displayed in a table format below the button.
## Screenshots
### Repositories
### Gists
### Followers
### Following
## Star ⭐ History
## Development
If you want to make modifications to GitGittu, you can clone the GitHub repository and make changes locally. Here are the steps to do so:
1. Clone the repository:
```
git clone https://github.com/shrudra/gitgittu.git
```
2. Open the index.html file in your browser to view the current version of the tool.
3. Make any changes you want to the JavaScript code in the main.js file.
4. Test your changes by refreshing the index.html file in your browser.
5. Once you're satisfied with your changes, commit and push them to the GitHub repository:
```
git add .
git commit -m "Description of changes made"
git push
```
## Contribute
If you find any bugs or want to contribute to the project, feel free to submit an issue or pull request.
# Donate
If you find value in what I'm creating, a book donation would be a great choice.
<a href="https://www.buymeacoffee.com/shrudra" target="_blank"><img src="https://img.buymeacoffee.com/button-api/?text=Buy%20me%20a%20book&emoji=📖&slug=shrudra&button_colour=FFDD00&font_colour=000000&font_family=Cookie&outline_colour=000000&coffee_colour=ffffff" alt="Buy Me A Book" style="height: auto !important;width: auto !important;" ></a>
## License
My Tool is licensed under the MIT License. See <a href="LICENSE">LICENSE</a> for more information.
## Contact
If you have any questions or want to reach out, you can email me at [sakhwt.hssain@gmail.com](mailto:sakhwt.hssain@gmail.com).
| GitGittu is a simple tool that allows users to view their GitHub repositories, gists, followers, and following. The tool is built with JavaScript and utilizes the GitHub REST API. | github-api,github-rest-api,javascript,javascript-app,rest-api | 2023-04-08T11:27:57Z | 2024-05-03T04:23:53Z | null | 2 | 1 | 14 | 0 | 1 | 14 | null | MIT | JavaScript |
mastermanav09/ClassZone | master | ## Project Deployment
This project is deployed and can be accessed at [Deployment Link](https://class-zone.onrender.com).
The app might run slow on the first load as it is deployed on a free plan.
## Getting Started
To get started, just clone the repository and run `npm install`:
git clone https://github.com/mastermanav09/ClassZone.git
npm install
## Dependencies
## This project relies on the following external services:
### MongoDB:
MongoDB is used as the database for storing and retrieving data.
### Cloudinary:
Cloudinary is used for managing and serving media assets such as images and files.
### Google Auth:
Used for Authentication.
## Setup
To run this project locally, you need to set up MongoDB, Cloudinary and Google O-Auth and provide the necessary API keys.
### MongoDB Setup
1. Install MongoDB on your machine.
2. Create a new MongoDB database for this project.
### Google Auth
1. Create your credentials here [Google API](https://console.cloud.google.com/apis).
### Cloudinary Setup
1. Sign up for a [Cloudinary account](https://cloudinary.com/users/register/free).
2. Obtain your Cloudinary API key, API secret, and cloud name.
3. Create a `.env` file in the project root and add the following information:
```env
MONGODB_URI=your_mongodb_connection_string
GOOGLE_ID=your_google_auth_id
GOOGLE_SECRET=your_google_auth_secret
SECRET=your_jwt_secret
NEXTAUTH_URL=your_base_url
NEXT_PUBLIC_NEXTAUTH_URL=your_base_url
NEXTAUTH_SECRET=your_next_auth_secret
CLOUDINARY_CLOUD_NAME=your_cloudinary_cloud_name
CLOUDINARY_API_KEY=your_cloudinary_api_key
CLOUDINARY_SECRET=your_cloudinary_api_secret
CLOUDINARY_UPLOAD_PRESET=your_cloudinary_upload_preset
CLOUDINARY_URL=cloudinary://my_key:my_secret@my_cloud_name
UPLOAD_CLOUDINARY_URL=https://api.cloudinary.com/v1_1/${my_cloud_name}/upload
```
## Running locally in development mode
```bash
npm run dev
# or
yarn dev
# or
pnpm dev
```
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
You can start editing the page by modifying `pages/index.js`. The page auto-updates as you edit the file.
[API routes](https://nextjs.org/docs/api-routes/introduction) can be accessed on [http://localhost:3000/api/hello](http://localhost:3000/api/hello). This endpoint can be edited in `pages/api/hello.js`.
The `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes](https://nextjs.org/docs/api-routes/introduction) instead of React pages.
## Learn More
To learn more about Next.js, take a look at the following resources:
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
## Deploy on Vercel
The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
| An E-Learning Management System inspired by Google Classroom, designed to help teachers create, distribute, and manage assignments, as well as communicate with their students. -------- NOTE - The app might run slow on the first load as it is deployed on a free plan | e-learning-management-system,google-classroom-clone,nextjs,reactjs,nodejs,scss,css-modules,javascript,classroom | 2023-04-02T06:10:49Z | 2024-02-27T21:38:23Z | null | 3 | 82 | 250 | 0 | 2 | 14 | null | MIT | JavaScript |
Alejandroq12/to-do-list | dev | <a name="readme-top">To do list</a>
<div align="center">
<img src="./assets/logo/todo.png" alt="logo" width="600" height="auto" />
<br/>
<h3><b>To do list</b></h3>
</div>
<!-- TABLE OF CONTENTS -->
# 📗 Table of Contents
- [📗 Table of Contents](#-table-of-contents)
- [📖 To do list ](#-to-do-list-)
- [🛠 Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Key Features ](#key-features-)
- [🚀 Live Demo ](#-live-demo-)
- [💻 Getting Started ](#-getting-started-)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#deployment)
- [👥 Authors ](#-authors-)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [❓ FAQ (OPTIONAL) ](#-faq-optional-)
- [📝 License ](#-license-)
<!-- PROJECT DESCRIPTION -->
# 📖 To do list <a name="about-project"></a>
🚀 This repository contains the front-end implementation of a to-do list web application. The app is designed to help users efficiently manage their tasks and stay organized, using modern web development practices and technologies.
## 🛠 Built With <a name="built-with"></a>
### Tech Stack <a name="tech-stack"></a>
<details>
<summary>Client</summary>
<ul>
<li><a href="https://developer.mozilla.org/es/docs/Learn/HTML">HTML</a></li>
<li><a href="https://developer.mozilla.org/es/docs/Web/CSS">CSS</a></li>
<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript">JavaScript</a></li>
<li><a href="https://webpack.js.org/">Webpack</a></li>
<li><a href="https://jestjs.io/">Jest</a></li>
</ul>
</details>
<!-- Features -->
### Key Features <a name="key-features"></a>
- **Use of ES6 syntax**
- **Modular JavaScript: The application is built using JavaScript modules, resulting in a well-organized, maintainable, and scalable codebase.**
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- LIVE DEMO -->
## 🚀 Live Demo <a name="live-demo"></a>
- [Live Demo Link](https://alejandroq12.github.io/to-do-list/)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- GETTING STARTED -->
## 💻 Getting Started <a name="getting-started"></a>
To get a local copy up and running, follow these steps:
### Prerequisites
To work with this project, you need:
1. A modern web browser to view the website (e.g., Google Chrome, Firefox, Safari, or Microsoft Edge).
2. A code editor for editing the code, such as Visual Studio Code, Atom, or Sublime Text.
3. Node.js installed on your machine. You can download the latest version [here](https://nodejs.org/en/download/).
4. npm (Node Package Manager) installed, which comes bundled with Node.js.
5. After cloning the project, make sure to run npm install to install all the necessary dependencies, including Luxon and linters, specified in the package.json file.
### Setup
Clone this repository to your desired folder:
1. Clone it using your terminal:
```
git clone https://github.com/Alejandroq12/to-do-list.git
```
2. If the previous method does not work you may also download the repo as a .zip file and once you decompress the .zip file you are ready to use it.
Important: do not forget to clone the repo in the correct folder, probably you will use the following commands to achieve that in your terminal:
1. To navigate a certain folder:
```
cd <folder name>
```
2. To navigate to the previous folder:
```
cd ..
```
### Install
Install this project with:
1. To view this project, no additional installation is required.
2. However, if you want to test the linters configured for detecting errors or use Luxon library, complete the following steps:
```
npm install
```
3. If you run `npm install`, remember to create a `.gitignore` file to prevent the node_modules folder from being uploaded to GitHub:
```
.gitignore
node_modules/
```
### Usage
To use this project locally on your computer, follow these steps:
1. Clone the repository or download the project files.
2. Navigate to the project directory where the index.html file is located.
3. Open the `index.html` file with a web browser.
- Optional: You can also use the Live Server extension for Visual Studio Code to view the website with live reloading.
-- Install the Live Server extension in Visual Studio Code.
-- Open the project folder in Visual Studio Code.
-- Right-click on the index.html file and select "Open with Live Server".
The website should now be displayed in your browser, and you can interact with the application as intended.
### Run tests
1. Make sure all the linters and their configurations are installed and set up correctly in your project. If you haven't installed them yet, run `npm install` in your project directory to install the packages listed in your `package.json` file.
2. Run each linter with the following commands:
- For ESLint:
```
npx eslint .
```
- For Stylelint:
```
npx stylelint "**/*.css"
```
- For hint:
```
npx hint .
```
- For Jest:
```
npx jest
```
3. Review the output of each linter and fix any issues reported.
### Deployment
You can deploy this project using GitHub pages:
1. Log in to your GitHub account and navigate to the repository that contains your website files.
2. Make sure that your website files are located in the main branch and in the root directory of the repository.
3. If your website is not already live, make sure that the index.html file is the main page of your website.
4. Click on the "Settings" tab in your repository.
5. Scroll down to the "GitHub Pages" section.
6. In the "Source" dropdown menu, select the branch where your website files are located. For a simple website with only HTML and CSS, this is typically the main branch.
7. In the "Path" field, make sure that the root directory is specified (i.e., "/").
8. Click "Save" to generate your website.
9. Wait a few minutes for GitHub to build and deploy your website.
10. Once the website is deployed, visit the GitHub Pages URL to view your site.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- AUTHORS -->
## 👥 Authors <a name="authors"></a>
👤 **Julio Quezada**
- GitHub: [Alejandroq12](https://github.com/Alejandroq12)
- Twitter: [@JulioAle54](https://twitter.com/JulioAle54)
- LinkedIn: [Julio Quezada](https://www.linkedin.com/in/quezadajulio/)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- FUTURE FEATURES -->
## 🔭 Future Features <a name="future-features"></a>
- [ ] **I will add media queries for larger screens**
- [ ] **I will use JavaScript to add more interactivity**
- [ ] **Mark tasks as completed**
- [ ] **Automatically reorder tasks based on priority**
- [ ] **Fully responsive design for mobile and desktop devices**
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- CONTRIBUTING -->
## 🤝 Contributing <a name="contributing"></a>
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- SUPPORT -->
## ⭐️ Show your support <a name="support"></a>
If you like this project please give a star.
Thanks in advance.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- ACKNOWLEDGEMENTS -->
## 🙏 Acknowledgments <a name="acknowledgements"></a>
I would like to thank Wes Bos because I learned how to implement flexbox with his free tutorial:
- Wes Bos: [Wes Bos](https://flexbox.io/)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- FAQ (optional) -->
## ❓ FAQ (OPTIONAL) <a name="faq"></a>
- **Are you going to use React in the future?**
- Yes! I will transform this website into a React App.
- **Did you create this website from scratch?**
- Yes! From zero, and I will improve it a lot.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- LICENSE -->
## 📝 License <a name="license"></a>
This project is [MIT](./MIT.md) licensed.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
| 🚀 This repository contains the front-end implementation of a to-do list web application. The app is designed to help users efficiently manage their tasks and stay organized, using modern web development practices and technologies. | css,dom,dom-manipulation,es6-javascript,html,javascript,todolist,webpack,jest,jest-tests | 2023-03-29T05:13:34Z | 2023-06-09T05:09:58Z | null | 2 | 11 | 95 | 3 | 0 | 14 | null | null | JavaScript |
corbado/example-passkeys-sveltekit | main | # Svelte Passkey Example App
This is a sample implementation of the Corbado UI component and Node SDK being integrated into a web application built
with Sveltekit.
Please see the [full blog post](https://www.corbado.com/blog/sveltekit-passkeys) to understand the detailed steps needed to
integrate passkeys into Svelte apps.
## File structure
- `src/routes/+page.svelte`: component for the sign up / login screen
- `src/routes/profile/+page.server.ts`: Used to load user information on the server side
- `src/routes/profile/+page.svelte`: component for the user profile information that is shown after successful
authentication
- `src/routes/+layout.server.ts`: file to switch SSR off (we're working on SSR support already)
- `.env`: add Corbado project ID and project secret as environment variables that you can obtain
from the [Corbado developer panel](https://app.corbado.com/signin#register)
## Setup
### Prerequisites
Please follow the steps in [Getting started](https://docs.corbado.com/overview/getting-started) to create and configure
a project in the [Corbado developer panel](https://app.corbado.com/signin#register).
You need to have [Node](https://nodejs.org/en/download) and `npm` installed to run it.
## Usage
Run
```bash
npm i
```
to install all dependencies.
Finally, you can run the project locally with
```bash
npm run dev
```
| This is a sample repository of a Svelte app (using SvelteKit and TailwindCSS) that offers passkey authentication for demo purposes. | faceid,fido2,javascript,passkey,passkeys,svelte,sveltekit,tailwind,tailwindcss,touchid | 2023-04-04T13:00:21Z | 2024-05-08T13:29:55Z | null | 6 | 18 | 110 | 0 | 0 | 14 | null | null | Svelte |
withaarzoo/Furniture-Website | main | # Multipage Furniture Website
This is a multipage furniture website built using HTML, CSS, and JavaScript. It features a clean and modern design, with multiple pages to showcase different types of furniture.
## Video Tutorial
A full video tutorial for building this website is available on YouTube. You can watch it at - https://youtu.be/e5ymgfaEqOI
## Features
- Responsive design for different screen sizes
- Multiple pages to showcase different types of furniture
- Image sliders and carousels for displaying furniture images
- Contact form for customers to send inquiries
- Google Maps integration to display store location
## Installation
To run the website locally, you can clone the source code from the GitHub repository and open the index.html file in your browser.
```bash
git clone https://github.com/Aarzoo75/Furniture-Website.git
cd Furniture-Website
```
Alternatively, you can download the source code as a ZIP file and extract it to a local directory.
## Usage
The website is designed to be easy to customize and modify. You can edit the HTML, CSS, and JavaScript files to change the content, styling, and functionality of the website.
The main HTML file is `index.html`, which includes links to the CSS and JavaScript files. The CSS files are located in the `css` directory, and the JavaScript files are located in the `js` directory.
## Contributing
If you find any issues or bugs with the website, or if you have suggestions for improvements, feel free to open an issue or pull request on the GitHub repository.
## Credits
This website was created by [Aarzoo](https://twitter.com/Aarzoo75).
## Source Code
You can access the source code at - [click here](https://rb.gy/emh3d7)
## Preview
| This is a multipage furniture website built using HTML, CSS, and JavaScript. It features a clean and modern design, with multiple pages to showcase different types of furniture. | css,ecommerce,furniture-ecommerce,furniture-websites,html,javascript,webdevelopment | 2023-04-06T06:47:40Z | 2024-05-01T10:36:39Z | null | 1 | 1 | 7 | 0 | 4 | 14 | null | null | SCSS |
fpsapc/To_Do_List | master | <a name="readme-top"></a>
<div align="center">
<h3><b>To Do List README</b></h3>
</div>
<!-- TABLE OF CONTENTS -->
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ (OPTIONAL)](#faq)
- [📝 License](#license)
<!-- PROJECT DESCRIPTION -->
# 📖 [To_Do_List] <a name="about-project"></a>
**[To_Do_List]** is a project that provide user a form. User can fill his/her daily task and remove them when they marked as completed.
## 🛠 Built With <a name="built-with"></a>
HTML
CSS
ES6 Modules
Webpack
### Tech Stack <a name="tech-stack"></a>
<details>
<summary>Client</summary>
<ul>
<li><a href="#">HTML,CSS and JavaScript</a></li>
</ul>
</details>
<details>
<summary>Server</summary>
<ul>
<li><a href="https://localhost:8080/">Dev Server</a></li>
</ul>
</details>
<details>
<summary>Pakage Manager</summary>
<ul>
<li><a href="#">NPM</a></li>
</ul>
</details>
<!-- Features -->
### Key Features <a name="key-features"></a>
- **[Allow user to add daily task]**
- **[Allow user to mark the tasks that were completed]**
- **[Allow user to deleted the completed tasks]**
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 🚀 Live Demo <a name="live-demo"></a>
- [Live Demo Link](https://fpsapc.github.io/To_Do_List)
<p>Desktop Version:</p>
<img src="./Assets/mobile.gif" alt="mobile live"/>
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- GETTING STARTED -->
## 💻 Getting Started <a name="getting-started"></a>
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
- A web browser to view output e.g [Google Chrome](https://www.google.com/chrome/).
- An IDE e.g [Visual studio code](https://code.visualstudio.com/).
- `node` should be installed in your local machine, [node website](https://nodejs.org/en/download/).
- Install the `npm` package manager use this [to install both node and npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm).
- [A terminal](https://code.visualstudio.com/docs/terminal/basics).
### Setup
Clone this repository to your desired folder or download the Zip folder:
```
https://github.com/fpsapc/To_Do_List
```
- Navigate to the location of the folder in your machine:
**``you@your-Pc-name:~$ cd To_Do_List``**
### Install
To install all dependencies, run:
```
npm install
```
### Usage
To run the project, follow these instructions:
- After Cloning this repo to your local machine.
- Open the `index.html` in your browser.
- You can also use `npm start` command in terminal to run this at localhost:8080
### Run tests
To run tests, run the following command:
- Track HTML linter errors run:
```
npx hint .
```
- Track CSS linter errors run:
```
npx stylelint "**/*.{css,scss}"
```
- Track JavaScript linter errors run:
```
npx eslint .
```
- run test:
```
npm test
```
### Deployment <a name="deployment"></a>
You can deploy this project using: GitHub Pages,
- I used GitHub Pages to deploy my website.
- For more information about publishing sources, see "[About GitHub pages](https://docs.github.com/en/pages/getting-started-with-github-pages/about-github-pages#publishing-sources-for-github-pages-sites)".
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- AUTHORS -->
## 👥 Author <a name="authors"></a>
👤 **Salman Ahmad Khan**
- GitHub: [@githubhandle](https://github.com/fpsapc)
- Twitter: [@twitterhandle](https://twitter.com/salman-ahmadkhan1987)
- LinkedIn: [LinkedIn](https://linkedin.com/in/salman-ahmad1987 )
👤 **Tebe Tisloh**
- GitHub: [@Booze33](https://github.com/Booze33)
- Twitter: [@twitterhandle](https://twitter.com/twitterhandle)
- LinkedIn: [LinkedIn](https://linkedin.com/in/linkedinhandle)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- FUTURE FEATURES -->
## 🔭 Future Features <a name="future-features"></a>
- [ ] **[I will add some images to this project to make it look's more attractive]**
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- CONTRIBUTING -->
## 🤝 Contributing <a name="contributing"></a>
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- SUPPORT -->
## ⭐️ Show your support <a name="support"></a>
If you like this project give me a star ⭐️
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- ACKNOWLEDGEMENTS -->
## 🙏 Acknowledgments <a name="acknowledgements"></a>
I would like to thank web.archive.org. for this to do list format
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- FAQ (optional) -->
## ❓ FAQ (OPTIONAL) <a name="faq"></a>
- **[How this list works]**
- [add your daily task and click on checkbox for completed task]
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- LICENSE -->
## 📝 License <a name="license"></a>
This project is [MIT](./LICENSE) licensed.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
| You can add your daily tasks list here and tick every task acording to its completion. You can also remove and edit tasks. You can also clear all completed tasks after selecting them from the list. HTML/CSS and JavaScript best practices are used to make this project. Also use webpacks in this project. This project can be run on localhost | css,html,javascript,linters,webpack | 2023-03-28T18:54:20Z | 2023-04-08T16:56:24Z | null | 2 | 7 | 41 | 0 | 0 | 14 | null | NOASSERTION | JavaScript |
adamlui/youtube-classic | main | null | 📺 Reverts YouTube to its classic design | classic,greasemonkey,javascript,nostalgia,nostalgic,ui,userscripts,youtube | 2023-04-02T16:28:53Z | 2024-05-20T06:37:33Z | null | 1 | 13 | 169 | 2 | 1 | 13 | null | NOASSERTION | JavaScript |
Bestbynature/Awesome-Books-Modules | main | <a name="readme-top"></a>
<div align="center">
<br/>
<h3><b>Awesome Books Project</b></h3>
</div>
<!-- TABLE OF CONTENTS -->
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#triangular_flag_on_post-deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)
<!-- PROJECT DESCRIPTION -->
# 📖 [Awesome Books Project] <a name="about-project"></a>
**[Awesome Books Project](https://bestbynature.github.io/awesome-books-project/)** is a a basic website that allows users to add and/or remove books from a list of books on the website. The Project is achieved by using JavaScript objects and arrays. The project also implemented features that dynamically modify the DOM and add basic events and listeners..
## 🛠 Built With <a name="built-with"></a>
### Tech Stack <a name="tech-stack"></a>
<details>
<summary>Client</summary>
<ul>
<li>HTML</li>
<li>CSS</li>
<li>JAVASCRIPT</li>
</ul>
</details>
<!-- Features -->
### Key Features <a name="key-features"></a>
- **[Responsive design]**
- **[Page Jumps]**
- **[Add/Remove buttons]**
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- LIVE DEMO -->
## 🚀 Live Demo <a name="live-demo"></a>
- [Awesome Books Project](https://bestbynature.github.io/awesome-books-project/)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- GETTING STARTED -->
## 💻 Getting Started <a name="getting-started"></a>
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
<ul>
<li>The current version of node</li>
<li>To have Git installed on your local machine</li>
<li>Node Package manager (npm) </li>
<li>An editor such as Visual Studio Code</li>
</ul>
### Setup
Clone this repository to your desired folder:
<ul>
<li>Create your classic access token from github.com</li>
<li>run "git clone https://{access_token}@github.com/username/{repo_name}.git"</li>
<li>Update your git identity by running "git config --global user.email "your_email@gmail.com""</li>
<li>Update your name on git by running "git config --global user.name "your_name"</li>
</ul>
### Install
Install this project with:
- In the first commit of your feature branch create a .github/workflows folder and add a copy of [.github/workflows/linters.yml](https://github.com/microverseinc/linters-config/blob/master/html-css-js/.github/workflows/linters.yml) to that folder.
- create a .gitignore file and add 'node_modules' to it
- run 'npm init -y'
- run 'npm install --save-dev hint@7.x'
- Copy [hintrc](https://github.com/microverseinc/linters-config/blob/master/html-css-js/.hintrc) to the root directory of your project.
- run 'npx hint .'
- Fix validation errors.
- run 'npm install --save-dev stylelint@13.x stylelint-scss@3.x stylelint-config-standard@21.x stylelint-csstree-validator@1.x'
- Copy [stylelintrc.json](https://github.com/microverseinc/linters-config/blob/master/html-css-js/.stylelintrc.json) to the root directory of your project.
- Run 'npx stylelint "\*_/_.{css,scss}"'
- fix linter errors
- run 'npm install --save-dev eslint@7.x eslint-config-airbnb-base@14.x eslint-plugin-import@2.x babel-eslint@10.x'
- Copy [eslintrc.json](https://github.com/microverseinc/linters-config/tree/master/html-css-js)
- Run npx eslint . on the root of your directory of your project
- Fix linter error.
### Usage
To run the project, execute the following command:
```sh
use git bash to open in Vs code
```
### Run tests
To run tests, run the following command:
```sh
Run "npx hint ."
Run "npx stylelint "**/*.{css,scss} --fix " to fix linters
Run "npx eslint . --fix to fix linters"
```
### Deployment
You can deploy this project using:
- github pages
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- AUTHORS -->
## 👥 Authors <a name="authors"></a>
👤 **Author**
- GitHub: [@githubhandle](https://github.com/Bestbynature)
- Twitter: [@twitterhandle](https://twitter.com/Dammybest)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/damilare-ismaila-4a5a8b30/)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- FUTURE FEATURES -->
## 🔭 Future Features <a name="future-features"></a>
- [ ] **[contact form page]**
- [ ] **[A feature for price inclusion]**
- [ ] **[A feature for updating the cart]**
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- CONTRIBUTING -->
## 🤝 Contributing <a name="contributing"></a>
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- SUPPORT -->
## ⭐️ Show your support <a name="support"></a>
If you like this project, kindly drop a star for me.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- ACKNOWLEDGEMENTS -->
## 🙏 Acknowledgments <a name="acknowledgements"></a>
I would like to use this medium to appreciate [Microverse](https://microverse.org) for giving me this type of opportunity.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- LICENSE -->
## 📝 License <a name="license"></a>
This project is [MIT](./LICENSE) licensed.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
| In this project, I restructure Awesome books app code using modular JavaScript, html and CSS. The web app can add a new book to the collection. Books can be deleted as well. Upon user interaction, the resulting book list is stored in local storage. | css,html,javascript | 2023-03-26T12:25:55Z | 2023-03-26T18:24:00Z | null | 1 | 1 | 12 | 0 | 0 | 13 | null | MIT | JavaScript |
roblouie/upyri | master | # UPYRI
My entry for the 2023 JS13K competition. The game placed 5th overall.
## Trailer
[](http://www.youtube.com/watch?v=sATZin4rFwQ "UPYRI")
## Making Of / Post Mortem
https://roblouie.com/article/1154/the-making-of-upyri-js13k-2023-post-mortem/
## Quick Start
Install dependencies: `npm install`
Run Server: `npm run serve`
| Upyri is a 13kb 3D adventure horror game that was awarded 5th place in JS13k 2023 | glsl,javascript,shaders,typescript,webgl | 2023-03-30T20:37:21Z | 2023-11-06T16:42:31Z | null | 1 | 1 | 83 | 0 | 1 | 13 | null | null | TypeScript |
EMI-INDO/emi-indo-cordova-plugin-admob | main |
# emi-indo-cordova-plugin-admob
Cordova Plugin Admob Android and IOS
### Mobile Ads SDK (Android: 22.6.0) [Release Notes:](https://developers.google.com/admob/android/rel-notes)
### Mobile Ads SDK (IOS: 10.14.0) [Release Notes:](https://developers.google.com/admob/ios/rel-notes)
## Minimum Cordova Engines
- cordova-android version = 12.0.0
- cordova-ios version = 7.0.0
## Minimum macOS | Xcode, and others
- Monterey
- Xcode 14.1 or higher
- Command Line Tools 14.1 or higher
- Target iOS 11.0 or higher
https://developers.google.com/admob/ios/quick-start
<details>
<summary>Guaranteed income using this plugin #14</summary>
> __Note__
> - ## It's Not a fork, it's purely rewritten, clean of 3rd party code.
> __Note__
> - ### No Ad-Sharing
> - ### No Remote Control
> - ### I guarantee 100% revenue for you.
> - [Code source:](https://github.com/googleads/googleads-mobile-android-examples) - Admob:
> -
</details>
## VIDEO Test Collapsible banner ads
- Test Plugin with construct 3
[](https://youtu.be/uUivVBC0cqs)
## VIDEO Test UMP or CMP SDK Android
- Test Plugin with construct 3
[](https://youtu.be/lELJRKDrkNk)
## VIDEO Test UMP or CMP SDK IOS
- Test Plugin with construct 3
[](https://youtu.be/d2dSn4LBvro)
## VIDEO Test Ad Type with Xcode/IOS
- Test Plugin with construct 3
[](https://youtu.be/YYMJuf7gIsg)
## 💰Sponsor this project
[](https://paypal.me/emiindo)
## [Check all release notes:](https://github.com/EMI-INDO/emi-indo-cordova-plugin-admob/releases/)
## Features
<details>
<summary>Features #1</summary>
<ul>
<li> initialize</li>
<li> targeting</li>
<li> globalSettings</li>
<li> AppTrackingTransparency (ATT)</li>
<li> CMP SDK</li>
<li> UMP SDK</li>
<li> App Open Ads</li>
<li> Banner Ads</li>
<li> Interstitial Ads</li>
<li> Rewarded Ads</li>
<li> Mediation</li>
<li> impression-level-ad-revenue</li>
</ul>
</details>
## Installation
```sh
cordova plugin add emi-indo-cordova-plugin-admob --save --variable APP_ID_ANDROID=ca-app-pub-xxx~xxx --variable APP_ID_IOS=ca-app-pub-xxx~xxx
```
## Remove
```sh
cordova plugin rm emi-indo-cordova-plugin-admob
```
## Import the Mobile Ads SDK IOS
### Then from the command line run:
- cd platforms/ios
### Then from the command line run:
- pod install --repo-update
## >>> Device Ready <<<
<details>
<summary>Methods: #2</summary>
<pre>
// Support Platform: Android | IOS
cordova.plugins.emiAdmobPlugin.globalSettings([config_globalSettings]);
cordova.plugins.emiAdmobPlugin.targeting([config_Targeting]);
cordova.plugins.emiAdmobPlugin.initialize();
// UMP SDK 2.1.0
cordova.plugins.emiAdmobPlugin.getConsentRequest(); // (Platform: Both)
cordova.plugins.emiAdmobPlugin.consentReset(); // (Platform: Both)
cordova.plugins.emiAdmobPlugin.showPrivacyOptionsForm(); // (Platform: Both)
// CMP SDK 2.2.0
cordova.plugins.emiAdmobPlugin.requestIDFA(); // UMP SDK to handle Apple's App Tracking Transparency (ATT) (Platform: IOS)
cordova.plugins.emiAdmobPlugin.getIabTfc((IABTFC) => { console.log(JSONstringify(IABTFC)) }); // CMP SDK 2.2 (Platform: Both)
</pre>
<details>
<summary>Note setDebugGeography #2</summary>
Testing is very easy, no need for VPN, TEST-DEVICE-HASHED-ID, or anything else, everything has been made programmatically.
must be false if the application is released to the play store / app store.
consent from will continue to be called regardless of its status 0,1,2,3,
until the value is changed to false.
setDebugGeography = true | false
</details>
<li>example</li></ul>
<pre>
document.addEventListener("deviceready", function(){
const config_globalSettings = [
setAppMuted = false, // default: false
setAppVolume = 1, // float: default: 1
enableSameAppKey = false, // default: false
npa = "1", // string "0" | "1"
enableCollapsible = true, // (BETA) activate the collapsible banner ads
responseInfo = false, // default: false
setDebugGeography = false // default: false
]
cordova.plugins.emiAdmobPlugin.getConsentRequest( (ststus) => { console.log("Consent Status: " + ststus) });
cordova.plugins.emiAdmobPlugin.globalSettings(config_globalSettings);
document.addEventListener('on.get.consent.status', () => {
// Regardless of the state, call SDK initialize
cordova.plugins.emiAdmobPlugin.initialize();
cordova.plugins.emiAdmobPlugin.getIabTfc((IABTFC) => { console.log(JSONstringify(IABTFC)) });
});
}, false);
</pre>
</details>
<details>
<summary>Event UMP SDK #3</summary>
<pre>
on.get.consent.status
<br>
</pre>
<li>example:#4</li></ul>
<pre>
document.addEventListener('on.get.consent.status', () => {
console.log("on get consent status");
});
</pre>
</details>
<details>
<summary>Event CMP SDK #5</summary>
<pre>
on.getIabTfc
on.TCString.expired
on.TCString.remove
<br>
</pre>
<details>
<summary>Note #6</summary>
TCString expires 360 days, plugin automatically deletes it after 360 days. call consentRest()
</details>
<li>example: #7</li></ul>
<pre>
document.addEventListener('on.TCString.expired', () => {
console.log("on TCString expires 360 days");
cordova.plugins.emiAdmobPlugin.consentReset();
});
</pre>
</details>
- [AppTrackingTransparency (ATT) framework:](https://developer.apple.com/documentation/apptrackingtransparency/attrackingmanager/authorizationstatus)
- [Consent Management Platform API:](https://github.com/InteractiveAdvertisingBureau/GDPR-Transparency-and-Consent-Framework/blob/master/TCFv2/IAB%20Tech%20Lab%20-%20CMP%20API%20v2.md#in-app-details)
- [Example Get Consent Status:](https://github.com/EMI-INDO/emi-indo-cordova-plugin-admob/blob/main/example/Advanced%20topics/consent.html) index.html
- [Example requestIDFA:](https://github.com/EMI-INDO/emi-indo-cordova-plugin-admob/blob/main/example/Advanced%20topics/requestIDFA.html) index.html
- [Example IABTFC:](https://github.com/EMI-INDO/emi-indo-cordova-plugin-admob/blob/main/example/Advanced%20topics/IABTFC.html) index.html
## Global Variable adunitId
```
<script>
Ad format Demo ad unit ID
// https://developers.google.com/admob/android/test-ads
// https://developers.google.com/admob/ios/test-ads
var App_Open_ID;
var Banner_ID;
var Interstitial_ID;
var Rewarded_ID;
var Rewarded_Interstitial_ID;
if (window.cordova.platformId === 'ios') {
App_Open_ID = 'ca-app-pub-3940256099942544/5575463023';
Banner_ID = 'ca-app-pub-3940256099942544/2934735716';
Interstitial_ID = 'ca-app-pub-3940256099942544/4411468910';
Rewarded_ID = 'ca-app-pub-3940256099942544/1712485313';
Rewarded_Interstitial_ID = 'ca-app-pub-3940256099942544/6978759866';
} else {
// Assume Android
App_Open_ID = 'ca-app-pub-3940256099942544/9257395921';
Banner_ID = 'ca-app-pub-3940256099942544/6300978111';
Interstitial_ID = 'ca-app-pub-3940256099942544/1033173712';
Rewarded_ID = 'ca-app-pub-3940256099942544/5224354917';
Rewarded_Interstitial_ID = 'ca-app-pub-3940256099942544/5354046379';
}
</script>
```
## AppOpenAd ADS
<details>
<summary>Methods:</summary>
<pre>
// Support Platform: Android | IOS
cordova.plugins.emiAdmobPlugin.loadAppOpenAd([config_AppOpenAd]);
cordova.plugins.emiAdmobPlugin.showAppOpenAd();
<br>
</pre>
<li>example:</li></ul>
<pre>
// WARNING config must be an array[] not an object{}
// adUnitId = call Global Variable
cordova.plugins.emiAdmobPlugin.loadAppOpenAd([ adUnitId = App_Open_ID, autoShow = true ]);
</pre>
</details>
<details>
<summary>Event</summary>
<pre>
on.appOpenAd.loaded
on.appOpenAd.failed.loaded
on.appOpenAd.dismissed
on.appOpenAd.failed.show
on.appOpenAd.show
on.appOpenAd.revenue
<br>
</pre>
<li>example:</li></ul>
<pre>
document.addEventListener('on.appOpenAd.loaded', () => {
console.log("On App Open Ad loaded");
});
</pre>
</details>
- [FULL AppOpenAd basic:](https://github.com/EMI-INDO/emi-indo-cordova-plugin-admob/blob/main/example/app_open_ads.html) -index.html
## BANNER ADS
<details>
<summary>Methods:</summary>
<pre>
cordova.plugins.emiAdmobPlugin.loadBannerAd([bannerConfig]);
cordova.plugins.emiAdmobPlugin.showBannerAd();
cordova.plugins.emiAdmobPlugin.hideBannerAd();
cordova.plugins.emiAdmobPlugin.removeBannerAd();
</pre>
<li>example:</li></ul>
<pre>
// WARNING config must be an array[] not an object{}
// adUnitId = call Global Variable
const bannerConfig = [
adUnitId = Banner_ID,
position = "bottom-center",
size = "BANNER",
collapsible = "bottom", // (BETA) enable in globalSettings
adaptive_Width = 320, // Ignored
autoShow = true // boolean
]
cordova.plugins.emiAdmobPlugin.loadBannerAd(bannerConfig);
</pre>
</details>
<details>
<summary>Position type string</summary>
<pre>
top-right
top-center
left
center
right
bottom-center
bottom-right
</pre>
</details>
<details>
<summary>Size type string</summary>
<pre>
ANCHORED
IN_LINE
FULL_WIDTH
BANNER
FLUID
LARGE_BANNER
MEDIUM_RECTANGLE
FULL_BANNER
LEADERBOARD
adaptive_Width = number
</pre>
</details>
<details>
<summary>Event</summary>
<pre>
on.banner.load
on.banner.failed.load
on.banner.click
on.banner.close
on.banner.impression
on.banner.open
// new
on.banner.revenue
on.banner.remove
on.banner.hide
</pre>
<li>example:</li></ul>
<pre>
document.addEventListener('on.banner.load', () => {
console.log("on banner load");
});</pre>
</details>
[FULL Banner basic:](https://github.com/EMI-INDO/emi-indo-cordova-plugin-admob/blob/main/example/banner_ads.html) index.html
## Interstitial ADS
<details>
<summary>Methods:</summary>
<pre>
// Support Platform: Android | IOS
cordova.plugins.emiAdmobPlugin.loadInterstitialAd([config_Interstitial]);
cordova.plugins.emiAdmobPlugin.showInterstitialAd();
<br>
</pre>
<li>example:</li></ul>
<pre>
// WARNING config must be an array[] not an object{}
// adUnitId = call Global Variable
cordova.plugins.emiAdmobPlugin.loadInterstitialAd([ adUnitId = Interstitial_ID, autoShow = true ]);
</pre>
</details>
<details>
<summary>Event</summary>
<pre>
on.interstitial.loaded
on.interstitial.failed.load
on.interstitial.click
on.interstitial.dismissed
on.interstitial.failed.show
on.interstitial.impression
on.interstitial.show
// new
on.interstitial.revenue
<br>
</pre>
<li>example:</li></ul>
<pre>
document.addEventListener('on.interstitial.loaded', () => {
console.log("on interstitial Ad loaded");
});
</pre>
</details>
[FULL Interstitial basic:](https://github.com/EMI-INDO/emi-indo-cordova-plugin-admob/blob/main/example/interstitial_ads.html) index.html
## Rewarded Interstitial ADS
<details>
<summary>Methods:</summary>
<pre>
// Support Platform: Android | IOS
cordova.plugins.emiAdmobPlugin.loadRewardedInterstitialAd([config_rewardedInt]);
cordova.plugins.emiAdmobPlugin.showRewardedInterstitialAd();
<br>
</pre>
<li>example:</li></ul>
<pre>
// WARNING config must be an array[] not an object{}
// adUnitId = call Global Variable
cordova.plugins.emiAdmobPlugin.loadRewardedInterstitialAd([ adUnitId = Rewarded_Interstitial_ID, autoShow = true ]);
</pre>
</details>
<details>
<summary>Event</summary>
<pre>
on.rewardedInt.loaded
on.rewardedInt.failed.load
on.rewardedInt.click
on.rewardedInt.dismissed
on.rewardedInt.failed.show
on.rewardedInt.impression
on.rewardedInt.showed
on.rewardedInt.userEarnedReward
// new
on.rewardedInt.revenue
on.rewardedInt.ad.skip
<br>
</pre>
<li>example:</li></ul>
<pre>
document.addEventListener('on.rewardedInt.loaded', () => {
console.log("on rewarded Interstitial load");
});
</pre>
</details>
[FULL Rewarded Interstitial basic:](https://github.com/EMI-INDO/emi-indo-cordova-plugin-admob/blob/main/example/rewarded_interstitial_ads.html) index.html
## Rewarded ADS
<details>
<summary>Methods:</summary>
<pre>
// Support Platform: Android | IOS
cordova.plugins.emiAdmobPlugin.loadRewardedAd([config_rewarded]);
cordova.plugins.emiAdmobPlugin.showRewardedAd();
<br>
</pre>
<li>example:</li></ul>
<pre>
// adUnitId = call Global Variable
cordova.plugins.emiAdmobPlugin.loadRewardedAd([ adUnitId = Rewarded_ID, autoShow = true ]);
</pre>
</details>
<details>
<summary>Event</summary>
<pre>
on.rewarded.loaded
on.rewarded.failed.load
on.rewarded.click
on.rewarded.dismissed
on.rewarded.failed.show
on.rewarded.impression
on.rewarded.show
on.reward.userEarnedReward
// new
on.rewarded.revenue
on.rewarded.ad.skip
<br>
</pre>
<li>example:</li></ul>
<pre>
document.addEventListener('on.rewarded.loaded', () => {
console.log("on rewarded Ad loaded");
});
</pre>
</details>
[FULL Rewarded basic:](https://github.com/EMI-INDO/emi-indo-cordova-plugin-admob/blob/main/example/rewarded_ads.html) index.html
<details>
<summary>Features and Coming soon #13</summary>
## Features
- SDK initialize
- targeting
- globalSettings
- App Open Ads
- Banner Ads
- Interstitial Ads
- Rewarded Ads
- Rewarded interstitial Ads
- [Consent](https://github.com/EMI-INDO/emi-indo-cordova-plugin-admob/blob/main/example/Advanced%20topics/consent.html)
- Mediation
- impression-level-ad-revenue
- GDPR IAB TFCv2.2
- AppTrackingTransparency (ATT)
- Collapsible banner ads (BETA)
## Coming soon
- App Open Ads ( Finished )
- User Consent ( Finished )
- Mediation ( Finished )
- https://developers.google.com/admob/android/native/start
- https://developers.google.com/admob/android/impression-level-ad-revenue ( Finished ) v1.1.9
- https://developers.google.com/admob/android/ssv
- https://developers.google.com/admob/android/privacy/gdpr ( Finished ) v1.4.0 [index.html](https://github.com/EMI-INDO/emi-indo-cordova-plugin-admob/blob/main/example/Advanced%20topics/consent_GDPR_IAB_TFCv2.2.html)
- https://github.com/InteractiveAdvertisingBureau/GDPR-Transparency-and-Consent-Framework/ ( Finished ) v1.4.0 [index.html](https://github.com/EMI-INDO/emi-indo-cordova-plugin-admob/blob/main/example/Advanced%20topics/consent_GDPR_IAB_TFCv2.2.html)
</details>
# IAB Europe Transparency & Consent Framework
<details>
<summary>Example How to read consent choices #12</summary>
// index.html https://github.com/EMI-INDO/emi-indo-cordova-plugin-admob/blob/main/example/Advanced%20topics/consent_GDPR_IAB_TFCv2.2.html
```sh
// >>>>>>>> New features (UMP) SDK v2.1.0
// https://developers.google.com/admob/android/privacy/gdpr
/*
If the user chooses not to display ads,
you can restrict access to the app, or ban it,
until they change their decision back,
Just call showPrivacyOptionsForm();
*/
cordova.plugins.emiAdmobPlugin.getIabTfc(
(info) => {
// How to read consent choices
console.log("IABTCF_gdprApplies: " + info.IABTCF_gdprApplies);
console.log("IABTCF_PurposeConsents: " + info.IABTCF_PurposeConsents);
console.log("IABTCF_TCString: " + info.IABTCF_TCString);
// A small example
var fundingChoices;
fundingChoices = info.IABTCF_PurposeConsents;
if (fundingChoices === "1111111111"){
// Enable app features.
loadRewardedAd();
} else if (fundingChoices === "") {
// disable app features.
} else {
// You have to test everything yourself.
console.log(info);
}
},
(error) => {
console.log("Error: " + error);
});
```
</details>
# Admob Mediation
<details>
<summary>Mediation #9</summary>
<img src="https://user-images.githubusercontent.com/78555833/229587307-91a7e380-aa2d-4140-a62d-fa8e6a8dd153.png" width="500">
## get Mediation Adapter Name
responseInfo = true // (debugging)
<img src="https://user-images.githubusercontent.com/78555833/230655800-0dbc3f12-72fb-4cf3-b4e6-801704fade28.png" width="250">
## Meta Audience Network
[Integrate Meta Audience Network with bidding :](https://developers.google.com/admob/android/mediation/meta)
- (Adapter default: 6.13.7.0)
### Installation
```sh
cordova plugin add emi-indo-cordova-plugin-mediation-meta
```
- ================================
## Unity Ads
[Integrate Unity Ads with Mediation :](https://developers.google.com/admob/android/mediation/unity)
- (Adapter default: 4.6.1.0)
### Installation
```sh
cordova plugin add emi-indo-cordova-plugin-mediation-unity
```
- ================================
## AppLovin Ads
[Integrate AppLovin with Mediation :](https://developers.google.com/admob/android/mediation/applovin)
- (Adapter default: 11.8.2.0)
### Installation
```sh
cordova plugin add emi-indo-cordova-plugin-mediation-applovin
```
- ================================
## AdColony Ads
[Integrate AdColony with Mediation :](https://developers.google.com/admob/android/mediation/adcolony)
- (Adapter default: 4.8.0.1)
### Installation
```sh
cordova plugin add emi-indo-cordova-plugin-mediation-adcolony
```
- ================================
## Chartboost Ads
[Integrate Chartboost with Mediation :](https://developers.google.com/admob/android/mediation/chartboost)
- (Adapter default: 9.2.1.0)
### Installation
```sh
cordova plugin add emi-indo-cordova-plugin-mediation-chartboost
```
- ================================
## ironSource Ads
[Integrate ironSource with Mediation :](https://developers.google.com/admob/android/mediation/ironsource)
- (Adapter default: 7.2.7.0)
### Installation
```sh
cordova plugin add emi-indo-cordova-plugin-mediation-ironsource
```
</details>
## Variables name or preference name
<details>
<summary>Variables name #10</summary>
> __Warning__
> This is so that if I don't have time to update the Mediation Adapter version later, you can do it yourself as below.
- Cordova CLI Update Adapter version with Variables
```sh
cordova plugin add emi-indo-cordova-plugin-mediation-meta --variable META_ADAPTER_VERSION="xxxxx"
```
- Update Adapter version with config.xml
```sh
<preference name="META_ADAPTER_VERSION" value="xxxxx" />
```
### Variables Name
- --variable META_ADAPTER_VERSION="xxxxx"
- --variable UNITY_ADAPTER_VERSION="xxxxx"
- --variable APPLOVIN_ADAPTER_VERSION="xxxxx"
- --variable ADCOLONY_ADAPTER_VERSION="xxxxx"
- --variable CHARTBOOST_ADAPTER_VERSION="xxxxx"
- --variable IRONSOURCE_ADAPTER_VERSION="xxxxx"
### preference name
- META_ADAPTER_VERSION
- UNITY_ADAPTER_VERSION
- APPLOVIN_ADAPTER_VERSION
- ADCOLONY_ADAPTER_VERSION
- CHARTBOOST_ADAPTER_VERSION
- IRONSOURCE_ADAPTER_VERSION
- ================================
</details>
## 💰Sponsor this project
[](https://paypal.me/emiindo)
## Earn more money, with other ad networks.
<details>
<summary>Other plugins #11</summary>
- ### emi-indo-cordova-plugin-fan
[Facebook Audience Network:](https://github.com/EMI-INDO/emi-indo-cordova-plugin-fan) - Ads:
- ### emi-indo-cordova-plugin-unityads
[Cordova Plugin Unity:](https://github.com/EMI-INDO/emi-indo-cordova-plugin-unityads) - Ads:
## New Open AI
- ### emi-indo-cordova-plugin-open-ai
[Cordova Plugin Open Ai:](https://github.com/EMI-INDO/emi-indo-cordova-plugin-open-ai) - Open AI:
## New Firebase Analytics
- ### emi-indo-cordova-plugin-fanalytics
[Cordova Plugin Firebase Analytics:](https://github.com/EMI-INDO/emi-indo-cordova-plugin-fanalytics) - Firebase Analytics:
</details>
| Cordova Plugin Admob Android | IOS | admob,construct3,javascript,admob-plus-cordova,cordova-plugin-admob,cordova-plugin-admob-free,cordova-plugin-admob-pro | 2023-03-26T19:04:42Z | 2024-04-02T17:54:38Z | 2023-07-07T18:53:22Z | 1 | 1 | 197 | 6 | 2 | 13 | null | ISC | Objective-C |
Andrew-Tsegaye/project_GPT-4_codeX | start-engine | # Project GPT-4 CodeX
This is a text generation web application that utilizes OpenAI's GPT-4 API to generate natural language text based on user input.
## Features
- User-friendly interface
- Ability to generate natural language text based on user input
- Option to select the length of the generated text
- Option to choose from a range of GPT-4 models
- Integration with OpenAI's GPT-4 API
## Technologies Used
The application was built using the following technologies:
- HTML
- CSS
- JavaScript
- Vite
- OpenAI's GPT-4 API
## Installation
To run this application on your local machine, you'll need to have Node.js installed. Once you have Node.js installed, follow these steps:
1. Clone the repository
2. Navigate to the project directory in your terminal
3. Run npm install to install the dependencies
4. Create a .env file in the root directory and add your OpenAI API key to it
5. Run npm run dev to start the development server
6. Open your browser and navigate to http://localhost:3000
## Usage
To generate text using the application, simply enter a prompt in the input field and select the desired length of the generated text. Then click on the "Generate Text" button to generate the text.
## Contributing
Contributions are welcome! If you'd like to contribute to this project, please follow these steps:
1. Fork the repository
2. Create a new branch
3. Make your changes
4. Commit your changes
5. Push your changes to your forked repository
6. Submit a pull request
Please make sure to include a detailed description of your changes in your pull request.
## License
This project is licensed under the MIT license. See the LICENSE file for more information.
## Contact
If you have any questions or comments about this project, please feel free to contact me at [andrewtsegaye@jsmastery.pro](mailto:andrewtsegaye7@gmail.com).
| This is a text generation web application that utilizes OpenAI's GPT-4 API to generate natural language text based on user input. | javascript,vite | 2023-04-08T05:16:27Z | 2023-04-09T10:42:07Z | null | 1 | 0 | 39 | 0 | 7 | 13 | null | null | JavaScript |
julieshapo/5th-element-filmoteka | main | # Parcel template
Этот проект был создан при помощи Parcel. Для знакомства и настройки
дополнительных возможностей [обратись к документации](https://parceljs.org/).
## Подготовка нового проекта
1. Убедись что на компьютере установлена LTS-версия Node.js.
[Скачай и установи](https://nodejs.org/en/) её если необходимо.
2. Склонируй этот репозиторий.
3. Измени имя папки с `parcel-project-template` на имя своего проекта.
4. Создай новый пустой репозиторий на GitHub.
5. Открой проект в VSCode, запусти терминал и свяжи проект с GitHub-репозиторием
[по инструкции](https://docs.github.com/en/get-started/getting-started-with-git/managing-remote-repositories#changing-a-remote-repositorys-url).
6. Установи зависимости проекта в терминале командой `npm install` .
7. Запусти режим разработки, выполнив команду `npm start`.
8. Перейди в браузере по адресу [http://localhost:1234](http://localhost:1234).
Эта страница будет автоматически перезагружаться после сохранения изменений в
файлах проекта.
## Файлы и папки
- Все паршалы файлов стилей должны лежать в папке `src/sass` и импортироваться в
файлы стилей страниц. Например, для `index.html` файл стилей называется
`index.scss`.
- Изображения добавляй в папку `src/images`. Сборщик оптимизирует их, но только
при деплое продакшн версии проекта. Все это происходит в облаке, чтобы не
нагружать твой компьютер, так как на слабых машинах это может занять много
времени.
## Деплой
Для настройки деплоя проекта необходимо выполнить несколько дополнительных шагов
по настройке твоего репозитория. Зайди во вкладку `Settings` и в подсекции
`Actions` выбери выбери пункт `General`.
Пролистай страницу до последней секции, в которой убедись что выбраны опции как
на следующем изображении и нажми `Save`. Без этих настроек у сборки будет
недостаточно прав для автоматизации процесса деплоя.
Продакшн версия проекта будет автоматически собираться и деплоиться на GitHub
Pages, в ветку `gh-pages`, каждый раз когда обновляется ветка `main`. Например,
после прямого пуша или принятого пул-реквеста. Для этого необходимо в файле
`package.json` отредактировать поле `homepage` и скрипт `build`, заменив
`your_username` и `your_repo_name` на свои, и отправить изменения на GitHub.
```json
"homepage": "https://your_username.github.io/your_repo_name/",
"scripts": {
"build": "parcel build src/*.html --public-url /your_repo_name/"
},
```
Далее необходимо зайти в настройки GitHub-репозитория (`Settings` > `Pages`) и
выставить раздачу продакшн версии файлов из папки `/root` ветки `gh-pages`, если
это небыло сделано автоматически.
### Статус деплоя
Статус деплоя крайнего коммита отображается иконкой возле его идентификатора.
- **Желтый цвет** - выполняется сборка и деплой проекта.
- **Зеленый цвет** - деплой завершился успешно.
- **Красный цвет** - во время линтинга, сборки или деплоя произошла ошибка.
Более детальную информацию о статусе можно посмотреть кликнув по иконке, и в
выпадающем окне перейти по ссылке `Details`.
### Живая страница
Через какое-то время, обычно пару минут, живую страницу можно будет посмотреть
по адресу указанному в отредактированном свойстве `homepage`. Например, вот
ссылка на живую версию для этого репозитория
[https://goitacademy.github.io/parcel-project-template](https://goitacademy.github.io/parcel-project-template).
Если открывается пустая страница, убедись что во вкладке `Console` нет ошибок
связанных с неправильными путями к CSS и JS файлам проекта (**404**). Скорее
всего у тебя неправильное значение свойства `homepage` или скрипта `build` в
файле `package.json`.
## Как это работает
1. После каждого пуша в ветку `main` GitHub-репозитория, запускается специальный
скрипт (GitHub Action) из файла `.github/workflows/deploy.yml`.
2. Все файлы репозитория копируются на сервер, где проект инициализируется и
проходит сборку перед деплоем.
3. Если все шаги прошли успешно, собранная продакшн версия файлов проекта
отправляется в ветку `gh-pages`. В противном случае, в логе выполнения
скрипта будет указано в чем проблема.
| It's a graduation team project of a great team named '5th Element'. JavaScript module, FSON-68 course. | api,axios,filmoteka,github,html-css,javascript,teamproject | 2023-03-29T19:31:41Z | 2023-04-06T16:23:34Z | null | 16 | 176 | 613 | 0 | 2 | 13 | null | null | JavaScript |
Kirti180/Talkies | main | 
# Talkies - Real Time Screen Sharing Chat Application
**Takies is a communications platform that allows users to connect with video, audio, screen share, and chat.**
**The power of collaboration is that it can turn a group of individuals into a team empowered to achieve great things
Talkies is a type of application that enables users to share their computer screens with others in real-time over the internet.
It includes features that allows user to chat, video call, screen share with each other.**
## Deployment Link - https://talkies-lets-connect.netlify.app/
## Tech Stack
**Client:** HTML | CSS | Javascript | Bootsrap | External CSS library
**Server:** Node.js | Express.js | MongoDB | WebRTC | PeerJS library | Socket.io | Bcrypt | PassPort | cors | Redis | JWT
**github:** To maintain repository and collabration and version control.
**VS Code:** To write HTML,CSS and JavaScript code.
**Microsoft Edge,Google Chrome & Mozilla Firefox:** To check the functionality and run the code.
## Frontend Part
- Home page
- Login/Signup
- Dashboard
- Google OAuth
- Github OAuth
## Backend Part
- Authentication using JWT
- implementation using Socket.io
- fully functional Video, Audio and Screen Share icons
## Database
- MongoDB
- Redis
## Features
- Screen Sharing
- Chatting
- Video Calling
## Application Guide to use features
### To use {Screen share} feature -->
- First Create room
- User can share the screen
- User can join the room using room ID
- Enter room ID to join
#### Stop share -->
- Click on stop share option
### To use {Video calling} feature -->
- First Create room
- User can join the call by using the room ID
- To end the call click on hang on button
### To use {Chat} feature -->
- First Create room
- User can join the room using room ID after login
- Time is displayed of message
- Notifies User info
## Examples
#### Creating connection and accessing user media .
```javascript
peer = new Peer(room_id);
peer.on('open', (id) => {
console.log("Peer has joined ID no", id);
hideModal()
// media options...
getUserMedia({ video: true, audio: true },
(stream) => {
local_stream = stream;
setLocalStream(local_stream)
}, (err) => {
console.log(err);
})
notify("Waiting for the member to join.")
})
```
## Group Members Info
1. Kirti Shinde(Team Lead)
> - e-Mail: kirti182001@gmail.com
> - GitHub: https://github.com/Kirti180
2. Love Porwal
> - e-Mail: lluvporwall@gmail.com
> - GitHub: https://github.com/love-porwal
3. Rishab Kumar Chaurasiya
> - e-Mail: rkc3660@gmail.com
> - GitHub: https://github.com/git-rishab
4. Pankaj Jain
> - e-Mail: pj9009815223@gmail.com
> - GitHub: https://github.com/pankubhaiya
5. Veeresh S P
> - e-Mail: veereshsp1234@gmail.com
> - GitHub: https://github.com/Veeresh-S-P
<br>
## Complete Work-flow of Talkies
## Home Page
## Footer Page
## Signing Page
## Login Page
## Dashboard Page
## Video Chat Platform
| Realtime screen sharing ,Video call and Messaging web application. | mongodb-atlas,nodejs,oauth,peerjs,socket-io,webrtc,bcrypt,boostrap,css,google-authentication | 2023-03-28T03:28:49Z | 2023-05-06T20:22:04Z | 2023-05-06T20:22:04Z | 6 | 33 | 113 | 0 | 6 | 13 | null | null | HTML |
danifromecuador/toDo-List | main | # ToDo List
Welcome to my ToDo List project
<a name="readme-top"></a>
<!-- TABLE OF CONTENTS -->
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)
<!-- PROJECT DESCRIPTION -->
# 📖 ToDo List! <a name="about-project"></a>
**ToDo List!** is my fourth project at Microverse, in this project I have created a basic list of tasks where the user can add a new task, mark as completed and delete all the completed tasks
## 🛠 Built With <a name="built-with"></a>
### Tech Stack <a name="tech-stack"></a>
<details>
<summary>Client</summary>
<ul>
<li><a href="https://developer.mozilla.org/en-US/docs/Web/CSS">HTML</></li>
<li><a href="https://developer.mozilla.org/en-US/docs/Web/CSS">CSS</a></li>
<li><a href="https://developer.mozilla.org/en-US/docs/Web/CSS">JavaScript</a></li>
</ul>
</details>
### Key Features <a name="key-features"></a>
- **A new task contains a description and a boolean state**
- **The user can add, mark as completed or delete all completed tasks**
- **The list of tasks will be preserved in local storage**
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- LIVE DEMO -->
## 🚀 Live Demo <a name="live-demo"></a>
- [ToDo List](https://danifromecuador.github.io/toDo-List/dist/)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- GETTING STARTED -->
## 💻 Getting Started <a name="getting-started"></a>
- Step 1: Clone this project using this git comand "git clone", (if you don't have git installed please visit
https://git-scm.com/downloads and install it).
- Step 2: Once you have installed git you can clone this project using the command below:
```
git clone git@github.com:danifromecuador/toDo-List.git
```
- Step 3: Once you have cloned this repo navigate to the folder that contains
the repository.
- Step 4: If you want to watch the html file open it with your favorite web browser.
- Step 5: If you want to edit this project open it with your favorite text editor.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- AUTHORS -->
## 👥 Authors <a name="authors"></a>
👤 **Dani Morillo**
- GitHub: [@danifromecuador](https://github.com/danifromecuador)
- Twitter: [@danifromecuador](https://twitter.com/danifromecuador)
- LinkedIn: [danifromecuador](https://www.linkedin.com/in/danifromecuador/)
<!-- FUTURE FEATURES -->
## 🔭 Future Features <a name="future-features"></a>
- The tasks could be ordered just dragging them
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- CONTRIBUTING -->
## 🤝 Contributing <a name="contributing"></a>
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- SUPPORT -->
## ⭐️ Show your support <a name="support"></a>
If you like this Awesome Books project please share my portfolio with recruters!
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- ACKNOWLEDGEMENTS -->
## 🙏 Acknowledgments <a name="acknowledgements"></a>
I would like to thank the Codepip company for creating the game called css frog.
https://twitter.com/playcodepip
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- FAQ (optional) -->
<!-- LICENSE -->
## 📝 License <a name="license"></a>
This project is [MIT](./LICENSE) licensed.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
| A minimalistic todo list where you can add, delete or delete all the completed activities | css,javascript,webpack | 2023-03-28T22:22:30Z | 2023-04-07T11:04:29Z | null | 2 | 8 | 32 | 1 | 0 | 13 | null | MIT | JavaScript |
AnsarIbrahim/To-Do-List | main |
<!-- TABLE OF CONTENTS -->
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#triangular_flag_on_post-deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#LICENSE)
<!-- PROJECT DESCRIPTION -->
# 📖 To Do List <a name="about-project"></a>
**To Do List** is a application that displays my Techinical skills and projects that i have done.
**Link to online version of To Do List** is in [Live Demo](#live-demo)
## 🛠 Built With <a name="built-with"></a>
### Tech Stack <a name="tech-stack"></a>
<details>
<summary>Client</summary>
<ul>
<li><a href="https://developer.mozilla.org/en-US/docs/Web/HTML">HTML</a></li>
<li><a href="https://developer.mozilla.org/en-US/docs/Web/CSS">CSS</a></li>
</ul>
</details>
<details>
<summary>Server</summary>
<ul>
<li><a href="#">N/A</a></li>
</ul>
</details>
<details>
<summary>Database</summary>
<ul>
<li><a href="#">N/A</a></li>
</ul>
</details>
<!-- Features -->
### Key Features <a name="key-features"></a>
- **To-do-list**
- **ADD**
- **REMOVE**
- **Setup with Webpack**
- **CSS loader Webpack**
- **HTML Webpack Plugin**
- **Source files in src(Folder)**
- **dist (folder)**
- **Setup with bundle webpack**
- **local-storage**
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- LIVE DEMO -->
## 🚀 Live Demo <a name="live-demo"></a>
- [Live Demo Link](https://ansaribrahim.github.io/To-Do-List/dist/)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- GETTING STARTED -->
## 💻 Getting Started <a name="getting-started"></a>
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
- Modern chrome Browser
### Setup
- Clone this repository to your desired folder with the following commend
```
git clone git@github.com:AnsarIbrahim/To-Do-List.git
```
### Install
- Type cd
```
To-Do-List
```
- open index.html file in the browser
### Usage
- To run the project, execute the following command:
- Type cd ``` To-Do-List ```
- open index.html file in the browser
### Run tests
- To run tests, run the following command:
- npm bulid run
### Deployment
- You can deploy this project using:
- Type cd ``` To-Do-List ```
- open index.html file in the browser
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- AUTHORS -->
## 👥 Authors <a name="authors"></a>
👤 **Ansar Ibrahim**
- GitHub: [Ansar Ibrahim](https://github.com/AnsarIbrahim)
- Twitter: [Ansar Ibrahim](https://twitter.com/ansaradheeb)
- LinkedIn: [Ansar Ibrahim](https://linkedin.com/in/ansar-ibrahim-61447424a/)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- FUTURE FEATURES -->
## 🔭 Future Features <a name="future-features"></a>
- [ ] **React**
- [ ] **Ruby**
- [ ] **Java-Script**
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- CONTRIBUTING -->
## 🤝 Contributing <a name="contributing"></a>
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- SUPPORT -->
## ⭐️ Show your support <a name="support"></a>
- If you like this project please give it a STAR⭐️
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- ACKNOWLEDGEMENTS -->
## 🙏 Acknowledgments <a name="acknowledgements"></a>
- I would like to thank following
- MicroVerse
- web.archive.org.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- LICENSE -->
## 📝 LICENSE <a name="LICENSE"></a>
This project is [MIT](./LICENSE) licensed.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
| "To-do list" is used to lists the things that you need to do and allows you to mark them as complete. This is built using ES6 and Webpack! | css,html,javascript | 2023-03-28T18:41:38Z | 2023-04-07T13:43:12Z | null | 2 | 5 | 36 | 1 | 0 | 12 | null | MIT | JavaScript |
UbdaNam/To-Do-list | main | # To-Do-List
<a name="readme-top"></a>
<div align="center">
<!-- You are encouraged to replace this logo with your own! Otherwise you can also remove it. -->
<br/>
<h3><b>To-Do-List</b></h3>
</div>
<!-- TABLE OF CONTENTS -->
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#triangular_flag_on_post-deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
<!-- PROJECT DESCRIPTION -->
# 📖 [TO_DO_LIST] <a name="about-project">
Hello, this a simple To do list</a>
To-Do List project is an application specially built to keep track of tasks that need to be done
## 🛠 Built With
### Tech Stack
HTML
CSS
JAVASCRIPT
### Key Features
- **[Layout]**
- **[Add task]**
- **[Show list of the tasks]**
- **[Mark task as finished]**
- **[Remove finished tasks]**
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 🚀 Live Demo <a name="live-demo"></a>
- [Live Demo Link](https://ubdanam.github.io/To-Do-list/)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- GETTING STARTED -->
## 💻 Getting Started <a name="getting-started"></a>
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:You have to clone this project to your local machine
### Setup
Clone this repository to your desired folder:git clone https://github.com/UbdaNam/To-Do-list.git
### Install
``` snippet
npm install
```
Install this project with: Any software which you are comfortable with
### Usage
To run the project, execute the following command: On your computer's keyboard press f5 or run it with live server
<!-- AUTHORS -->
## 👥 Authors <a name="authors"></a>
👤 **Abdurahim Miftah**
- GitHub: [@UbdaNam](https://github.com/UbdaNam)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- FUTURE FEATURES -->
## Future Features
- [ ] **[Add update option]**
- [ ] **[Add refresh task]**
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- CONTRIBUTING -->
## 🤝 Contributions
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/UbdaNam/To-Do-list/issues).
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- SUPPORT -->
## ⭐ Show your support <a name="support"></a>
If you like this project please send add feedbacks and give it a start
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- ACKNOWLEDGEMENTS -->
## 🙏 Acknowledgments <a name="acknowledgements"></a>
I would like to thank microverse in advance. This is the first draft of this project. It works on my machine. If you try it and run into problems, please create an issue; I'll do what I can to fix it.
## 📝 License
This project is [MIT](./LICENSE) licensed.
| Stay organized and on top of your tasks with my easy-to-use to-do app. With a simple and intuitive interface, you can quickly add, edit, and delete your tasks. Built with love using HTML, CSS, and JavaScript | javascript,localstorage | 2023-03-29T12:14:49Z | 2023-04-07T12:51:54Z | null | 2 | 7 | 31 | 1 | 0 | 12 | null | MIT | JavaScript |
CodeSystem2022/Perricornios-Tercer-Semestre | main | ## ${\color{mediumorchid }Perricornios-Tercer-Semestre}$
### :unicorn: `Repositorio general`
### :computer: ${\color{blue}Laboratorio: Python}$ y ${\color{yellow}JavaScript}$
### :computer: ${\color{red}Programación: Java}$
### :unicorn: `Tenemos división de materias por carpetas`
#### :arrow_right: Dentro de cada materia nos organizamos por semanas :arrow_left:
| **Semana** | **Scrum Master** | **Anotaciones** | | |
| ---- | ---- | --- | --- | --- |
| 👩💻 **1** | *Noelia Romina Ruiz* | **SEMANA COMPLETA** |
| 👩💻 **2** | *Nadia Soledad Pereyra* | **SEMANA COMPLETA** |
| 👨💻 **3** | *Bruno Leandro Cosimano Abadie* | **SEMANA INCOMPLETA** | **ASIGNADO A**| **REASIGNADO A** |
| | **JAVASCRIPT** | 1.1 Introducción a Funciones | :x: FACUNDO BENJAMÍN MÉNDEZ | :heavy_check_mark: BRUNO LEANDRO COSIMANO ABADIE |
| | | 1.6 Funciones flecha | :x: CARLOS FERNANDO VILLALON | :heavy_check_mark: BRUNO LEANDRO COSIMANO ABADIE |
| | | 1.8 Concepto hoisting | :x: FACUNDO BENJAMÍN MÉNDEZ | :heavy_check_mark: BRUNO LEANDRO COSIMANO ABADIE |
| | **PYTHON** | 1.5 Comenzamos con las pruebas ingresando las otras clases, parte 1 | :x: CARLOS FERNANDO VILLALON | :heavy_check_mark: GABRIEL JUAN ALEJANDRO JUHASZ |
| | **JAVA** | 1.2 Manejo de Enumeraciones (enum) - V3 | :x: CARLOS FERNANDO VILLALON | :heavy_check_mark: NOELIA ROMINA RUIZ |
| | | 1.3 Pruebas de enum, con la creación de enum Continentes - V6 | :x: FACUNDO BENJAMÍN MÉNDEZ | :heavy_check_mark: NOELIA ROMINA RUIZ |
| | | 1.4 Manejo de bloques de código - V7 | :x: JUAN IGNACIO ENCINAS | :heavy_check_mark: NOELIA ROMINA RUIZ |
| 👨💻 **4** | *Gabriel Juan Alejandro Juhasz* | **SEMANA COMPLETA** |
| 👨💻 **5** | *Juan Ignacio Encinas* | **SEMANA COMPLETA** |
| 👨💻 **6** | *Braian Guzmán Echarri* | **SEMANA COMPLETA** |
| 👨💻 **7** | *Carlos Fernando Villalón* | **SEMANA COMPLETA** |
| 👨💻 **8** | *Facundo Benjamín Méndez* | **SEMANA INCOMPLETA** | **ASIGNADO A** | **REASIGNADO A** |
| | **JAVASCRIPT** | 7.3 Clase Object, toString, sobreescritura y Polimorfismo (video 4) | :x: JUAN IGNACIO ENCINAS | :heavy_check_mark: NOELIA ROMINA RUIZ |
| | **PYTHON** | 7.2 Manejo de logging: Parte 1 (video 3) | :x: FACUNDO BENJAMIN MÉNDEZ (SCRUM) | :heavy_check_mark: NOELIA ROMINA RUIZ |
| | **JAVA** | 7.2 Manejo de Interfaces Parte 2 | :x: JUAN IGNACIO ENCINAS | :heavy_check_mark: NOELIA ROMINA RUIZ |
| | | 7.5 Pruebas: Parte 2 | :x: FACUNDO BENJAMÍN MÉNDEZ (SCRUM) | :heavy_check_mark: NOELIA ROMINA RUIZ |
| 👩💻 **9** | *Noelia Romina Ruiz* | **SEMANA INCOMPLETA** | **ASIGNADO A** | **RESIGNADO A** |
| | | **JAVA** 8.6 Agregamos el finally y catch (VIDEO 11) | :x: JUAN IGNACIO ENCINAS | :heavy_check_mark: NOELIA ROMINA RUIZ |
| 👩💻 **10** | *Nadia Soledad Pereyra* | **SEMANA COMPLETA** |
| 👨💻 **11** | *Gabriel Juan Alejandro Juhasz* | **12/6 al 18/6** |
| 👨💻 **12** | *Bruno Leandro Cosimano Abadie* | **SEMANA INCOMPLETA** | **ASIGNADO A** | **REASIGNADO A** |
| | **JAVA** | 11.3 Sincronizamos con Maven y agregamos la dependencia -> Parte 1 y 2 - Video 5 | :x: FACUNDO BENJAMÍN MÉNDEZ | :heavy_check_mark: Bruno Leandro Cosimano Abadie |
| 👨💻 **13** | *Braian Guzmán Echarri* | **SEMANA EN CURSO 26/6 al 2/7** |
| ${\color{orange} Equipo - Perricornios}$ | ${\color{orange} Link - GitHub}$ |
| --- | --- |
| :unicorn: ${\color{magenta}Pereyra, Nadia soledad.}$ | [Nadia Soledad Pereyra](https://github.com/NaSP32) |
| :unicorn: ${\color{magenta}Ruiz, Noelia Romina.}$ | [Noelia Romina Ruiz](https://github.com/Noe3467) - [Noelia Ruiz](https://github.com/Noelia-Ruiz) |
| :unicorn: ${\color{cyan}Cosimano Abadie, Bruno Leandro.}$ | [Bruno Cosimano](https://github.com/BrunoLCA95)
| :unicorn: ${\color{cyan}Echarri, Brian Guzmán.}$ | [Braian Guzman Echarri](https://github.com/bguzmanech)
| :unicorn: ${\color{cyan}Encinas, Juan Ignacio.}$ | [Juan Ignacio Encinas](https://github.com/asterisko19)
| :unicorn: ${\color{cyan}Juhasz, Gabriel Juan Alejandro.}$ | [Gabriel Juan Alejandro Juhasz](https://github.com/GabJaJ)
| :unicorn: ${\color{cyan}Méndez, Facundo Benjamín.}$ | [Facundo Méndez](https://github.com/ChuequitoMendez)
| :unicorn: ${\color{cyan}Villalon, Carlos Fernando.}$ | [Carlos Villalón](https://github.com/VillaC95)
| Repositorio Perricornios: Laboratorio III en Python y JavaScript y Programación III en Java del Tercer Semestre. | java,python,javascript | 2023-04-06T04:26:07Z | 2023-07-03T14:00:13Z | 2023-04-23T23:13:29Z | 12 | 344 | 774 | 0 | 0 | 12 | null | null | Java |
joyapisi/To-Do-List | main | # To Do List
HTML, CSS and JavaScript To Do List Project
<a name="readme-top"></a>
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- - [Tech Stack](#tech-stack)
- - [Key Features](#key-features)
- [🎥 Video Explanation](#video-explanation)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#set-up)
- [Prerequisites](#prerequisites)
- [Install](#install)
- - [Install webpack](#webhint-installation)
- - [Install linters](#linter-installation)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ](#faq)
- [📝 License](#license)
# 📖 [To_Do_List] <a name="To DO List"></a>
**[To_Do_List]** is a simple a simple web page that displays a list of To Do tasks inserted by a user. It is built using webpack and served by a webpack dev server.
## 🛠 Built With <a name="built-with"></a>
### Tech Stack <a name="tech-stack"></a>
<summary>Javascript runtime environment</summary>
<ul>
<li><a href="https://nodejs.org/en/">Node JS</a></li>
</ul>
<summary>JS Packages</summary>
<ul>
<li><a href="https://webpack.js.org/guides/getting-started/#basic-setup">webpack</a></li>
</ul>
<summary>Version control</summary>
<ul>
<li><a href="github.com">Git Hub</a></li>
</ul>
</details>
### Key Features <a name="key-features"></a>
- **[Webpack]**
- **[Desktop-Version]**
- **[Dynamic-Design]**
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 🎥 Video Explanation <a name="video-explanation">Coming soon!</a>
## 🚀 Live Demo <a href="https://joyapisi.github.io/To-Do-List/dist" name="live-demo">Live Demo</a>
## 💻 Getting Started <a name="getting-started"></a>
Creating your first "To DO List" project
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
-A Git hub account
-Git bash
-Node JS
-Webpack
-Visual Studio Code as your code editor
# Setup <a name="set-up"></a>
Clone this repository to your desired folder:
```sh
cd my-folder
git clone[(https://github.com/joyapisi/To-Do-List.git)]
```
## Understand Set Up Requirements
Since this code is using webpack, run `npm start` in your terminal to run it instead of using the live server.
## Understand Set Up Requirements
### Define webpack
<a href="https://webpack.js.org/concepts/">webpack</a>is a static module bundler for modern JavaScript applications. When webpack processes your application, it internally builds a dependency graph from one or more entry points and then combines every module your project needs into one or more bundles, which are static assets to serve your content from.
### Define Linters
A linter is a tool to help you improve your code. You can learn more about Linters here: (source: (<https://www.testim.io/blog/what-is-a-linter-heres-a-definition-and-quick-start-guide/>)).
#### Advantages of Linting:
1. Fewer errors in production- The use of linters helps to diagnose and fix technical issues such as code smells. As a result, fewer defects make their way to production.
2. Achieving a more readable and consistent style, through the enforcement of its rules.
3. Having more secure and performant code.
4. Having an objective and measurable assessment of code quality.
5. Having fewer discussions about code style and aesthetic choices during code reviews.
# Install webpack and linters <a name="install"></a>
## Install webpack <a name="webpack-installation"></a>
- Follow the instructions <a href="https://webpack.js.org/guides/getting-started/#basic-setup">here</a> to set up webpack.
### Steps to Install webpack
- In the link above, go through these topics in order:
<ul>
<li><a href="https://webpack.js.org/guides/getting-started/#basic-setup">Getting Started</a></li>
<li><a href="https://webpack.js.org/guides/asset-management/#loading-css">Asset Management</a></li>
<li><a href="https://webpack.js.org/guides/output-management/#setting-up-htmlwebpackplugin">Output Management</a></li>
<li><a href="https://webpack.js.org/guides/development/#adjusting-your-text-editor">Development</a></li>
</ul>
## Install Linters <a name="linter-installation"></a>
Linters for various programming languages are available for use, e.g. Rubocop for Ruby or ESLint for JavaScript.
There are many ways you can integrate a linter in your workflow:
-text editor plugin
-GitHub Actions
-GitHub apps
### Steps to Install Linters
**Note:** The npm package manager is going to create a node_modules directory to install all of your dependencies. You shouldn't commit that directory. To avoid that, you can create a .gitignore file and add node_modules to it:
# .gitignore
node_modules/
## ESLint
Run
```
npm install --save-dev eslint@7.x eslint-config-airbnb-base@14.x eslint-plugin-import@2.x babel-eslint@10.x
```
## Web Hint <a name="webhint-installation"></a>
This is a customizable linting tool that helps you improve your site's accessibility, speed, cross-browser compatibility, and more by checking your code for best practices and common errors.
**NOTE:** If you are using Windows, make sure you initialize npm to create `package.json` file.
```
npm init -y
```
1. Run
```
npm install --save-dev hint@7.x
```
_how to use npm: (https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)._
2. Copy [.hintrc](.hintrc) to the root directory of your project.
3. **Do not make any changes in config files - they represent style guidelines that you share with your team - which is a group of all Microverse students.**
- If you think that change is necessary - open a [Pull Request in this repository](../README.md#contributing) and let your code reviewer know about it.
4. Run
```
npx hint .
```
[Copy contents of .eslintrc.json to the root directory of your project](https://github.com/microverseinc/linters-config/blob/master/html-css-js/.eslintrc.json)
5. Fix validation errors.
### [Stylelint](https://stylelint.io/) <a name="stylelint-installation"></a>
A mighty, modern linter that helps you avoid errors and enforce conventions in your styles.
1. Run
npm install --save-dev stylelint@13.x stylelint-scss@3.x stylelint-config-standard@21.x stylelint-csstree-validator@1.x
not sure how to use npm? Read this.
2. Copy .stylelintrc.json to the root directory of your project.
3. **Do not make any changes in config files - they represent style guidelines that you share with your team - which is a group of all Microverse students.**
If you think that change is necessary - open a Pull Request in this repository and let your code reviewer know about it. 4. Run npx stylelint "\*_/_.{css,scss}" on the root of your directory of your project.
5. Fix linter errors.
6. **IMPORTANT NOTE:** feel free to research auto-correct options for Stylelint if you get a flood of errors but keep in mind that correcting style errors manually will help you to make a habit of writing a clean code!
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 👥 Authors <a name="authors"></a>
👤 **Joy Phoebe**
- GitHub: (https://github.com/joyapisi)
- Twitter: (https://twitter.com/joyapisi)
- LinkedIn: (https://http://www.linkedin.com/in/joy-phoebe-00b80a13a)
## 🤝 Contributing <a name="contributing"></a>
## 🔭 Future Features <a name="future-features"></a>
# **[Feature-1]**
- Add more styling (aesthetics)
# **[Feature-2]**
- Add mobile version
<p align="right">(<a href="#readme-top">back to top</a>)</p>
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/joyapisi/To-Do-List/issues).
## ⭐️ Show your support <a name="support"></a>
If you like this project, kindly leave a comment below and share it with someone who enjoys coding! Coding is all about continuous learning and allowing yourself to be a beginner. Keep going!
## 🙏 Acknowledgments <a name="Microverse Inc."></a>
I'm thankful to Microverse for providing a study platform which guided me through this project.
## ❓ FAQ <a name="faq"></a>
- **[Question_1]**
An easier and quicker way to understand webpack?
- This YouTube<a href="https://www.youtube.com/watch?v=MpGLUVbqoYQ">video</a> will help you understand webpack better and in details
- **[Question_2]**
Where can I download node JS for installation?
- Node Js can be downloaded here- <ul>
<li><a href="https://nodejs.org/en/download/"> Node JS </a></li>
</ul>
## 📝 License <a name="license"></a>
This project is [MIT](https://choosealicense.com/licenses/mit/) licensed.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
| To Do List is a simple a simple web page that displays a list of To Do tasks. It is built using webpack and served by a webpack dev server. | css,eslint,javascript,stylelint,webpack | 2023-03-27T21:00:24Z | 2023-04-11T20:19:17Z | null | 2 | 7 | 52 | 0 | 0 | 12 | null | null | JavaScript |
Noumanabegum/Quote-Generator | main | # Quote Generator
### Live preview : https://noumanabegum.github.io/Quote-Generator/
This is a simple quote generator website that displays random quotes to the user when they click the "New Quote" button. The project was created using HTML, CSS and JavaScript. This project uses an API to generate random quotes.
## Features :
* Displays a random quote each time the "New Quote" button is clicked.
* Allows the user to listen the displayed quote by clicking the "Speech" button.
* Allows the user to copy the displayed quote by clicking the "Copy" button.
* Allows the user to tweet the displayed quote by clicking the "Tweet" button.
## Screenshots
## How to use :
* Clone the repository to your local machine using the command "git clone https://github.com/Noumanabegum/Quote-Generator.git".
* Open the "index.html" file in your browser.
* Click the "New Quote" button to display a new quote.
* Click the "Tweet" button to share the quote on Twitter.
## API used :
https://api.quotable.io/random
## Responsive design :
## Contributing :
If you would like to contribute to this project, you can fork the repository and create a pull request with your changes.
## License
This project is licensed under the [MIT](https://choosealicense.com/licenses/mit/) License.
See the LICENSE file for more information.
| Random Quote Generator Website | css,html,javascript | 2023-03-29T04:39:04Z | 2023-03-29T05:43:50Z | null | 1 | 0 | 11 | 0 | 0 | 12 | null | null | CSS |
creativetimofficial/black-dashboard-genezio | main | <div align="center">
<h1><b>Black Dashboard React x genezio </b></h1>
</div>
<div align="center">
<h2>The Ultimate Full-Stack Serverless Application</h2>
</div>
<div align="center">
[](https://github.com/genez-io/genezio)
[]()
[]()
</div>
<div align="center">
[](https://twitter.com/intent/follow?screen_name=CreativeTim)
[](https://twitter.com/intent/follow?screen_name=geneziodev)
</div>
[Black Dashboard React](https://www.creative-tim.com/genezio) is a beautiful [Bootstrap 4](http://getbootstrap.com/), [Reactstrap](https://reactstrap.github.io/) and [React](https://reactjs.org/) ([create-react-app](https://github.com/facebook/create-react-app)) Admin Dashboard with a huge number of components built to fit together and look amazing. If you are looking for a tool to manage and visualize data about your business, this dashboard is the thing for you. It combines colors that are easy on the eye, spacious cards, beautiful typography, and graphics.
Black Dashboard React comes packed with all plugins that you might need inside a project and documentation on how to get started. It is light and easy to use, and also very powerful.
Black Dashboard React features over 16 individual components, giving you the freedom of choosing and combining. This means that there are thousands of possible combinations. All components can take variations in color, that you can easily modify using SASS files. You will save a lot of time going from prototyping to full-functional code because all elements are implemented.
We thought about everything, so this dashboard comes with 2 versions, Dark Mode and Light Mode.
Special thanks go for the owners of these plugins:
- [Perfect Scrollbar](http://utatti.github.io/perfect-scrollbar/) for the nice scrollbar for Windows.
- [React Chartjs](http://jerairrest.github.io/react-chartjs-2/) for the wonderful wrapper for charts.
- [Chartjs](https://www.chartjs.org/) for the wonderful charts.
We are very excited to share this dashboard with you and we look forward to hearing your feedback!
### Table of Contents
- [Quick start](#quick-start)
- [Frontend template](#frontend-template)
- [Versions](#versions)
- [Demo](#demo)
- [Backend logic provided by genezio](#backend-logic-provided-by-genezio)
- [Documentation](#documentation)
- [Project Structure](#project-structure)
- [Browser Support](#browser-support)
- [Resources](#resources)
- [Reporting Issues](#reporting-issues)
- [Technical Support or Questions](#technical-support-or-questions)
- [Licensing](#licensing)
- [Useful Links](#useful-links)
# Quick start
1. **Create a `genezio` account** by going to https://app.genez.io.
2. **Install `genezio` package.** Run the command below in your terminal:
```bash
npm install genezio -g
```
2. **Login to `genezio`.** Run the following command to login into your account:
```bash
genezio login
```
3. **Clone this repo.** Copy the following command in your terminal:
```bash
git clone https://github.com/creativetimofficial/black-dashboard-genezio
```
4. **Navigate to the backend folder.** Copy the following command in your terminal:
```bash
cd ./backend
```
5. **Deploy your code.** Use the command below to deploy the code using `genezio`:
```bash
genezio deploy --env ./.env
```
6. **Test your project.** You can use the test interface provided in the [genezio dashboard](https://app.genez.io/dashboard) to test your project.
# Frontend template
## Versions
| HTML | React | Vue |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [](https://www.creative-tim.com/product/black-dashboard) | [](https://www.creative-tim.com/product/black-dashboard-react) | [](https://www.creative-tim.com/product/vue-black-dashboard) |
## Demo
| Dashboard | User Profile | Tables | Map | Notification |
| ------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------- |
| [](https://black-dashboard-genezio.creative-tim.com/admin/dashboard) | [](https://black-dashboard-genezio.creative-tim.com/admin/user-profile) | [](https://black-dashboard-genezio.creative-tim.com/admin/tables) | [](https://black-dashboard-genezio.creative-tim.com/admin/map) | [](https://black-dashboard-genezio.creative-tim.com/admin/notifications) |
## [Live Demo: You can try by yourself here](https://black-dashboard-genezio.creative-tim.com/auth/login)
# Backend logic provided by genezio
`genezio` is a platform that allows developers to write, deploy, and use serverless APIs with ease. With `genezio`, developers can write their backend logic in classes and design their frontend using their preferred programming language.
Once the backend classes are written, `genezio` deploys them onto a serverless infrastructure. The platform generates an SDK that developers can use to remotely call the methods of their class in a very natural way, making it easy to call backend logic from the client.
The platform comes with a handful of examples to start from, and developers can integrate it into their CI/CD pipeline with a dedicated GitHub action.
For more tutorials and details check the genezio resources:
- Documentation: https://genez.io/docs
- Tutorials: https://genez.io/tags/tutorials/
- Examples: https://github.com/Genez-io/genezio-examples
# Documentation
The documentation for the **Black Dashboard React** is hosted at our [website](https://demos.creative-tim.com/black-dashboard-react/#/documentation/tutorial).
The documentation for deploying with **genezio** can be found on our [website](https://genez.io).
# Project Structure
Within the archive downloaded you'll find the following directories and files
<details>
<summary> Click on the arrow to expand the project structure
```
├── README.d
├── backend
└── frontend
```
</summary>
```
.
├── README.d
├── backend
│ ├── article.js
│ ├── config.js
│ ├── genezio.yaml
│ ├── middleware
│ │ └── reqAuth.js
│ ├── models
│ │ ├── activeSession.js
│ │ ├── articles.js
│ │ ├── assignments.js
│ │ ├── books.js
│ │ ├── brands.js
│ │ ├── clients.js
│ │ ├── comments.js
│ │ ├── countries.js
│ │ ├── departments.js
│ │ ├── destinations.js
│ │ ├── employees.js
│ │ ├── events.js
│ │ ├── hotels.js
│ │ ├── languages.js
│ │ ├── orders.js
│ │ ├── playlists.js
│ │ ├── products.js
│ │ ├── reviews.js
│ │ ├── roles.js
│ │ ├── rooms.js
│ │ ├── songs.js
│ │ ├── tasks.js
│ │ └── users.js
│ ├── order.js
│ ├── package.json
│ ├── package-lock.json
│ ├── product.js
│ ├── task.js
│ ├── user.js
│ └── utils
│ └── constants.js
└── frontend
├── CHANGELOG.md
├── Documentation
│ └── documentation.html
├── github-assets
│ ├── angular.png
│ ├── black-dashboard-react.gif
│ ├── chrome.png
│ ├── dashboard-page.png
│ ├── edge.png
│ ├── firefox.png
│ ├── html.png
│ ├── maps-page.png
│ ├── notifications-page.png
│ ├── opera.png
│ ├── react.svg
│ ├── safari.png
│ ├── table-page.png
│ ├── user-page.png
│ └── vuejs.png
├── gulpfile.js
├── ISSUE_TEMPLATE.md
├── jsconfig.json
├── LICENSE.md
├── package.json
├── public
│ ├── apple-icon.png
│ ├── favicon.png
│ ├── index.html
│ └── manifest.json
└── src
├── assets
│ ├── css
│ │ ├── black-dashboard-react.css
│ │ ├── black-dashboard-react.css.map
│ │ ├── black-dashboard-react.min.css
│ │ └── nucleo-icons.css
│ ├── demo
│ │ └── demo.css
│ ├── fonts
│ │ ├── nucleo.eot
│ │ ├── nucleo.ttf
│ │ ├── nucleo.woff
│ │ └── nucleo.woff2
│ ├── img
│ │ ├── anime3.png
│ │ ├── anime6.png
│ │ ├── apple-icon.png
│ │ ├── bg5.jpg
│ │ ├── default-avatar.png
│ │ ├── emilyz.jpg
│ │ ├── favicon.png
│ │ ├── header.jpg
│ │ ├── img_3115.jpg
│ │ ├── james.jpg
│ │ ├── mike.jpg
│ │ └── react-logo.png
│ └── scss
│ ├── black-dashboard-react
│ │ ├── custom
│ │ │ ├── _alerts.scss
│ │ │ ├── _badges.scss
│ │ │ ├── _buttons.scss
│ │ │ ├── cards
│ │ │ │ ├── _card-chart.scss
│ │ │ │ ├── _card-map.scss
│ │ │ │ ├── _card-plain.scss
│ │ │ │ ├── _card-task.scss
│ │ │ │ └── _card-user.scss
│ │ │ ├── _card.scss
│ │ │ ├── _checkboxes-radio.scss
│ │ │ ├── _dropdown.scss
│ │ │ ├── _fixed-plugin.scss
│ │ │ ├── _footer.scss
│ │ │ ├── _forms.scss
│ │ │ ├── _functions.scss
│ │ │ ├── _images.scss
│ │ │ ├── _input-group.scss
│ │ │ ├── _misc.scss
│ │ │ ├── mixins
│ │ │ │ ├── _alert.scss
│ │ │ │ ├── _background-variant.scss
│ │ │ │ ├── _badges.scss
│ │ │ │ ├── _buttons.scss
│ │ │ │ ├── _dropdown.scss
│ │ │ │ ├── _forms.scss
│ │ │ │ ├── _icon.scss
│ │ │ │ ├── _inputs.scss
│ │ │ │ ├── _modals.scss
│ │ │ │ ├── opacity.scss
│ │ │ │ ├── _page-header.scss
│ │ │ │ ├── _popovers.scss
│ │ │ │ ├── _vendor-prefixes.scss
│ │ │ │ └── _wizard.scss
│ │ │ ├── _mixins.scss
│ │ │ ├── _modal.scss
│ │ │ ├── _navbar.scss
│ │ │ ├── _rtl.scss
│ │ │ ├── _sidebar-and-main-panel.scss
│ │ │ ├── _tables.scss
│ │ │ ├── _type.scss
│ │ │ ├── utilities
│ │ │ │ ├── _backgrounds.scss
│ │ │ │ ├── _floating.scss
│ │ │ │ ├── _helper.scss
│ │ │ │ ├── _position.scss
│ │ │ │ ├── _shadows.scss
│ │ │ │ ├── _sizing.scss
│ │ │ │ ├── _spacing.scss
│ │ │ │ ├── _text.scss
│ │ │ │ └── _transform.scss
│ │ │ ├── _utilities.scss
│ │ │ ├── _variables.scss
│ │ │ ├── vendor
│ │ │ │ ├── _plugin-perfect-scrollbar.scss
│ │ │ │ └── _plugin-react-notification-alert.scss
│ │ │ └── _white-content.scss
│ │ └── react-differences
│ │ ├── _inputs.scss
│ │ └── react-differences.scss
│ └── black-dashboard-react.scss
├── backedComponents
│ ├── BarChart
│ │ ├── BarChart.js
│ │ └── BarChartView.js
│ ├── LineChart
│ │ ├── LineChart.js
│ │ └── LineChartView.js
│ └── SimpleTable
│ ├── SimpleTable.js
│ └── SimpleTableView.js
├── backend-sdk
│ ├── article.sdk.js
│ ├── order.sdk.js
│ ├── product.sdk.js
│ ├── remote.js
│ ├── task.sdk.js
│ └── user.sdk.js
├── components
│ ├── Alerts
│ │ └── DismissableAlert.js
│ ├── BackgroundColorWrapper
│ │ └── BackgroundColorWrapper.js
│ ├── FixedPlugin
│ │ └── FixedPlugin.js
│ ├── Footer
│ │ └── Footer.js
│ ├── Navbars
│ │ ├── AdminNavbar.js
│ │ ├── AuthNavbar.js
│ │ └── RTLNavbar.js
│ ├── Sidebar
│ │ └── Sidebar.js
│ └── ThemeWrapper
│ └── ThemeWrapper.js
├── contexts
│ ├── BackgroundColorContext.js
│ └── ThemeContext.js
├── index.js
├── layouts
│ ├── Admin
│ │ └── Admin.js
│ ├── Auth
│ │ └── Auth.js
│ └── RTL
│ └── RTL.js
├── logo.svg
├── routes.js
├── variables
│ └── charts.js
└── views
├── Dashboard.js
├── Icons.js
├── Login.js
├── Map.js
├── Notifications.js
├── Register.js
├── Rtl.js
├── TableList.js
├── Typography.js
└── UserProfile.js
```
</details>
# Browser Support
At present, we officially aim to support the last two versions of the following browsers:
<img src="https://s3.amazonaws.com/creativetim_bucket/github/browser/chrome.png" width="64" height="64"><img src="https://s3.amazonaws.com/creativetim_bucket/github/browser/firefox.png" width="64" height="64"><img src="https://s3.amazonaws.com/creativetim_bucket/github/browser/edge.png" width="64" height="64"><img src="https://s3.amazonaws.com/creativetim_bucket/github/browser/safari.png" width="64" height="64"><img src="https://s3.amazonaws.com/creativetim_bucket/github/browser/opera.png" width="64" height="64">
# Resources
- Demo: https://black-dashboard-genezio.creative-tim.com/#/dashboard
- Download Page: https://www.creative-tim.com/product/black-dashboard-genezio
- CreativeTim Documentation: https://demos.creative-tim.com/black-dashboard-genezio/#/documentation/tutorial
- Genezio Documentation: https://genez.io/docs
- Genezio Examples: https://github.com/Genez-io/genezio-examples/
- License Agreement: https://www.creative-tim.com/license
- Support: https://www.creative-tim.com/contact-us
- Issues: [Github Issues Page](https://github.com/creativetimofficial/black-dashboard-react/issues)
# Reporting Issues
We use GitHub Issues as the official bug tracker for the Black Dashboard React. Here are some advices for our users that want to report an issue:
1. Make sure that you are using the latest version of the Black Dashboard React. Check the CHANGELOG from your dashboard on our [website](https://www.creative-tim.com/).
2. Providing us reproducible steps for the issue will shorten the time it takes for it to be fixed.
3. Some issues may be browser specific, so specifying in what browser you encountered the issue might help.
# Technical Support or Questions
If you have questions or need help integrating the product please [contact us](https://www.creative-tim.com/contact-us) instead of opening an issue.
# Licensing
- Copyright 2022 Creative Tim (https://www.creative-tim.com)
- Licensed under MIT (https://github.com/creativetimofficial/black-dashboard-react/blob/master/LICENSE.md)
# Useful Links
More products from Creative Tim: <https://www.creative-tim.com/products>
Tutorials: <https://www.youtube.com/channel/UCVyTG4sCw-rOvB9oHkzZD1w>
Freebies: <https://www.creative-tim.com/products>
Affiliate Program (earn money): <https://www.creative-tim.com/affiliates/new>
Genezio Social Media:
- LinkedIn <https://www.linkedin.com/company/genezio/>
- Twitter: <https://twitter.com/geneziodev>
- Instagram: <https://instagram.com/genezio.dev>
- Facebook: <https://www.facebook.com/genezio.dev>
CreativeTim Social Media:
- Twitter: <https://twitter.com/CreativeTim>
- Facebook: <https://www.facebook.com/CreativeTim>
- Dribbble: <https://dribbble.com/creativetim>
- Google+: <https://plus.google.com/+CreativetimPage>
- Instagram: <https://instagram.com/creativetimofficial>
| Build and deploy serverless applications like never before with our ultimate full-stack solution. | dashboard,genezio,backend,frontend,javascript,react,serverless,serverless-functions,bootstrap4,reactstrap | 2023-03-30T13:23:59Z | 2023-09-25T11:57:08Z | null | 6 | 1 | 11 | 0 | 31 | 12 | null | null | CSS |
Bestbynature/leaderboard-project | dev | <a name="readme-top"></a>
<div align="center"><br/><h3><b></b></h3></div>
https://user-images.githubusercontent.com/104390780/231420479-8752b6e4-41e8-4699-bd48-45f547866c79.mp4
<!-- TABLE OF CONTENTS -->
# 📗 Table of Contents
- [📗 Table of Contents](#-table-of-contents)
- [📖 \[LeaderBoard Project\] ](#-leaderboard-project-)
- [🛠 Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Key Features ](#key-features-)
- [🚀 Live Demo ](#-live-demo-)
- [**Leaderboard Project**](#leaderboard-project)
- [💻 Getting Started ](#-getting-started-)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage ](#usage-)
- [Run tests ](#run-tests-)
- [Deployment ](#deployment-)
- [👥 Authors ](#-authors-)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [📝 License ](#-license-)
<!-- PROJECT DESCRIPTION -->
# 📖 [LeaderBoard Project] <a name="about-project"></a>
**[LeaderBoard Project](https://bestbynature.github.io/leaderboard-project/)** is a JavaScript project that builds the Leaderboard list app, using webpack and ES6 features (notably modules). It employs the Leaderboard API using JavaScript async and await, with some nice styling. The application contains two buttons - `Refresh` and `Submit`. Clicking the `Submit` button after filling the name and score input will perform a `POST` method on the API and bring back a confirmatory message in the DOM (which disappears after 5 seconds). In contrast, clicking the `Refresh` button performs a `GET` method and pulls the currently available data, with respect to the already programmed GameID, from the API and displays the full list in the DOM.
## 🛠 Built With <a name="built-with"></a>
### Tech Stack <a name="tech-stack"></a>
<details>
<summary>Client</summary>
<ul>
<li>HTML</li>
<li>CSS</li>
<li>JAVASCRIPT</li>
</ul>
</details>
<!-- Features -->
### Key Features <a name="key-features"></a>
- **[Linter checks]**
- **[Webpack]**
- **[API]**
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- LIVE DEMO -->
## 🚀 Live Demo <a name="live-demo"></a>
### **[Leaderboard Project](https://bestbynature.github.io/leaderboard-project/)**
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- GETTING STARTED -->
## 💻 Getting Started <a name="getting-started"></a>
To get a local copy up and running, follow these steps.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
### Prerequisites
In order to run this project you need:
<ul>
<li>The current version of node</li>
<li>To have Git installed on your local machine</li>
<li>Node Package manager (npm) </li>
<li>An editor such as Visual Studio Code</li>
</ul>
<p align="right">(<a href="#readme-top">back to top</a>)</p>
### Setup
Clone this repository to your desired folder:
<ul>
<li>Create your classic access token from github.com</li>
<li>run "git clone https://{access_token}@github.com/username/{repo_name}.git"</li>
<li>Update your git identity by running "git config --global user.email "your_email@gmail.com""</li>
<li>Update your name on git by running "git config --global user.name "your_name"</li>
</ul>
<p align="right">(<a href="#readme-top">back to top</a>)</p>
### Install
Install this project with:
```sh
- In the first commit of your feature branch create a .github/workflows folder and add a copy of [.github/workflows/linters.yml](https://github.com/microverseinc/linters-config/blob/master/html-css-js/.github/workflows/linters.yml) to that folder.
- create a .gitignore file and add 'node_modules' to it
- run 'npm init -y'
- run 'npm install --save-dev hint@7.x'
- Copy [hintrc](https://github.com/microverseinc/linters-config/blob/master/html-css-js/.hintrc) to the root directory of your project.
- run 'npx hint .'
- Fix validation errors.
- run 'npm install --save-dev stylelint@13.x stylelint-scss@3.x stylelint-config-standard@21.x stylelint-csstree-validator@1.x'
- Copy [stylelintrc.json](https://github.com/microverseinc/linters-config/blob/master/html-css-js/.stylelintrc.json) to the root directory of your project.
- Run 'npx stylelint "\*_/_.{css,scss}"'
- fix linter errors
- run "npm install --save-dev eslint@7.x eslint-config-airbnb-base@14.x eslint-plugin-import@2.x babel-eslint@10.x"
- Copy [eslintrc.json](https://github.com/microverseinc/linters-config/tree/master/html-css-js)
- Run npx eslint . on the root of your directory of your project
- Fix linter error.
### To Install Jest
- run npm install --save-dev jest
- add " "test": "jest", "watch": "jest --watch *.js" to the scripts section of package.json"
- run npm install --save-dev @babel/plugin-transform-modules-commonjs
- create a file at the root called .babelrc
- copy `{
"env": {
"test": {
"plugins": ["@babel/plugin-transform-modules-commonjs"]
}
}
}` inside the file
```
<p align="right">(<a href="#readme-top">back to top</a>)</p>
### Usage <a name="usage"></a>
To run the project, execute the following command:
```sh
use git bash to open in Vs code
use npm start to run web dev server
npm run build to get the production version
```
<p align="right">(<a href="#readme-top">back to top</a>)</p>
### Run tests <a name="run-tests"></a>
To run tests, run the following command:
```sh
Run "npx hint ."
Run "npx stylelint "**/*.{css,scss} --fix " to fix linters
Run "npx eslint . --fix to fix linters"
```
<p align="right">(<a href="#readme-top">back to top</a>)</p>
### Deployment <a name="triangular_flag_on_post-deployment"></a>
You can deploy this project using:
- github pages
```sh
- npm run deploy
```
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- AUTHORS -->
## 👥 Authors <a name="authors"></a>
👤 **Author**
- GitHub: [@githubhandle](https://github.com/Bestbynature)
- Twitter: [@twitterhandle](https://twitter.com/Dammybest)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/damilare-ismaila-4a5a8b30/)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- FUTURE FEATURES -->
## 🔭 Future Features <a name="future-features"></a>
- [ ] **[contact form page]**
- [ ] **[A feature for prize inclusion]**
- [ ] **[A feature for updating the scores on the board]**
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- CONTRIBUTING -->
## 🤝 Contributing <a name="contributing"></a>
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- SUPPORT -->
## ⭐️ Show your support <a name="support"></a>
If you like this project, kindly drop a star for me.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- ACKNOWLEDGEMENTS -->
## 🙏 Acknowledgments <a name="acknowledgements"></a>
I would like to use this medium to appreciate [Microverse](https://microverse.org) for giving me this type of opportunity.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- LICENSE -->
## 📝 License <a name="license"></a>
This project is [MIT](./LICENSE) licensed.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
| This JavaScript project builds the Leaderboard list app, using webpack and ES6 features, notably modules. It employs the Leaderboard API using JavaScript async and await, with some nice styling. | css,eslint,html5,javascript,stylelint | 2023-04-08T17:20:58Z | 2023-04-12T09:46:49Z | null | 1 | 3 | 26 | 0 | 0 | 12 | null | MIT | JavaScript |
MussieTeka/To-Do-List | main | <a name="readme-top"></a>
<div align="center">
<img src="mussie.png" alt="logo" width="300px" height="300px" />
<br/>
<h3><b>To Do List App</b></h3>
</div>
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#triangular_flag_on_post-deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ (OPTIONAL)](#faq)
- [📝 License](#license)
<!-- PROJECT DESCRIPTION -->
# 📖 To Do List App <a name="about-project"></a>
This is a simple to-do list web application that allows users to add, edit, and delete tasks. The app is built using HTML, CSS, JavaScript, and runs on WebApp. The project is still on progress.
## 🛠 Built With <a name="built-with"></a>
### Tech Stack <a name="tech-stack"></a>
- Client: HTML, CSS, JavaScript
- Server: Not applicable
- Database: Not applicable
<details>
<summary>Client</summary>
<ul>
<li><a href="https://www.w3.org/html/">HTML</a></li>
<li><a ref="https://www.w3.org/Style/CSS/">CSS</a></li>
<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript">JS</a></li>
</ul>
</details>
The project was built using the following technologies:
- HTML
- CSS
- JavaScript
<p align="right">(<a href="#readme-top">back to top</a>)</p>
### Key Features <a name="key-features"></a>
- **Create a task with a title and description**
- **Mark tasks as complete or incomplete**
- **Delete tasks**
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 💻 Getting Started <a name="getting-started"></a>
To get a local copy of the project up and running, follow these steps.
### Prerequisites
In order to run this project, you need to have a web browser installed on your computer.
### Setup
Clone this repository to your desired folder by running the following command:
```sh
clone git@github.com:MussieTeka/To-Do-List.git
```
### Install
Run npm install to install all dependencies
```sh
cd To-Do-List
npm install
```
### Usage
Run npm start to start the application using webapp live server.
```sh
npm start
```
This will open the app in your browser at http://localhost:8081/
### Run tests
To run tests for the To Do List App, follow these steps:
- Open the command prompt or terminal on your computer.
- Navigate to the project directory using the cd command.
- Type the command npm run test and press enter.
```sh
npm run test
```
### Deployment
You can deploy this project using any web hosting service of your choice.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- AUTHORS -->
## 👥 Author <a name="authors"></a>
This project was developed by:
👤 **Mussie Kahsay** - Developer
- GitHub: [@MussieTeka](https://github.com/MussieTeka)
- Twitter: [@mussieteka](https://twitter.com/mussieteka)
- LinkedIn: [@mussieteka](https://linkedin.com/in/mussieteka)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 🔭 Future Features <a name="future-features"></a>
The work on this project is still in progress. Currently, users can add tasks to the list, mark tasks as complete, and delete tasks. However, some features are still under development, such as the ability to edit tasks and sort tasks by priority or due date.
<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](../../issues/).
<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 give it a star on GitHub.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 🙏 Acknowledgments <a name="acknowledgements"></a>
I would like to thank the following resources and individuals for their help and inspiration:
- <a href="https://www.microverse.org/">Microverse</a>, an online software engineering coding bootcamp.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## ❓ FAQ (OPTIONAL) <a name="faq"></a>
- **Can I modify and redistribute this project?**
- Yes, you can modify and redistribute this project as long as you follow the terms of the MIT license.
- **How can I contribute to this project?**
- Contributions, issues, and feature requests are welcome! You can check the issues page to see if there are any current issues or feature requests that you can work on. If not, feel free to submit a new issue or pull request. Before contributing, please read the CONTRIBUTING.md file for guidelines on how to contribute to this project.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- LICENSE -->
## 📝 License <a name="license"></a>
This project is [MIT](./LICENSE) licensed.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
| This repository is for a to-do list web application. The website also allows the user to add, edit, and delete tasks, as well as clear completed tasks and archive them. | css,css3,html,javascript,reactjs | 2023-03-31T00:11:16Z | 2023-04-01T08:21:07Z | null | 1 | 4 | 21 | 0 | 0 | 11 | null | MIT | JavaScript |
CruuzAzul/appwrite-workshop | main | <h1 align="center">🇬🇧 Workshop: Journey into Appwrite's Heart ✍🏼</h1><br />
<img width="1790" alt="image" src="https://github.com/CruuzAzul/appwrite-workshop/assets/60877626/b9ddf77e-a0d0-4bdd-bb3c-228559deafe7">
## The Open-Source Backend Challenging Firebase 🧳
### Discover the fundamentals that make Appwrite an essential tool for all developers! Join us for this experience 🛫
The purpose of this workshop is to introduce you to the world of open-source backend and familiarize you with the Appwrite solution. During this event, we will explore the basics of Appwrite, from setting up the environment to exploring more advanced features. Together, we will discover the various core services that make Appwrite an indispensable tool for any developer looking for an easy-to-use and high-performance backend 🚀
## 🖥️ How It Works
The workshop was created in JS/TS. However, it is entirely possible to do it in Flutter or using another mobile technology, but some resources may not be available at the time of the workshop. However, there should be no problem following the workshop outline with another compatible technology.
**To follow the workshop, simply follow these instructions** 👉🏼 [Appwrite Workshop](https://appwrite-workshop.vercel.app/)
## 🆘 Need Help?
If you encounter difficulties during the workshop or have questions, feel free to contact us via our email address or our Github page. We are always happy to help and receive feedback to improve our workshops.
## 🪪 License
This workshop is under the MIT license. You are free to use, modify, and distribute it according to your needs, with proper attribution 🙏🏼
## 🤝🏼 Contributing
Please read CONTRIBUTING.md to learn about contributing to this project.
<br/><br/>
<h1 align="center">🇫🇷 Workshop : Voyage au coeur d'Appwrite ✍🏼</h1><br />
<img width="1790" alt="image" src="https://github.com/CruuzAzul/appwrite-workshop/assets/60877626/b62ea713-1d97-4839-b714-0c96ce410055">
<h2 align="center"> Le backend open-source qui challenge Firebase 🧳</h2><br />
### Découvrez les fondamentaux qui font d'Appwrite un outil indispensable pour tous les développeurs ! Embarquez avec nous pour cette expérience 🛫
Le but de cet atelier est de vous faire découvrir l'univers du backend open-source et de vous familiariser avec la solution Appwrite. Durant cet évènement, nous explorerons les fondamentaux d'Appwrite, de la mise en place de l'environnement à l'exploration de fonctionnalités plus avancées. Nous découvrirons ensemble les différents services de base qui font d'Appwrite un outil indispensable pour tout développeur à la recherche d'un backend facile à utiliser et performant 🚀
## 🖥️ Comment ça marche ?
Le workshop a été créé en JS / TS. Cependant, il est tout à fait possible de le faire en Flutter ou en utilisant une autre techno mobile, mais il se peut que toutes les ressources ne soient pas disponibles au moment du workshop. Mais il n'y aura aucun problème pour suivre la trame du workshop avec une autre technologie compatible.
**Pour suivre le workshop vous avez juste à suivre les indications suivantes** 👉🏼 https://appwrite-workshop.vercel.app/
## 🆘 Besoin d'aide ?
Si vous rencontrez des difficultés pendant le workshop ou si vous avez des questions, n'hésitez pas à nous contacter via notre adresse e-mail ou notre page Github. Nous sommes toujours heureux d'aider et de recevoir des commentaires pour améliorer nos ateliers.
## 🪪 Licence
Ce workshop est sous licence MIT. Vous êtes libre de l'utiliser, de le modifier et de le distribuer selon vos besoins, sous conditions de créditation 🙏🏼
## 🤝🏼 Contribution
Veuillez lire CONTRIBUTING.md pour en savoir plus sur la contribution à ce projet.
| This is a workshop to learn basics of Appwrite 🚀 | appwrite,flutter,javascript,typescript,workshop | 2023-03-26T10:31:42Z | 2024-01-30T21:33:10Z | null | 4 | 39 | 62 | 3 | 2 | 11 | null | MIT | null |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.