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 |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
sofiane-abou-abderrahim/javascript-introduction-to-testing-asynchronous-code | main | null | In this little JavaScript demo, I tested asynchronous code using mocks for http apis and third-party libraries, like axios. | axios,javascript,jest,nodejs,webpack,asynchronous,mock,mocking,http-api,third-party-libraries | 2023-10-31T20:02:35Z | 2023-10-31T21:04:35Z | null | 1 | 1 | 12 | 0 | 0 | 2 | null | null | JavaScript |
learosema/retro-sound | main | ---
title: Introducing retro-sound.js
layout: demo
---
`retro-sound.js` is Lea's new Web Audio Library for 8-bit style retro sounds, based on Web Audio API. It's an `npm install` away:
```sh
npm install retro-sound
```
Let's have a look how it works. As it is based on Web Audio API, first thing to do is to create a new `AudioContext`.
I also create a gain node to reduce the overall loudness a bit.
```ts
const AC = new AudioContext();
const masterVolume = AC.createGain();
masterVolume.gain.setValueAtTime(0.25, 0);
masterVolume.connect(AC.destination);
```
My library exports a `Sound` class which uses the Builder pattern to create sounds based on the four basic oscillators available in Web Audio API (triangle, singe, square and sawtooth). There are builder methods to add a couple of effects to the sound, like a modulator or a lowpass filter.
```ts
AC.resume();
const FM = new Sound(AC, 'triangle')
.withModulator('square', 6, 600, 'detune')
.withModulator('square', 12, 300, 'detune')
.withFilter('lowpass', 1000)
.toDestination(masterVolume);
FM.play('A5')
.rampToVolumeAtTime(0, 1)
.waitDispose();
```
There is also a `WhiteNoise` class. Combining it with a low-pass filter and changing it over time can create interesting effects like swooshes or percussions.
```ts
AC.resume();
const noise = new WhiteNoise(AC)
.withFilter('lowpass', 10000)
.toDestination(masterVolume);
noise.play()
.rampFilterFreqAtTime(1000, .25)
.rampToVolumeAtTime(0, .5).waitDispose();
```
| 8-bit style sound library based on Web Audio API | javascript,webaudio-api | 2023-10-14T21:21:45Z | 2023-11-26T00:13:45Z | 2023-11-26T00:13:45Z | 1 | 0 | 26 | 0 | 0 | 2 | null | MIT | TypeScript |
mohdaamil120/MediPulse-Hospital | main | ## vogue-pocket-8479
## MediPulse
Description
MediPulse is a doctor consultation and appointment booking website. Experiencing the website we can book doctors in the different cities within the variety of different departments by using the filter and sorting.
In this way, the website can be easily navigated according to our needs. this project uses the React library, with the Javascript and CSS which includes external CSS like CharkaUI and MaterialUI. This website is fully `responsive` so we can have a hassle-free experience on any device.
### Contribution
A team of 5 members created this project over the course of six days.
**TEAM MEMBERS**
1. [Mohd Aamil](https://github.com/Srinivas831)
2. [Aditya Choudhary](https://github.com/Aditya-Choudhary0)
3. [Priya_P](https://github.com/Priyap1038)
4. [Vishvendra Tomar](https://github.com/VishvendraTomar)
5. [Piyush Sharma ](https://github.com/pspiyush130)
### Deployed Link
old link https://vogue-pocket-8479-ftweywdrx-mohdaamil120.vercel.app/
New link https://vogue-pocket-8479-8gpxiyi3q-mohdaamil120.vercel.app/
### JSON Server
https://vogue-pocket-data.onrender.com
### Tech-Stack Used
```
- HTML
- CSS
- JavaScript
- React
- ChakraUI
- MaterialUI
```
## Details Of Website
MediPulse is designed to be user-friendly and easy to navigate. The website includes the following pages:
[**`Home`**](vogue-pocket-8479/src/Pages/Home.jsx): Landing Page with the details about our services and different departments and doctors. There is a Testimonial section that helps us know about the services.
[**`Doctors`**](vogue-pocket-8479/src/Pages/Doctors.jsx): On this page there is a list of doctors and we can find appropriate doctors by applying the filters available. We can book the appointment or have an on-call consultation.
[**`SignIn and SignUp`**](vogue-pocket-8479/src/Pages/Register.jsx): SignUp page where the customer can create a new account for fast, seamless booking of appointments. SignIn page where existing users can sign in so that their experience is uninterrupted.
[**`About`**](vogue-pocket-8479/src/Pages/AboutPage.jsx): A page where we get all the details of our Hospital.
[**`Contact`**](vogue-pocket-8479/src/Pages/ContactPage.jsx): Contact details are present through which we can connect the Hospital. There are different ways like Address, Mobile number, and Email address.
[**`Admin`**](vogue-pocket-8479/src/Pages/Admin.jsx): On the Admin page we can access all the doctors available for the appointment and can also Add or remove the doctors accordingly. There is a User section in which the admin can easily see the users and the related information and can remove the user.
All the page of the website is ***`responsive`*** in nature for all devices.
Contributions to vogue-pocket-8479 are welcome! If you would like to contribute, please follow these guidelines:
### Fork the repository
+ Create a new branch for your changes
+ Make your changes and commit them with clear commit messages
+ Push your changes to your fork
+ Create a pull request with a clear description of your changes
+ Credits will be given for the work done.
| MediPulse is a doctor consultation and appointment booking website. Experiencing the website we can book doctors in the different cities within the variety of different departments by using the filter and sorting. In this way, the website can be easily navigated according to our needs. | chakra-ui,css,html,javascript,material-ui,react,redux,json,render | 2023-11-01T06:29:23Z | 2023-11-29T09:38:49Z | null | 6 | 20 | 67 | 0 | 2 | 2 | null | null | JavaScript |
polar-rules/nest-task | main |
<p align="center">
<img src="https://github.com/polar-rules/nest-task/blob/main/assets/mascot.png?raw=true" width="120" alt="Nest Logo" />
</p>
<p align="center">
The ultimate solution to execute simple tasks in <a href="https://github.com/nestjs/nest" target="_blank">Nest.js</a>
environment fully supporting import of <a href="https://github.com/nestjs/nest" target="_blank">Nest.js</a> classes,
basic tools and approaches.
</p>
<p align="center">
<img src="https://github.com/polar-rules/nest-task/actions/workflows/branch-main.yml/badge.svg?branch=main" alt="Main" style="max-width: 100%;">
<a href="https://www.npmjs.com/package/@polar-rules/nest-task?activeTab=versions" target="_blank"><img src="https://img.shields.io/github/release/polar-rules/nest-task?include_prereleases=&sort=semver&color=blue" alt="NPM Version" /></a>
<a href="https://www.npmjs.com/package/@polar-rules/nest-task?activeTab=versions" target="_blank"><img src="https://img.shields.io/badge/License-MIT-pink" alt="Package License" /></a>
</p>
<p align="center">
<a href="https://github.com/polar-rules/nest-task/actions" target="_blank"><img src="https://polar-rules.github.io/nest-task/assets/badges/coverage.svg" alt="Coverage" /></a>
</p>
## Preview
<div align="center">
<div style="display: inline-block; text-align: center;">
<p><strong>List tasks:</strong></p>
<img src="https://github.com/polar-rules/nest-task/blob/main/assets/nest-task-list.gif?raw=true" width="800" />
</div>
<div style="display: inline-block; text-align: center;">
<p><strong>Call task:</strong></p>
<img src="https://github.com/polar-rules/nest-task/blob/main/assets/nest-task-run.gif?raw=true" width="800" />
</div>
</div>
## Description
[`@polar-rules/nest-task`](https://github.com/polar-rules/nest-task) is the ultimate tool for generating and executing tasks within
<a href="https://github.com/nestjs/nest" target="_blank">Nest.js</a> environment using its
classes, services, etc. We are fully following <a href="https://github.com/nestjs/nest" target="_blank">Nest.js</a>
conventions, rules and approaches to make our library as simple and as familiar as <a href="https://github.com/nestjs/nest" target="_blank">Nest.js</a> itself.
Under the hood we are using the same tool set as <a href="https://github.com/nestjs/nest" target="_blank">Nest.js</a>
do: Reflect, class-transformer, class-validator, etc.
More documentation can be found on our [website](https://polar-rules.github.io/nest-task/).
### Features
- **Easy Setup**: Quickly set up and integrate tasks within your Nest.js environment with a simple setup command.
- **Support ESM & CJS**: Fully support latest modules, `CJS` and `ESM`.
- **Convention-based**: Follows Nest.js conventions and supports different file naming conventions for flexibility.
- **Interactive Assistant**: Use the interactive assistant (`bear`) for a more human-friendly and guided experience.
- **CLI Commands**: Execute a variety of commands for task creation, information retrieval, and task execution.
- **Documentation**: Well-documented with examples and explanations to guide users through the process.
### Table of content
- [Getting started](#getting-started)
- [Installation](#installation)
- [Help](#help)
- [Guides](#guides)
- [Creating task](#creating-task)
- [Receiving the list of tasks](#receiving-the-list-of-tasks)
- [Running task](#running-task)
- [Documentation](#documentation)
- [Nest integration](#nest-integration)
- [Entrypoint](#entrypoint)
- [TasksModule](#tasksmodule)
- [Task](#task)
- [CLI](#cli)
- [Issues](#issues)
- [Contributing](#contributing)
- [Stay in touch](#stay-in-touch)
- [Acknowledgments](#acknowledgments)
- [License](#license)
## Getting started
### Nest.js version
At this point we support only 10.x.x version of Nest.js (at least this is the version that is fully tested), however
this package should theoretically work with 9.x.x and lower, but it wasn't tested.
### Installation
Via `NPM`:
```Bash
npm install @polar-rules/nest-task
```
Via `Yarn`:
```Bash
yarn add @polar-rules/nest-task
```
### Help
From command line you can call help prompt to receive a list of available commands:
```Bash
npx nest-task help
```
### Guides
Once you've installed you will have available `nest-task` binary available to run. We recommend you to run `npx` to run
binary, but you choose whatever suits you the best.
Now you need to run:
```Bash
npx nest-task setup --convention kebab-case
```
In case you have `project` key inside your `nest-cli.json` you need to add `--project-name` flag and specify project
name. For example:
```Bash
npx nest-task setup --project-name <project> --convention kebab-case
```
Or run interactive assistant and pick `Setup` option, and then just follow installation steps:
```Bash
npx nest-task bear
```
This action will do the following:
- modify the `nest-cli.json` and create new key `task` there
- create the folder `tasks` under `src`
- create `main.ts` and `tasks.module.ts`
- create a simple `example` task for education purposes
### Creating task
To create a task you need to run:
```Bash
npx nest-task create --name <name> --description <description>
```
Or if you have `project` key inside your `nest-cli.json` you need to add `--project-name` flag and specify project
name.
```Bash
npx nest-task create --project-name <project> --name <name> --description <description>
```
You can run interactive assistant and pick `create` option and just follow proposed steps to generate task:
```Bash
npx nest-task bear
```
### Receiving the list of tasks
**IMPORTANT.** In purpose for your tasks run correctly you need to build your project firstly.
To receive a list of tasks
```Bash
npx nest-task info
```
Or if you have `project` key inside your `nest-cli.json` you need to add `--project-name` flag and specify project
name.
```Bash
npx nest-task info --project-name <project>
```
You can run interactive assistant and pick `info` option and just follow proposed steps to generate task:
```Bash
npx nest-task bear
```
### Running task
**IMPORTANT.** In purpose for your tasks run correctly you need to build your project firstly.
To create a task you need to run:
```Bash
npx nest-task run --name <name> <other-arguments>
```
Or if you have `project` key inside your `nest-cli.json` you need to add `--project-name` flag and specify project
name.
```Bash
npx nest-task run --project-name <project> --name <name> <other-arguments>
```
You can run interactive assistant and pick `run` option and just follow proposed steps to generate task:
```Bash
npx nest-task bear
```
### Running task without CLI
Yes, starting from `0.2.0` you can run tasks without CLI and directly using `node` command totally bypassing the case
when default Nest.js configuration is not available. All you need to do is to call compiled `main.js` file with correct
arguments.
_Note_: In case you don't have `package.json` or for some reason you're missing `nest-cli.json` on your server
youre force to run this commands directly.
To pass arguments you need literally to do the same thing as you do with default CLI command.
For example:
```Bash
node ./dist/task/main.js --name <name> <other-arguments>
```
Since you're calling `main.ts` file directly you don't need to handle project name at all, since we assume that you're
that location of `main.js` already in default or under correct directory.
If you want to pass additional arguments, it's easy to do with the following syntax:
```Bash
node ./dist/task/main.js --name <name> --argument1 value
```
_Note_:
`--argument1` - can have any desired name, except pre-defined fields, like `name`, `projectName` and other.
## Documentation
### Nest integration
In purpose to integrate with <a href="https://github.com/nestjs/nest" target="_blank">Nest.js</a> we modify `nest-cli.json` file located inside your root directory. We add
key `task` in this file on top level. The object should have the following format:
`<root>/nest-cli.json`
```json
{
"task": {
"path": "src/tasks",
"entryPoint": "main.ts",
"convention": "kebab-case",
"distDirectory": "dist"
}
}
```
Or if you use `projects` feature from <a href="https://github.com/nestjs/nest" target="_blank">Nest.js</a> then your `nest-cli.json` should look like this:
`<root>/nest-cli.json`
```json
{
"projects": {
"example": {
"task": {
"path": "src/tasks",
"entryPoint": "main.ts",
"convention": "kebab-case",
"distDirectory": "dist"
}
}
}
}
```
------------------------------
#### `distDirectory`
Optional.
By default, we assume that your script is compiled to the `"dist"` directory.
So for example, in default setup, you use your `"dist"` folder as compiled folder. This is basically where we will be
looking for tasks when you're using CLI. (This will be ignored when you're using `node` command on entrypoint directly).
But, sometimes your configuration on server may be a bit different, since sometimes you're deploying your project as is, which may
include you dist folder, and in this case you don't need to do anything, but there may the cases when transpiled
code is located in other directory (not the on that is mentioned in `tsconfig`). So in this case we will recommend you
to use specific path to this directory.
We're heavy really on `package.json` location and build our path to task from `package.json` and we assume that this
is the project root. Then we will use `distDirectory` as a next folder from there.
For example this is how we build path `<package.json root folder>/${distDirectory}/${path.replace("src", "")/${entryPoint}}`
#### `path`
Required.
Refers to directory where tasks will be held. By default, we set it to `src/tasks` but you're free to
change it to another directory as you will.
#### `entryPoint`
Required.
The main file name entrypoint should be present here, this file should be present with in
directory specified in `path` key.
#### `conventions`
Required.
Directive the specifies what kind of file naming convention we should use when using `create`
command. Available options are: `"camel-case"`, `"snake-case"`, `"kebab-case"` or `"polar-rules"`.
------------------------------
### Entrypoint
Entrypoint file, `main.ts` it's similar to <a href="https://github.com/nestjs/nest" target="_blank">Nest.js</a> `main.ts` file. Basically after you run `npx nest-task setup` you
don't need to change it, except the cases when you want to use custom paths.
Its implementation is straight forward, and one time. You don't need make changes afterward.
`<root>/src/tasks/main.ts`
```Typescript
import { Factory } from "@polar-rules/nest-task";
import { TasksModule } from "./tasks.module";
async function main(): Promise<void> {
const app = await Factory.create(TasksModule);
await app.run();
}
main();
```
The only thing that you can possibly would like to change here is path to `TasksModule` in case of custom setup.
### TasksModule
The implementation is close to <a href="https://github.com/nestjs/nest" target="_blank">Nest.js</a> `@Module` implementation.
`<root>/src/tasks/tasks.module.ts`
```Typescript
import { Decorators } from "@polar-rules/nest-task";
import { ExampleTask } from "./example/example.task";
@Decorators.Module({
tasks: [
ExampleTask,
],
})
export class _Module {}
```
------------------------
#### `tasks`
Required.
Array of `Task` classes.
------------------------------
### Task
Defining `Task` class.
`<root>/src/tasks/example/example.task.ts`
```Typescript
import { Decorators } from "@polar-rules/nest-task";
import { AppModule } from "../../app.module";
import { AppService } from "../../app.service";
import { ExampleRunner } from "./example.runner";
@Decorators.Task({
name: "Example",
description: "Task created for demonstration how to create basic example of task",
runner: ExampleRunner,
module: AppModule,
providers: [AppService],
deprecated: false,
})
export class ExampleTask {}
```
------------------------------
Overall, you already familiar with the syntax of this approach.
#### `name`
Required.
Unique.
Name of the tasks. Should be unique for `@Decorators.Module`. Used to located task, provider information about the task.
#### `description`
Required.
Short description of the task. Even if we do not have any limitation for length, we still recommend to keep it simple
as possible.
#### `runner`
Required.
Your `@Decorators.Runner` class that will be covered in the next step. This class wil be the only class that will be
executed by the task.
#### `module`
Required.
Main <a href="https://github.com/nestjs/nest" target="_blank">Nest.js</a> application module is required to correctly initialise <a href="https://github.com/nestjs/nest" target="_blank">Nest.js</a> environment.
#### `providers`
Optional.
Array of <a href="https://github.com/nestjs/nest" target="_blank">Nest.js</a> services, entities and just classes that you want to use withing task in a same way as you do this
within `@Controller`, `@Injectable`, etc.
#### `deprecated`
Optional.
Boolean value. Literally a flag that blocks you from running the task. Useful in cases when your task is meant to be run
only one time and you want to avoid issues with running it second time.
------------------------------
Defining `Runner` class.
`<root>/src/tasks/example/example.runner.ts`
```Typescript
import { INestApplication, Logger } from "@nestjs/common";
import { Decorators } from "@polar-rules/nest-task";
import { ExampleDto } from "./example.dto";
@Decorators.Runner()
export class _Runner {
public constructor(private readonly appService: AppService) {}
public async perform(@Decorators.App() app: INestApplication, @Decorators.Logger() logger: Logger, @Decorators.Arguments() args: ExampleDto): Promise<void> {
// Your code goes here
}
}
```
------------------------------
#### `providers`
Are matched from `@Decorators.Task` `providers` field into `constructor` by type. The same way as you do with <a href="https://github.com/nestjs/nest" target="_blank">Nest.js</a>.
#### `app`
By using `@Decorators.App()` for an argument you can pass the <a href="https://github.com/nestjs/nest" target="_blank">Nest.js</a> application variable.
#### `logger`
By using `@Decorators.Logger()` for an argument you can pass the <a href="https://github.com/nestjs/nest" target="_blank">Nest.js</a> default logger.
Now you can use as you would use default logger that is coming from <a href="https://github.com/nestjs/nest" target="_blank">Nest.js</a>.
```typescript
logger.log("Example")
```
#### `args`
If you need to pass additional arguments from command line to the task you can use `@Decorators.Arguments()` with `DTO`
in a same way as you do for <a href="https://github.com/nestjs/nest" target="_blank">Nest.js</a> `@Controller`.
------------------------------
Defining `DTO` class.
`<root>/src/tasks/example/example.dto.ts`
```Typescript
import { Type } from "class-transformer";
import { IsNumber, IsString } from "class-validator";
import { Decorators } from "@polar-rules/nest-task";
export class ExampleDto {
@Decorators.Property()
@Type(() => String)
@IsString()
data: string;
@Decorators.Property()
@Type(() => IsNumber)
@IsNumber()
userId: number;
}
```
The same way that you do with <a href="https://github.com/nestjs/nest" target="_blank">Nest.js</a> DTO.
**However**
Even due `class-transformer` library do support complex types, as array, object, etc. And theoretically we can do this
too, but we still recommend to use simple primitive types like:
- string
- number
- boolean
- null
- undefined
If you want to use more complex type we recommend to use string and JSON combination.
class and variable naming.
## CLI
More details CLI documentation you can read [CLI Documentation](documentation/CLI.md) section.
## Issues
Please make sure to read the [Issue Reporting Checklist](https://github.com/nestjs/nest/blob/master/CONTRIBUTING.md#-submitting-an-issue)
before opening an issue. Issues not conforming to the guidelines may be closed immediately.
- We're heavy really on `package.json` location and build our path to task from `package.json` and we assume that this
is the project root, when you're using our CLI, hence do development be sure that you have package.json inside your
project. Same rules applied when you're running our CLI on server that's why you need to be sure that you have `package.json`
on your server, if you want to use CLI. In case, for some reason you don't have `package.json` on server - then
you can run your tasks with `node entrypoint.js` command.
## Contributing
We welcome contributions! Please read our [Contribution Guidelines](CONTRIBUTING.md) before submitting a pull request.
## Stay in touch
- Author - [Andrii Drozdov](https://github.com/d4ins)
## Acknowledgments
- The `@nestjs/cli` for providing a solid foundation for <a href="https://github.com/nestjs/nest" target="_blank">Nest.js</a> projects.
- The `class-validator` and `class-transformer` for easy class validation
## License
Released under [MIT](/LICENSE) by [@polar-rules](https://github.com/polar-rules).
| Execute commands from NestJS environment | javascript,nest,nestjs,nestjs-backend,npm,npm-package,package,typescript | 2023-10-14T03:04:20Z | 2023-12-16T22:02:20Z | 2023-12-01T05:15:13Z | 2 | 163 | 91 | 0 | 0 | 2 | null | MIT | TypeScript |
607011/chilly | main | # Santa Chilly
## Rätsel Nr. 3 aus c’t 28/2023
<img width="458" alt="grafik" src="https://github.com/607011/chilly/assets/2240271/26b00c25-b762-44ba-9345-d3476d133d2c">
Chilly, der Pinguin, soll für den Weihnachtsmann Geschenkpakete einsammeln. Helfen Sie Chilly, indem Sie die beste Route über sämtliche Pakete bis zum Ziel finden. Damit ist diejenige mit den wenigsten Zügen gemeint. Chillys eisige Welt ist ein Torus. Das heißt, wenn er an einem Rand rausrutscht, erscheint er am gegenüberliegenden Rand und rutscht in derselben Richtung weiter bis zu einem Hindernis. Wenn Chilly in ein Loch fällt, taucht er an einem bestimmten anderen wieder auf.
## Spielen und gewinnen
Dieses Spielchen ist Teil einer Verlosung anlässlich des 40-jährigen Bestehens der Computerzeitschrift [c’t](https://ct.de). Mehr dazu in [c’t 28/2023, S. 58](https://www.heise.de/select/ct/2023/28/2329707360694897070).
Viel Erfolg beim Schubsen!
**[Jetzt spielen!](https://607011.github.io/chilly/)**
| Adventsrätsel Nr. 3 in c’t 28/2023 | game,javascript,puzzle,puzzle-game | 2023-11-07T09:23:01Z | 2023-12-02T13:07:13Z | 2023-11-28T11:56:28Z | 2 | 1 | 35 | 0 | 1 | 2 | null | null | JavaScript |
codingwizzzard/Construction | main | null | null | bootstrap,css3,html5,javascript,jquery | 2023-10-26T04:49:39Z | 2023-10-26T04:49:25Z | null | 1 | 0 | 2 | 0 | 0 | 2 | null | null | HTML |
mahmoudelmougy/FreshCart-Ecommerce | main | # Getting Started with Create React App
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
## Available Scripts
In the project directory, you can run:
### `npm start`
Runs the app in the development mode.\
Open [http://localhost:3000](http://localhost:3000) to view it in your browser.
The page will reload when you make changes.\
You may also see any lint errors in the console.
### `npm test`
Launches the test runner in the interactive watch mode.\
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
### `npm run build`
Builds the app for production to the `build` folder.\
It correctly bundles React in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.\
Your app is ready to be deployed!
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
### `npm run eject`
**Note: this is a one-way operation. Once you `eject`, you can't go back!**
If you aren't satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own.
You don't have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it.
## Learn More
You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
To learn React, check out the [React documentation](https://reactjs.org/).
### Code Splitting
This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting)
### Analyzing the Bundle Size
This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size)
### Making a Progressive Web App
This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app)
### Advanced Configuration
This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration)
### Deployment
This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment)
### `npm run build` fails to minify
This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify)
| E-Commerce with real api using(React - react-router-dom - context - react-query - Authentication using jwt - react-hot-toast - react-detect-offline - formik - yup - regex - axios - react-helmet - bootstrap - scss ) | bootstrap5,javascript,jsx-syntax,reactjs,scss | 2023-10-30T23:19:41Z | 2023-12-27T19:38:02Z | null | 1 | 0 | 12 | 0 | 0 | 2 | null | null | JavaScript |
andrerip/employee-maintenance | main |
> Andre's FullStack Assessment. Project: Simple Employee Maintenance web app
# About my solution
In this assignment, I built a web application using a tech stack that combines the power of Express.js, Next.js, and Tailwind CSS. The project is structured within a mono repo, providing a seamless development experience.
## Backend
### Express.js
For the backend, I chose Express.js, a widely-used and well-documented Node.js framework. Express.js allowed me to build a robust and efficient server. It follows a Model-View-Controller (MVC) architecture, making the codebase organized and maintainable. Express.js is known for its speed and scalability, which makes it a solid choice for building RESTful APIs and handling HTTP requests efficiently.
### SQLite3
As the database system, I opted for SQLite3. This choice is excellent for small to medium-sized applications, as it is lightweight and serverless, which simplifies the setup. SQLite3 provides persistent storage on disk, ensuring data integrity and reliability. Its flexibility and simplicity made it a great fit for this project.
### Better-npm-run
To streamline the configuration management of the project, I utilized Better-npm-run. This tool helped manage scripts within the package.json file, making it easier to run various tasks, such as building and running the application. It enhances the development process by simplifying and automating routine tasks.
### ESLint
ESLint was employed for code quality and style consistency. It's a widely adopted tool for identifying and fixing problems in JavaScript code. By using ESLint, I ensured that the code adheres to best practices and maintains a high level of quality.
### Testing
I adopted a comprehensive testing approach for this project. Unit testing was performed on the model, validating the correctness of the individual components.
Additionally, integration tests were conducted among the backend endpoints to ensure the smooth interaction of different parts of the application.
### Database Seeding
I incorporated a script for seeding the database and configuring initial values, such as Departments. This feature ensures that the application starts with predefined data, allowing for a smooth user experience from the beginning.
## Frontend
### Next.js
For the frontend, I selected Next.js, a React framework known for its performance, scalability, and developer-friendly features. Next.js provides server-side rendering, automatic code splitting, and routing, making it perfect for building fast and SEO-friendly web applications. The choice of Next.js allowed me to create a dynamic and responsive user interface.
### Tailwind CSS
For styling, I harnessed the power of Tailwind CSS. Tailwind is a utility-first CSS framework that simplifies the design process and provides a consistent and visually appealing user interface. It enables rapid development by applying pre-defined styles, which significantly accelerates the frontend development workflow.
## Conclusion
The combination of Express.js, Next.js, Tailwind CSS, and the other tools mentioned above creates a robust, maintainable, and high-performance web application.
The use of these technologies ensures a seamless development experience, efficient resource management, and a user-friendly interface. This tech stack allowed me to deliver a reliable and well-structured solution for this assignment.
# Data Models
> **All models are defined in src/models/model.js**
# Pre-requisites
The exercise requires [Node.js 16.14 or later](https://nodejs.org/en/) to be installed. I recommend using the LTS version.
> Start by creating a local repository for this folder.
# DEV
## Getting Set Up
1. In the repo root directory, open a terminal and run `npm install` to gather all dependencies.
1. Next, on the terminal, `npm run seed-dev` will seed the local SQLite database with all tables populated with some tests. **Warning: This will drop the database if it exists**. The database lives in a local file `database.sqlite3`.
1. Open a terminal and run `npm run start-dev-api` which should start the api. Leave it running.
1. Open another terminal and run `npm run start-dev` which should start the frontend server. Leave it running.
1. Open the URL localhost:3000/ on a browser of your choice.
## How to start the backend server on Debug Mode
1. Stop all other instances of the terminal
1. Open the terminal and run `npm run debug-dev-api`
## How to run the tests (Unit and Integration)
> Open the terminal and run `npm run test`
## How to change the running port of the server (frontend)
1. Open the file 'package.json' on the root folder
1. Locate the property "betterScripts" and inside it you will find "start-prod" and "start-dev"
1. Change the property "PORT" for the one that you need (the default Prod port is 8080 and Dev is 3000)
# PROD
## Building and deploying manually
1. Log into the production server and clone this project repository to it.
1. In the repo root directory, open a terminal and run `npm install` to gather all dependencies.
1. Configure the departments of your company by editing the file `scripts\departments.json`
1. On the terminal, run `npm run build` to deploy a ".next" folder fully optimized
1. Next, on the terminal, run `npm run seed`. It will create the local SQLite database and seed it with the departments you have configured.
**Warning: This will drop the database if it exists**. The database lives in a local file `database.sqlite3`.
1. Open a terminal and run `npm run start-prod-api` which should start the api. LEAVE it running.
1. Open another terminal and run `npm run start-prod` which should start the frontend server. LEAVE it running.
1. Open the URL localhost:8080/ on a browser of your choice and test the application to see if suceeded. If failed, check if you did not change port 8080 by another one.
| Small Employee Maintenance website with back and frontend | expressjs,javascript,nextjs,reactjs,tailwindcss | 2023-10-28T14:55:33Z | 2023-10-19T23:42:22Z | null | 1 | 0 | 37 | 0 | 0 | 2 | null | null | JavaScript |
UniversityOfGdanskTeamPython/epseon_gui | main | <p align="center">
<img width="400" src="https://github.com/UniversityOfGdanskTeamPython/epseon_backend/assets/56170852/094eb29d-ad4d-420c-bf20-60eae2cadb0b" alt="" />
</p>
<h1 align="center"> Epseon GUI </h1>
## Installation
Epseon GUI can be installed with `pip` from PyPI:
```
pip install epseon_gui
```
Alternatively, it is also possible to install it directly from repository:
```
pip install git+https://github.com/UniversityOfGdanskTeamPython/epseon_gui.git
```
## Development
To quickly set up development environment, first you have to install `poetry` globally:
```
pip install poetry
```
Afterwards you will be able to create development virtual environment:
```
poetry shell
```
Then You have to install dependencies into this environment:
```
poetry install --with=docs
```
And pre-commit hooks:
```
poe install-hooks
```
Now you are good to go. Whenever you commit changes, pre-commit hooks will be invoked.
If they fail or change files, you will have to re-add changes and commit again.
## Build from source
To build Epseon GUI from source make sure you have `poetry` environment activated with:
```
poetry shell
```
```
poetry install
```
With environment active it should be possible to build wheel and source distribution
with:
```
poe build
```
## Build documentation
To locally build documentation site, first you will need to install all documentation
related dependencies. This can be achieved with following command:
```
poetry install --with docs
```
Afterwards you can invoke `mkdocs` to generate documentation in form of HTML website:
```
mkdocs build
```
**Important** this is not how CI builds documentation, do not use this approach to
upload documentation to GitHub pages.
| Web interface for epseon application | fastapi,html,javascript,jsx,python,react,scss,sqlalchemy | 2023-10-16T18:47:18Z | 2024-01-22T21:32:09Z | null | 3 | 70 | 24 | 2 | 0 | 2 | null | MIT | JavaScript |
eskin22/Historian | master | <p align="center">
<img src="public/assets/logo.png" width="600" alt="logo">
</p>
<p align="center">
Created by
<img src="public/assets/test.svg" width="130" height="25" align="center">
</p>
---
<br>
<br>
# 📋 Table of Contents
1. [📖 What is Historian?](#📖-what-is-historian)
2. [🎯 Objective](#🎯-objective)
3. [🚀 Usage](#🚀-usage)
4. [🛠 Build](#🛠-build)
4. [💙 Contributors](#💙-contributors)
# 📖 What is Historian?
> Final project for CS 410 Text Information Systems at the University of Illinois Urbana-Champaign
**Historian** is a Google Chrome extension that builds a knowledge graph of your visited webpages based on their similarity with respect to each other.
<p align="center">
<a href="https://www.youtube.com/watch?v=EzGEQ4Oikb4">
<img src="public/assets/thumbnail.png" width="700">
</a>
</p>
## Features
* Builds graph of webpages visited
* Visualizes the similarity of webpages in history
* Clusters similar webpages together under shared topics
* Presents an intuitive way to research
<br>
# 🎯 Objective
Create a Google Chrome extension that acts as a [knowledge graph builder](https://www.ibm.com/topics/knowledge-graph#:~:text=A%20knowledge%20graph%2C%20also%20known,the%20term%20knowledge%20%E2%80%9Cgraph.%E2%80%9D) for webpages that the user visits while researching information online.
The extension should represent the user's visited webpages as nodes in a graph where the edges reflect the relative similarity between them such that similar webpages will be clustered together.
This will offer users an intuitive way to visualize their search history while performing online research and eliminate the reliance on other third party applications to track this information.
# 📌 Tasks
| Task | Assigned To |
| --- | --- |
| Learn how to make a Chrome extension | Everyone |
| Visualizing Graphs | Blake |
| Web Scraping | Megha |
| Similarity Algorithm | Michael |
| Build Frontend | Rohan |
| Build Backend | Kaushal |
# 🚀 Usage
> [!NOTE]
> The section(s) that follow provide comprehensive instructions for getting **Historian** setup on your local device. After completing [Step 1](###step-1:-clone-this-repository) and [Step 4](###step-4:-load-the-unpacked-extension-into-chrome), you can run the [demo script](demo.py) to install dependencies, start the local server, and open some sample webpages to see an easy demonstration of how **Historian** works.
## Dependencies
The table below gives an overview of the dependencies for this project as well as the versions used. For the packages, you can download these directly or run the `setup.py` script as discussed in the next section.
<details><summary><b>Show dependencies</b></summary>
| Item | Version |
| --- | --- |
| Python | [3.12.0](https://www.python.org/downloads/release/python-3120/) |
| NumPy | [1.26.1](https://pypi.org/project/numpy/#files) |
| SciPy | [1.11.3](https://pypi.org/project/scipy/#files) |
| SciKit-Learn | [1.3.2](https://pypi.org/project/scikit-learn/#files) |
| NLTK | [3.8.1](https://pypi.org/project/nltk/#files) |
| BeautifulSoup | [4.12.2](https://pypi.org/project/beautifulsoup4/#files) |
| Plotly | [5.18.0](https://pypi.org/project/plotly/#files) |
| Dash | [2.14.2](https://pypi.org/project/dash/#files) |
| Flask | [3.0.0](https://pypi.org/project/Flask/#files) |
| Flask-Caching | [2.1.0](https://pypi.org/project/Flask-Caching/#files) |
| Flask-Cors | [4.0.0](https://pypi.org/project/Flask-Cors/#files) |
| Regex | [2023.10.3](https://pypi.org/project/regex/#files) |
| Alive-Progress | [3.1.5](https://pypi.org/project/alive-progress/#files) |
</details>
## Setup
> [!IMPORTANT]
> Historian is not currently being hosted on a domain, which means that the only way to currently use this extension is by running the server locally on your machine. The instructions below will guide you through the setup process step-by-step.
### Step 1: Clone this Repository
First you need to clone this repo to your local machine to access the server as well as the extension. The instructions below are adapted from [GitHub's documentation](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) on cloning repositories; for more information, please refer to the [docs](https://docs.github.com/en).
<details><summary><b>Show instructions</b></summary>
1. Navigate to the main page of the repository.
2. Above the list of files, click **<> Code**.
3. Copy the URL for the repository.
- To clone the repository using HTTPS, under "HTTPS", click <img src="public/assets/misc/CopyIcon.png" width="17">.
4. Open Git Bash.
5. Change the current working directory to the location where you want the cloned repository. e.g.
```
cd path/to/folder
```
6. Type `git clone`, and then paste the URL you copied earlier, e.g.
```
git clone https://github.com/blakepm2/CS410_Final_Project
```
7. Press **Enter** to create your local clone.
</details>
### Step 2: Install dependencies
After cloning the repo, you can install the [dependencies](##dependencies) using the `setup.py` or manually with `pip`.
> [!NOTE]
> **Python 3.12** is required in order to run `setup.py`. If you do not have **Python 3.12** installed, please download it [here](https://www.python.org/downloads/release/python-3120/) before proceeding.
<details><summary><b>Show instructions</b></summary>
#### Option 1: Using `setup.py`
1. Navigate to the directory where you saved the repository.
```
cd path/to/repository
```
2. Run `setup.py` to install all dependencies.
```
py -3.12 setup.py
```
#### Option 2: Using `pip`
1. Navigate to the directory where you saved the repository.
```
cd path/to/repository
```
2. In the terminal, run the following command:
```
py -3.12 -m pip install -r config/requirements.txt
```
</details>
### Step 3: Start the local server
Once you've successfully cloned the repo and installed the necessary dependencies, you can host the local server on your machine to enable the backend functionality of the extension.
<details><summary><b>Show instructions</b></summary>
1. Navigate to the directory where you saved the repository.
2. Run `server.py`.
- This will begin hosting a server on your local network.
3. Verify that the server is running.
- You can verify that the server is running by visiting http://127.0.0.1:8050/ in a web browser.
</details>
> [!IMPORTANT]
> Historian works by sending a list of the URLs from your history to the server, which will then perform the computations needed to create the graph. Once completed, the server will asynchrononously update the graph on the frontend for you to see. Thus, it is imperative that you run the server in order to see your results visualized.
### Step 4: Load the unpacked extension into Chrome
In order to use the extension in Chrome, you need to load an unpacked version into your extensions. The instructions below are adapted from [Google Chrome's documentation](https://support.google.com/chrome_webstore/answer/2664769?hl=en), which you can consult for more information.
<details><summary><b>Show instructions</b></summary>
1. On your computer, open **Chrome**.
2. At the top right, click **More** (three dots) **> Extensions > Manage Extensions**.
3. At the top right, enable **Developer mode**.
4. At the top left, click **Load unpacked**.
5. Navigate to the directory where you stored the repository, and select the `extension` folder.
6. Verify that the extension has been loaded.
- Once the extension has been successfully loaded into Chrome, you should see **Historian** listed in **My extensions**.
</details>
### Step 5: Displaying the graph
After the extension has been loaded into Chrome and the local server has been started, you should now be able to use **Historian** to see the hierarchical graph of your recent search history.
1. On your computer, open **Chrome**.
2. Visit some webpages.
- Try to visit different kinds of webpages so that the app can highlight the divisions between them (e.g. "best snack foods", "top 10 careers for computer science majors", "best nba players of all time").
- If you're having trouble coming up with ideas or would rather use some pre-selected samples, **please use the [demo](demo.py)**.
3. In the top right, click <img src='public/assets/misc/ChromeExtensionsIcon.png' width='17'> and select **Historian** from the dropdown menu.
4. In **Historian**, click **Visualize History**.
You should see a graph populate with lines connecting nodes that represents the hierarchical clusters of your browsing history.
### Troubleshooting FAQ
#### The server successfully created the graph but the extension loads forever
If there are no errors on the server-side and the extension takes too long to load your dendrogram, the issue is the Cross-Origin Resource Sharing (CORS) policy. This issue occurs because when you load **Historian** into Chrome, your **Extension ID** may be different from the one included in the code.
To fix this, simply go to **Chrome** > **Manage Extensions** and copy the **Extension ID** you see under **Historian**. Then navigate to [server.py](server.py) and replace line 37 with your **Extension ID**.
#### The server failed to create a graph due to a dimensional mismatch
If the server throws an error saying it failed to create the dendrogram due to a mismatch in dimensions, this is likely because either the webpages could not be parsed or the webpages had the same titles. Currently, Historian can only analyze distinct webpages (i.e. webpages with unique titles).
To fix this, you can either try to visit some different webpages or you can simply run the [demo script](demo.py) to get some presampled webpages to use.
# 🛠 Build
## Overview
**Historian** defines several modules to facilitate its functionality. The table below provides a high-level overview of these modules with links to their respective code and documentation.
| Module | Purpose | Documentation |
| --- | --- | --- |
| [Document](src/webScraping/document.py) | Represent webpages as documents | [Link](##document) |
| [WebScraper](src/webScraping/webScraper.py) | Extract webpage text data | [Link](##webscraper) |
| [HierarchicalClustering](src/graphing/hierarchicalClustering.py) | Perform agglomerative hierarchical clustering | [Link](##hierarchicalclustering) |
| [Dendrogram](src/graphing/dendrogram.py) | Visualize hierarchical clusters | [Link](##dendrogram) |
| [Frontend](extension/script.js) | Enable user functionality | [Link](##frontend) |
## [Document](src/webScraping/document.py)
A class to represent scraped webpages as documents
```
src.webScraping.document.Document(self, title, text, url)
```
### Parameters
- ***self*** `Document` : The `Document` object
- ***title*** `str` : The title of the webpage
- ***text*** `str` : The text data of the webpage
- ***url*** `str` : The url of the webpage
### Methods
---
None
---
## [WebScraper](src/webScraping/webScraper.py)
A class for extracting text data from webpages
```
src.webScraping.webScraper.WebScraper(self)
```
### Parameters
- ***self*** `WebScraper` : The `WebScraper` object
### Methods
---
**getWebpageText( *self*, *response* )**
Extracts and preprocesses the data from a webpage from a given `requests.Response` object
**Parameters**
- ***self*** `WebScraper` : The `WebScraper` object
- ***response*** `requests.Response` : A `requests.Response` object for a given URL
**Returns** `str`
---
**scrapeWebpages ( *self*, *urls* )**
Extracts text data from webpage(s) at a given url and saves their text data as a string into the `Webscraper.corpus` hashmap
**Parameters**
- ***self*** `WebScraper` : The `WebScraper` object
- ***urls*** `list` : A list of URLS for the webpages you want to scrape
**Returns** `dict`
---
## [HierarchicalClustering](src/graphing/hierarchicalClustering.py)
A class to perform agglomerative hierarchical clustering with average link for a collection of webpages
```
src.graphing.hierarchicalClustering.HierarchicalCluster(self)
```
### Parameters
- ***self*** `HierarchicalClustering` : The `HierarchicalClustering` object
### Methods
---
**preprocess( *self*, *text* )**
Preprocesses text data from a document by performing normalization, tokenization, and lemmatization
**Parameters**
- ***self*** `HierarchicalClustering` : The `HierarchicalClustering` object
- ***text*** `str` : The text data from a webpage document
**Returns** `str`
---
**preprocess_docs( *self*, *docs* )**
Preprocesses text for a collection of documents by performing normalization, tokenization, and lemmatization
**Parameters**
- ***self*** `HierarchicalClustering` : The `HierarchicalClustering` object
- ***docs*** `list` : A list of the processed documents to
**Returns** `list`
---
**extract_features( *self*, *docs* )**
Implements Term Frequency (TF) - Inverse Document Frequency (IDF) weighting to a set of (processed) documents
**Parameters**
- ***self*** `HierarchicalClustering` : The `HierarchicalClustering` object
- ***docs*** `list` : A list of the processed documents you want to analyze
**Returns** `numpy.ndarray`
---
**create_hierarchical_cluster( *self*, *tfidf_matrix* )**
Performs hierarchical/agglomerative clustering for a TF-IDF weighted matrix of text data from a collection of documents using Average-Link
**Parameters**
- ***self*** `HierarchicalClustering` : The `HierarchicalClustering` object
- ***tfidf_matrix*** `numpy.ndarray` : A TF-IDF weighted mattrix of text data
**Returns** `numpy.ndarray`
---
**create_dendrogram( *self*, *cluster*, *docs*)**
Creates a dendrogram to visualize a hierarchical/agglomerative cluster
**Parameters**
- ***self*** `HierarchicalClustering` : The `HierarchicalClustering` object
- ***cluster*** `numpy.ndarray` : The hierarchical cluster of the data
- ***docs*** `list` : A list of the original documents
---
**Returns** `Dendrogram`
## [Dendrogram](src/graphing/dendrogram.py)
A class to visualize a hierarchical clustering of webpages
```
src.graphing.dendrogram.Dendrogram(self, cluster, docs)
```
### Parameters
- ***self*** `Dendrogram` : The `Dendrogram` object
- ***cluster*** `np.ndarray` : The hierarchical cluster of the data
- ***docs*** `list` : A list of the original documents
### Methods
---
**create( *self* )**
Creates a dendrogram figure for a hierarchical/agglomerative cluster
**Parameters**
- ***self*** `Dendrogram` : The `Dendrogram` object
**Returns** `plotly.graph_objs.Figure`
---
**create_lines( *self* )**
Creates the lines representing the relationships between nodes in a dendrogram
**Parameters**
- ***self*** `Dendrogram` : The `Dendrogram` object
**Returns** None
---
**create_nodes( *self* )**
Creates the nodes representing the documents in a dendrogram
**Parameters**
- ***self*** `Dendrogram` : The `Dendrogram` object
**Returns** None
---
**create_layout( *self* )**
Creates the layout of the dendrogram
**Parameters**
- ***self*** `Dendrogram` : The `Dendrogram` object
**Returns** None
---
## [Frontend](extension/script.js)
Enables user functionality by sending data to the server
### Methods
---
[**fetchHistory( )**](extension/src/fetchHistory.js)
Uses the Google Chrome history API to fetch the user's recent browsing history
**Parameters**
None
**Returns** `Response`
---
[**checkAvailability( )**](extension/src/getGraph.js)
Checks the server to see if the preprocessing has been done so it can fetch the graph
**Parameters**
None
**Returns** `boolean`
---
[**getGraph( )**](extension/src/getGraph.js)
Loads the graph created by the server into the frontend for the user to see
**Parameters**
None
**Returns** `boolean`
---
[**sendURLSToServer( )**](extension/src/sendURLStoServer.js)
Leverages API call to send the user's browsing history over to the server for processing
**Parameters**
None
**Returns** `data.message`
---
[**showSpinner( )**](extension/src/spinners.js)
Shows a spinner while the page loads
**Parameters**
None
**Returns** None
---
[**hideSpinner( )**](extension/src/spinners.js)
Hides the spinner after a page has finished loading
**Parameters**
None
**Returns** None
---
# 💙 Contributors
"⭐️" denotes Team Leader
| Name | NetID/Email | Contributions |
| --- | --- | --- |
| Blake McBride ⭐️ | blakepm2@illinois.edu | Created Document class; created WebScraper class; created HierarchicalClustering class; created Dendrogram class; configured agglomerative hierarchical clustering algorithm; designed webscraping logic; wrote visualization logic; configured local server; created all functions for and designed frontend; implemented API calls from frontend to server; created setup and demo scripts; designed logo(s); wrote setup instructions; wrote documentation; designed and wrote README; wrote, editied, and produced video presentation.|
| Kaushal Dadi | kdadi2@illinois.edu | Created manifest.json; put iframe in HTML to show graph on webpage; built preliminary frontend. |
| Rohan Parekh | rohanjp2@illinois.edu | Helped Kaushal with creation of manifest.json and the chrome extension that displayed the graph on the webpage. |
| Megha Chada | megharc2@illinois.edu | Changed colors for graph; added comments to code; added title, timestamp, and description to graph; created architectural diagram. |
| Michael Ma | chiuyin2@illinois.edu | Added unfinished topic labels to the graph. | | A Google Chrome extension that builds a hierarchical knowledge graph of your visited webpages | agglomerative-clustering,dendrograms,extension-chrome,information-retrieval,javascript,python3,topic-modeling | 2023-10-27T12:28:19Z | 2023-12-15T19:30:05Z | null | 3 | 8 | 35 | 0 | 0 | 2 | null | null | Python |
mayurjadhav2002/Progress | main |
# Progress
Progress is a Kanban-based sprint tracking facilitates streamlined planning and execution of tasks, providing a visual representation of work, tasks, and progress to facilitate seamless project monitoring. The incorporation of features such as resource sharing with documentation feature akin to Confluence enhances collaborative efforts, fostering a culture of teamwork and knowledge-sharing.
## Demo
Find Demo at - https://progress-two.vercel.app/
## Usage
Once the backend and frontend servers are running in development Environment, you can access the Progress application on [http://localhost:3000](http://localhost:3000).
For Production Environment please check your domain name associated with it.
## Tech Stack
**Client:** React, Shadcn, TailwindCSS, Material Tailwind, React DnD, headlessUI, react-tables, react-icons, react-toastify, Redux
**Server:** Node.js, Express.js, mongoose, Docker, nodemailer, multer
**Other:** Axios, nodemon, jwt, moment, Google Auth, editorjs, imgbb
## Run Locally
1. Clone the repository from
```bash
git clone https://github.com/mayurjadhav2002/progress
```
2. Close the Backend branch
```bash
git clone https://github.com/mayurjadhav2002/progress -b backend
```
3. Unzip both files then open the folders in terminal and run following command
```bash
npm install
```
4. To run this project, you will need to add the following environment variables to your `.env` file
Create `.env` files in both repo and insert following credentials in it.
- Frontend
``` env
REACT_APP_GOOGLE_CLIENT_ID=
REACT_APP_GOOGLE_CLIENT_SECRET=
REACT_APP_IMGBB_CRED=
REACT_APP_BACKEND_URL=
REACT_APP_BACKEND_URL_PROD=
```
- Backend
```env
PORT=
ENVIRONMENT=prod/dev
BACKEND_URL=
APP_URL=
MONGO_INITDB_ROOT_USERNAME=
MONGO_INITDB_ROOT_PASSWORD=
MONGO_INITDB_DATABASE=
MONGO_URL=
MONGO_LOCAL_URL=
JWT_SECRET_KEY=
EMAIL_ADDRESS=
EMAIL_PASSWORD=
IMGBB_API_KEY=
GOOGLE_AUTH_CLIENT_ID=
```
5. Once done Run following commands to start your application.
- Frontend
```bash
npm start
---- or ---
npm install -g serve
serve -s build
```
- Backend
```bash
npm run start:dev
```
## License
[MIT](https://choosealicense.com/licenses/mit/)
## Authors
- [@mayurjadhav2002](https://www.github.com/mayurjadhav2002)
## Feedback
If you have any feedback, please reach out to us at mayurshrikantjadhav@gmail.com
| Progress is a Kanban-based sprint tracking tool that streamlines planning and task execution. It offers a visual representation of work, tasks, and progress for efficient project monitoring. | agile,project-management,react,javascript | 2023-10-31T19:33:17Z | 2024-02-05T15:06:31Z | null | 1 | 5 | 27 | 0 | 0 | 2 | null | MIT | JavaScript |
Abhinavrajsrivastav/React-Projects | master | # React Projects 🍀
Welcome to my collection of small and exciting React-based projects! This repository is a showcase of diverse mini-projects and demos that highlight various aspects of React development.
<div align="center">
<img src="https://cdn.freebiesupply.com/logos/large/2x/react-1-logo-png-transparent.png" alt="React Logo" style="height: 200px; width: 200px;">
</div>
## Table of Contents
- [Projects](#projects)
- [Getting Started](#getting-started)
- [Contributing](#contributing)
- [License](#license)
## Projects
### 1. hindlish - Music Player App 🎵
Dive into the world of music with this sleek and intuitive music player built using React. Explore a seamless audio experience and discover your favorite tunes in style.
- **Folder:** `/Musics/hindlish`
### 2. To-Do List
Note down your daily tasks, manage your works. This project helps you to organize and prioritize your daily tasks.
- **Folder:** `/To-do-list/to-do-list`
## Getting Started
If you want to explore these projects on your local machine, follow these steps:
### Clone this repository:
```bash
git clone git clone https://github.com/Abhinavrajsrivastav/React-Projects.git
| "This repository features concise React projects, demonstrating both creativity and practicality 🎈. Explore bite-sized React examples for quick inspiration." | css,html,javascript,nodejs,reactjs | 2023-11-02T14:13:05Z | 2024-03-16T11:07:42Z | null | 1 | 0 | 68 | 0 | 0 | 2 | null | null | JavaScript |
Alexandrbig1/header-login-form | main | # **Hero-header** Login Form
<img align="right" src="https://media.giphy.com/media/du3J3cXyzhj75IOgvA/giphy.gif" width="100"/>
practising HTML & CSS and JavaScript while studying on [Udemy courses](https://www.udemy.com/) <img style="margin: 10px" src="https://findlogovector.com/wp-content/uploads/2022/04/udemy-logo-vector-2022.png" alt="HTML5" height="30" />
## Languages and Tools:
<div align="center">
<a href="https://en.wikipedia.org/wiki/HTML5" target="_blank"><img style="margin: 10px" src="https://profilinator.rishav.dev/skills-assets/html5-original-wordmark.svg" alt="HTML5" height="50" /></a>
<a href="https://www.w3schools.com/css/" target="_blank"><img style="margin: 10px" src="https://profilinator.rishav.dev/skills-assets/css3-original-wordmark.svg" alt="CSS3" height="50" /></a>
<a href="https://www.javascript.com/" target="_blank"><img style="margin: 10px" src="https://profilinator.rishav.dev/skills-assets/javascript-original.svg" alt="JavaScript" height="50" /></a>
</div>
## Connect with me:
<div align="center">
<a href="https://linkedin.com/in/alex-smagin29" target="_blank">
<img src=https://img.shields.io/badge/linkedin-%231E77B5.svg?&style=for-the-badge&logo=linkedin&logoColor=white alt=linkedin style="margin-bottom: 5px;" />
</a>
<a href="https://github.com/alexandrbig1" target="_blank">
<img src=https://img.shields.io/badge/github-%2324292e.svg?&style=for-the-badge&logo=github&logoColor=white alt=github style="margin-bottom: 5px;" />
</a>
<a href="https://stackoverflow.com/users/alex-smagin" target="_blank">
<img src=https://img.shields.io/badge/stackoverflow-%23F28032.svg?&style=for-the-badge&logo=stackoverflow&logoColor=white alt=stackoverflow style="margin-bottom: 5px;" />
</a>
<a href="https://dribbble.com/Alexandrbig1" target="_blank">
<img src=https://img.shields.io/badge/dribbble-%23E45285.svg?&style=for-the-badge&logo=dribbble&logoColor=white alt=dribbble style="margin-bottom: 5px;" />
</a>
<a href="https://www.behance.net/a1126" target="_blank">
<img src=https://img.shields.io/badge/behance-%23191919.svg?&style=for-the-badge&logo=behance&logoColor=white alt=behance style="margin-bottom: 5px;" />
</a>
</div>
| header-login-form(HTML/CSS/JS) | computerscience,css3,frontend,hacktoberfest,hacktoberfest2023,html-css-javascript,html5,javascript,softwareengineer,ui-design | 2023-10-27T17:59:42Z | 2023-10-27T18:04:01Z | null | 1 | 0 | 3 | 0 | 0 | 2 | null | null | CSS |
khushboo787/Amusement-Park-Management-System | main | # actual-shoes-7533
<p align="center">
<a href="https://git.io/typing-svg"><img src="https://readme-typing-svg.demolab.com?font=Delicious+Handrawn&weight=100&size=53&pause=1000&color=C3F70C¢er=true&vCenter=true&width=605&height=118&lines=JoyLand" alt="Typing SVG" /></a>
<img src="Frontend/assests/JoyLand.png"/>
</p>
## Contributors
- [Khushboo Kumari](https://github.com/khushboo787)
- [Abhishek bhardwaj](https://github.com/0505Abhishek)
- [Shubham Ratnakar Kulkarni](https://github.com/Shubham17121999)
<br>
We are JoyLand and We are Adv|
At Joyland, we're in the business of creating memories and laughter. Nestled in the heart of excitement, Joyland is your passport to adventure and fun. With a rich history of delivering joy and thrills, we take pride in being the destination for families and friends seeking a day of unforgettable experiences. From exhilarating rides to delightful games and captivating entertainment, Joyland offers something for everyone. Our commitment to safety, top-notch service, and a vibrant atmosphere is what sets us apart. Come and join us in the world of endless fun and wonder. Explore, play, and make memories that will last a lifetime at Joyland, where the joy never ends
### <h2 style="margin-top:100px ;"><i>👨🏻💻 Tech Stack & Languages used</i></h2>
<img src="https://img.shields.io/badge/Libraries-563D7C?style=for-the-badge&logo=bootstrap&logoColor=white" alt="bootstrap" />
<img src="https://img.shields.io/badge/Git-f44d27?style=for-the-badge&logo=git&logoColor=white" alt="git" />
<img src="https://img.shields.io/badge/GitHub-100000?style=for-the-badge&logo=github&logoColor=white" alt="github" />
### <h2><i>🚀 Libraries & Frameworks</i></h2>
<a href="" target="blank"><img src="https://img.shields.io/static/v1?style=for-the-badge&message=Spring&color=852100&label=" alt=""/></a>
<a href="" target="blank"><img src="https://img.shields.io/static/v1?style=for-the-badge&message=SpringBoot&color=00d09c&label=" alt="" /></a>
<a href="" target="blank"><img src="https://img.shields.io/static/v1?style=for-the-badge&message=Hibernate&color=000030&label=" alt=""/></a>
<a href="" target="blank"><img src="https://img.shields.io/static/v1?style=for-the-badge&message=JDBC&color=400030&label=" alt=""/></a>
<a href="" target="blank"><img src="https://img.shields.io/static/v1?style=for-the-badge&message=Servlets&color=700030&label=" alt=""/></a>
### <h2><i>💻 Databases</i></h2>
## Landing Page
.png>)
## Customer Page
.png>)
## Admin Page
.png>)
## login Page
.png>)
```
https://localhost:8080/
```
```
http://localhost:8888/swagger-ui/index.html
```
## Modules
- Abstract User Module
- Customer Module
- Category Module
- Admin Module
- Ticket Module
- Activity Module
## Getting Started
1. Clone the repository using the command:
```
https://github.com/khushboo787/actual-shoes-7533
2. Compile and run the Java application to launch the console-based shopping platform.
## Deployed Link
https://6548cfa162392e15659aba40--lovely-vacherin-163d50.netlify.app/
## ER Diagram
<img src="https://github.com/khushboo787/actual-shoes-7533/assets/115460837/044d815d-e073-4852-aaa9-9314b4e07078" alt="ER Diagram" />
## Contributions
We welcome contributions! Feel free to fork the repository, enhance functionalities, and submit pull requests.
## License
This project is licensed under the MIT License. Refer to the [LICENSE](LICENSE) file for detailed terms.
For any inquiries or feedback, contact us at [contact@Joyland.com](mailto:contact@sweethoneydukes.com). Embark on your journey with Joyland today!
| Amusement park management system designed for seamless park operations. Utilizes a Spring Boot-created REST API presented through an elegant frontend, offering features such as effortless ticket booking and activity management for both users and administrators. | core-java,css,hibernate,html,javascript,spring-boot,spring-security,mysql | 2023-10-31T04:14:35Z | 2023-12-19T16:04:08Z | null | 3 | 15 | 39 | 0 | 0 | 2 | null | null | CSS |
JAM-Productions/malker | main | # Malker [React + Vite + Flask]
Try it: https://jam-productions.github.io/malker
Backend deployed in: https://jamproductions.pythonanywhere.com
It is also deployed in OnRender (very slow):
- Frontend: https://malker.onrender.com
- Backend: https://malker-backend.onrender.com
> [!TIP]
> We recommend using GitHub deployment instead of OnRender. OnRender [puts the server to sleep](https://docs.render.com/free#free-web-services) and has to wake up, which worsens the user experience.
## What is *malker*?
Malker is a web application designed to facilitate the management of social plans with friends. Unlike traditional platforms, Malker doesn't require users to log in; instead, it operates seamlessly using tokens and shared URLs.
The application architecture comprises React for the frontend, Flask for the backend, and Firebase for the database.
## How it works?
## Requirements
Make sure you have the following software installed on your system before running the project:
- **Node.js and npm**: Required for managing and installing JavaScript packages.
Install Node.js and npm by following the instructions on [the official Node.js website](https://nodejs.org/).
- **Python 3**: Required for the backend.
Install Python 3 by following the instructions on [the official Python website](https://www.python.org/).
- **Vite**: Required for the frontend.
Install Vite globally using npm:
```sh
npm install -g create-vite
```
> [!IMPORTANT]
> We have been using Python 3.10, Node 18 and Node 21. So if your current version does not work, we recommend installing one of these versions.
## Setup
You can setup both frontend and backend using Makefile:
```sh
make deps
```
> [!WARNING]
> Makefiles work for MacOS and Windows. You have to do the manual configuration for Linux.
### Setup frontend
Using Makefile:
```sh
make setup-frontend
```
Or manually:
```sh
npm install
```
### Set-up backend
Using Makefile:
```sh
make setup-backend
```
Or manually:
Navigate to Flask directory
```sh
cd backend
```
Create the virtual environment
```sh
python -m venv venv
```
Activate the environment
#### On Windows
```sh
venv\Scripts\activate
```
#### On MacOS
```sh
source venv/bin/activate
```
Install pip packages:
```sh
pip install -r requirements.txt
```
### Backup packages
```sh
pip freeze > requirements.txt
```
### Firebase key + environment variables setup
You have to download these files:
- [Firebase key](https://drive.google.com/file/d/1nPYWyNK5Ssrp9ks0aGVi7NDksAjxPrw_/view?usp=sharing)
- [.env file](https://drive.google.com/file/d/1E8fmx5yGL719LYT_6fa87_bCAJsCDi4F/view?usp=drive_link)
> [!NOTE]
> Only JAM-Productions members have access to these sensitive files.
Put them on `backend` directory.
## Run the app
### Run frontend
Using Makefile:
```sh
make frontend
```
Or manually:
```sh
npm run dev
```
### Run backend
Using Makefile:
```sh
make backend
```
Or manually:
```sh
npm run start-api
```
Or:
```sh
cd backend
python app.py
```
## Testing
### Frontend
#### Using the terminal
Run the following command:
```sh
npm run cypress
```
#### Using the UI
Start running the command below:
```sh
npx cypress open
```
1. Then select the type of testing (in our case, it's E2E).
2. Select where the tests will run. We recommend using Chrome.
3. Open the specs tab and open the file `app.cy.js`; this will test the entire application.
### Backend
Using Makefile:
```sh
make backend-test
```
Or manually:
```sh
cd backend
python -m pytest
```
## Linter
Run the following command:
```sh
npm run lint
```
## Format
Run the following command:
```sh
make fmt
```
### Format frontend
```sh
npm run format
```
### Format backend
```sh
cd backend
autopep8 --recursive --exclude venv --in-place .
```
| a web application to manage a social plan with your friends | firebase,flask,javascript,python,react,vite | 2023-11-05T12:25:45Z | 2024-04-14T07:08:16Z | null | 3 | 117 | 462 | 9 | 0 | 2 | null | Apache-2.0 | JavaScript |
arvindpndit/stack-doubts | main | 
<div align="center">
<h1>stack d🤔ubts</h1>
</div>
<div align="center">
<p>A knowledge sharing opensource platform to facilitate Q&A, real-time events, and community interaction.</p>
</div>
<div align="center">
<a href="https://stack-doubts.vercel.app/">🏠 Website</a>
<span> • </span>
<a href="https://www.youtube.com/@arvindexplains">🎬 YouTube</a>
<span> • </span>
<a href="https://twitter.com/arvindpnditz">🐦 Twitter</a>
</div>
<div align="center">
<a href="https://github.com/arvindpndit/stack-doubts">🔎 Explore Code</a>
</div>
## Prerequisites
- Node.js v18+
## Development
1. Clone the repository:
```bash
git clone https://github.com/arvindpndit/stack-doubts.git
```
2. Enter the project directory:
```bash
cd stack-doubts
```
3. Install the dependencies:
```bash
npm i
```
4. Configure the env vars as described below -
1. Create a new file named `.env.local` in your project's root directory
2. Open the `.env.local` file in a text editor.
3. Set the values of the environment variables with the appropriate values
```dotenv
NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY=your_clerk_publishable_key
CLERK_SECRET_KEY=your_clerk_secret_key
NEXT_PUBLIC_TINY_URL_API_KEY=your_tinyurl_api_key
MONGODB_URL=your_mongodb_connection_url
WEBHOOK_SECRET=your_webhook_secret
```
5. Start the development server with:
```bash
npm run dev
```
> Note:
> If you encounter any problem in local setup, DM me on [LinkedIn](https://www.linkedin.com/in/arvindpndit/) or on [X/twitter](https://twitter.com/arvindpnditz)
| An opensource knowledge sharing platform to facilitate Q&A, real-time events, and community interaction. | backend,clerkauth,frontend,fullstack,javascript,mongodb,mongoose,nextjs,reactjs,tailwindcss | 2023-10-30T17:30:08Z | 2024-04-17T13:33:23Z | null | 1 | 22 | 137 | 0 | 0 | 2 | null | null | TypeScript |
arvindpndit/stack-doubts | main | 
<div align="center">
<h1>stack d🤔ubts</h1>
</div>
<div align="center">
<p>A knowledge sharing opensource platform to facilitate Q&A, real-time events, and community interaction.</p>
</div>
<div align="center">
<a href="https://stack-doubts.vercel.app/">🏠 Website</a>
<span> • </span>
<a href="https://www.youtube.com/@arvindexplains">🎬 YouTube</a>
<span> • </span>
<a href="https://twitter.com/arvindpnditz">🐦 Twitter</a>
</div>
<div align="center">
<a href="https://github.com/arvindpndit/stack-doubts">🔎 Explore Code</a>
</div>
## Prerequisites
- Node.js v18+
## Development
1. Clone the repository:
```bash
git clone https://github.com/arvindpndit/stack-doubts.git
```
2. Enter the project directory:
```bash
cd stack-doubts
```
3. Install the dependencies:
```bash
npm i
```
4. Configure the env vars as described below -
1. Create a new file named `.env.local` in your project's root directory
2. Open the `.env.local` file in a text editor.
3. Set the values of the environment variables with the appropriate values
```dotenv
NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY=your_clerk_publishable_key
CLERK_SECRET_KEY=your_clerk_secret_key
NEXT_PUBLIC_TINY_URL_API_KEY=your_tinyurl_api_key
MONGODB_URL=your_mongodb_connection_url
WEBHOOK_SECRET=your_webhook_secret
```
5. Start the development server with:
```bash
npm run dev
```
> Note:
> If you encounter any problem in local setup, DM me on [LinkedIn](https://www.linkedin.com/in/arvindpndit/) or on [X/twitter](https://twitter.com/arvindpnditz)
| An opensource knowledge sharing platform to facilitate Q&A, real-time events, and community interaction. | backend,clerkauth,frontend,fullstack,javascript,mongodb,mongoose,nextjs,reactjs,tailwindcss | 2023-10-30T17:30:08Z | 2024-04-17T13:33:23Z | null | 1 | 22 | 137 | 0 | 0 | 2 | null | null | TypeScript |
felixApps/WattpadConnect-JavaScript | master | # WattpadConnect for JavaScript
Unfortunately, the wattpad API no longer exists for programmers who are not familiar with wattpad.
WattpadConnect is an alternative interface that can still be used to retrieve data from the wattpad platform easily & for free.
It is extremely easy to use and you can get almost all data from wattpad with it.
Ingenious, isn't it?
With this interface, you can get data from this URLs:
- wattpad.com/chapteridxyz
- wattpad.com/story/storyidxyz
- wattpad.com/user/useraliasxyz
**Notice: This software is not endorsed or affiliated with Wattpad.**
🐍 Python version here: [WattpadConnect for Python](https://github.com/felixApps/WattpadConnect-Python)
Overview:
- [WattpadConnect for JavaScript](#wattpadconnect-for-javascript)
- [❗DISCLAIMER❗](#disclaimer)
- [🤷♂️ How to use it?](#%EF%B8%8F-how-to-use-it)
1. [Import it](#import-it)
2. [Get JSON](#get-json)
3. [Use JSON](#use-json)
- [👉 Examples](#-examples)
1. [scheme wattpad.com/chapteridxyz](#wattpadcomchapteridxyz)
2. [scheme wattpad.com/story/storyidxyz](#wattpadcomstorystoryidxyz)
3. [scheme wattpad.com/user/useraliasxyz](#wattpadcomuseruseraliasxyz)
- [🪲 BUGS](#-bugs)
- [📋 What can I get?](#--what-can-i-get)
1. [scheme wattpad.com/chapteridxyz](#wattpadcomchapteridxyz-json)
2. [scheme wattpad.com/story/storyidxyz](#wattpadcomstorystoryidxyz-json)
3. [scheme wattpad.com/user/useraliasxyz](#wattpadcomuseruseraliasxyz-json)
## ❗DISCLAIMER❗
Use of this software is at your own risk.
The author of this software disclaims all warranties,
whether expressed or implied, as to the functionality,
security, or legality of the software.
Please be aware that the use of this software may be in
violation of Wattpad's terms of service, which explicitly
prohibit scraping, crawling, or any other method to remove
content from any part of the Site or Services.
It is your responsibility to ensure that your use of
the software complies with applicable laws and Wattpad's terms of service.
The author of this software expressly disclaims any liability
for damages, legal consequences, or losses resulting from the
use of the software. Use this software at your own discretion.
It is advisable to use the software only for lawful purposes and in
accordance with applicable laws and regulations.
## 🤷♂️ How to use it?
It's very simple.
1. #### Import it:
Just paste this in the Header of your HTML file:
```HTML
<script src="path/to/api.js"></script>
```
Don't forget to replace "path/to/api.js" with the path of the api.js file.
2. #### Get JSON:
To get data, just run the function with the URL.
You can extract information from the following URLs:
- wattpad.com/chapteridxyz
- wattpad.com/story/storyidxyz
- wattpad.com/user/useraliasxyz
E.g. to get data about a wattpad user:
```javascript
const userdata = await extractInformationFromWattpad('https://www.wattpad.com/user/username');
```
Replace 'username' with the username of the user which informations you want to get.
Now, `userdata` contains a JSON with all the user's data.
3. #### Use JSON:
So now you got a whole JSON, but how to get the data?
To extract the single informations, use this (example):
```javascript
// gets the user's avatar image url:
const avatar = userdata.metadata.data[0].avatar;
// gets the user's description:
const description = userdata.metadata.data[0].description;
```
Scroll down to see more examples:
## 👉 Examples
Okay, let's start with a HTML template:
`index.html`
```html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>test</title>
<!-- Import the wattpad connect script: -->
<script src="wattpadconnect.js"></script>
<!-- And lets import a custom script: -->
<script src="script.js"></script>
</head>
<body>
</body>
</html>
```
Now lets add some code to the `script.js`:
```javascript
// In this example, we'll use this to run the function myFunc() when the window has finished loading:
window.addEventListener('load', function () {
myFunc(); // very creative name
})
async function myFunc() {
// basic: get the json and output it to the console
// very important: use await with the function. otherwise it will propably not work
const json = await extractInformationFromWattpad('https://www.wattpad.com/1387067563');
console.log(json);
}
```
Lets take a look in the browser's console:
You are now confronted with a huge pile of data.
Let's see how you can extract the most important data.
1. #### wattpad.com/chapteridxyz:
So, in this scheme the "chapteridxyz" stands for the chapter id of the story.
Example URL: [https://www.wattpad.com/1387067563](https://www.wattpad.com/1387067563)
The URL can also include the story name and/or part(chapter) name, it doesn't matter.
`script.js`:
```javascript
async function myFunc() {
// basic: get the json and output it to the console
// very important: use await with the function. otherwise it will propably not work
const json = await extractInformationFromWattpad('https://www.wattpad.com/1387067563');
console.log(json);
// save the most important data in variables:
const storytext = json.metadata.data.storyText;
const title = json.metadata.data.title;
const currentpage = json.metadata.data.pageNumber;
const pages = json.metadata.data.pages; // how much pages has the CURRENT part?
const pagetext = currentpage + ' / ' + pages; // optional: if you want to show your users on which page they are
const storytitle = json.metadata.data.group.title;
const storycover = json.metadata.data.group.cover; // returns the URL to the image
const readcount = json.metadata.data.readCount;
const commentcount = json.metadata.data.commentCount;
const votescount = json.metadata.data.voteCount;
const completed = json.metadata.data.group.completed; // true or false
const description = json.metadata.data.group.description;
const parts = json.metadata.data.group.parts; // returns an array, you may want to program a function that processes it
const nextparturl = json.metadata.data.nextPart.url; // only aviable if there's a next part
const authorname = json.metadata.data.group.user.name;
const authoravatar = json.metadata.data.group.user.avatar; // returns the URL to the image
const authoralias = json.metadata.data.group.user.username;
const authorlink = 'https://www.wattpad.com/user/' + authoralias;
}
```
So yes, now you know how to save the data in variables.
How they are further processed is entirely up to you.
2. #### wattpad.com/story/storyidxyz
In this scheme, the "storyidxyz" stands for the story's ID.
Example: [https://www.wattpad.com/story/9341306-news-updates](https://www.wattpad.com/story/9341306-news-updates)
`script.js`:
```javascript
async function myFunc() {
// basic: get the json and output it to the console
// very important: use await with the function. otherwise it will propably not work
const json = await extractInformationFromWattpad('https://www.wattpad.com/story/9341306-news-updates');
console.log(json);
// save the most important data in variables:
const storytitle = json.metadata.data.group.title;
const description = json.metadata.data.group.description;
const cover = json.metadata.data.group.cover; // returns the URL to the image
const completed = json.metadata.data.group.completed; // return true or false
const parts = json.metadata.data.group.parts; // returns an array, you may want to program a function that processes it
const authorname = json.metadata.data.group.user.name;
const authorlink = 'https://www.wattpad.com/user/' + json.metadata.data.group.user.username;
const authoravatar = json.metadata.data.group.user.avatar; // returns the URL to the image
}
```
3. #### wattpad.com/user/useraliasxyz
In this scheme, the "useraliasxyz" stands for the user's username.
Example: [https://www.wattpad.com/user/Wattpad](https://www.wattpad.com/user/Wattpad)
`script.js`:
```javascript
async function myFunc() {
// basic: get the json and output it to the console
// very important: use await with the function. otherwise it will propably not work
const json = await extractInformationFromWattpad('https://www.wattpad.com/user/Wattpad');
console.log(json);
// save the most important data in variables:
const name = json.metadata.data[0].name;
const alias = json.metadata.data[0].username;
const avatar = json.metadata.data[0].avatar; // returns the URL to the image
const background = json.metadata.data[0].backgroundUrl; // returns the URL to the image
const description = json.metadata.data[0].description;
const createdate = json.metadata.data[0].createDate; // returns ISO 8601 standard
const followingcount = json.metadata.data[0].followingtotal; // returns a number
const following = json.metadata.data[0].following; // returns an array, you may want to program a function that processes it
const followerscount = json.metadata.data[0].numFollowers; // returns a number
const location = json.metadata.data[0].location;
const stories = json.metadata.data[0].stories; // returns an array, you may want to program a function that processes it
const verified = json.metadata.data[0].verified; // returns true or false
}
```
## 🪲 BUGS
This are the known bugs:
| Bug Name | Bug description |
|:--------------------------------------------|:---------------------------------------------------------------------------------|
| story text incomplete | When the part is a little larger, the storytext variable doesn't contain the whole story part's text. Then, it only contains it til the page is full. In such a case, you just need to run it again but with a /page/pagenumber behind the URL. Example: https://www.wattpad.com/1387067563/page/2. Then this contains the text til the page is full again. And so it goes on, until at some point the next part begins.
| user's stories incomplete | Unfortunately, the array returned with json.metadata.data[0].stories can only have a maximum of three elements. So, if the user has written more than three stories, only three will be displayed anyway. With json.metadata.data[0].stories.total the complete number of published stories can be calculated.
| no reading lists and conversations aviable | coming soon.
## 📋 What can I get?
As mentioned before, you can get the data of three different types of URLs:
- wattpad.com/chapteridxyz
- wattpad.com/story/storyidxyz
- wattpad.com/user/useraliasxyz
No matter what URL you want to retrieve, you will get a JSON.
So if you want to know what data you can get, take a look at the structure of the JSONs.
Here's a list of all things you can get:
1. #### wattpad.com/chapteridxyz JSON:
| Name | JSON Path | Description |
|:------------------------------|:------------------------------------------------|:----------------------------------------------------------|
| ampUrl | chapterdata.metadata.data.ampUrl | redirects to the chapter |
| anonymousUser | chapterdata.metadata.data.anonymousUser | except you're logged in into your wattpad account, this will be true |
| bgCover | chapterdata.metadata.data.bgCover | URL to the image file of the cover |
| bottomBannerImage | chapterdata.metadata.data.bottomBannerImage | URL to the image file of the banner |
| bottomBannerTitle | chapterdata.metadata.data.bottomBannerTitle | banner title |
| branchLink | chapterdata.metadata.data.branchLink | just another URL which redirects to the same thing. |
| brandSafetyLevel | chapterdata.metadata.data.brandSafetyLevel | only wattpad knows what this is |
| brandSafetySource | chapterdata.metadata.data.brandSafetySource | same as brandSafetyLevel - nobody knows. |
| commentCount | chapterdata.metadata.data.commentCount | number of comments |
| commentsAdProps | chapterdata.metadata.data.commentsAdProps | again, nobody knows what that is. |
| createDate | chapterdata.metadata.data.createDate | date and time when this chapter was created. ISO 8601 standard |
| dedication | chapterdata.metadata.data.dedication | I don't know what this is. |
| descCharLimit | chapterdata.metadata.data.descCharLimit | ¯\_(ツ)_/¯ |
| dismissibleBanner | chapterdata.metadata.data.dismissibleBanner | just some stuff for the webpage |
| draft | chapterdata.metadata.data.draft | is it a draft? Let's hope it's not. |
| firstPage | chapterdata.metadata.data.firstPage | are you on the first page? |
| group | chapterdata.metadata.data.group | contains information about the story |
| group.USReader | chapterdata.metadata.data.group.USReader | are you from the US? |
| group.categories | chapterdata.metadata.data.group.categories | which categories apply? contains only numbers. |
| group.category | chapterdata.metadata.data.group.category | contains the main category of the story. only numbers. |
| group.completed | chapterdata.metadata.data.group.completed | true / false - is the story finished yet? |
| group.cover | chapterdata.metadata.data.group.cover | image URL of the cover |
| group.cover_timestamp | chapterdata.metadata.data.group.cover_timestamp | cover image timestamp |
| group.createDate | chapterdata.metadata.data.group.createDate | when was this story / book created? |
| group.deleted | chapterdata.metadata.data.group.deleted | is this story deleted? Hopefully not. |
| group.description | chapterdata.metadata.data.group.description | the story's description. |
| group.draft | chapterdata.metadata.data.group.draft | is this story a draft? |
| group.id | chapterdata.metadata.data.group.id | the story's id. Example URL: [https://www.wattpad.com/story/storyurl](https://www.wattpad.com/story/storyurl) |
| group.inLanguage | chapterdata.metadata.data.group.inLanguage | the story's language |
| group.isAdExempt | chapterdata.metadata.data.group.isAdExempt | does this story contain wattpad website/app ads? If yes, this is false. |
| group.isBrandSafe | chapterdata.metadata.data.group.isBrandSafe | some wattpad related stuff |
| group.isPaywalled | chapterdata.metadata.data.group.isPaywalled | wattpad paywall |
| group.language | chapterdata.metadata.data.group.language | contains more info about the story's language |
| group.language.id | chapterdata.metadata.data.group.language.id | id of the story's language |
| group.language.name | chapterdata.metadata.data.group.language.name | name of the story's language |
| group.mainCategory | chapterdata.metadata.data.group.mainCategory | the main category of this story, e.g., 'Random' |
| group.mainCategoryEnglish | chapterdata.metadata.data.group.mainCategoryEnglish | the main category of this story in English, in case the story's language isn't English |
| group.modifyDate | chapterdata.metadata.data.group.modifyDate | when was the story's last update? ISO 8601 standard |
| group.paidModel | chapterdata.metadata.data.group.paidModel | I don't know what this is. |
| group.parts | chapterdata.metadata.data.group.parts | contains all the parts of the story, inclusive of the URLs, etc. |
| group.parts.length | chapterdata.metadata.data.group.parts.length | how many parts? |
| group.parts[number] | chapterdata.metadata.data.group.parts[number] | contains all the data of a single part. In this example, 'number' is a placeholder for the number of the part, ranging from 0 to infinity |
| group.parts[number].active | chapterdata.metadata.data.group.parts[number].active | is this the active part? |
| group.parts[number].draft | chapterdata.metadata.data.group.parts[number].draft | is this a draft? |
| group.parts[number].id | chapterdata.metadata.data.group.parts[number].id | id of the part (URL usage: [https://www.wattpad.com/partid](https://www.wattpad.com/partid)) |
| group.parts[number].rating | chapterdata.metadata.data.group.parts[number].rating | rating. |
| group.parts[number].title | chapterdata.metadata.data.group.parts[number].title | title of the part. |
| group.parts[number].url | chapterdata.metadata.data.group.parts[number].url | URL to the part |
| group.rankings | chapterdata.metadata.data.group.rankings | contains the rankings |
| group.rankings.length | chapterdata.metadata.data.group.rankings.length | how many rankings? |
| group.rating | chapterdata.metadata.data.group.rating | rating of the story |
| group.tags | chapterdata.metadata.data.group.tags | contains the hashtags of the story |
| group.tags[number] | chapterdata.metadata.data.group.tags[number] | contains the hashtag string. Numbers range from 0 to infinity |
| group.title | chapterdata.metadata.data.group.title | the story's title |
| group.url | chapterdata.metadata.data.group.url | the story's URL |
| group.user | chapterdata.metadata.data.group.user | contains all the information about the author |
| group.user.authorMessage | chapterdata.metadata.data.group.user.authorMessage | the author's message |
| group.user.avatar | chapterdata.metadata.data.group.user.avatar | URL of the author's avatar image |
| group.user.name | chapterdata.metadata.data.group.user.name | the author's name |
| group.user.numFollowers | chapterdata.metadata.data.group.user.numFollowers | number of the author's followers |
| group.user.twitter | chapterdata.metadata.data.group.user.twitter | if available, the author's Twitter/'x' handle |
| group.user.username | chapterdata.metadata.data.group.user.username | the author's username (handle, alias - @xyz) |
| hasBannedHeader | chapterdata.metadata.data.hasBannedHeader | wait, what's a banned header??? |
| hide3rdPartyAuth | chapterdata.metadata.data.hide3rdPartyAuth | something for wattpad's website |
| id | chapterdata.metadata.data.id | the part's ID ([https://www.wattpad.com/partid](https://www.wattpad.com/partid)) |
| isAdExempt | chapterdata.metadata.data.isAdExempt | again, wattpad-related stuff |
| isAdmin | chapterdata.metadata.data.isAdmin | are you a wattpad admin? |
| isAuthor | chapterdata.metadata.data.isAuthor | are you the author? |
| isBigPart | chapterdata.metadata.data.isBigPart | is this a big part? |
| isDesktop | chapterdata.metadata.data.isDesktop | are you on desktop? |
| isMediumPart | chapterdata.metadata.data.isMediumPart | is this a medium part? |
| isMicroPart | chapterdata.metadata.data.isMicroPart | is this a micro part? |
| isModerator | chapterdata.metadata.data.isModerator | are you a moderator? |
| isSmallPart | chapterdata.metadata.data.isSmallPart | is this a small part? |
| isStoryReading | chapterdata.metadata.data.isStoryReading | are you just reading the story? |
| isTablet | chapterdata.metadata.data.isTablet | are you on a tablet? I know no one who's coding on a tablet, but yeah... |
| isWriterPreview | chapterdata.metadata.data.isWriterPreview | are you the writer who's previewing his story? |
| knownUnsafe | chapterdata.metadata.data.knownUnsafe | is this a known unsafe story? Hopefully NOT. |
| lastPage | chapterdata.metadata.data.lastPage | are you on the last page? |
| length | chapterdata.metadata.data.length | I think it's the count of characters, but I'm not sure... |
| media | chapterdata.metadata.data.media | contains some information for sharing the story, etc. |
| mediaShare | chapterdata.metadata.data.mediaShare | contains some sharing information for social networks like Facebook, Pinterest... |
| meta | chapterdata.metadata.data.meta | even more information for sharing. |
| modifyDate | chapterdata.metadata.data.modifyDate | when was the part's last update? ISO 8601 standard |
| nextPage | chapterdata.metadata.data.nextPage | if there's a next page, here's a link to it. |
| nextPart | chapterdata.metadata.data.nextPart | only aviable if there's a next part. its an array |
| page | chapterdata.metadata.data.page | contains information about the page |
| page.title | chapterdata.metadata.data.page.title | contains the page's title (for the browser window) |
| pageNumber | chapterdata.metadata.data.pageNumber | on which page are you at the moment |
| pages | chapterdata.metadata.data.pages | how many pages does this part have? |
| photoUrl | chapterdata.metadata.data.photoUrl | God knows what that is |
| rank | chapterdata.metadata.data.rank | ranking of the story in specific hashtags (I'm not 100 percent sure) |
| rating | chapterdata.metadata.data.rating | the part's rating |
| readCount | chapterdata.metadata.data.readCount | how many people read this |
| readingBottomProps | chapterdata.metadata.data.readingBottomProps | something weird again |
| readingTopProps | chapterdata.metadata.data.readingTopProps | IDK |
| reportUrl | chapterdata.metadata.data.reportUrl | URL to report this part on wattpad |
| showAdminPanel | chapterdata.metadata.data.showAdminPanel | something for the wattpad website |
| showBottomBanner | chapterdata.metadata.data.showBottomBanner | wattpad website AGAIN |
| showCarousel | chapterdata.metadata.data.showCarousel | carousel? |
| showCover | chapterdata.metadata.data.showCover | show story cover or not? |
| showStoryReadingSurvey | chapterdata.metadata.data.showStoryReadingSurvey | show survey? |
| socialShareHidden | chapterdata.metadata.data.socialShareHidden | hidden 'share' buttons on wattpad's website |
| socialShareVisible | chapterdata.metadata.data.socialShareVisible | visible 'share' buttons on wattpad's website |
| storyInfoFlag | chapterdata.metadata.data.storyInfoFlag | I have no idea what this could be |
| storyText | chapterdata.metadata.data.storyText | the story's text |
| text_url | chapterdata.metadata.data.text_url | includes data about fetching the story's text from wattpad's API. Unfortunately, this API can only be used by wattpad's own apps/websites. |
| title | chapterdata.metadata.data.title | the part's title |
| url | chapterdata.metadata.data.url | the part's URL |
| videoId | chapterdata.metadata.data.videoId | I don't know what this is |
| voteCount | chapterdata.metadata.data.voteCount | how many votes? |
| wordCount | chapterdata.metadata.data.wordCount | how many words? |
2. #### wattpad.com/story/storyidxyz JSON
| Name | JSON Path | Description |
|:------------------------------------------|:----------------------------------------------|:-----------------------------------------------------------|
| anonymousUser | chapterdata.metadata.data.anonymousUser | except you're logged in into your wattpad account, this will be true |
| bgCover | chapterdata.metadata.data.bgCover | URL to the image file of the cover |
| bottomBannerImage | chapterdata.metadata.data.bottomBannerImage | URL to the image file of the banner |
| bottomBannerTitle | chapterdata.metadata.data.bottomBannerTitle | banner title |
| branchLink | chapterdata.metadata.data.branchLink | just another URL which redirects to the same thing |
| brandSafetyLevel | chapterdata.metadata.data.brandSafetyLevel | only wattpad knows what this is |
| brandSafetySource | chapterdata.metadata.data.brandSafetySource | same as brandSafetyLevel - nobody knows |
| commentsAdProps | chapterdata.metadata.data.commentsAdProps | again, nobody knows what that is |
| createDate | chapterdata.metadata.data.createDate | date and time when this story was created. ISO 8601 standard |
| dedication | chapterdata.metadata.data.dedication | I don't know what this is |
| descCharLimit | chapterdata.metadata.data.descCharLimit | idk |
| dismissibleBanner | chapterdata.metadata.data.dismissibleBanner | just some stuff for the webpage |
| draft | chapterdata.metadata.data.draft | is it a draft? let's hope it's not |
| group | chapterdata.metadata.data.group | contains information about the story |
| group.USReader | chapterdata.metadata.data.group.USReader | are you from the US? |
| group.categories | chapterdata.metadata.data.group.categories | which categories apply? contains only numbers |
| group.category | chapterdata.metadata.data.group.category | contains the main category of the story. only numbers |
| group.completed | chapterdata.metadata.data.group.completed | true / false - is the book finished yet? |
| group.cover | chapterdata.metadata.data.group.cover | image URL of the cover |
| group.cover_timestamp | chapterdata.metadata.data.group.cover_timestamp | cover image timestamp |
| group.createDate | chapterdata.metadata.data.group.createDate | when was this story / book created? |
| group.deleted | chapterdata.metadata.data.group.deleted | is this book deleted? hopefully not. |
| group.description | chapterdata.metadata.data.group.description | the story's description |
| group.draft | chapterdata.metadata.data.group.draft | is this story a draft? |
| group.id | chapterdata.metadata.data.group.id | the story's id. example URL: [https://www.wattpad.com/story/storyurl](https://www.wattpad.com/story/storyurl) |
| group.inLanguage | chapterdata.metadata.data.group.inLanguage | the story's language |
| group.isAdExempt | chapterdata.metadata.data.group.isAdExempt | contains this story on the wattpad website/app ads? if yes, this is false |
| group.isBrandSafe | chapterdata.metadata.data.group.isBrandSafe | some wattpad related stuff |
| group.isPaywalled | chapterdata.metadata.data.group.isPaywalled | wattpad paywall |
| group.language | chapterdata.metadata.data.group.language | contains more info about the story's language |
| group.language.id | chapterdata.metadata.data.group.language.id | id of the story's language |
| group.language.name | chapterdata.metadata.data.group.language.name | name of the story's language |
| group.mainCategory | chapterdata.metadata.data.group.mainCategory | the main category of this story, eg 'Random' |
| group.mainCategoryEnglish | chapterdata.metadata.data.group.mainCategoryEnglish | the main category of this story in English, in case the story's language isn't English |
| group.modifyDate | chapterdata.metadata.data.group.modifyDate | when was the story's last update? ISO 8601 standard |
| group.paidModel | chapterdata.metadata.data.group.paidModel | idk what this is |
| group.parts | chapterdata.metadata.data.group.parts | contains all the parts of the story inclusive the URLs etc |
| group.parts.length | chapterdata.metadata.data.group.parts.length | how much parts? |
| group.parts[number] | chapterdata.metadata.data.group.parts[number] | contains all the data of a single part. in this example, 'number' is a placeholder for the number of the part. goes from 0 - infinity |
| group.parts[number].active | chapterdata.metadata.data.group.parts[number].active | is this the active part? |
| group.parts[number].draft | chapterdata.metadata.data.group.parts[number].draft | is this a draft? |
| group.parts[number].id | chapterdata.metadata.data.group.parts[number].id | id of the part (URL usage: [https://www.wattpad.com/partid](https://www.wattpad.com/partid)) |
| group.parts[number].rating | chapterdata.metadata.data.group.parts[number].rating | rating. |
| group.parts[number].title | chapterdata.metadata.data.group.parts[number].title | title of the part. |
| group.parts[number].url | chapterdata.metadata.data.group.parts[number].url | URL to the part |
| group.rankings | chapterdata.metadata.data.group.rankings | contains the rankings |
| group.rankings.length | chapterdata.metadata.data.group.rankings.length | how much ranking |
| group.rating | chapterdata.metadata.data.group.rating | rating of the story |
| group.tags | chapterdata.metadata.data.group.tags | contains the hashtags of the story |
| group.tags[number] | chapterdata.metadata.data.group.tags[number] | contains the hashtag string. numbers are going from 0 - infinity |
| group.title | chapterdata.metadata.data.group.title | the story's title |
| group.url | chapterdata.metadata.data.group.url | the story's URL |
| group.user | chapterdata.metadata.data.group.user | contains all the information about the author |
| group.user.authorMessage | chapterdata.metadata.data.group.user.authorMessage | the author's message |
| group.user.avatar | chapterdata.metadata.data.group.user.avatar | URL of the author's avatar image |
| group.user.name | chapterdata.metadata.data.group.user.name | the author's name |
| group.user.numFollowers | chapterdata.metadata.data.group.user.numFollowers | number of the author's followers |
| group.user.twitter | chapterdata.metadata.data.group.user.twitter | if available, the author's twitter/'x' handle |
| group.user.username | chapterdata.metadata.data.group.user.username | the author's username (handle, alias - @xyz) |
| hasBannedHeader | chapterdata.metadata.data.hasBannedHeader | wait what's a banned header ??? |
| hide3rdPartyAuth | chapterdata.metadata.data.hide3rdPartyAuth | something for wattpad's website |
| id | chapterdata.metadata.data.id | the story's id ([https://www.wattpad.com/partid](https://www.wattpad.com/partid)) |
| isAdExempt | chapterdata.metadata.data.isAdExempt | again wattpad related stuff |
| isAdmin | chapterdata.metadata.data.isAdmin | are you a wattpad admin? |
| isAuthor | chapterdata.metadata.data.isAuthor | are you the author? |
| isBigPart | chapterdata.metadata.data.isBigPart | is this a big part? |
| isDesktop | chapterdata.metadata.data.isDesktop | are you on desktop? |
| isMediumPart | chapterdata.metadata.data.isMediumPart | is this a medium part? |
| isMicroPart | chapterdata.metadata.data.isMicroPart | is this a micro part? |
| isModerator | chapterdata.metadata.data.isModerator | are you a moderator? |
| isSmallPart | chapterdata.metadata.data.isSmallPart | is this a small part? |
| isStoryReading | chapterdata.metadata.data.isStoryReading | are you just reading the story? |
| isTablet | chapterdata.metadata.data.isTablet | are you on tablet? I know no one who's coding on a tablet but yeah ... |
| isWriterPreview | chapterdata.metadata.data.isWriterPreview | are you the writer who's previewing his story? |
| knownUnsafe | chapterdata.metadata.data.knownUnsafe | is this a known unsafe story? hopefully NOT. |
| media | chapterdata.metadata.data.media | contains some information for sharing the story etc. |
| mediaShare | chapterdata.metadata.data.mediaShare | contains some sharing information for social networks like Facebook, Pinterest ... |
| meta | chapterdata.metadata.data.meta | even more information for sharing. |
| photoUrl | chapterdata.metadata.data.photoUrl | god knows what that is |
| rank | chapterdata.metadata.data.rank | ranking of the story in specific hashtags (I'm not 100 percent sure) |
| readingBottomProps | chapterdata.metadata.data.readingBottomProps | something weird again |
| readingTopProps | chapterdata.metadata.data.readingTopProps | idk |
| reportUrl | chapterdata.metadata.data.reportUrl | URL to report this part on wattpad |
| showAdminPanel | chapterdata.metadata.data.showAdminPanel | something for the wattpad website |
| showBottomBanner | chapterdata.metadata.data.showBottomBanner | wattpad website AGAIN |
| showCarousel | chapterdata.metadata.data.showCarousel | carousel? |
| showCover | chapterdata.metadata.data.showCover | show story cover or not? |
| showStoryReadingSurvey | chapterdata.metadata.data.showStoryReadingSurvey | show survey? |
| socialShareHidden | chapterdata.metadata.data.socialShareHidden | hidden 'share' buttons on wattpad's website |
| socialShareVisible | chapterdata.metadata.data.socialShareVisible | visible 'share' buttons on wattpad's website |
| storyInfoFlag | chapterdata.metadata.data.storyInfoFlag | I have no idea what this could be |
| storyText | chapterdata.metadata.data.storyText | the story's text. |
| title | chapterdata.metadata.data.title | the part's title |
| url | chapterdata.metadata.data.url | the part's URL |
| videoId | chapterdata.metadata.data.videoId | I dunno what this is |
3. #### wattpad.com/user/useraliasxyz JSON
| Name | JSON Path | Description |
|:---------------------------------------|:----------------------------------------------|:-------------------------------------------------------------|
| allowCrawler | userdata.metadata.data[0].allowCrawler | Tells search engines like Google if they are allowed to crawl this page |
| ambassador | userdata.metadata.data[0].ambassador | True / False - Is this user part of the wattpad ambassador program? (https://www.wattpad.com/story/345106-the-ambassador-program) |
| avatar | userdata.metadata.data[0].avatar | URL to the avatar image of this user |
| backgroundUrl | userdata.metadata.data[0].backgroundUrl | URL to the background image of this user |
| createDate | userdata.metadata.data[0].createDate | User account created on ... at ... (ISO 8601 standard) |
| description | userdata.metadata.data[0].description | The user's bio |
| facebook | userdata.metadata.data[0].facebook | If Facebook connected -> link here! |
| firstName | userdata.metadata.data[0].firstName | First name (if given) |
| followerRequest | userdata.metadata.data[0].followerRequest | Idk what this is. If you know it, please let me know. |
| following | userdata.metadata.data[0].following | Yeah. |
| following[number].avatar | userdata.metadata.data[0].following[number].avatar | URL to the avatar image of this user |
| following[number].backgroundUrl | userdata.metadata.data[0].following[number].backgroundUrl | URL to the background image of this user |
| following[number].description | userdata.metadata.data[0].following[number].description | The user's bio |
| following[number].highlight_colour | userdata.metadata.data[0].following[number].highlight_colour | The user's highlight color |
| following[number].location | userdata.metadata.data[0].following[number].location | The user's location |
| following[number].name | userdata.metadata.data[0].following[number].name | The user's name |
| following[number].numFollowers | userdata.metadata.data[0].following[number].numFollowers | The user's count of followers |
| following[number].numFollowing | userdata.metadata.data[0].following[number].numFollowing | The user's count of following |
| following[number].numLists | userdata.metadata.data[0].following[number].numLists | The user's count of lists |
| following[number].numStoriesPublished | userdata.metadata.data[0].following[number].numStoriesPublished | The user's count of published stories |
| following[number].username | userdata.metadata.data[0].following[number].username | The user's username |
| followingRequest | userdata.metadata.data[0].followingRequest | Idk |
| followingtotal | userdata.metadata.data[0].followingtotal | The user's total count of following |
| gender | userdata.metadata.data[0].gender | The user's gender |
| highlight_colour | userdata.metadata.data[0].highlight_colour | The user's highlight color |
| html_enabled | userdata.metadata.data[0].html_enabled | Something for the wattpad website |
| isMuted | userdata.metadata.data[0].isMuted | If you know what 'muted' means on wattpad, please correct me. |
| isPrivate | userdata.metadata.data[0].isPrivate | Is this user account private? |
| is_staff | userdata.metadata.data[0].is_staff | Is this user wattpad staff? |
| lastName | userdata.metadata.data[0].lastName | The user's last name |
| location | userdata.metadata.data[0].location | The user's location |
| name | userdata.metadata.data[0].name | The user's name |
| numFollowers | userdata.metadata.data[0].numFollowers | The count of this user's followers |
| numFollowing | userdata.metadata.data[0].numFollowing | The count of this user's following |
| numLists | userdata.metadata.data[0].numLists | The count of this user's reading lists |
| numStoriesPublished | userdata.metadata.data[0].numStoriesPublished | The count of this user's published stories |
| programs | userdata.metadata.data[0].programs | Does this user participate in any of wattpad's special programs? |
| programs.wattpad_circle | userdata.metadata.data[0].programs.wattpad_circle | Does this user participate in the wattpad circle program? |
| programs.wattpad_stars | userdata.metadata.data[0].programs.wattpad_stars | Does this user participate in the wattpad stars program? |
| safety | userdata.metadata.data[0].safety | Contains safety information |
| safety.isBlocked | userdata.metadata.data[0].safety.isBlocked | Is this user blocked? |
| safety.isMuted | userdata.metadata.data[0].safety.isMuted | Is this user muted? |
| smashwords | userdata.metadata.data[0].smashwords | The user's Smashwords |
| stories | userdata.metadata.data[0].stories | Contains the first three stories of the user and some information |
| stories.nextUrl | userdata.metadata.data[0].stories.nextUrl | wattpad API URL to get the user's stories - works only on wattpad official website/app |
| stories.stories | userdata.metadata.data[0].stories.stories | Contains the first three stories of the user |
| stories.stories[number].commentCount | userdata.metadata.data[0].stories.stories[number].commentCount | How many comments does this story have? |
| stories.stories[number].completed | userdata.metadata.data[0].stories.stories[number].completed | Is this story already completed? |
| stories.stories[number].cover | userdata.metadata.data[0].stories.stories[number].cover | The story's cover image URL |
| stories.stories[number].description | userdata.metadata.data[0].stories.stories[number].description | The story's description |
| stories.stories[number].firstPartId | userdata.metadata.data[0].stories.stories[number].firstPartId | The ID of the story's first part (https://www.wattpad.com/parturl) |
| stories.stories[number].isPaywalled | userdata.metadata.data[0].stories.stories[number].isPaywalled | Is this story paywalled? |
| stories.stories[number].lastPublishedPart | userdata.metadata.data[0].stories.stories[number].lastPublishedPart | Contains data about the last published part |
| stories.stories[number].lastPublishedPart.createDate | userdata.metadata.data[0].stories.stories[number].lastPublishedPart.createDate | When was the last part created? |
| stories.stories[number].lastPublishedPart.id | userdata.metadata.data[0].stories.stories[number].lastPublishedPart.id | ID of the last published part |
| stories.stories[number].mature | userdata.metadata.data[0].stories.stories[number].mature | I'm not 100 percent sure, but I think it's like 'is it 18+?' |
| stories.stories[number].numParts | userdata.metadata.data[0].stories.stories[number].numParts | How many parts does this story have? |
| stories.stories[number].paidModel | userdata.metadata.data[0].stories.stories[number].paidModel | IDK |
| stories.stories[number].parts | userdata.metadata.data[0].stories.stories[number].parts | List of the story's parts |
| stories.stories[number].parts[number].commentCount | userdata.metadata.data[0].stories.stories[number].parts[number].commentCount | How many comments does this part have? |
| stories.stories[number].parts[number].createDate | userdata.metadata.data[0].stories.stories[number].parts[number].createDate | When was this part created |
| stories.stories[number].parts[number].draft | userdata.metadata.data[0].stories.stories[number].parts[number].draft | Is this part a draft |
| stories.stories[number].parts[number].id | userdata.metadata.data[0].stories.stories[number].parts[number].id | ID of this part |
| stories.stories[number].parts[number].length | userdata.metadata.data[0].stories.stories[number].parts[number].length | I think it's the character/word count |
| stories.stories[number].parts[number].modifyDate | userdata.metadata.data[0].stories.stories[number].parts[number].modifyDate | When was this last updated |
| stories.stories[number].parts[number].photoUrl | userdata.metadata.data[0].stories.stories[number].parts[number].photoUrl | I still don't know what this is |
| stories.stories[number].parts[number].rating | userdata.metadata.data[0].stories.stories[number].parts[number].rating | The part's rating |
| stories.stories[number].parts[number].readCount | userdata.metadata.data[0].stories.stories[number].parts[number].readCount | How many people have already read this |
| stories.stories[number].parts[number].title | userdata.metadata.data[0].stories.stories[number].parts[number].title | The part's title |
| stories.stories[number].parts[number].url | userdata.metadata.data[0].stories.stories[number].parts[number].url | Link to the part |
| stories.stories[number].parts[number].videoId | userdata.metadata.data[0].stories.stories[number].parts[number].videoId | IDK what this is |
| stories.stories[number].parts[number].voteCount | userdata.metadata.data[0].stories.stories[number].parts[number].voteCount | Vote count |
| stories.stories[number].parts.length | userdata.metadata.data[0].stories.stories[number].parts.length | How many parts |
| stories.stories[number].rankings | userdata.metadata.data[0].stories.stories[number].rankings | IDK |
| stories.stories[number].rating | userdata.metadata.data[0].stories.stories[number].rating | The story's rating |
| stories.stories[number].readCount | userdata.metadata.data[0].stories.stories[number].readCount | How many people have already read this story |
| stories.stories[number].tagRankings | userdata.metadata.data[0].stories.stories[number].tagRankings | Contains a list of how well the story performed in hashtags |
| stories.stories[number].tags | userdata.metadata.data[0].stories.stories[number].tags | Story's hashtags |
| stories.stories[number].title | userdata.metadata.data[0].stories.stories[number].title | The story's title |
| stories.stories[number].url | userdata.metadata.data[0].stories.stories[number].url | Link to the story |
| stories.stories[number].voteCount | userdata.metadata.data[0].stories.stories[number].voteCount | Vote count |
| stories.stories.length | userdata.metadata.data[0].stories.stories.length | How many stories are shown (always 3) |
| stories.total | userdata.metadata.data[0].stories.total | Number of total stories |
| username | userdata.metadata.data[0].username | The user's username (handle, alias) wattpad.com/user/blahblahblahexampleee |
| verified | userdata.metadata.data[0].verified | True / False |
| verified_email | userdata.metadata.data[0].verified_email | User's email address already verified? |
| wattpad_squad | userdata.metadata.data[0].wattpad_squad | True / False. IDK what this is |
| website | userdata.metadata.data[0].website | If the user connected a website, the address is here (example.com) |
| interface that can still be used to retrieve data from the wattpad platform easily & for free. | javascript,wattpad,wattpad-api,wattpad-book,wattpad-client,wattpad-scraper,wattpad-story | 2023-10-13T17:44:04Z | 2023-10-20T16:40:50Z | null | 1 | 0 | 8 | 0 | 0 | 2 | null | null | JavaScript |
wagao29/photomap24 | main | # PhotoMap24
location-based photo sharing service that can be viewed for 24 hours only.
site: https://photomap24.com
<img src="src/assets/app_screen.png" width="380px">
| location-based photo sharing service that can be viewed for 24 hours only | firebase,mapbox,pwa,react,javascript,typescript | 2023-10-21T02:54:09Z | 2024-02-25T04:13:13Z | null | 1 | 13 | 102 | 0 | 1 | 2 | null | MIT | TypeScript |
faiz-naushad/My_portfolio | main | # My_Portfolio
| Experience a seamless user interface crafted with ReactJs and enhanced by the elegance of Tailwind CSS. | css,html,javascript,reactjs,tailwindcss,threejs | 2023-10-31T14:00:23Z | 2023-10-31T14:36:25Z | null | 1 | 0 | 5 | 0 | 0 | 2 | null | null | JavaScript |
sofiane-abou-abderrahim/javascript-share-my-place-firebase-static-host | main | null | This is my deployed static "JavaScript Share My Place" demo application with Firebase which only consists of HTML, CSS and JavaScript files. | css3,deployment,firebase,html-css-javascript,html5,javascript,webpack | 2023-10-26T12:39:59Z | 2023-10-26T18:16:52Z | null | 1 | 6 | 4 | 0 | 0 | 2 | null | null | JavaScript |
sofiane-abou-abderrahim/react-javascript-share-my-place | main | null | This a little React JavaScript demo application which I built based on my JavaScript Share My Place app built with Webpack | javascript,nodejs,reactjs,webpack | 2023-10-18T20:07:49Z | 2023-10-19T11:08:53Z | null | 1 | 4 | 3 | 0 | 0 | 2 | null | null | JavaScript |
SwamiTheDev/Ps_landing_page | main | # PlayStation Version 4 🎮
Welcome to the PlayStation Version 4 Landing Page Project! 🚀
## Project Description
The PlayStation Version 4 Landing Page is a front-end project that captures the essence of the iconic gaming console. With captivating animations and a responsive design, it offers an engaging and visually stunning user interface.
🌟 Features:
- Interactive animations that bring the PlayStation experience to life.
- A responsive layout for a seamless user experience on all devices.
- Attractive and eye-catching design that pays homage to the PlayStation 4.
## Tech Stack
This project is built using the following technologies and tools:
- HTML
- CSS
- JavaScript
- Bootstrap 5
- SCSS
- jQuery
## Quick Links
🔗 [GitHub Repository](https://github.com/SwamiTheDev/Ps_landing_page)
🔗 [Live Demo](https://play-station4.vercel.app/)
## How to Contribute
If you're a fan of the PlayStation and have a passion for web development, we welcome your contributions to make this project even more amazing! Feel free to fork the repository and submit pull requests.
🤝 We're excited to have you on board!
## Hashtags
Here are some related hashtags to explore and share this project:
- #PlayStation4
- #Gaming
- #WebDesign
- #FrontEnd
- #UIUX
- #ResponsiveDesign
- #Bootstrap5
- #JavaScript
- #CSS
- #GitHub
- #OpenSource
Feel free to use these hashtags to spread the word about our project and connect with fellow gamers and developers. 🎉
Thank you for checking out the PlayStation Version 4 Landing Page Project! 🎮✨
| Experience the future of gaming with our PlayStation Version 4! Explore a stunning product landing page featuring captivating animations and a responsive, visually appealing UI that will leave you in awe. Get ready to elevate your gaming experience like never before. | css,figma,frontend,frontenddevloper,frontendproject,html,html-css-javascript,innovation,javascript,jquery | 2023-10-29T06:55:55Z | 2023-10-29T07:42:54Z | null | 1 | 0 | 10 | 0 | 0 | 2 | null | null | CSS |
signeasynow/vue-pdf-sdk | main | # Vue PDF Editor
View, edit, and Chat-with-your-PDF with AI.
Add View to your app for free. Learn pricing for all features [here](https://www.signeasynow.com/upgrade)
# Demo
https://www.signeasynow.com/edit-your-pdf
Want to see the source code for the above demo? Find it [here]([https://github.com/alien35/vue-pdf-demo).
# Quick start
1. Copy-paste the `pdf-ui` folder [here](https://github.com/signeasynow/react-pdf-demo/tree/main/public/pdf-ui) into your own `public` folder.
1. Install
`npm install --save @prodfox/vue-pdf-editor`
or
`yarn add @prodfox/vue-pdf-editor`
3. Create a component
```
<template>
<div>
<button @click="download">Download</button>
<div ref="containerRef" class="container" id="pdf"></div>
</div>
</template>
<script>
import { ref, onMounted } from 'vue';
import { useCreateIframeAndLoadViewer } from '@prodfox/vue-pdf-editor';
export default {
name: 'App',
setup() {
const containerRef = ref(null);
const { download } = useCreateIframeAndLoadViewer({
container: containerRef,
uuid: 'some-user',
licenseKey: 'sandbox',
locale: 'en',
tools: {
editing: ['extract', 'remove', 'move'],
thumbnails: ['zoom', 'expand'],
general: [
'thumbnails',
'download',
'search',
'panel-toggle',
'zoom',
],
},
files: [
{
url: 'https://pdftron.s3.amazonaws.com/downloads/pl/demo-annotated.pdf',
name: 'my-file1.pdf',
},
{
url: 'https://pdftron.s3.amazonaws.com/downloads/pl/demo-annotated.pdf',
name: 'my-file2.pdf',
},
],
});
console.log(download, 'download')
return {
containerRef,
download,
};
},
};
</script>
<style scoped>
</style>
```
## Core
## Parameters
### container `Required`
The HTML element to attach the PDF viewer to.
### tools `Object` `{}`
Control what tools are available in the UI. Available keys are `thumbnails`, `general`, `editing`, ...
```
useCreateIframeAndLoadViewer({
tools: {
thumbnails: ...,
general: ...,
editing: ...,
},
...other parameters
});
```
#### general `Object` `[]`
| Field | Description |
| ------- | ---------------- |
| zoom | Enable zoom in/out of the document in view |
| search | Enable search functions |
| download | Enable downloading the document |
| thumbnails | Enable a thumbnails panel |
| panel-toggle | Enable the left-side panel to be togglable |
| chat | Enable AI conversations with your PDF (user ID is required after 10 questions) |
```
useCreateIframeAndLoadViewer({
tools: {
general: [
"zoom",
"search",
"download",
"thumbnails",
"panel-toggle"
],
},
...other parameters
});
```
#### thumbnails `Object` `[]`
| Field | Description |
| ------- | ---------------- |
| zoom | Enable a slider above thumbnails to increase/decrease the size of the thumbnails |
| expand | Enable the thumbnails bar to be expandable to the full screen |
```
useCreateIframeAndLoadViewer({
tools: {
thumbnails: [
"zoom",
"expand"
],
},
...other parameters
});
```
#### editing `Object` `[]`
| Field | Description |
| ------- | ---------------- |
| remove | Enable the ability to remove pages |
| rotation | Enable the rotation of individual pages |
| extraction | Enabling extracting out a set of pages into one document |
| move | Re-arrange pages in a document |
```
useCreateIframeAndLoadViewer({
tools: {
editing: [
"remove",
"rotation",
"extraction",
"move"
],
},
...other parameters
});
```
#### locale `string` `en` `Optional`
Options:
`en` - English
`es` - Spanish
`ru` - Russian
(Reach out if you need a particular language added)
#### onFileFailed `Function` `optional`
Callback when a file fails to upload
```
useCreateIframeAndLoadViewer({
onFileFailed: (errorMessage) => {
// handle the failure as you need
}
});
```
#### mode `string` `optional`
Defaults to `regular`. Set it to `split` to enable being able to select split markers to be then used for splitting a document into several documents.
# Functions
Combine several files into one
```
const { combineFiles } = useCreateIframeAndLoadViewer({
...
});
combineFiles();
```
Listen for when the pages are loaded for the active document
```
const { pagesLoaded } = useCreateIframeAndLoadViewer({
...
});
if (pagesLoaded) {
// logic here
}
```
Download
```
const { download } = useCreateIframeAndLoadViewer({
...
});
download();
```
Listen for when the PDF editor is ready to accept commands
```
const { isReady } = useCreateIframeAndLoadViewer({
...
});
if (isReady) {
// logic here
}
```
Toggle displaying the full screen thumbnail view
```
const { toggleFullScreenThumbnails } = useCreateIframeAndLoadViewer({
...
});
toggleFullScreenThumbnails(true) // set this to true or false to open/close it.
```
Control the thumbnail zoom level. Ranges from 0 to 1.
```
const { setThumbnailZoom } = useCreateIframeAndLoadViewer({
...
});
setThumbnailZoom(0.5)
```
Toggle displaying the search bar on the right
```
const { toggleSearchbar } = useCreateIframeAndLoadViewer({
...
});
toggleSearchbar(true) // set this to true or false to open/close it.
```
Delete the AI conversation chat history
```
const { removeChatHistory } = useCreateIframeAndLoadViewer({
...
});
removeChatHistory()
```
Get the 0-indexed array of selected pages
```
const { selectedPages } = useCreateIframeAndLoadViewer({
...
});
```
Extract the selected pages
```
const { extractPages } = useCreateIframeAndLoadViewer({
...
});
extractPages()
```
Split the document into several documents based on the split markers the user selected.
```
const { splitPages } = useCreateIframeAndLoadViewer({
...
});
splitPages()
```
| Open Source Vue PDF Editor | document-signing,javascript,open-source,pdf-editor,pdf-editor-free,pdf-editor-react,pdf-sign,self-hosted,signing,vue | 2023-10-13T03:22:52Z | 2024-02-01T02:13:07Z | null | 1 | 0 | 9 | 0 | 0 | 2 | null | NOASSERTION | JavaScript |
gursewaktut/TeamPines | main | # TeamPines
CMPT 276 Term project
## Project Objectives
Code Mentor AI: An Interactive Programming Learning Platform
Code Mentor AI is a cutting-edge platform designed to revolutionize how we learn programming. Leveraging advanced APIs and a sophisticated tech stack, it offers an interactive and tailored learning experience. Features include support for multiple languages, real-time code evaluation, virtual tutors, and the ability to analyze code from digarams among other notable features. Our mission is to make programming education universally accessible and adaptable to each learner's unique style, bridging the gap between concept mastery and practical application.
## Technology Stack
## Frontend
React.js: Chosen for its component-based architecture, JSX syntax, and easy integration with other libraries.
[ReactJS Tutorial](https://react.dev/learn)
[React with API Tutorial](https://www.freecodecamp.org/news/how-to-consume-rest-apis-in-react/)
Chakra UI: For its customizability, consistent design language, and seamless integration with React.
## Backend
Python: Primary language for backend to integrate with the Steamship API and other backend functionalities.
## Testing
Jest: A JavaScript testing framework for unit testing React components.
9 unit tests and 6 integration tests - all written in Jest
[Jest Tutorial](https://www.digitalocean.com/community/tutorials/how-to-test-a-react-app-with-jest-and-react-testing-library)
## CI/CD
GitHub Actions: For its seamless integration with Git, easy configuration, and automation capabilities.
[GitHub Actions](https://docs.github.com/en/actions/learn-github-actions)
## Hosting
Netlify: For hosting the frontend, given its ease of use and continuous deployment features.[Netlify](https://www.netlify.com)
## Contributors
- Avni Kapoor : avkap007
[ProjectMilestone#1_AI_Declaration_Avni_Kapoor_301446648.pdf](./extra/ProjectMilestone%231_AI_Declaration_Avni_Kapoor_301446648.pdf)
[ProjectMilestone#2_AI_Declaration_Avni_Kapoor_301446648.pdf](./extra/ProjectMilestone%232_AI_Declaration_Avni_Kapoor_301446648.pdf)
- Gursewak Singh: gursewaktut
[ProjectMilestone#1_AI_Declaration_Gursewak_Singh_301575663.pdf](./extra/ProjectMilestone%231_AI_Declaration_Gursewak_Singh_301575663.pdf)
[ProjectMilestone#2_AI_Declaration_Gursewak_Singh_301575663.pdf](./extra/ProjectMilestone%232_AI_Declaration_Gursewak_Singh_301575663.pdf)
- Henrik Sachdeva : henriksfu
[ProjectMilestone#1_AI_Declaration_Henrik_Sachdeva_301563572](./extra/ProjectMilestone%231_AI_Declaration_Henrik_Sachdeva_301563572.pdf)
[ProjectMilestone#2_AI_Declaration_Henrik_Sachdeva_301563572](./extra/ProjectMilestone%232_AI_Declaration_Henrik_Sachdeva_301563572.pdf)
- Jiya Garg : jiyaagargg
[ProjectMilestone#1_AI_Declaration_JIYA_GARG_301563502.pdf](./extra/ProjectMilestone%231_AI_Declaration_JIYA_GARG_301563502.pdf)
[ProjectMilestone#2_AI_Declaration_JIYA_GARG_301563502.pdf](./extra/ProjectMilestone%232_AI_Declaration_Jiya_Garg_301563502.pdf)
## Set Up Instructions
Please follow the following steps to run the app on your local environment:
```
git clone https://github.com/gursewaktut/TeamPines.git
cd TeamPines
npm install
npm start
```
| Code Mentor AI: An interactive Programming learning platform | code-learning,css,html,javascript,python,steamship-api,termproject | 2023-10-26T01:53:51Z | 2023-12-07T06:04:36Z | null | 6 | 9 | 113 | 0 | 0 | 2 | null | null | JavaScript |
codingwizzzard/EstateAgency | main | null | null | bootstrap,css,html,javascript,jquery | 2023-10-28T15:38:07Z | 2023-10-28T15:37:52Z | null | 1 | 0 | 2 | 0 | 0 | 2 | null | null | HTML |
x-imayank/Sudoku | main | # Sudoku
Sudoku game mady by using HTML, CSS, Js, jquery
| Sudoku game mady by HTML, CSS, Js | css,html,javascript,sudoku | 2023-11-06T14:26:53Z | 2023-12-27T12:26:54Z | null | 1 | 0 | 5 | 0 | 0 | 2 | null | null | HTML |
bright-spark/blueprint | main | # The better and improved carbonized.red version of theradio.fm full of mo͞ozik - l o v e [theradio.fm](https://theradio.fm) is a simple PWA stream browser.
## theradio.fm is a structured PWA browser mainly serving streaming content from my YouTube Channel: [mo͞ozik @theradiostream](https://www.youtube.com/@theradiostream)
[](https://app.netlify.com/sites/theradio-fm/deploys)
### About
theradio.fm is mobile first and easy to use. It runs on all desktop and mobile devices. Sometimes allowed to deliver South African live radio, or the latest YouTube music videos and YouTube radio. Pivoting on Twitter and some other social media which is used for simple promotion and reach.
Inspired by my love for music, radio and people! Dedicated to my dad who never stopped supporting me or my research.
### Tooling
[Framework7](https://framework7.io) and [Thorium Builder](https://thoriumbuilder.com) used for framework, scaffolding and design. Github for source control, automation and static hosting. Not to mention stacks of trial and error including extreme determination!
### Summary:
In essence the theradio.fm is pre configured to aggregate existing open streaming media in a structured browser enhancing the StreamBrowser user experience.
### Legal:
Thanking all external media sources and services, whom each remain the rightful owners of their own individual content and copyright. The content is merely aggregated and the user directed to the url when they use the StreamBrowser of theradio.fm and the sources are never owned or modified at all.
### Content:
Only open social media or public facing websites are browsed or aggregated in the StreamBrowser of theradio.fm. No attempts are made to decrypt or bypass any digital rights management at all. The sources are freely available online and the StreamBrowser of theradio.fm only contains links to these. In some cases for example the Rebrandly Link Gallery in the StreamBrowser of theradio.fm publicly available url links are used to navigate the user to the resources outside the StreamBrowser by piping up the site that is linked to the dashboard. The users are simply redirected to the respective websites or content by the StreamBrowser of theradio.fm. They are then in turn navigated back to the origin, which in this case is the StreamBrowser of theradio.fm. All efforts are made to present this seamlessly within the StreamBrowser of theradio.fm to the user. All efforts are made to enhance and perfect the StreamBrowser of theradio.fm and the user's in-app experience. The content is not copied, modified, filtered or altered at all. The StreamBrowser of theradio.fn acts just like any modern browser like Google Chrome or Apple Safari except the destinations can't be determined by the user, yet they can still navigate to the destination included in the structure of the StreamBrowser of theradio.fm as they choose giving them a typical app like experience instead of a simple browser.
### Design & Architecture:
Hosting: Namecheap, Cloudflare
DevOps: Github, Netlify, Cloudflare, Vercel
Social: Twitter, Facebook, Instagram, Whatsapp, Gooogle, Apple, Microsoft
Images: Pintrest, Canva, Adobe Express
Audio/Video: Shazam, YouTube, Selected South African and Namibian Radio Stations
### Takedowns
Any takedowns requests will always be considered, and should be addresed to: pleasetakedownfromtheradiofmorelse@havit.me and please also make direct contact on [+27847801119](tel:+27847801119)
| The result of many successfull iterations that have now brought us to this point becoming the cornerstone of theradio.fm rapid mobile first PWA build system | blueprint,builder,css,framework7,html,iframe,javascript,pattern,pwa,no-cors | 2023-11-04T01:08:06Z | 2023-11-05T17:14:29Z | null | 1 | 0 | 22 | 0 | 0 | 2 | null | Apache-2.0 | JavaScript |
Braismp007/MiWeb | main | 
--------------------
    
Este proyecto es uno de mis proyectos personales donde voy a ir aprendiendo distintos leguajes de programación. En este caso voy a aprender a desarrollar una página web desde cero con **HTML 5**, **CSS 3** y **Java Script**.
En este caso voy a estar siguiendo los pasos de un [libro](https://www.amazon.es/gran-libro-HTML5-JavaScript-Edici%C3%B3n/dp/8426724639) que he comprado donde me explican como desarrollar la web. La página como el repositorio voy a actualizar a medidad que vaya desarrollando la página.
Este proyecto va a estar programado, como dije anteriormente en **HTML5** y **CSS3** principalmente, sin embargo, posiblemente en el futuro usemos **JavaScript** para algunas funciones.
> [!NOTE]
> Se va a publicar junto al código de la web contenido como imágenes, logos, etc. Estos son de libre uso siempre que se respete su autor.
| Desarrollo de una página web siguiendo las pautas de un libro | css3,html5,javascript,learning,web | 2023-10-20T08:42:27Z | 2024-01-06T22:10:22Z | null | 1 | 1 | 12 | 1 | 1 | 2 | null | null | HTML |
iamvijay98/Fitness-Gym-Website-Design | main | # About
Fitness is a Tailwind CSS template for fitness websites. This responsive gym website template is an elegant site skin for fitness centers, gyms, yoga studios, and other related organizations. Moreover, it has a fantastic design with fully responsive layouts. The dark outlook will surely spark the interest of the audience. FitnessClub is all set and ready to go right off the bat and work seamlessly on any browser or device.Besides, the bundle of features contains quite a bunch of impressive and dynamic features. You will find hero header, parallax effect, call to action button, drop-down menu, modal video player, hover effects, and a whole lot more inside the box. FitnessClus is absolutely easy to customize and changeable into the appearance of your desire. Last but not least, make your own place on the web with FitnessClub and shine online
# Tech Stack💻:
* HTML5
* CSS3
* Tailwind CSS
* Javascript
* React Js
# Features🗒:
**Tailwind CSS:**
* Clean and minimal design
* Cross-browser compatibility
* Fully responsive
**Hero Header:**
* Hero header
* Call to action button
* Content slider
**Sticky top navigation bar:**
* Hover effects
**Drop-down menu:**
* Back to top button
* Tabbed content
* Footer navigation
**Parallax effect:**
* Photo gallery
* Testimonial carousel
* Blog section
# Libraries and Plugins:
* Tailwind CSS
* FontAwesome
* Framer Motion
* React Icons
| FitnessClub is a Tailwind CSS template for fitness websites. This responsive gym website template is an elegant site skin for fitness centers, gyms, yoga studios, and other related organizations. Moreover, it has a fantastic design with fully responsive layouts. The dark outlook will surely spark the interest of the audience... | animation,html5,javascript,mobile-first,motion-framer,react,responsive-design,tailwindcss | 2023-10-23T13:24:56Z | 2023-12-09T09:39:24Z | null | 1 | 0 | 7 | 0 | 1 | 2 | null | null | JavaScript |
mohitsupolia/WorldWise-adventure-track | master | # WorldWide Adventure Track Website
<img width="1120" alt="worldwise-homePage" src="https://github.com/mohitsupolia/WorldWise-adventure-track/assets/104218088/1984de69-5401-44dd-92ae-a5ed6344aa11">
## Description
Worldwide Adventure Track is a mapping app built with React.js, HTML, CSS, and JavaScript. Track your global adventures, record details, and store memories on an interactive map. Share your experiences with friends, compile a record of your journeys, and relive the excitement through stored memories. It's your personalized adventure journal, connecting you with friends and creating a visual archive of your global explorations.
## Features
. Map Tracking: Explore and track adventures using an easy-to-use map interface.
. List-Based Recording: Add and manage adventures efficiently through a simple list.
. Memory Storage: Store memories by uploading photos, notes, and other multimedia.
. Easy List Management: Organize and view recorded adventures effortlessly with a user-friendly list.
. Offline Memory Saving: Save memories even without internet, syncing when a connection is available.
## Installation
Step 1: Install Node.js:
. Ensure that you have Node.js installed on your machine. You can download it from Node.js website.
Step 2: Create a New Vite Project:
. Open your terminal and run the following command to create a new Vite project with React:
```
npx create-vite my-react-vite-app --template react
```
Step 3: Navigate to the Project Directory:
. Move into the project directory:
```
cd my-react-vite-app
```
Step 4: Install Dependencies:
. Install project dependencies by running:
```
npm install
```
Step 5: Start the Development Server:
. Start the Vite development server with the following command:
```
npm run dev
```
Step 6: Open in Browser:
. Open your browser and navigate to http://localhost:3000. You should see your React application running with Vite.
## Usage
1. Open the World Wide Adventure Track Website in your Browser.
2. Login the Website.
<img width="1120" alt="Worldwise-LoginPage" src="https://github.com/mohitsupolia/WorldWise-adventure-track/assets/104218088/231f535b-1aa7-48dc-ac38-47dd19c0d510">
3. And go to the Map page. Select the City Location and add to the List.
<img width="1120" alt="Worldwise-MapPage" src="https://github.com/mohitsupolia/WorldWise-adventure-track/assets/104218088/00c1c846-7651-45d4-a093-20921b441b1f">
## Acknowledgment
We extend our gratitude to the React.js community for their powerful UI library, JavaScript for its versatility, and the maintainers of external APIs.Special thanks to the open-source community, CSS frameworks, and development tools that played a vital role in the World Wide Adventure Track website. This collaboration embodies the ethos of knowledge sharing and innovation within the software development community.
| I developed a worldwise adventure track project with the help of REACT.JS, CSS, API's | css,reactjs,html5,javascript | 2023-11-05T07:46:10Z | 2024-04-30T13:11:37Z | null | 1 | 0 | 10 | 0 | 0 | 2 | null | null | JavaScript |
Thumuss/yash.thumus.eu | main | # YASH
> **Y**et **A**n other **SH**ell
YASH is a side project of my website [`thumus.eu`](https://thumus.eu). It emulates bash by calling an interface (a sort of bridge)
# Extensions
The extensions are `.ysh` and `.yash`. It supports `.sh` and `.bash` in a strict bash environnement.
# Why
I wanted a portable version of bash on the web.
There are projects who ports bash into a framework like NextJS but I wanted something usable in a CLI too. Typescript is the best choice for me there. It's more a fun project than a serious project for me.
# Read-Eval-Print-Loop (REPL)
You need `bun` for simplicity or anything that can compile typescript.
```sh
$ bun src/repl.ts
```
# Run
Same as REPL but the command is
```sh
$ bun src/run.ts [FILE1] [FILE2]...
```
Replace `FILE1`, etc... by your files.
# Install
For now on, YASH is compiled in two versions, REPL and RUN.
To compile the run version:
```sh
$ bun build --compile src/run.ts --outfile ./build/YASH_run
```
To compile the repl version:
```sh
$ bun build --compile src/repl.ts --outfile ./build/YASH_repl
```
and then to execute a command, it's the same as above but you replace `bun src/[NAME].ts` by `YASH_[NAME]`. `NAME` is `repl` or `run`
# Grammar
WORK IN PROGRESS
> The langage will change that's for sure.
White spaces are ommited
## YASH version
```EBNF
text = ('"' .* '"') | ("'" .* "'") | ('`' .* '`');
literal = "null" | number | text | bool | argument | var | regex;
bool = 'true' | 'false';
int = digit+;
float = digit+ ('.' digit+)?;
number = int | float;
digit = '0' | ... | '9';
argument = [a-zA-Z] ([a-zA-Z] | digit)*;
var = "$" ([a-zA-Z] | digit | "*" | "@")+;
list = "[" litteral? | ((literal ",")+ litteral) "]"
endstate = (";" | "\n")+;
leftUnary = "!" | "-";
rightUnary = "&";
unary-expr = (expr rightUnary) | (leftUnary expr);
binary-expr = (expr binary expr) ;
binary = logical | math;
logical = "&&" | "||" | "==" | "!=" | ">=" | "<=" | ">" | "<" | "|" | "|>" | "<|" | "=~";
math = "+" | "-" | "/" | "*" | "%" | "**";
math-block = ('((' expr '))') | ('(' expr ')') ;
string-block = ("[[" expr "]]") | ("[" expr "]") | ("(" expr ")");
condition-block = math-block | string-block;
if-expr = "if" condition-block endstate "then" expr endstate ("fi" | elfi-expr | else-expr);
elif-expr = "elif" condition-block endstate "then" endstate expr ("fi" | elfi-expr | else-expr);
else-expr = "else" endstate "then" endstate expr "fi";
time-expr = "time" expr;
while-expr = "while" condition-block endstate "do" expr endstate "done";
until-expr = "until" condition-block endstate "do" expr endstate "done";
case-expr = "case" expr "in" endstate ((regex | litteral) ")" endstate expr endstate ";;" endstate )* "*)" endstate expr endstate ";;" endstate "esac";
local-expr = "local" argument
keywords-expr = if-expr | elif-expr | else-expr | time-expr | while-expr | until-expr | case-expr | select-expr | function-expr | local-expr;
one-expr = unary-expr | binary-expr | ltteral | keywords-expr;
expr = (one-expr) | ((one-expr endstate) one-expr);
```
## BASH version (strict mode)
wip
# Contributing & Bugs
You can open an issue at my [repository](https://github.com/Thumuss/yash.thumus.eu/issues), I don't accept PR (normally).
# TODO
Things I need to do:
- [ ] Separate topics: Numbers need to be with Equations, Args with args etc...
- [ ] Statement: Everything is a statement but it's not normal
- [ ] Equations: Numbers, Floats
- [ ] Logical: Logical operators with booleans
- [x] Args: Contains command and args for the command
- [ ] Flow: Preprocess (|>, <|), link external tools?
- [ ] Bits: Operators with bits (&, |, )
- [ ] Strict mode: The goal is to run normal bash and yash. Useful with equations
- [ ] Impl basic helper functions: We need functions to use it in C for example.
- [ ] Yash to Bash: A converter tool can be useful.
- [ ] Errors: Line, column with a little graphic and a stack trace.
- [ ] Add keywords: Some keywords aren't already implemented.
- [ ] Reorganise: Everything is in the name
- [ ] DOCS: obv
- [ ] Add structs: Arrays, Dicts, Tuples, ...
| Yet An other SHell, oriented web and portable | ast,bash,javascript,language,typescript | 2023-11-03T21:47:52Z | 2024-02-04T10:50:51Z | null | 1 | 0 | 20 | 0 | 0 | 2 | null | null | TypeScript |
simranlotey/react-video-call | master | # React Video Call
Welcome to the React Video Call App, a real-time video calling application that allows users to connect with each other, providing the ability to initiate video calls and control their audio and video settings.
## Features
- Initiate video calls with other users.
- Mute/unmute your microphone during a call.
- Enable/disable your camera during a call.
- User-friendly interface with intuitive controls.
- Real-time communication using WebRTC and Socket.io.
- Built with React, Context API, Ant Design, React Bootstrap, Aphrodite, React Copy to Clipboard, and React Icons.
## Technologies Used
- React: A JavaScript library for building user interfaces.
- Context API: Used for managing application-wide state and providing data to components.
- WebRTC: A real-time communication technology for video and audio transmission.
- Socket.io: Enables real-time, bidirectional communication between the server and clients.
- Ant Design: A popular UI library for React applications with a rich set of components.
- React Bootstrap: A library that combines React and Bootstrap for responsive and attractive UI design.
- Aphrodite: A CSS-in-JS library for managing styles in a JavaScript environment.
- React Copy to Clipboard: Provides a simple way to copy text to the clipboard.
- React Icons: Offers a comprehensive set of icons for React applications.
## Installation
1. Clone this repository to your local machine:
```
git clone https://github.com/simranlotey/react-video-call.git
```
2. Change into the project directory:
```
cd react-video-call
```
3. Install the required dependencies:
```
npm install
```
4. Start the server:
```
npm start
```
5. Install the required dependencies for the client:
```
cd client
npm install
```
6. Start the development server:
```
npm start
```
7. Open your web browser and visit [http://localhost:3000](http://localhost:3000) to access the application.
## Usage
1. Start a new video call by entering the ID of the person you want to call.
2. Use the controls to mute/unmute your microphone and enable/disable your camera during the call.
3. Enjoy real-time video communication with your friends and colleagues!
## Deployment
- **Frontend Hosting**: The frontend of this application is hosted on [Netlify](https://www.netlify.com/). You can access it at [Frontend url](https://yourvideoshare.netlify.app/).
- **Backend Hosting**: The backend of this application is hosted on [Render.com](https://render.com/). You can access it at [Backend url](https://video-call-server-gm7i.onrender.com).
## Contributing
We welcome contributions from the community. If you'd like to contribute to the project, please follow these steps:
1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Make your changes and commit them.
4. Push your changes to your fork.
5. Submit a pull request to the `master` branch of this repository.
## Contact
If you have any questions or suggestions, please feel free to contact us at [simranlotey01@gmail.com](mailto:simranlotey01@gmail.com).
Thank you for using the React Video Call App!
| A real-time video calling application that allows users to connect with each other, providing the ability to initiate video calls and control their audio and video settings. | bootstrap,context-api,express,javascript,nodejs,react,socket-io,webrtc | 2023-11-01T21:35:43Z | 2024-05-14T20:55:58Z | null | 1 | 0 | 13 | 0 | 0 | 2 | null | null | JavaScript |
Shivam-Sharma-1/Facility-Management-System | main | # Facility Management System
The Facility Management System is a comprehensive management solution developed using the MERN (MongoDB, Express.js, React, Node.js) stack. It allows users to book time slots in facilities and provides role-based access control for various functionalities. This tool is a modified version of the one which was created as a project for DRDO Cabs during an internship. With four distinct roles, users can manage bookings, approvals, cancellations, and generate reports based on their permissions and responsibilities.
## Table of Contents
- [Screenshots](#screenshots)
- [Demo](#demo)
- [Features](#features)
- [Technologies Used](#technologies-used)
- [Packages Used](#packages-used)
- [Environment Variables](#environment-variables)
- [Getting Started](#getting-started)
- [Folder Structure](#folder-structure)
- [Running the Application](#running-the-application)
- [Author](#author)
- [Documentation](#documentation)
## Screenshots
Login Page
Reset Password Page
User Dashboard
GD & FM Dashboard
Calendar View
Create New Booking
My Bookings Page
Approval Request Page of GD & FM
Cancellation Request Page of GD & FM
GD & FM Report Page
Admin Manage Facilities Page
Admin Manage Bookings Page
## Demo
This project cannot be deployed as it requires a backend server to set cookie which is blocked by services offering hosting unless you are using a paid domain. However, you can follow the steps below to run the application on your local machine.
## Features
- **Role-based Access**:
- Users can be assigned one of four roles: User, Group Director (GD), Facility Manager (FM), or Admin, each with specific permissions and responsibilities.
- **Booking Management**:
- Users can request bookings for time slots in facilities.
- Bookings are then approved or rejected by designated approvers based on their role.
- **Booking Status Tracking**:
- Users can track the status of their bookings, including pending, approved, and rejected statuses.
- Timestamps of status changes are recorded for transparency and tracking.
- **Cancellation Requests**:
- Users can initiate cancellation requests for their bookings.
- Cancellation requests must be approved by designated approvers.
- **Approval Workflow**:
- When a user initiates a booking, the status is set to pending.
- The booking is forwarded to the appropriate approver (GD or FM) based on the user's group and facility.
- The approver can then approve or reject the booking, providing a remark for the reason if rejected.
- If approved, the booking status is updated accordingly.
- **Cancellation Workflow**:
- Users can request cancellations for their bookings, specifying the reason for cancellation.
- Cancellation requests must be approved by designated approvers (GD and FM) if the booking has been approved.
- The approvers can accept or reject the cancellation request, providing remarks for the reason if rejected.
- If approved, the booking status is updated to canceled, and the time slot becomes available for booking again.
- **Admin Powers**:
Admins have additional powers, including:
- Creating, editing, and deleting facilities.
- Reassigning FM (Facility Manager) roles for facilities.
- Approving or canceling bookings directly.
- Generating reports in PDF format for facilities and bookings.
- **Report Generation**:
- GDs, FMs, and Admins can generate reports in PDF format based on various criteria such as month, year, facility, or user group.
- **UI Navigation**:
- Navigation options are tailored based on the user's role.
- Users have easy access to relevant features and functionalities based on their permissions.
- **Single Sign-Out**(only in dev branch):
- Integration with a Java Spring Boot project enables seamless single sign-out functionality across both the Java and Node.js servers.
- **Authentication**:
- Users can authenticate using their employee ID and password for secure access to the system.
## Technologies Used
### Frontend
- **React**: JavaScript library for building user interfaces.
- **FullCalendar**: JavaScript event calendar for displaying bookings.
- **Material-UI**: React UI components for modern web applications.
- **React Router DOM**: Declarative routing for React applications.
- **Tailwind CSS**: Utility-first CSS framework for styling.
- **React Query**: Data fetching and caching library for React applications.
### Backend
- **Node.js**: JavaScript runtime environment for server-side development.
- **Express.js**: Web application framework for Node.js.
- **PostgresSQL**: SQL database for data storage.
- **Prisma**: ORM for database management.
## Packages Used
### Client-side
- **[@emotion/react](https://emotion.sh/docs/introduction)**: Library for CSS-in-JS styling.
- **[@mui/icons-material](https://mui.com/components/material-icons/)**, **[@mui/material](https://mui.com/getting-started/installation/)**: Material-UI components for UI design.
- **[@fullcalendar/react](https://fullcalendar.io/docs/react)**: React wrapper for FullCalendar.
- **[tailwindcss](https://tailwindcss.com/)**: Utility-first CSS framework for styling.
- **[axios](https://axios-http.com/)**: Promise-based HTTP client for the browser and Node.js.
- **[dayjs](https://day.js.org/)**: Library for date and time formatting.
- **[react-to-pdf](https://www.npmjs.com/package/react-to-pdf)**: Library for generating PDF documents from React components.
- **[react-query](https://react-query.tanstack.com/)**: Data fetching and caching library for React applications.
### Server-side
- **[@prisma/client](https://www.prisma.io/docs/concepts/components/prisma-client)**: Prisma client for database access.
- **[argon2](https://www.npmjs.com/package/argon2)**: Library for password hashing.
- **[express](https://expressjs.com/)**: Web application framework for Node.js.
- **[express-session](https://www.npmjs.com/package/express-session)**: Session middleware for Express.
- **[winston](https://github.com/winstonjs/winston)**: Logging library for Node.js.
## Environment Variables
The project relies on environment variables stored in a .env. file located at the root of the client directory and server directory to manage configurations. Ensure that essential variables such as database connection strings, API keys, or any other sensitive information are properly set up.
### Client-side Environment Variables
Create a `.env` file in the `client` directory and add the following variable:
```bash
VITE_APP_SERVER_URL="http://localhost:3000"
```
### Server-side Environment Variables
Create a `.env` file in the `server` directory and add the following variables:
```bash
DATABASE_URL="*YOUR POSTGRES DATABASE URL*"
SESSION_SECRET="*ANY SECRET*"
CLIENT_URL="http://localhost:5173"
```
Be sure to replace `*YOUR POSTGRES DATABASE URL*` with your actual postgress database url containing data and `*ANY SECRET*` with secret generated from secret generator to enable proper integration.
**Note**: Environment variables containing sensitive information like API keys, database credentials, or any other secrets should not be committed to version control. Ensure that the `.env` files are included in your project's `.gitignore` file to prevent accidental exposure of sensitive data.
## Getting Started
1. Clone this repository
to your local machine:
```bash
git clone https://github.com/Shivam-Sharma-1/Facility-Management-System.git
```
2. Change to the project directory:
```bash
cd facility-management-system
```
3. Install client dependencies and start the client:
```bash
cd client
npm install
npm run dev
```
4. In another terminal tab install server dependencies and start the server:
```bash
cd server
npm install
npx prisma generate
npm run watch
npm run devT ##in separate terminal
```
## Folder Structure
The project structure is organized as follows:
```
facility-management-system/
├── client/ # Client-side codebase (React)
│ ├── .env # Environment variables (not committed to version control)
│ ├── constants/ # Constants or configurations
│ ├── package.json # Client-side dependencies and scripts
│ ├── public/ # Public assets
│ └── src/ # Source code
│ ├── components/ # React components
│ ├── hooks/ # Custom hooks
│ ├── pages/ # Different pages for the dashboard
│ ├── reports/ # API service functions
│ ├── types.d.ts # Type definitions
│ └── utils/ # Utility functions
│
└── server/ # Server-side codebase (Node.js, Express)
├── .env # Environment variables (not committed to version control)
├── logs/ # Logs
├── package.json # Server-side dependencies and scripts
├── prisma/ # Database models (Mongoose)
└── src/ # Source code
├── controllers/ # Route controllers
├── db/ # Database connection and setup
├── middleware/ # Middleware functions
├── routes/ # API routes
├── types/ # Type definitions
└── utils/ # Utility functions
```
## Running the Application
- Start the client: `npm run dev` within the `client` directory.
- Start the server: `npm run devT` within the `server` directory.
The client-side application will run on `http://localhost:3000`, and the server-side application will run on `http://localhost:5173`.
### Credentials to Access the Application
| Role | EmployeeID | Password |
| --------------------- | ---------- | -------- |
| User | 446210 | password |
| Group Director (GD) | 635110 | password |
| Facility Manager (FM) | 395003 | password |
## Author
- [@Shivam-Sharma-1](https://github.com/Shivam-Sharma-1) [Frontend]
- [@Vector-ops](https://github.com/Vector-ops) [Backend]
## Documentation
- **[React Documentation](https://reactjs.org/docs/getting-started.html)**: Learn more about React for building user interfaces.
- **[FullCalendar Documentation](https://fullcalendar.io/docs)**: Explore FullCalendar documentation for JavaScript event calendar functionality.
- **[Material-UI Documentation](https://mui.com/getting-started/installation/)**: Dive into Material-UI documentation for React UI components.
- **[React Router DOM Documentation](https://reactrouter.com/web/guides/quick-start)**: Learn about React Router DOM for declarative routing in React applications.
- **[Tailwind CSS Documentation](https://tailwindcss.com/docs)**: Explore Tailwind CSS documentation for utility-first CSS framework for styling.
- **[React Query Documentation](https://react-query.tanstack.com/)**: Discover Tanstack React Query documentation for data fetching and caching in React applications.
- **[Node.js Documentation](https://nodejs.org/en/docs/)**: Explore Node.js documentation for server-side JavaScript runtime environment.
- **[Express.js Documentation](https://expressjs.com/en/starter/installing.html)**: Discover Express.js documentation for web application framework in Node.js.
- **[PostgreSQL Documentation](https://www.postgresql.org/docs/)**: Learn more about PostgreSQL for relational database management.
- **[Prisma Documentation](https://www.prisma.io/docs/)**: Dive into Prisma documentation for ORM and database management.
---
| The Facility Management System is a comprehensive management solution developed using the MERN (MongoDB, Express.js, React, Node.js) stack. It allows users to book time slots in facilities and provides role-based access control for various functionalities. This is a modified version of the one which was created as a project for DRDO Cabs internship | express,material-ui,nodejs,prisma-orm,react,typescript,css3,html5,javascript,react-router-dom | 2023-10-28T07:39:01Z | 2024-04-27T11:39:02Z | null | 2 | 40 | 624 | 0 | 1 | 2 | null | null | TypeScript |
dfagundes2001/portifolio | main | # React + Vite
Link: https://portifolio-react-rosy.vercel.app/
This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
Currently, two official plugins are available:
- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
| Nele você verá projetos que estou desenvolvendo, os próximos e os principais, tecnologias que uso e um pouco sobre o Dev que sou. | css3,html5,javascript,tailwind-css,vite,react-hooks,react-router-dom,react,styledcomponents | 2023-10-16T21:01:04Z | 2024-05-16T19:54:13Z | null | 1 | 4 | 39 | 0 | 0 | 2 | null | null | JavaScript |
tugsem/LA-mountains | develop |
# Losangeles Mountains
> Explore the rich history of the Los Angeles mountains and stay updated on upcoming climbing schedules with our dedicated website.
## Built With
- HTML
- CSS
- JavaScript
- Linters
## Live Demo
[Live Demo Link](https://tugsem.github.io/LA-mountains/)
## Getting Started
To get a local copy up and running follow these simple example steps.
### Setup
clone the repository:
`git clone https://github.com/tugsem/LA-mountains`
### Usage
open the project directory
click the index.html
### Deployment
this project deployed using github pages.
## Authors
👤 **Tuğsem Saranlı**
- GitHub: [@tugsem](https://github.com/tugsem)
- Twitter: [@tugsem](https://twitter.com/tugsemSAranli)
- LinkedIn: [LinkedIn](https://linkedin.com/in/tugsem)
## 🤝 Contributing
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
## Show your support
Give a ⭐️ if you like this project!
## Acknowledgments
Thanks to Coalition Technologies for providing me this design.
## 📝 License
This project is [MIT](./LICENSE) licensed.
| Explore the rich history of the Los Angeles mountains and stay updated on upcoming climbing schedules with our dedicated website. | css,html,javascript | 2023-10-19T14:21:27Z | 2023-10-30T14:51:33Z | null | 1 | 0 | 13 | 0 | 0 | 2 | null | null | CSS |
tugsem/LA-mountains | develop |
# Losangeles Mountains
> Explore the rich history of the Los Angeles mountains and stay updated on upcoming climbing schedules with our dedicated website.
## Built With
- HTML
- CSS
- JavaScript
- Linters
## Live Demo
[Live Demo Link](https://tugsem.github.io/LA-mountains/)
## Getting Started
To get a local copy up and running follow these simple example steps.
### Setup
clone the repository:
`git clone https://github.com/tugsem/LA-mountains`
### Usage
open the project directory
click the index.html
### Deployment
this project deployed using github pages.
## Authors
👤 **Tuğsem Saranlı**
- GitHub: [@tugsem](https://github.com/tugsem)
- Twitter: [@tugsem](https://twitter.com/tugsemSAranli)
- LinkedIn: [LinkedIn](https://linkedin.com/in/tugsem)
## 🤝 Contributing
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
## Show your support
Give a ⭐️ if you like this project!
## Acknowledgments
Thanks to Coalition Technologies for providing me this design.
## 📝 License
This project is [MIT](./LICENSE) licensed.
| Explore the rich history of the Los Angeles mountains and stay updated on upcoming climbing schedules with our dedicated website. | css,html,javascript | 2023-10-19T14:21:27Z | 2023-10-30T14:51:33Z | null | 1 | 0 | 13 | 0 | 0 | 2 | null | null | CSS |
asad1996172/quizbot | main | # QuizBot
QuizBot is an interactive platform that allows users to explore and share quizzes powered by ChatGPT. Users can dive into personalized tests on topics of their choosing, get questions marked in real-time, and if puzzled by an answer, chat directly with the AI to understand why. It serves as an interactive learning hub where curiosity meets clarity.
Features:
- User Authentication: The application provides Google authentication for users to sign in.
- Quiz Creation: Users can create personalized quizzes with specific prompts, tags, and titles.
- Quiz Exploration: The platform offers a feed where users can explore various quizzes created by others.
- Profile Management: Users can view and manage their profiles, including the quizzes they've created.
- Search Functionality: Users can search for quizzes based on tags or usernames.
- Chat Functionality: Users can chat with the AI to understand why a certain answer is correct or incorrect.
- Real-time Marking: The application marks the user's answers in real-time and provides feedback.
Technical Details:
- Stack: Next.js, React, TypeScript, Tailwind CSS, MongoDb Atlas, ChatGPT
- Deployment: Vercel
- APIs & Integrations: NextAuth for authentication with Google.
- Database Technologies: MongoDB
## Getting Started
First, run the development server:
```bash
npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev
```
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
## Demo
[](https://www.youtube.com/watch?v=02g7MAkJuHQ)
| A NextJS based webapp where you can create and share tests and also take tests using ChatGPT | chatgpt,interactive-learning,javascript,mongodb,nextjs,quiz,react,typescript,gpt-3,gpt-35-turbo | 2023-10-21T04:30:07Z | 2023-10-31T23:56:15Z | null | 1 | 0 | 15 | 0 | 0 | 2 | null | null | TypeScript |
H1m9n5hu/Redux-Counter-App | main | # Getting Started with Create React App
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
## Available Scripts
In the project directory, you can run:
### `npm start`
Runs the app in the development mode.\
Open [http://localhost:3000](http://localhost:3000) to view it in your browser.
The page will reload when you make changes.\
You may also see any lint errors in the console.
### `npm test`
Launches the test runner in the interactive watch mode.\
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
### `npm run build`
Builds the app for production to the `build` folder.\
It correctly bundles React in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.\
Your app is ready to be deployed!
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
### `npm run eject`
**Note: this is a one-way operation. Once you `eject`, you can't go back!**
If you aren't satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own.
You don't have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it.
## Learn More
You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
To learn React, check out the [React documentation](https://reactjs.org/).
### Code Splitting
This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting)
### Analyzing the Bundle Size
This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size)
### Making a Progressive Web App
This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app)
### Advanced Configuration
This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration)
### Deployment
This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment)
### `npm run build` fails to minify
This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify)
| This is an simple counter app which is made by using Redux. It is just an practice project for Redux. | css,html,javascript,react-redux,react-router-dom,reactjs,redux | 2023-10-25T12:55:07Z | 2023-10-25T12:56:29Z | null | 1 | 0 | 1 | 0 | 0 | 2 | null | null | JavaScript |
seanpm2001/EMAIL2_Tester | EMAIL2_Tester_Main-dev |
***
# <projectName>
# By:
<!--  !-->
## [Seanpm2001](https://github.com/seanpm2001/), [<developerName>](https://github.com/<developerName>/) Et; Al.
### Top
# `README.md`
***
## Read this article in a different language
**Sorted by:** `A-Z`
[Sorting options unavailable](https://github.com/<developerName>/<repoName>)
( [af Afrikaans](/.github/README_AF.md) Afrikaans | [sq Shqiptare](/.github/README_SQ.md) Albanian | [am አማርኛ](/.github/README_AM.md) Amharic | [ar عربى](/.github/README_AR.md) Arabic | [hy հայերեն](/.github/README_HY.md) Armenian | [az Azərbaycan dili](/.github/README_AZ.md) Azerbaijani | [eu Euskara](/.github/README_EU.md) Basque | [be Беларуская](/.github/README_BE.md) Belarusian | [bn বাংলা](/.github/README_BN.md) Bengali | [bs Bosanski](/.github/README_BS.md) Bosnian | [bg български](/.github/README_BG.md) Bulgarian | [ca Català](/.github/README_CA.md) Catalan | [ceb Sugbuanon](/.github/README_CEB.md) Cebuano | [ny Chichewa](/.github/README_NY.md) Chichewa | [zh-CN 简体中文](/.github/README_ZH-CN.md) Chinese (Simplified) | [zh-t 中國傳統的）](/.github/README_ZH-T.md) Chinese (Traditional) | [co Corsu](/.github/README_CO.md) Corsican | [hr Hrvatski](/.github/README_HR.md) Croatian | [cs čeština](/.github/README_CS.md) Czech | [da dansk](README_DA.md) Danish | [nl Nederlands](/.github/README_NL.md) Dutch | [**en-us English**](/.github/README.md) English | [EO Esperanto](/.github/README_EO.md) Esperanto | [et Eestlane](/.github/README_ET.md) Estonian | [tl Pilipino](/.github/README_TL.md) Filipino | [fi Suomalainen](/.github/README_FI.md) Finnish | [fr français](/.github/README_FR.md) French | [fy Frysk](/.github/README_FY.md) Frisian | [gl Galego](/.github/README_GL.md) Galician | [ka ქართველი](/.github/README_KA) Georgian | [de Deutsch](/.github/README_DE.md) German | [el Ελληνικά](/.github/README_EL.md) Greek | [gu ગુજરાતી](/.github/README_GU.md) Gujarati | [ht Kreyòl ayisyen](/.github/README_HT.md) Haitian Creole | [ha Hausa](/.github/README_HA.md) Hausa | [haw Ōlelo Hawaiʻi](/.github/README_HAW.md) Hawaiian | [he עִברִית](/.github/README_HE.md) Hebrew | [hi हिन्दी](/.github/README_HI.md) Hindi | [hmn Hmong](/.github/README_HMN.md) Hmong | [hu Magyar](/.github/README_HU.md) Hungarian | [is Íslenska](/.github/README_IS.md) Icelandic | [ig Igbo](/.github/README_IG.md) Igbo | [id bahasa Indonesia](/.github/README_ID.md) Icelandic | [ga Gaeilge](/.github/README_GA.md) Irish | [it Italiana/Italiano](/.github/README_IT.md) | [ja 日本語](/.github/README_JA.md) Japanese | [jw Wong jawa](/.github/README_JW.md) Javanese | [kn ಕನ್ನಡ](/.github/README_KN.md) Kannada | [kk Қазақ](/.github/README_KK.md) Kazakh | [km ខ្មែរ](/.github/README_KM.md) Khmer | [rw Kinyarwanda](/.github/README_RW.md) Kinyarwanda | [ko-south 韓國語](/.github/README_KO_SOUTH.md) Korean (South) | [ko-north 문화어](README_KO_NORTH.md) Korean (North) (NOT YET TRANSLATED) | [ku Kurdî](/.github/README_KU.md) Kurdish (Kurmanji) | [ky Кыргызча](/.github/README_KY.md) Kyrgyz | [lo ລາວ](/.github/README_LO.md) Lao | [la Latine](/.github/README_LA.md) Latin | [lt Lietuvis](/.github/README_LT.md) Lithuanian | [lb Lëtzebuergesch](/.github/README_LB.md) Luxembourgish | [mk Македонски](/.github/README_MK.md) Macedonian | [mg Malagasy](/.github/README_MG.md) Malagasy | [ms Bahasa Melayu](/.github/README_MS.md) Malay | [ml മലയാളം](/.github/README_ML.md) Malayalam | [mt Malti](/.github/README_MT.md) Maltese | [mi Maori](/.github/README_MI.md) Maori | [mr मराठी](/.github/README_MR.md) Marathi | [mn Монгол](/.github/README_MN.md) Mongolian | [my မြန်မာ](/.github/README_MY.md) Myanmar (Burmese) | [ne नेपाली](/.github/README_NE.md) Nepali | [no norsk](/.github/README_NO.md) Norwegian | [or ଓଡିଆ (ଓଡିଆ)](/.github/README_OR.md) Odia (Oriya) | [ps پښتو](/.github/README_PS.md) Pashto | [fa فارسی](/.github/README_FA.md) |Persian [pl polski](/.github/README_PL.md) Polish | [pt português](/.github/README_PT.md) Portuguese | [pa ਪੰਜਾਬੀ](/.github/README_PA.md) Punjabi | No languages available that start with the letter Q | [ro Română](/.github/README_RO.md) Romanian | [ru русский](/.github/README_RU.md) Russian | [sm Faasamoa](/.github/README_SM.md) Samoan | [gd Gàidhlig na h-Alba](/.github/README_GD.md) Scots Gaelic | [sr Српски](/.github/README_SR.md) Serbian | [st Sesotho](/.github/README_ST.md) Sesotho | [sn Shona](/.github/README_SN.md) Shona | [sd سنڌي](/.github/README_SD.md) Sindhi | [si සිංහල](/.github/README_SI.md) Sinhala | [sk Slovák](/.github/README_SK.md) Slovak | [sl Slovenščina](/.github/README_SL.md) Slovenian | [so Soomaali](/.github/README_SO.md) Somali | [[es en español](/.github/README_ES.md) Spanish | [su Sundanis](/.github/README_SU.md) Sundanese | [sw Kiswahili](/.github/README_SW.md) Swahili | [sv Svenska](/.github/README_SV.md) Swedish | [tg Тоҷикӣ](/.github/README_TG.md) Tajik | [ta தமிழ்](/.github/README_TA.md) Tamil | [tt Татар](/.github/README_TT.md) Tatar | [te తెలుగు](/.github/README_TE.md) Telugu | [th ไทย](/.github/README_TH.md) Thai | [tr Türk](/.github/README_TR.md) Turkish | [tk Türkmenler](/.github/README_TK.md) Turkmen | [uk Український](/.github/README_UK.md) Ukrainian | [ur اردو](/.github/README_UR.md) Urdu | [ug ئۇيغۇر](/.github/README_UG.md) Uyghur | [uz O'zbek](/.github/README_UZ.md) Uzbek | [vi Tiếng Việt](/.github/README_VI.md) Vietnamese | [cy Cymraeg](/.github/README_CY.md) Welsh | [xh isiXhosa](/.github/README_XH.md) Xhosa | [yi יידיש](/.github/README_YI.md) Yiddish | [yo Yoruba](/.github/README_YO.md) Yoruba | [zu Zulu](/.github/README_ZU.md) Zulu ) Available in 110 languages (108 when not counting English and North Korean, as North Korean has not been translated yet [Read about it here](/OldVersions/Korean(North)/README.md))
Translations in languages other than English are machine translated and are not yet accurate. No errors have been fixed yet as of March 21st 2021. Please report translation errors [here](https://github.com/<developerName>/<repoName>/issues/). Make sure to backup your correction with sources and guide me, as I don't know languages other than English well (I plan on getting a translator eventually) please cite [wiktionary](https://en.wiktionary.org) and other sources in your report. Failing to do so will result in a rejection of the correction being published.
Note: due to limitations with GitHub's interpretation of markdown (and pretty much every other web-based interpretation of markdown) clicking these links will redirect you to a separate file on a separate page that isn't the intended page. You will be redirected to the [.github folder](/.github/) of this project, where the README translations are hosted.
Translations are currently done with Bing translate and DeepL. Support for Google Translate translations is coming to a close due to privacy concerns.
***
# Index
[00.0 - Top](#Top)
> [00.1 - Title](#<projectName>)
> [00.2 - Read this article in a different language](#Read-this-article-in-a-different-language)
> [00.3 - Index](#Index)
[01.0 - Description](#RepositoryName)
[02.0 - About](#About)
[03.0 - Wiki](#Wiki)
[04.0 - History](#History)
> [04.1 - Pre-history](#Pre-history)
> [04.2 - Alpha History](#Alpha-history)
> [04.3 - Beta History](#Beta-history)
> [04.4 - Modern History](#Modern-history)
[05.0 - Copying](#Copying)
[06.0 - Credits](#Credits)
[07.0 - Installation](#Installation)
[08.0 - Version history](#Version-history)
[09.0 - Version history](#Version-history)
[10.0 - Software status](#Software-status)
[11.0 - Sponsor info](#Sponsor-info)
[12.0 - Contributers](#Contributers)
[13.0 - Issues](#Issues)
> [13.1 - Current issues](#Current-issues)
> [13.2 - Past issues](#Past-issues)
> [13.3 - Past pull requests](#Past-pull-requests)
> [13.4 - Active pull requests](#Active-pull-requests)
[14.0 - Resources](#Resources)
[15.0 - Contributing](#Contributing)
[16.0 - About README](#About-README)
[17.0 - README Version history](#README-version-history)
[18.0 - Footer](#You-have-reached-the-end-of-the-README-file)
> [18.9 - End of file](#EOF)
***
# <repoName>
<repo_description>
***
## About
See above. <extendedRepoDescription>
***
## Wiki
[Click/tap here to view this projects Wiki](https://github.com/<developerName>/<repoName>/wiki)
If the project has been forked, the Wiki was likely removed. Luckily, I include an embedded version. You can view it [here](/External/ProjectWiki/).
***
## History
Write about this projects history here.
### Pre-history
No pre-history to show for this project.
### Alpha history
No Alpha history to show for this project.
### Beta history
No Beta history to show for this project.
### Modern history
No Modern history to show for this project.
***
## Copying
View the copying license for this project [here](/COPYING) (if you haven't built the project yet with the makefile, here is the original link: [COPYINGL](/COPYINGL)
Please note that you also have to follow the rules of the GNU General Public License v3 (GPL3) which you can view [here](/LICENSE.txt)
***
## Credits
View the credits file for this project and see the people who got together to make this project by [clicking/tapping here](/CREDITS)
***
## Installation
View the installation instructions file for this project [here](/INSTALL)
Requirements: Read the instructions for more info, and get the latest up-to-date instructions [here](https://gist.github.com/seanpm2001/745564a46186888e829fdeb9cda584de)
***
## Sponsor info
You can sponsor this project if you like, but please specify what you want to donate to. [See the funds you can donate to here](https://github.com/seanpm2001/Sponsor-info/tree/main/For-sponsors/)
You can view other sponsor info [here](https://github.com/seanpm2001/Sponsor-info/)
Try it out! The sponsor button is right up next to the watch/unwatch button.
***
## Version history
**Version history currently unavailable**
**No other versions listed**
***
## Software status
All of my works are free some restrictions. DRM (**D**igital **R**estrictions **M**anagement) is not present in any of my works.
This sticker is supported by the Free Software Foundation. I never intend to include DRM in my works.
I am using the abbreviation "Digital Restrictions Management" instead of the more known "Digital Rights Management" as the common way of addressing it is false, there are no rights with DRM. The spelling "Digital Restrictions Management" is more accurate, and is supported by [Richard M. Stallman (RMS)](https://en.wikipedia.org/wiki/Richard_Stallman) and the [Free Software Foundation (FSF)](https://en.wikipedia.org/wiki/Free_Software_Foundation)
This section is used to raise awareness for the problems with DRM, and also to protest it. DRM is defective by design and is a major threat to all computer users and software freedom.
Image credit: [defectivebydesign.org/drm-free/...](https://www.defectivebydesign.org/drm-free/how-to-use-label/)
***
## Contributers
Currently, I am the only contributer. Contributing is allowed, as long as you follow the rules of the [CONTRIBUTING.md](/CONTRIBUTING.md) file.
> * 1. [seanpm2001](https://github.com/seanpm2001/) - x commits (As of Yr, DoW, Month, DoM, at ##:## a/pm)
> * 2. No other contributers.
***
## Issues
### Current issues
* None at the moment
* No other current issues
If the repository has been forked, issues likely have been removed. Luckily I keep an archive of certain images [here](/.github/Issues/)
[Read the privacy policy on issue archival here](/.github/Issues/README.md)
**TL;DR**
I archive my own issues. Your issue won't be archived unless you request it to be archived.
### Past issues
* None at the moment
* No other past issues
If the repository has been forked, issues likely have been removed. Luckily I keep an archive of certain images [here](/.github/Issues/)
[Read the privacy policy on issue archival here](/.github/Issues/README.md)
**TL;DR**
I archive my own issues. Your issue won't be archived unless you request it to be archived.
### Past pull requests
* None at the moment
* No other past pull requests
If the repository has been forked, issues likely have been removed. Luckily I keep an archive of certain images [here](/.github/Issues/)
[Read the privacy policy on issue archival here](/.github/Issues/README.md)
**TL;DR**
I archive my own issues. Your issue won't be archived unless you request it to be archived.
### Active pull requests
* None at the moment
* No other active pull requests
If the repository has been forked, issues likely have been removed. Luckily I keep an archive of certain images [here](/.github/Issues/)
[Read the privacy policy on issue archival here](/.github/Issues/README.md)
**TL;DR**
I archive my own issues. Your issue won't be archived unless you request it to be archived.
***
## Resources
Here are some other resources for this project:
[Project language file A](PROJECT_LANG_1.<fileExtensionForProgrammingLanguage>)
[Join the discussion on GitHub](https://github.com/<developerName>/<repoName>/discussions)
No other resources at the moment.
***
## Contributing
Contributing is allowed for this project, as long as you follow the rules of the `CONTRIBUTING.md` file.
[Click/tap here to view the contributing rules for this project](/CONTRIBUTING.md)
***
## About README
**File type:** `Markdown Document (*.md *.mkd *.markdown)`
**File version:** `0.1.6 (Monday, August 23rd 2021 at 6:37 pm)`
**Line count (including blank lines and compiler line):** `0,407`
***
## README version history
Version 0.1 (Sunday, March 21st 2021 at 7:50 pm)
> Changes:
> * Started the file
> * Added the title section
> * Added the index
> * Added the about section
> * Added the Wiki section
> * Added the version history section
> * Added the issues section.
> * Added the past issues section
> * Added the past pull requests section
> * Added the active pull requests section
> * Added the contributors section
> * Added the contributing section
> * Added the about README section
> * Added the README version history section
> * Added the resources section
> * Added a software status section, with a DRM free sticker and message
> * Added the sponsor info section
**ITERATION 5**
> * Updated the title section
> * Updated the index
> * Added the history section
> * Updated the file info section
> * Updated the file history section
**ITERATION 6**
> * Updated the title section
> * Fixed and update template links
> * Updated the index
> * Added the copying section
> * Added the credits section
> * Added the installation section
> * Updated the resources section
> * Updated the contributors section
> * Added the technical notes section
> * Updated the footer
> * Updated the file info section
> * Updated the file history section
> * No other changes in version 0.1
Version 1 (Coming soon)
> Changes:
> * Coming soon
> * No other changes in version 1
Version 2 (Coming soon)
> Changes:
> * Coming soon
> * No other changes in version 2
***
### You have reached the end of the README file
( [Back to top](#Top) | [Exit to GitHub](https://github.com) | [Exit to Bing](https://www.bing.com/) | [Exit to DuckDuckGo](https://duckduckgo.com/) | [Exit to Ecosia](https://www.ecosia.org) )
### EOF
***
| 📧️2️⃣️🚧️ The official source repository for the EMAIL 2.0 compliance testing tool. | compliance-testing,email-2,email-revolution,email-update,email-upgrade,email2,gpl3,gplv3,javascript,javascript-lang | 2023-10-29T03:18:00Z | 2023-10-29T23:21:19Z | null | 1 | 0 | 18 | 0 | 1 | 2 | null | GPL-3.0 | JavaScript |
matmont/searchy | main | # Searchy
[](https://app.netlify.com/sites/searchy-aif/deploys)
[**Searchy**](https://searchy-aif.netlify.app/) wants to be an environment to test and visualize different problem-solving AI agents (i.e.
**searching algorithms**) upon a simple problem as a fully-observable maze scenario.
This simple project has been developed as part of my studies in the Artificial Intelligence Master's Degree in Pisa, during the lectures of the Artificial Intelligence Fundamentals course. My willingness is to open source this and try to continuously improve and evolve it to support less trivial scenarios. You can find the theory of those concepts in the [2.3 Chapter of the AIMA (Artificial Intelligence: A Modern Approach, 4th ed.)](https://aima.cs.berkeley.edu/).
You can play with it [here](https://searchy-aif.netlify.app/). Take a look at this [blog post](https://mmont.dev/blog/problem-solving-agents) too.
## Usage
Even if pretty simple, I want to introduce the basic controls in that section of the README. The idea is to be able to configure your maze choosing the number of **rows** and **columns** of the grid. After that, you can go ahead with the maze generation. Once you have your preferred setup, just select your algorithm of choice and hit that **start** button. Enjoy! 😁
After the first run, you can see below the controls a little section showing some stats about the last search. This section will be expanded with useful infos whenever they come to my mind. That's the section of reference when comparing different algorithms!
## Run Locally
To start the project locally
```bash
git clone https://github.com/matmont/searchy.git
cd searchy
pnpm install
pnpm run dev
npx tailwindcss -i ./src/style.css -o ./dist/style.css --watch
```
## To Do
I want to gather here a kind of roadmap for the app. Feel free to open issues to propose new ones and PRs to start burning those out!
- [ ] Add more algorithms
- [ ] Genetic algorithms
- [ ] Dijkstra's algorithm
- [ ] Add more stats
- [ ] Optimal solution?
- [ ] Draw optimal solution(s)
- [ ] Allows user to change starting player position
- [ ] Allows for multiple goals
- [ ] Add uncertainty/partial observability
- [ ] Allows user to remove maze
- [ ] Support and allows for selection of multiple maze-generation techniques
| Searchy 🔎 is a simple web app built to explore problem-solving search algorithms in a maze environment. This app has been developed during my studies in Artificial Intelligence at University of Pisa. | ai,daisyui,javascript,tailwindcss,typescript | 2023-11-02T18:34:51Z | 2023-11-09T12:28:40Z | null | 1 | 0 | 17 | 0 | 0 | 2 | null | null | TypeScript |
Cedar-81/paginate | main | # Paginate
Paginate is a JavaScript library for paginating text using HTML canvas. It allows users to change the font, font size, line height, and more.
## Getting Started
To run PaginatorJS locally, you'll need to install TypeScript and a global HTTP server. Follow these steps:
### Prerequisites
Before you get started, make sure you have Node.js and npm (Node Package Manager) installed on your system. You can download and install them from [Node.js website](https://nodejs.org/).
### Installation
1. Clone the repository to your local machine:
```bash
git clone https://github.com/Cedar-81/paginate.git
```
2. Navigate to the project directory:
```bash
cd Paginator
```
3. Install the required development dependencies:
```bash
pnpm install
```
4. To run on dev server:
```bash
pnpm run dev
```
This will generate mjs, js nd d.ts files in the `dist` directory from src/paginate.ts.
5. ****IMPORTANT:**** Do well to import all exported functions in the src/index.ts files so that it is compiled to mjs file on build
6. Open your web browser and access your PaginatorJS page at `http://localhost:8080` or a different URL provided by your HTTP server.
## Usage
To use PaginatorJS in your own HTML project, include the generated JavaScript file in your HTML, and follow the usage instructions mentioned in the previous README example.
## Options
- `font`: The font to use.
- `fontSize`: The font size.
- `fontColor`: The font color.
- `lineHeight`: The line height.
- Add more options and their descriptions here.
## Contributing
If you would like to contribute to PaginatorJS, please follow our [contributing guidelines](Contributing.md).
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE.txt) file for details.
| A js library to make it easy to paginate texts | hacktoberfest2023,hacktoberfest,css,html5,javascript,pagination,pagination-library,text-pagination | 2023-10-18T08:52:43Z | 2023-10-21T03:41:48Z | null | 1 | 5 | 15 | 4 | 4 | 2 | null | MIT | HTML |
marcode24/codember-solutions | main | <div align="center">
<img alt="codember 2022" src="https://res.cloudinary.com/dfeujtobk/image/upload/v1671160716/Challenges/codember_foznhx.png" width="1200" />
<br />
<br />
<h1>🎯 Codember Solutions</h1>
</div>
## ℹ️ About
This repository contains my solutions to the challenges of the [Codember](https://codember.dev/) challenges. The challenges are created by [@midudev](https://twitter.com/midudev)
## 🚀 Installation & Usage
```bash
# clone the repo
git clone https://github.com/marcode24/codember-solutions
# go to the codember-solutions directory
cd codember-solutions
# install dependencies
npm install
# run test
npm run test
# run specific test
npm run test 'year'/'folder-name'/solution.test.js
```
## 🎯 2023 Challenges
<details open>
<summary>Show / Hide</summary>
| # | Challenge |Status | My Solution |
| :-: | ----------------------------------------------------------------- |:----: | :------------------------------------------------------------------------------------------------------: |
| 01 | [El Reto](https://codember.dev) |✅ | [here](https://github.com/marcode24/codember-solutions/tree/main/2023/01-el-reto) |
| 02 | [Mini Compiler Challenge](https://codember.dev) |✅ | [here](https://github.com/marcode24/codember-solutions/tree/main/2023/02-mini-compiler) |
| 03 | [El Desafío del Cifrado Espía](https://codember.dev) |✅ | [here](https://github.com/marcode24/codember-solutions/tree/main/2023/03-cifrado-espia) |
</details>
## 🎯 2022 Challenges
<details open>
<summary>Show / Hide</summary>
| # | Challenge |Status | My Solution |
| :-: | ----------------------------------------------------------------- |:----: | :------------------------------------------------------------------------------------------------------: |
| 01 | [¡Arregla Twitter!](https://codember.dev) |✅ | [here](https://github.com/marcode24/codember-solutions/tree/main/2022/01-arregla-twitter) |
| 02 | [¡Atrapa a esos ciber criminales!](https://codember.dev) |✅ | [here](https://github.com/marcode24/codember-solutions/tree/main/2022/02-atrapa-a-esos-ciber-criminales) |
| 03 | [La zebra de colores](https://codember.dev) |✅ | [here](https://github.com/marcode24/codember-solutions/tree/main/2022/03-zebra-de-colores) |
| 04 | [Encuentra la contraseña de tu amigo](https://codember.dev) |✅ | [here](https://github.com/marcode24/codember-solutions/tree/main/2022/04-encuentra-password) |
| 05 | [Battle Royale de frameworks y bibliotecas](https://codember.dev) |✅ | [here](https://github.com/marcode24/codember-solutions/tree/main/2022/05-battle-royale) |
</details>
## 📝 License
Licensed under the [MIT License](./LICENSE). | 🎯 This repository contains my solutions to the challenges of the Codember challenges. The challenges are created by @midudev | codember,codember2022,codember2023,eslint,eslint-config-airbnb,eslint-plugin-import,eslint-plugin-jest,husky,javascript,jest | 2023-11-07T04:45:17Z | 2023-11-23T07:36:36Z | null | 1 | 8 | 28 | 0 | 0 | 2 | null | MIT | JavaScript |
cyberzsk/servant | main | null | A new Servant with discord.js | discord-bot,discord-js,javascript | 2023-10-14T02:18:33Z | 2023-11-16T13:46:43Z | null | 2 | 4 | 29 | 1 | 0 | 2 | null | null | JavaScript |
RoodyCode/Pi-Panel | main | # Pi Panel
Your personal hub for keeping an eye on your Raspberry Pi's performance.
Quickly gauge its health, see how long it's been running, or check memory usage, all in one simple dashboard.
## ⭐ Features
- **Connected Status:** Instantly see if your Raspberry Pi is online or offline.
- **CPU Usage:** Monitor the current CPU usage to ensure optimal performance.
- **RAM Usage:** Keep an eye on memory consumption to prevent potential slowdowns or crashes.
- **Up-Time:** Track how long your Raspberry Pi has been running without interruptions.
- **Reboot and Shutdown:** Execute these crucial commands with just a click, ensuring safe and easy management.
## 🐳 Installation using Docker
**One-Line Installation**: To quickly get Pi Panel up and running with Docker, use the following command:
```bash
docker run -d --name pi-panel -p 3000:3000 roodycode/pi-panel:latest
```
Made in 2020
| Pi-Panel: Your personal hub for keeping an eye on your Raspberry Pi's performance. | dashboard,hardware-monitoring,javascript,monitoring,raspberry-pi,raspberrypi,raspi | 2023-11-02T13:22:16Z | 2024-03-08T10:22:17Z | null | 1 | 0 | 8 | 0 | 0 | 2 | null | null | JavaScript |
sixcolors/gofiber-react-session-csrf-example | main | # Example GoFiber Backend with React Frontend using Sessions and CSRF
This is an example of a GoFiber backend with a React frontend that uses sessions and CSRF tokens.
Inspired by https://redis.com/blog/json-web-tokens-jwt-are-dangerous-for-user-sessions/ and developer questions about such a use case on the GoFiber discord server.
It uses an nginx reverse proxy to serve the frontend and backend on the same port. The backend is served on `/api` and the frontend is served on `/`.
This example is not complete and therefore should not be used in production.
It still needs the following:
- [x] Docker compose for development (see [docker-compose.yml](docker-compose.yml))
- [x] React Dev Tools do not work with the proxy, fix
- [x] Go Delve remote debugger (see [launch.json](.vscode/launch.json)) `Docker: Attach to Go (Delve)` config for debugging the backend in VSCode
- [x] React debugging (see [launch.json](.vscode/launch.json)) `Launch Chrome against localhost` config for debugging the frontend in VSCode
- [ ] Seperate frontend and backend docker containers
- [ ] SECURE Dockerfiles (ie dont run as root etc)
- [ ] Secure handling of login credentials in the backend
- [x] Timeouts on the frontend
- [x] Mechanism to refresh auth status on the frontend (if auth error happens, or the user does something that changes their auth status)
- [x] TODO: session timeout in the front end with multiple tabs open could cause the session to be extended indefinitely, fix
- [ ] Some browsers (Safari) will not offer to save passwords when using fetch and require a page load to trigger the save password dialog, fix
## Development
A docker-compose file is provided for development. It will start the backend, frontend and a redis cache.
```bash
docker-compose up
```
The server will be available at [http://localhost:8080](http://localhost:8080).
To support web socket based hot reloading of the frontend, Ngix is configured to proxy_pass `/ws` requests to the frontend container.
Note: React Dev Tools require ENV `WDS_SOCKET_PORT` to be set to `8080` to work with the proxy, (see [react-app/Dockerfile.dev](react-app/Dockerfile.dev)).
The backend will be restarted when changes are made to the backend code using [air](https://github.com/cosmtrek/air).
Go delve remote debugger will be available at [http://localhost:2345](http://localhost:2345) (see [launch.json](.vscode/launch.json)) `Docker: Attach to Go (Delve)` config for debugging the backend in VSCode.
## Production
```bash
docker build -t gofiber-react-session-csrf-example .
docker run -p 8080:8080 gofiber-react-example
```
The server will be available at [http://localhost:8080](http://localhost:8080).
## Credentials
There are two users:
- `admin` with password `admin`
- `user` with password `user`
## API
### `POST /api/auth/login`
request:
```json
{
"username": "admin",
"password": "admin"
}
```
response:
```json
{
"loggedIn": true,
"username": "admin",
"roles": ["admin", "user"],
"sessionTimeout": 3600 // seconds
}
```
### `POST /api/auth/logout`
request:
```json
{}
```
response:
```json
{
"loggedIn": false,
}
```
### `GET /api/auth/status`
response:
```json
{
"loggedIn": true,
"username": "admin",
"roles": ["admin", "user"],
"sessionTimeout": 3600 // seconds
}
```
### `GET /api/thingamabob`
response:
```json
{
[
{
"id": 1,
"name": "Thingamabob 1"
},
{
"id": 2,
"name": "Thingamabob 2"
}
]
}
```
### `POST /api/thingamabob`
request:
```json
{
"name": "Thingamabob 3"
}
```
response:
```json
{
"id": 3,
"name": "Thingamabob 3"
}
```
### `GET /api/thingamabob/:id`
response:
```json
{
"id": 1,
"name": "Thingamabob 1"
}
```
### `PUT /api/thingamabob/:id`
request:
```json
{
"name": "Thingamabob 1 Updated"
}
```
response:
```json
{
"id": 1,
"name": "Thingamabob 1 Updated"
}
```
### `DELETE /api/thingamabob/:id`
response:
```http
204 No Content
```
## License
MIT
| Example of a GoFiber backend with a React frontend that uses sessions and CSRF protection | csrf-protection,docker-compose,gofiber,golang,javascript,react,reverse-proxy,sessions | 2023-11-03T16:34:49Z | 2024-03-19T01:50:29Z | null | 1 | 7 | 38 | 0 | 1 | 2 | null | null | Go |
Alexandrbig1/goit-react-hw-03-phonebook | main | # **Phonebook**
<img align="right" src="https://media.giphy.com/media/du3J3cXyzhj75IOgvA/giphy.gif" width="100"/>
doing homework while studying in bootcamp @GoIT on Fullstack developer course
## Project Specifications:
React module(states/hooks/classes/localStorage/derivedStates/events/props/forms/libraries/Formik/Yup/ReactIcons/modernNormalize/styledComponents/nanoid)
## Languages and Tools:
<div align="center">
<a href="https://en.wikipedia.org/wiki/HTML5" target="_blank"><img style="margin: 10px" src="https://profilinator.rishav.dev/skills-assets/html5-original-wordmark.svg" alt="HTML5" height="50" /></a>
<a href="https://www.w3schools.com/css/" target="_blank"><img style="margin: 10px" src="https://profilinator.rishav.dev/skills-assets/css3-original-wordmark.svg" alt="CSS3" height="50" /></a>
<a href="https://www.javascript.com/" target="_blank"><img style="margin: 10px" src="https://profilinator.rishav.dev/skills-assets/javascript-original.svg" alt="JavaScript" height="50" /></a>
<a href="https://git-scm.com/" target="_blank" rel="noreferrer"> <img src="https://www.vectorlogo.zone/logos/git-scm/git-scm-icon.svg" alt="git" width="40" height="40"/> </a>
<a href="https://reactjs.org/" target="_blank" rel="noreferrer"> <img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/react/react-original-wordmark.svg" alt="react" width="40" height="40"/> </a>
</div>
## Connect with me:
<div align="center">
<a href="https://linkedin.com/in/alex-smagin29" target="_blank">
<img src=https://img.shields.io/badge/linkedin-%231E77B5.svg?&style=for-the-badge&logo=linkedin&logoColor=white alt=linkedin style="margin-bottom: 5px;" />
</a>
<a href="https://github.com/alexandrbig1" target="_blank">
<img src=https://img.shields.io/badge/github-%2324292e.svg?&style=for-the-badge&logo=github&logoColor=white alt=github style="margin-bottom: 5px;" />
</a>
<a href="https://stackoverflow.com/users/22484161/alex-smagin" target="_blank">
<img src=https://img.shields.io/badge/stackoverflow-%23F28032.svg?&style=for-the-badge&logo=stackoverflow&logoColor=white alt=stackoverflow style="margin-bottom: 5px;" />
</a>
<a href="https://dribbble.com/Alexandrbig1" target="_blank">
<img src=https://img.shields.io/badge/dribbble-%23E45285.svg?&style=for-the-badge&logo=dribbble&logoColor=white alt=dribbble style="margin-bottom: 5px;" />
</a>
<a href="https://www.behance.net/a1126" target="_blank">
<img src=https://img.shields.io/badge/behance-%23191919.svg?&style=for-the-badge&logo=behance&logoColor=white alt=behance style="margin-bottom: 5px;" />
</a>
</div>
| React module(events/states/props/forms/localStorage/libraries) | css3,frontend,hacktoberfest,hacktoberfest2023,html-css-javascript,html5,javascript,js,localstorage,react | 2023-10-17T16:27:43Z | 2023-10-17T16:55:41Z | null | 1 | 0 | 4 | 0 | 0 | 2 | null | null | JavaScript |
you97ssef/MicroShop | main | # MicroShop
This is a project that is designed on a microservices architecture, built on different languages and frameworks and can run on docker containers using custom docker images and Docker Compose. These microservices are interconnected to each other via a gateway, each serving specific functionalities and domains. The microservices included in this repository are:
- **DataVortex**: PostgreSQL provider with the capability to pre-create databases.
- **UserVerse**: User management API REST microservice responsible for user authentication and authorization. Developed using PHP and Lumen.
- **ProdCat**: Product catalog API REST microservice handling product and category management, as well as search and filtering functionalities. Built using Golang and Gin with a custom architecture.
- **OrderPro**: Order processing API REST microservice managing order-related tasks and processing. Developed using C# and .NET Core.
- **PayShip**: Payment and shipping API REST microservice overseeing payment and shipping management and processing. Developed using Node.js and Express.
- **Gatekepper**: Gateway API REST microservice managing routing and interconnection between the microservices. Developed using Node.js with TypeScript and Nest.js.
## Prerequisites
Before running these microservices, ensure that you have Docker and Docker Compose installed on your machine. Alternatively, you can refer to the readme file of each microservice for specific instructions on how to run it.
## Running the Microservices
To run this project microservices, follow these steps:
1. Clone this repository to your local machine.
2. Open a terminal and navigate to the root directory of the repository.
3. Run the following command to start the microservices:
```
docker-compose up
```
This will start the microservices.
4. Once the microservices are running, you can access the infrastructure gateway using the following URL:
```
http://localhost:8000
```
## Controlling the Microservices
To control the microservices, you can use the following commands:
```bash
# Start the microservices in the background
docker-compose up -d
# Stop the microservices
docker-compose stop
# Start the microservices
docker-compose start
# Stop and remove the microservices
docker-compose down
# Stop and remove the microservices, as well as all their dependencies
docker-compose down --rmi all --volumes --remove-orphans
```
## Documentation
you'll find a postman collection file **Microshop.postman_collection.json** in the root directory of this repository. This file contains all the API endpoints of the microservices, as well as the required parameters to the gateway of the application.
You can also find the documentation of the infrastructure in the following link:
[MicroShop Documentation](https://documenter.getpostman.com/view/13996413/2s9YeEcsJi)
## License
This code is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
| The Microservices Shop API application is designed to showcase the seamless integration of microservices written in diverse languages and frameworks, along with their deployment utilizing Docker images and Docker Compose. | asp-net-core,csharp,docker,docker-compose,express,gin-gonic,golang,javascript,lumen,nestjs | 2023-10-26T22:07:41Z | 2024-02-06T10:17:34Z | null | 1 | 9 | 117 | 1 | 0 | 2 | null | MIT | Go |
fadrian06/JSPHP | main | # Wait... JS and PHP? How's that?
> Nota: Esta documentación está siendo traducida: [> Ver en español](https://github.com/fadrian06/JSPHP/blob/docs/LEAME.md)
📚 JSPHP is a powerful PHP library that provides a set of classes designed to mimic the behavior of **JavaScript's primitive classes** such as Number, String, and more.
🎯 With JSPHP, PHP developers can leverage familiar JavaScript concepts and functionalities in their PHP projects. 🌈
This library aims to bridge the gap between JavaScript and PHP, allowing developers to write cleaner and more efficient code.
> **✨ Whether you're a PHP developer looking to explore JavaScript-like features or a JavaScript developer working with PHP, JSPHP is the perfect tool to enhance your development experience. 💪**
>
> **Give your PHP projects a touch of JavaScript with JSPHP! 🚀**
## Requirements
- [PHP version 7 or greater](https://php.net)
## Installation
🚀 Getting started with using JSPHP is super easy! Just follow these simple steps:
**1- First, install JSPHP using composer:**
```bash
composer require faslatam/jsphp
```
**2. Include the composer autoloader:**
```php
<?php
require '/path/to/vendor/autoload.php';
# Finally, you're all set! You can now start using JSPHP in your projects.
$name = String('foo');
echo $name->toUpperCase(); # Output: FOO
$user = JSON::parse('{ "id": 1, "name": "foo" }');
echo $user->name; # Output: foo
$colors = JSArray(['red', 'purple', 'black']);
$colors->forEach(function (?string $color): void {
echo "I like the color $color\n";
});
echo "\ncolors = $colors";
/* Output:
----------
I like the color red
I like the color purple
I like the color black
colors = red,purple,black
*/
```
## Components
JSPHP is divided in components that are equivalent to JS classes. Some components
are under development, feel free to contribute adding extra functionalities.
> [> See documentation](https://fadrian06.github.io/JSPHP/)
| Component | Status |
|-------------------------------------------------------------------------|--------------------------|
| [JSON](https://fadrian06.github.io/JSPHP/classes/JSON.html) | ℹ️ _(under development)_ |
| [Math](https://fadrian06.github.io/JSPHP/classes/Math.html) | ℹ️ _(under development)_ |
| [JSString](https://fadrian06.github.io/JSPHP/classes/JSString.html) | ℹ️ _(under development)_ |
| [JSNumber]() | ❌ _(unimplement)_ |
| [JSArray]() | ℹ️ _(under development)_ |
| [JSObject]() | ❌ _(unimplement)_ |
| [undefined](https://fadrian06.github.io/JSPHP/files/src-undefined.html) | ✅ _(finished)_ |
| 🌟 Give your PHP projects a touch of JavaScript with JSPHP! ✨ | javascript,library,open-source,php | 2023-10-22T03:34:15Z | 2024-04-13T00:13:28Z | null | 2 | 0 | 57 | 0 | 0 | 2 | null | MIT | PHP |
Hixon10/TOTP-authenticator-telegram-bot | main | # Generate 2FA TOTP codes from telegram bot
**!!! DO NOT USE THIS BOT FOR ANYTHING, WHAT IS IMPORTANT FOR YOU. IT IS JUST A TOY PROJECT. FOR IMPORTANT STUFF, USE Google Authenticator, or Microsoft Authenticator. !!!**
[This bot](https://t.me/TotpAuthenticatorBot) allows to generate 2FA TOTP codes for two-factor authentication. Basically, it is a simple Authenticator, in case if you want to generate TOTP codes from any your device, which has access to your telegram account.
It is your responsibility to use strong `SECRET_ENCODING_PASSWORD`, which is used to encrypt a `secret`.
The bot is implemented on top of [Cloudflare Workers](https://workers.cloudflare.com/) and [Workers KV](https://www.cloudflare.com/products/workers-kv/).
The worker `AES-CBC` encrypts secrets, before saving to the `Workers KV`. Encryption key are stored inside [Cloudflare Secrets](https://blog.cloudflare.com/workers-secrets-environment/).
## Security vulnerability
This solution is not secure by any means. You send a `secret` via regular telegram message (during `save` stage), so anyone, who can read it (e.g., telegram employees, cloudflare employees, or anyone, who has direct access to your mobile phone) will be able to generate TOTP codes for your accounts. Therefore, **do not use this bot** for anything, what has any value for you.
## Credits
1. [https://github.com/hectorm/otpauth](https://github.com/hectorm/otpauth) - I use it to generate TOTP codes.
2. [https://github.com/my-telegram-bots/hitokoto_bot](https://github.com/my-telegram-bots/hitokoto_bot) - I use it as a telegram bot template.
3. [https://bitwarden.com/help/article/what-encryption-is-used/](https://bitwarden.com/help/article/what-encryption-is-used/) and [https://bitwarden.com/help/crypto](https://bitwarden.com/help/crypto) - I use it for cryptography-related code (secret encryption/decryption).
4. [https://www.cloudflare.com/](https://www.cloudflare.com/) - I use it as free telegram bot hosting.
## Available bot commands:
1. **save** - `/save ISSUER_NAME SECRET_ENCODING_PASSWORD SECRET`
2. **generate** - `/generate ISSUER_NAME SECRET_ENCODING_PASSWORD`
3. **myissuers** - Get list of your issuers
4. **deleteissuers** - Delete all your issuers
5. **help** - How to use the bot
6. **about** - Info about bot
## How to self host the bot.
1. Firstly, you need to create [Workers KV](https://www.cloudflare.com/products/workers-kv/), which will be used as secret storage. I define a store in `wrangler.toml` file. You need to change a ID of `HOTP_AUTHENTICATOR_MANAGER` store.
2. Secondly, you need to create [Worker](https://workers.cloudflare.com/) and copy a code from this repo.
3. Thirdly, you need to set up previously created storage (step 1) for the Worker. You could do this either via [dashboard](https://dash.cloudflare.com), or using [Wrangler](https://developers.cloudflare.com/workers/cli-wrangler).
4. After that, you need to configure the following Secrets for your worker: `BOT_TOKEN` (you can get it via [@BotFather](https://t.me/BotFather)), `MASTER_PASSWORD` (crypto random string), `MASTER_PASSWORD_SALT` (crypto random string). Again, you can use either the dashboard, or CLI.
5. Finally, you need to set up `Telegram Bot Webhooks` for created worker - `curl -F "url=https://<YOURDOMAIN.EXAMPLE>/<WEBHOOKLOCATION>" https://api.telegram.org/bot<YOURTOKEN>/setWebhook`
6. You can use `wrangler deploy` command, or `Cloudflare dashboard` to deploy a bot.
## Telegram bot authentication
Unfortunately, there is no way to correctly implement authentication for a telegram bot. Their [documentation](https://core.telegram.org/bots/api#setwebhook) says:
> If you'd like to make sure that the Webhook request comes from Telegram, we recommend using a secret path in the URL, e.g. https://www.example.com/<token>. Since nobody else knows your bot's token, you can be pretty sure it's us.
> If you want to limit access to Telegram only, please allow traffic from 149.154.167.197-233 (starting July 2019 please use: 149.154.160.0/20 and 91.108.4.0/22). Whenever something stops working in the future, please check this document again as the range might expand or change.
For me, it looks super unreliable. Instead, I would expect to have `mTLS`. Unfortunately, we don't have such thing at present. Therefore, we must use secret path for `Cloudflare worker`, and check client IPs:
```javascript
if (!(inSubNet(clientIP, '149.154.160.0/20') ||
inSubNet(clientIP, '91.108.4.0/22'))) {
// https://core.telegram.org/bots/webhooks#an-open-port
console.log("[ERROR] received request from non telegram IP: ", clientIP)
return new Response('ok: ', {status: 200})
}
```
| A telegram bot, which issues TOTP codes for two-factor authentication | 2fa,authenticator,cloudflare-workers,hotp,javascript,telegram-bot,two-factor-authentication,autentificator,totp | 2023-10-22T21:53:31Z | 2023-10-22T22:58:48Z | null | 1 | 0 | 9 | 0 | 0 | 2 | null | MIT | JavaScript |
kom-senapati/30-Days-Coding-Challenges | main | # 30 Days of Coding Challenges 🚀💻
Welcome to my coding challenge repository! Here, I document my journey of tackling various coding challenges. Feel free to explore, and if you're up for the challenge, join in!
<!--
completed = 
active = 
-->
| Challenges | State |
| ------------- | :-----------: |
| 30 days of JavaScript X Scaler Topics |  |
| 30 Days of Node.js |  |
| 30 days of Arrays & Linked lists |  |
## About This Repository
This repository is a collection of my coding journey, where I take on coding challenges to improve my skills. The challenges cover a variety of topics and difficulty levels. Feel free to use this repository as inspiration for your coding adventures.
If you decide to take on similar challenges or have suggestions for new ones, don't hesitate to let me know!
Happy coding! 🚀💻
| Diving into a sea of coding challenges! 🌊💻 | javascript,nodejs | 2023-11-06T13:19:27Z | 2024-05-04T12:49:01Z | null | 1 | 0 | 82 | 0 | 0 | 2 | null | null | JavaScript |
luciana-pereira/portal-esg | master | # Plataforma ESG
`CURSO: Sistemas para Internet | FIAP`
`ATIVIDADE: Plataforma ESG`
## :page_facing_up: Índice
* [1. Sobre](#1-sobre)
* [2. Planejamento Ágil](#2-planejamento-ágil)
* [3. Prótotipo](#3-prótotipo)
* [4. Tecnologias e Ferramentas externas utilizadas](#4-tecnologias-e-ferramentas-externas-utilizadas)
* [5. Desenvolvedores](#5-desenvolvedores)
## 1. Sobre
A <b>[ESG Game](https://portal-esg.vercel.app/login)</b> é uma plataforma gamificada, focada na promoção de práticas sustentáveis e responsáveis, alinhadas aos princípios do ESG para empresas e seus colaboradores, foi desenvolvido para o curso de graduação de Sistemas para Internet da FIAP. </br></br>
<div align="center">
<a href="https://portal-esg.vercel.app/login">
<img width="957" alt="tela de login" src="https://github.com/luciana-pereira/portal-esg/assets/37550557/0febd05c-9c02-4e57-9e5b-44ce1bd062ae">
</a>
</div>
## 2. Planejamento Ágil
:memo:
Utilizamos da Kanban da aba projects do GitHub para planejar as ideais e organizar as tarefas, colocando em nosso backlog os itens prioritarios para realizar o desenvolvimento e divindo entre o grupo para realização da parte funcional do portal.
## 3. Prótotipo
O projeto foi desenvolvido utilizando protótipo realizado no Figma. Para ter acesso ao prótipo e todas as informações sobre, acesse [AQUI](https://www.figma.com/file/tj9NEyoRzty4XpIovI0uh5/ESG?type=design&node-id=0-1468&mode=design&t=f7e48BfsT1yqImOC-0)
## 4. Tecnologias, APIs e Ferramentas externas utilizadas
### Firebase
Está ferramenta foi utilizada para autenticação de usuários, e armazenamento de dados com **Firestore**, usamos o Firebase como um serviço de backend para o aplicativo e integrá-lo com o **Firestore** para armazenamento e recuperação de dados do usuario.</br></br>
## 5. Desenvolvedores
:octocat:
Esta aplicação foi desenvolvida por:
<table align="center">
<tr>
<td align="center">
<a href="https://github.com/flavialbraz" target="_blank">
<img src="https://avatars.githubusercontent.com/u/78583429?v=4" width="100px;" alt="Foto de Flavia no GitHub"/><br>
<sub>
<b>Flavia </b>
</sub>
</a>
</td>
<td align="center">
<a href="https://github.com/luciana-pereira" target="_blank">
<img src="https://avatars.githubusercontent.com/u/37550557?v=4" width="100px;" alt="Foto de Fernanda no GitHub"/><br>
<sub>
<b>Luciana Pereira</b>
</sub>
</a>
</td>
<td align="center">
<a href="https://github.com/matheus-poro" target="_blank">
<img src="https://avatars.githubusercontent.com/u/111644802?v=4" width="100px;" alt="Foto de Matheus Cavalcante no GitHub"/><br>
<sub>
<b>Matheus Cavalcante</b>
</sub>
</a>
</td>
<td align="center">
<a href="https://github.com/TobiasGustavo" target="_blank">
<img src="https://avatars.githubusercontent.com/u/88210620?v=4" width="100px;" alt="Foto de Tobias Soares no GitHub"/><br>
<sub>
<b>Tobias Soares</b>
</sub>
</a>
</td>
</tr>
</table>
| Este projeto consiste em uma plataforma gamificada, chamada ESG Game, focada na promoção de práticas sustentáveis e responsáveis, alinhadas aos princípios do ESG para empresas e seus colaboradores. | esg,fiap,fiap-project,firebase,firebase-auth,firestore,javascript,js,jsx,react | 2023-10-16T12:12:36Z | 2024-05-05T15:52:06Z | null | 4 | 1 | 20 | 9 | 0 | 2 | null | null | TypeScript |
rupeshtiwari/nodejs-bookstore | main | Node.js Microservices: Advanced Topics and Best Practices
=========================================================
**Subtitle**: Mastering the Art of Building Scalable and Efficient Microservices with Node.js
What You Will Learn:
--------------------
- Deep understanding of microservices architecture and its advantages.
- Implementing Domain-Driven Design (DDD) in microservices.
- Advanced techniques like CQRS, Event Sourcing, and database sharding.
- Best practices for scaling, optimizing, and securing your microservices.
Target Audience:
----------------
- Advanced developers looking to upskill in microservices architecture.
- Professionals who are working with Node.js and want to dive deep into microservices.
Course Includes:
----------------
- **180 minutes** of on-demand video.
- **15+** hands-on demos.
- **5** practical exercises.
Course Content:
---------------
### Module 1: Implementing Domain-Driven Design (DDD) in Microservices
**Learning Goals**: Understand the principles of DDD and how to apply them in a microservices architecture. **Concepts Covered**: Basics of DDD, Bounded Contexts, Aggregates, Entities, Value Objects. **Total Time**: 36 mins
#### Clips:
1. **Introduction to DDD (6 mins)**
- **Description**: Overview of DDD and its importance in microservices.
- **Concepts**: What is DDD? Why use DDD in microservices?
2. **Bounded Contexts in Microservices (8 mins)**
- **Description**: Dive into bounded contexts and their role in defining microservice boundaries.
- **Concepts**: Bounded Context, Context Mapping.
- **Demo**: Defining bounded contexts for the BookStoreHub platform.
3. **Working with Aggregates and Entities (10 mins)**
- **Description**: Understand the role of aggregates and entities in DDD.
- **Concepts**: Aggregates, Entities, Lifecycle.
- **Demo**: Designing the Book entity for the BookStoreHub.
4. **Value Objects in DDD (8 mins)**
- **Description**: Explore value objects and their significance.
- **Concepts**: Value Objects, Immutability.
- **Demo**: Implementing a Price value object for books.
### Module 2: Command Query Responsibility Segregation (CQRS) and Event Sourcing
**Learning Goals**: Grasp the principles of CQRS and Event Sourcing and their benefits in a microservices setup. **Concepts Covered**: CQRS Basics, Event Sourcing, Event Store, Projections. **Total Time**: 36 mins
#### Clips:
1. **Introduction to CQRS (6 mins)**
- **Description**: An overview of CQRS and its advantages.
- **Concepts**: What is CQRS? Why use CQRS in microservices?
2. **Diving into Event Sourcing (10 mins)**
- **Description**: Understand event sourcing and its role in maintaining system state.
- **Concepts**: Event Sourcing, Benefits, Challenges.
- **Demo**: Implementing event sourcing for the BookStoreHub's order service.
3. **Setting Up an Event Store (10 mins)**
- **Description**: Learn about the event store and how to set it up.
- **Concepts**: Event Store, Storing Events, Retrieving Events.
- **Demo**: Setting up an event store for the BookStoreHub.
4. **Working with Projections (8 mins)**
- **Description**: Explore projections and their role in querying data.
- **Concepts**: Projections, Read Models.
- **Demo**: Creating projections for the BookStoreHub's inventory service.
### Module 3: Scaling and Optimizing Your Microservices
**Learning Goals**: Learn strategies to scale microservices and optimize their performance. **Concepts Covered**: Load Balancing, Service Discovery, Database Sharding, Caching. **Total Time**: 36 mins
#### Clips:
1. **Introduction to Microservices Scaling (6 mins)**
- **Description**: Overview of the need and methods to scale microservices.
- **Concepts**: Why scale? Horizontal vs. Vertical scaling.
2. **Load Balancing in Microservices (8 mins)**
- **Description**: Understand the role of load balancers in distributing traffic.
- **Concepts**: Load Balancing, Types of Load Balancers.
- **Demo**: Setting up a load balancer for the BookStoreHub services.
3. **Service Discovery Patterns (10 mins)**
- **Description**: Dive into service discovery mechanisms in a microservices ecosystem.
- **Concepts**: Service Discovery, Service Registry.
- **Demo**: Implementing service discovery for the BookStoreHub.
4. **Database Sharding and Caching (10 mins)**
- **Description**: Techniques to optimize database performance in microservices.
- **Concepts**: Database Sharding, Caching Strategies.
- **Demo**: Implementing database sharding for the BookStoreHub's user service.
### Module 4: Microservices Security Best Practices
**Learning Goals**: Understand the security challenges in microservices and how to address them. **Concepts Covered**: Authentication, Authorization, API Gateways, Encryption. **Total Time**: 36 mins
#### Clips:
1. **Security Challenges in Microservices (6 mins)**
- **Description**: Overview of security concerns in a microservices setup.
- **Concepts**: Common security threats, Importance of security.
2. **Authentication and Authorization (10 mins)**
- **Description**: Dive into securing microservices using authentication and authorization.
- **Concepts**: JWT, OAuth2.0, Role-Based Access Control.
- **Demo**: Implementing JWT authentication for the BookStoreHub.
3. **API Gateways and Security (10 mins)**
- **Description**: Understand the role of API gateways in securing microservices.
- **Concepts**: API Gateways, Rate Limiting, Threat Detection.
- **Demo**: Setting up an API gateway with security policies for the BookStoreHub.
4. **Data Encryption and Secure Communication (8 mins)**
- **Description**: Techniques to ensure data security and secure communication between services.
- **Concepts**: Data Encryption, HTTPS, Mutual TLS.
- **Demo**: Implementing data encryption for sensitive data in the BookStoreHub.
### Module 5: Techniques for Refactoring Monolith to Microservices
**Learning Goals**: Understand the process of transitioning from a monolithic architecture to microservices. **Concepts Covered**: Monolithic Architecture, Strangler Pattern, Decomposition Strategies. **Total Time**: 36 mins
#### Clips:
1. **Monolith vs. Microservices (6 mins)**
- **Description**: A comparison of monolithic and microservices architectures.
- **Concepts**: Advantages and Disadvantages, When to choose which?
2. **Strangler Pattern Explained (8 mins)**
- **Description**: Dive into the Strangler pattern and its role in refactoring.
- **Concepts**: Strangler Pattern, Incremental Refactoring.
- **Demo**: Applying the Strangler pattern to a section of the BookStoreHub.
3. **Decomposition Strategies (12 mins)**
- **Description**: Techniques to break down a monolith into microservices.
- **Concepts**: Decomposition by Business Capability, by Subdomain.
- **Demo**: Decomposing the BookStoreHub's inventory module.
4. **Challenges and Best Practices (8 mins)**
- **Description**: Addressing common challenges and following best practices during refactoring.
- **Concepts**: Data Consistency, Communication Overhead, Best Practices.
- **Demo**: Addressing data consistency challenges in the BookStoreHub.
| Explore advanced Node.js microservices in this course, covering Domain-Driven Design, CQRS, Event Sourcing, and database sharding. Includes 180 minutes of video, 15+ demos, and practical exercises for advanced developers. | docker,javascript,kubernetes,minikube,nodejs | 2023-10-27T03:13:40Z | 2024-04-23T13:25:16Z | null | 1 | 0 | 54 | 0 | 0 | 2 | null | null | JavaScript |
heybran/nodejs-web-components-jobs-tracker | main | # Jobs Tracker
A jobs tracker application built with vanilla `Web Components` as frontend and `Node.js` as backend.
## Motivation.
I have been hunting for new remote front-end developer jobs for the last few months. As a developer I hate to keep track of the companies that I have applied with Excel, so I create this jobs tracker to improve the whole experience. This project is intended to run locally.
This is a refactoring of another project of mine (private repo) which is built with `Web Components` as frontend and `PHP` as backend with `AWS DynamoDB`.
## Tech Stack
- Web Components
- [Cucumber Components](https://github.com/heybran/cucumber-components)
- Node.js/Express.js
- XATA Database (https://xata.io/)
| A jobs tracker application built with vanilla Web Components as frontend and Node.js as backend. | javascript,nodejs,webcomponents | 2023-11-07T03:13:25Z | 2023-11-14T01:22:42Z | null | 1 | 2 | 24 | 0 | 0 | 2 | null | MIT | HTML |
Piercel2022/Ecom-world | main | <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
<!-- 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](#faq)
- [📝 License](#license)
# 📖 Ecom world <a name="about-project"></a>
**Ecom world** is a complete E-Commerce App or a shopping App With React. The project set up and configure React and Redux to create a simple ecommerce store, complete with checkout and payment processing!
## 🛠 Built With <a name="built-with"></a>
### Tech Stack <a name="tech-stack"></a>
<details>
<summary>Client</summary>
<ul>
<li><a href="https://reactjs.org/">React.js</a></li>
</ul>
</details>
<details>
<summary>Server</summary>
<ul>
<li><a href="https://node.org/">Node.js</a></li>
</ul>
</details>
<details>
<summary>Database</summary>
<ul>
<li><a href="https://www.mongodb.com/">Mongo</a></li>
</ul>
</details>
<!-- Features -->
### Key Features <a name="key-features"></a>
- **Main homepage**
- **React Rating**
- **React Marquee**
- **Add differents categories**
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- LIVE DEMO -->
## 🚀 Live Demo <a name="live-demo"></a>
- [Ecom world](https://ecom-world.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:
```sh
npm install react-router-dom --save
```
### Setup
Clone this repository to your desired folder:
```sh
git clone git@github.com:Piercel2022/Ecom-world.git
cd ecommerce-app
```
### Install
Install this project with:
```sh
npx create-react-app ecommerce-app --template-redux
cd ecommerce-app
```
### Usage
To run the project, execute the following command:
```sh
npm start
```
### Deployment
You can deploy this project using: Netlify
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 👥 Author <a name="authors"></a>
- GitHub: [@gPiercel2022](https://github.com/Piercel2022)
- Twitter: [@pier_celestin](https://twitter.com/pier_celestin)
- LinkedIn: [Piercel2022](https://linkedin.com/in/piercelestinmax)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 🔭 Future Features <a name="future-features"></a>
- [ ] **Checkout Page**
- [ ] **Compare Products**
- [ ] **Like Products**
<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...
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 🙏 Acknowledgments <a name="acknowledgements"></a>
I would like to thank...
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- LICENSE -->
## 📝 License <a name="license"></a>
This project is [MIT](./LICENSE) licensed.
| Ecom world is a complete E-Commerce App or a shopping App With React. The project set up and configure React and Redux to create a simple ecommerce store, complete with checkout and payment processing! | bootstrap5,css3,html5,javascript,reactjs,redux-toolkit | 2023-10-20T21:37:38Z | 2023-11-16T13:37:10Z | null | 1 | 52 | 542 | 0 | 1 | 2 | null | MIT | JavaScript |
makslasard/liga-2 | main | # Репозиторий для хранения домашних заданий - liga
- Каждая домашка в отдельной ветке
| Репозиторий для хранения домашних заданий - стажировка liga | css3,html5,javascript,typescript | 2023-10-23T11:31:04Z | 2023-11-15T11:32:46Z | null | 1 | 18 | 42 | 0 | 0 | 2 | null | MIT | TypeScript |
makslasard/liga-2 | main | # Репозиторий для хранения домашних заданий - liga
- Каждая домашка в отдельной ветке
| Репозиторий для хранения домашних заданий - стажировка liga | css3,html5,javascript,typescript | 2023-10-23T11:31:04Z | 2023-11-15T11:32:46Z | null | 1 | 18 | 42 | 0 | 0 | 2 | null | MIT | TypeScript |
SartajPrattoy/Smart-Wear | main | # Smart-Wear
using Laravel as the framework this Project delivers an E-commerce rental website; a smart way to rent cloths for user and vendor business
# SmartWear - A cloathing Rental website
# Project Details
-[Framework: Laravel]
- [Backend: MySQL, XAMBP]
# Sprints : Admin Panel
-[Login & Registration,Product Management,Add Product,View, Edit & Delete Product,Category & Apparel Management, Admin Interface]
# Home / Shop
- Homepage Products Display: Showcasing featured product on the website's home page.
- Products Page:
Size, Description, Price, Days, Vendor Name Display
Sort Products
Search Products
- Cart:
Update,
IP Handling
- Customer Review
- User Authentication
# User Dashboard
- View Profile
- Payment Gateway Implementation
- Order Confirmation
- Edit Profile
- Order Management:
View Orders
View Return Dates
# Vendor Management
- Vendor Registration approval from admin required
- Vendor Authentication:
- Product Submission
- Order Management
- Vendor Interface
Dashboard, Sidebar & Navbar: Convenient navigation for vendor tasks.
- Admin Panel Interaction:
Vendor Account Request
View & Remove Vendors
Product Post Requests
It was a project for System Design Course so along with me[Shihab and Nusaiba] two more people worked on this project.
[Sartaj Emon Prattoy](https://github.com/SartajPrattoy)
Thank you for visiting in SmartWear. For any questions or feedback, feel free to contact me at tajemon9@gmail.com. Happy coding!
| using Laravel as the framework this Project delivers an E-commerce rental website; a smart way to rent cloths for user and vendor business | css,html,javascript,laravel,php | 2023-10-14T18:57:56Z | 2023-10-14T20:10:39Z | null | 1 | 0 | 7 | 0 | 0 | 2 | null | MIT | HTML |
ZeroDayArcade/HTML5_Raycaster | main | # HTML5 Raycasting
This project consists of raycasting demos built in JavaScript. The vector based example is a port of Lode Vandevenne's C++ raycaster to JavaScript/HTML5: <a href="https://zerodayarcade.com/demos/raycaster">Live Demo</a>. <br/><br/>
I've also included a euclidean angles example and a debugging version showing the overhead 2D view along side the rendered raycaster. These are meant to serve as a jumping off point for you to build a Wolfenstein 3D style raycasting game in the browser, or to learn about how raycasters work. In my opinion, the modern browser is a fantastic medium for this.
<img width="1141" alt="rc1" src="https://github.com/ZeroDayArcade/HTML5_Raycaster/assets/141867962/76cc2bf1-64bf-4e83-9025-2b43de7245d6">
I've set the maps to the same layout in each approach for comparison. All demos should look nearly identical when rendered. The vectors-based version uses less code and is a good choice for building off of, while the euclidean example uses angles intuitively and works in a similar way to many other raycasters.
## Euclidean Version
By "euclidean" it is simply meant that we are using a player angle, field of view (fov) and iterating through that fov at different ray angles calcuated based on the player angle, fov and current ray number. We then use a series of trigonometric calculations to cast rays and determine the ultimate line height for each ray. This version uses one of the most common techniques for raycasting and is relatively intuitive when programming game logic by thinking in terms of the player's xy position and angle. Like other examples that use this technique, "fisheye" correction is needed before rendering, though this only amounts to multiplying the calculated distance by the cosine of the playerAngle - rayAngle.
<img width="280" alt="rc4" src="https://github.com/ZeroDayArcade/HTML5_Raycaster/assets/141867962/17448fa1-0a6f-4ba2-9733-6e86bdcf6ddf"> <img width="498" alt="rc3" src="https://github.com/ZeroDayArcade/HTML5_Raycaster/assets/141867962/baf340ae-541f-4cd4-8124-2adbfc59783f">
## Vectors Version
This version primarily uses vectors in XY space rather than doing a series of trigonometric calculations. Though initially thinking in terms of fov and player angle can be intuitive, ultimately the same calculations can be accomplished more efficiently and with less code using a vector based approach. This version is ported from Lode Vandevenne's C++ tutorial into a JavaScript version. See his excellent tutorial here: https://lodev.org/cgtutor/raycasting.html
## 2D View and Debugging
It can both be informative in learning about how raycasters work, as well as extremely useful for debugging to see the overhead 2D view that the raycaster builds it's semi 3D graphics from. I've included a debugging version here to show the two side-by-side. This can be very helpful for designing levels and testing. Because more rendering is needed to show both, you'll probably want to run this at a lower frame rate which can easily be changed in the section toward the bottom of the code by changing the value of the FPS variable.
<img width="1141" alt="rc1" src="https://github.com/ZeroDayArcade/HTML5_Raycaster/assets/141867962/8fd4b4ab-d9ae-4c8c-a518-27ea0091f56f">
## Texturing Walls, Adding Ceilings and Floors
These demos are meant as a jumping off point and include single color walls with some basic lighting. Using textured walls like in Wolfenstein 3D and other famous raycasters is fairly straightforward, as is creating ceilings and floors. For this, I'll point you to Lode Vandevenne's fantastic tutorial:
Adding Textures: https://lodev.org/cgtutor/raycasting.html#Textured_Raycaster
Floors and Ceilings: https://lodev.org/cgtutor/raycasting2.html
<img width="396" alt="rc4" src="https://github.com/ZeroDayArcade/HTML5_Raycaster/assets/141867962/5ee239bf-d361-47d1-85b5-18fe368b7897">
## Sprites, Items, and Enemies
Sprites representing items and enemies can easily be added as well. Items/weapons can often be rendered as a simple overlay after walls have been rendered. For some really nice Wolfenstein-style sprites to play around with, checkout these sprites from a GZDoom mod by user itsmeveronica: https://www.moddb.com/mods/volkograd-3d/images/makarov-reload-animation#imagebox. You can right-click and save the images, and then load them into the canvas. For details on code implementation, see this tutorial: https://lodev.org/cgtutor/raycasting3.html
<img width="520" alt="rc4" src="https://github.com/ZeroDayArcade/HTML5_Raycaster/assets/141867962/550d1030-d47a-46fc-b103-7730b1febf88"><img width="280" alt="rc4" src="https://github.com/ZeroDayArcade/HTML5_Raycaster/assets/141867962/a5bf1123-9733-483d-b787-ff1589c6b9d9">
## Full 3D Graphics
Raycasters use a semi-3D graphics technique that takes advantage of the fact that there is no vertical movement or angling to greatly simplify the math and allow for level and game design strategies similar to 2D games while producing 3D looking graphics.<br/><br/>It is also possible to build full 3D graphics engines in JavaScript using software rendering where you explicitly calculate the 3D transformations and 3D→2D projections in the JavaScript code.
<p align="center">
<img width="618" alt="wcube" src="https://github.com/ZeroDayArcade/HTML5_Raycaster/assets/141867962/293f886e-13dd-4c80-b29a-740d4176d812">
</p>
Of course, you can always create more advanced and modern graphics by using GPU-accelerated 3D rendering as many HTML5 3D libraries do. But spending some time to learn how 3D graphics work with software rendering can improve your understanding and allow you to create 3D scenes and games on systems that have no native 3D hardware. For a very simple example of 3D software rendering in JavaScript, see this <a href="https://zerodayarcade.com/demos/3d-wireframe">Wireframe Demo</a> (and the <a href="https://github.com/ZeroDayArcade/HTML5_3D-Wireframe-Cube">Code</a>) which draws SVG polygons to the DOM to produce a rotating 3D cube.
### See the <a href="https://zerodayarcade.com/demos/raycaster">Live Raycasting Demo</a>
| A port of Lode Vandevenne's C++ raycaster example to JavaScript/HTML5. | cpp-port,gaming,graphics,graphics-programming,html5,html5-game-development,javascript,js-port,port,raycaster | 2023-10-17T23:58:12Z | 2023-10-18T03:25:36Z | null | 1 | 0 | 8 | 0 | 0 | 2 | null | MIT | HTML |
Amadeo-Frontend/calculator-react | main | ##
<h1 align="center">Desafio de projeto da DIO 🏆</h1>
</br>
<div style="display: inline_block" align="center">
<img align="center" alt="Amadeo-ReactJs" src="https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB">
<img align="center" alt="Amadeo-HTML" src="https://img.shields.io/badge/JavaScript-323330?style=for-the-badge&logo=javascript&logoColor=F7DF1E">
<img align="center" alt="Amadeo-JavaScript" src="https://img.shields.io/badge/styled--components-DB7093?style=for-the-badge&logo=styled-components&logoColor=white">
</div>
</br>
## <p align="center">Essa calculadora feita com JavaScript, React e Styled-Components tem as seguintes funcionalidades
- Interface de usuário:
Exibe um display para entrada e exibição de números.
Possui botões numéricos de 0 a 9, botão "C" para limpar, botão de backspace, botões para operações de adição, subtração, multiplicação e divisão, botão de porcentagem e botão de igual.
- Funcionalidade de cálculo:
Permite que o usuário digite números e realize cálculos aritméticos básicos (adição, subtração, multiplicação, divisão).
Mostra o resultado no display.
Limpa o display quando necessário.
- Limitação de dígitos:
Limita a exibição no display a 12 dígitos no máximo.
- Controle por teclado:
Permite que o usuário use o teclado para inserir números e operadores.
- Estilo e animação:
Usa o Styled-Components para estilizar a interface de usuário.
Inclui uma barra que aparece quando não há entrada de texto no display e pisca para chamar a atenção.</p>
</br>
<div align="center">
<p align="center">LIVE:</p>
https://calculator-react-navy.vercel.app/
</div>
#
| null | javascript,react,styled-components | 2023-10-24T21:54:13Z | 2023-10-24T23:42:01Z | null | 1 | 0 | 3 | 0 | 0 | 2 | null | null | JavaScript |
MarkoTeixido/FunkoshopCaC-Backend | main |
# Funkoshop
¡Bienvenido a Funkoshop!
Esta es una aplicación web que simula un E-Commerce real. Ofrece funcionalidades completas de creación, visualización, actualización y eliminación de productos (CRUD). Además, permite el registro y el inicio de sesión de usuarios, otorgando acceso al cliente a la parte administrativa para el manejo de la tienda online.
## Stack de Tecnologías🎇
**Design:** Figma
**Front-End:** EJS, CSS, Javascript
**Back-End:** MVC (Arquitectura), NodeJS, Express, BcryptJS
**Database:** MySQL, Sequelize(ORM)
## Comenzando 🚀
_Estas instrucciones te permitirán obtener una copia del proyecto en funcionamiento en tu máquina local para propósitos de desarrollo y pruebas._
### Instalación
> [!IMPORTANT]
> Es necesario ya tener instalado (y actualizados en versiones) NodeJS, NPM y GIT en tu máquina.
Primero que nada, debes descargar (.zip) o clonar el repositorio del proyecto de la siguiente manera:
```bash
git clone https://github.com/MarkoTeixido/FunkoshopCaC-Backend.git
```
Ahora que ya tienes el proyecto, puedes abrirlo en tu editor de codigo y desde la terminal del mismo, instalar las dependencias de la siguiente manera:
```bash
npm install
```
Ahora solo falta la parte de la base de datos para que tu proyecto funcione completamente.
> [!TIP]
> Si no tienes experiencia con base de datos, te recomiendo que crees una cuenta en AlwaysData y una vez hayas accedido, ve a la sección 'Databases' para crear una base de datos en MySQL y tambien, un usuario para que puedas acceder a la misma. Cuando hayas finalizado eso, puedes ir a https://phpmyadmin.alwaysdata.com/ y listo! Ahora puedes acceder con ese usuario a tu base de datos. 💪💪
En tu proyecto veras un archivo llamado 'markoadmin_funkoshopdb.sql' el cual en tu base de datos debes importar (o copiar el contenido y pegarlo como una consulta SQL) para armar la estructura que debe tener.
Ya casi tienes todo listo, solo queda un paso y es crear en tu proyecto un archivo .env, el cual debe contener la información de acceso a tu base de datos. Este archivo debe contener lo siguiente:
### Deployment
Para desplegar el proyecto de manera local:
```bash
npm start
```
O puede probarlo simplemente accediendo a este link: https://funkoshopcac.vercel.app/
> [!NOTE]
> Si experimenta fallas al acceder en vercel, puede ser que los servidores no esten funcionando muy bien debido a que es un servicio gratuito. Puede esperar o recargar el sitio.
## Autores 📌
_Este proyecto fue realizado en equipo junto a los siguientes integrantes:_
* **Yamila Lerman** - [https://github.com/yamilerman](https://github.com/yamilerman)
* **Tomás Rivetta** - [https://github.com/TomasRivetta](https://github.com/TomasRivetta)
| Simple E-Commerce App | css,ejs,javascript,mysql,nodejs,sequelize,express,mvc,responsive-design | 2023-11-07T22:31:42Z | 2023-12-20T17:47:28Z | null | 6 | 0 | 127 | 0 | 0 | 2 | null | null | CSS |
devp19/StockEye | main | null | 'StockEye' is a discord bot that automates the process of manual research labor. Built through node.js module, holding the capability of web scrape data extraction, GPT-Model information and more. | discord,discord-js,finance,javascript,python,stock-market,webscrape | 2023-10-30T00:27:16Z | 2023-11-09T04:44:49Z | null | 1 | 0 | 28 | 0 | 0 | 2 | null | MIT | JavaScript |
lebarrichello/gerador-senha-segura | main | ## Mini projeto: Gerador de senhas seguras
Projeto desenvolvido como parte dos estudos no módulo de Front-End do curso de desenvolvimento web da Trybe
[Gravação de tela de 06-11-2023 16:37:11.webm](https://github.com/lebarrichello/gerador-senha-segura/assets/42211040/87dbf9bc-9d2b-4bb8-961f-513c52677366)
<p>Acesse o projeto em produção <a href="https://lebarrichello.github.io/gerador-senha-segura/" target="_blank">clicando aqui</a></p>
## 🎯 Objetivo
Desenvolver uma pequena aplicação que é um gerador de senhas aleatórias, onde cada vez que é clicado no botão de gerar senha é recomendada uma senha forte. Essa senha é gerada por uma biblioteca externa chamada [nanoid](https://zelark.github.io/nano-id-cc/)
## 💻 Tecnologias utilizadas:
<div style="display: inline_block">
<img alt="HTML5" src="https://img.shields.io/badge/HTML5-E34F26?style=for-the-badge&logo=html5&logoColor=white">
<img alt="CSS3" src="https://img.shields.io/badge/CSS3-1572B6?style=for-the-badge&logo=css3&logoColor=white">
<img alt="JavaScript" src="https://img.shields.io/badge/JavaScript-323330?style=for-the-badge&logo=javascript&logoColor=F7DF1E">
</div>
## 📌 Créditos
- **Favicon:** -> [br.vexels](https://br.vexels.com/icon/cadeado/)
| Projeto desenvolvido no módulo de Front-End do curso de desenvolvimento web Full Stack da Trybe | css3,gerador-de-senha,html5,javascript | 2023-11-06T19:14:54Z | 2023-11-06T19:58:44Z | null | 1 | 0 | 4 | 0 | 0 | 2 | null | null | CSS |
joepdooper/audiovisualize | main | # AudioVisualize
**AudioVisualize** is a 3 kB JavaScript module that leverages the power of the Web Audio API to analyze and visualize audio in your web applications. It provides an easy-to-use interface for loading audio and extracting the necessary data used to generate visualizations. Check out these [examples](#examples) to learn how to bring your audio data to life with some simple visuals.
> Create real-time visualizations of audio, including frequency spectrum analysis.
## Installation
Easily install **AudioVisualize** via npm…
```bash
npm i audiovisualize
```
…or import the script from a CDN.
```html
<script type="module">
import { AudioVisualize } from "https://unpkg.com/audiovisualize";
</script>
```
```html
<script type="module">
import { AudioVisualize } from "https://cdn.jsdelivr.net/npm/audiovisualize@1.1.1/audiovisualize.min.js"
</script>
```
## Usage
You can create an instance of the **AudioVisualize** object and use its methods to load, analyze, and visualize audio. Use the *loading* method to load an audio file and set up event listeners for loading progress and playback events.
```javascript
// Create an instance of the AudioVisualize object.
const av = AudioVisualize;
av.loading(
// Path to your audio file
'path-to-your-audio-file.mp3',
() => {
// Audio loaded callback
console.log('Audio loaded');
},
(event) => {
// Progress update callback
console.log('Update event:', event);
},
() => {
// Audio ended callback
console.log('Audio ended');
}
);
// Create your custom audio visualizations here
```
When the **AudioVisualize** object is initialized, `av.element` is created as an instance of an HTML [`<audio>` element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/audio) that serves as the core component for loading, playing, and controlling audio files within a web page.
You can use the getFrequencies method to get the frequency data of the audio at any given moment. It returns an array of frequency values within a specified range.
```javascript
const lowFrequency = 20; // Minimum frequency in Hz
const highFrequency = 20000; // Maximum frequency in Hz
const frequencies = av.getFrequencies(lowFrequency, highFrequency); // `frequencies` is an array of frequency data.
```
To get the average amplitude of the frequency spectrum within a specified frequency range use the getAverageBetweenFrequencies method.
```javascript
let bass = 0, mid = 0, treble = 0;
function animation() {
if (!av.element.paused) {
bass = av.getAverageBetweenFrequencies(20, 250);
mid = av.getAverageBetweenFrequencies(250, 1500);
treble = av.getAverageBetweenFrequencies(1500, 20000);
}
// Create your custom audio visualizations here
requestAnimationFrame(animation);
}
requestAnimationFrame(animation);
```
If you want to get the average frequency range over the entire audio track, you can use the getAverageRange method. This method will analyze the audio frame by frame and calculate the average over the specified frequency range.
```javascript
const averageLowFrequency = 100; // Minimum frequency in Hz
const averageHighFrequency = 2000; // Maximum frequency in Hz
av.getAverageRange(averageLowFrequency, averageHighFrequency).then((average) => {
console.log('Average range over time:', average);
});
```
Retrieve the sample rate of the audio context used, providing essential information about the rate at which audio data is processed. This value can be used to ensure accurate audio analysis and visualizations in your web applications.
```javascript
console.log(av.audioContext.sampleRate);
```
## Options
Adjust the frequency resolution, the FFT size, used for audio analysis. Default value is *2048*
```javascript
av.fftSize = 512;
```
## Examples
**Example 1**
```html
<canvas id="canvasElement"></canvas>
<script type="module">
import { AudioVisualize } from 'https://unpkg.com/audiovisualize';
const av = AudioVisualize;
av.loading(
'path-to-your-audio-file.mp3',
() => {
console.log('Audio duration', av.element.duration);
// Add the audio element to the body
document.body.appendChild(av.element);
av.element.setAttribute('controls', 'controls');
},
() => {
console.log('Buffered', av.element.buffered);
console.log('Current time', av.element.currentTime);
},
() => {
console.log('Audio ended', av.element.currentTime, av.element.duration);
}
);
const canvas = document.getElementById('canvasElement');
const ctx = canvas.getContext("2d");
function draw() {
if(!av.element.paused){
av.getFrequencies();
// Clear the canvas
ctx.clearRect(0, 0, canvas.width, canvas.height);
// Draw the waveform
ctx.strokeStyle = "black";
ctx.lineWidth = 1;
ctx.beginPath();
for (let i = 0; i < av.spectrum.length; i++) {
const x = (canvas.width / av.spectrum.length) * i;
const y = canvas.height - (canvas.height * av.spectrum[i]) / 255;
if (i === 0) {
ctx.moveTo(x, y);
} else {
ctx.lineTo(x, y);
}
}
ctx.stroke();
}
// Request the next animation frame
requestAnimationFrame(draw);
}
// Start the animation loop
draw();
</script>
```
**Example 2**
```html
<canvas id="canvasElement"></canvas>
<script type="module">
import { AudioVisualize } from 'https://unpkg.com/audiovisualize';
const av = AudioVisualize;
av.loading(
'path-to-your-audio-file.mp3',
() => {
console.log('Audio duration', av.element.duration);
// Add the audio element to the body
document.body.appendChild(av.element);
av.element.setAttribute('controls', 'controls');
},
() => {
console.log('Buffered', av.element.buffered);
console.log('Current time', av.element.currentTime);
},
() => {
console.log('Audio ended', av.element.currentTime, av.element.duration);
}
);
const canvas = document.getElementById('canvasElement');
const ctx = canvas.getContext("2d");
function draw() {
if (!av.element.paused) {
// Calculate the average frequencies for bass, mids, and treble
const bassFrequency = av.getAverageBetweenFrequencies(20, 250); // Adjust the range for bass
const midFrequency = av.getAverageBetweenFrequencies(250, 1500); // Adjust the range for mids
const trebleFrequency = av.getAverageBetweenFrequencies(1500, 20000); // Adjust the range for treble
// Clear the canvas
ctx.clearRect(0, 0, canvas.width, canvas.height);
// Draw the bass line
ctx.strokeStyle = "blue";
ctx.lineWidth = 1;
ctx.beginPath();
const x1 = canvas.width / 4; // Position for bass
const y1 = canvas.height - (canvas.height * (bassFrequency / 255));
ctx.moveTo(x1, canvas.height);
ctx.lineTo(x1, y1);
ctx.stroke();
// Draw the mid line
ctx.strokeStyle = "green";
ctx.lineWidth = 1;
ctx.beginPath();
const x2 = canvas.width / 2; // Position for mids
const y2 = canvas.height - (canvas.height * (midFrequency / 255));
ctx.moveTo(x2, canvas.height);
ctx.lineTo(x2, y2);
ctx.stroke();
// Draw the treble line
ctx.strokeStyle = "red";
ctx.lineWidth = 1;
ctx.beginPath();
const x3 = (canvas.width * 3) / 4; // Position for treble
const y3 = canvas.height - (canvas.height * (trebleFrequency / 255));
ctx.moveTo(x3, canvas.height);
ctx.lineTo(x3, y3);
ctx.stroke();
}
// Request the next animation frame
requestAnimationFrame(draw);
}
// Start the animation loop
draw();
</script>
```
| AudioVisualize is a JavaScript module that leverages the power of the Web Audio API to visualize and analyze audio in your web applications. | audio,audio-analysis,audio-analyzer,audio-spectrum,audio-spectrum-visualizer,audio-visualizer,equalizer,equalizers-and-visualizations,music,music-player | 2023-10-30T13:18:33Z | 2024-02-05T19:28:46Z | 2023-11-18T22:58:33Z | 1 | 0 | 41 | 0 | 1 | 2 | null | MIT | JavaScript |
nidhish-nayak/nayan | main | # Nayan's Portfolio
[](https://codespaces.new/Nidhish-D-Nayak/nayan/tree/main)
Welcome to the Nayan's Portfolio! This README provides an in-depth exploration of our versatile Multipage Application (MPA).
## Table of Contents
- [About the Project](#about-the-project)
- [Folder Structure](#folder-structure)
- [Key Features](#key-features)
- [Seamless Integrations](#seamless-integrations)
- [Getting Started](#getting-started)
- [Commands](#commands)
- [Configuration](#configuration)
- [Deployment Made Easy](#deployment-made-easy)
- [Feedback and Suggestions](#feedback-and-suggestions)
## About the Project
This project is a fusion of portfolio and blog functionalities, complete with an intuitive admin page driven by Netlify CMS. Our project is meticulously fine-tuned for performance, leveraging server-side rendering (SSR) and cutting-edge image optimization through Sharp.
<p align="left">
<img alt="GitHub Language Count" src="https://img.shields.io/github/languages/count/nidhish-nayak/nayan" />
<img alt="GitHub Top Language" src="https://img.shields.io/github/languages/top/nidhish-nayak/nayan" />
<img alt="" src="https://img.shields.io/github/repo-size/nidhish-nayak/nayan" />
<img alt="GitHub Issues" src="https://img.shields.io/github/issues/nidhish-nayak/nayan" />
<img alt="GitHub Closed Issues" src="https://img.shields.io/github/issues-closed/nidhish-nayak/nayan" />
<img alt="GitHub Closed Pull Requests" src="https://img.shields.io/github/issues-pr-closed/nidhish-nayak/nayan" />
<img alt="GitHub Last Commit" src="https://img.shields.io/github/last-commit/nidhish-nayak/nayan" />
<img alt="GitHub Commit Activity (Year)" src="https://img.shields.io/github/commit-activity/y/nidhish-nayak/nayan" />
</p>
## Folder Structure
The project is structured with an eye for clarity and ease of use:
```
├── public/ # Public assets and HTML template
│ ├── admin/ # Netlify CMS configuration file
│ └── fonts/ # All fonts
│
├── src/
│ ├── assets/ # Optimized assets used in the application
│ ├── components/ # Reusable Preact and Astro components
│ ├── content/ # Blog & Project CMS Content with Zod types
│ ├── layouts/ # Reusable layouts for posts
│ ├── pages/ # Top-level application pages
│ └── styles/ # Global CSS styles
└── ...
```
- **public/**: Home to essential static files including `robots.txt`, `favicon.svg`, and the all-important `social-image.png`.
- **src/**: The heart of the application, boasting reusable components in the `components/` directory and a variety of layouts in `layouts/`.
- **astro.config.mjs**: The command center for Astro, empowering you to tailor the project to your unique requirements.
- **package.json**: Home to your project's dependencies and script definitions.
- **tsconfig.json**: A meticulously crafted TypeScript configuration, ensuring a seamless development experience.
- **tailwind.config.mjs**: Your canvas for configuring the potent Tailwind CSS framework.
## Key Features
The project boasts a dazzling array of features:
- **Multipage Application (MPA)**: The canvas for creating multiple pages, perfect for showcasing your diverse content.
- **Portfolio and Blog Functionalities**: A powerful platform for spotlighting your projects and effortlessly managing engaging blog posts.
- **Admin Page**: The integration of Netlify CMS ensures client-friendly content management is a breeze.
- **Server-Side Rendering (SSR)**: Harness the speed and efficiency of SSR, providing an exceptional user experience.
- **Image Optimization**: Say goodbye to lag with Sharp's image optimization, enhancing performance and visual appeal.
<br>
<br>
- [x] type-safe markdown
- [x] super fast performance
- [x] responsive (mobile ~ desktops)
- [x] SEO-friendly
- [x] light & dark mode
- [x] draft posts
- [x] sitemap & rss feed
## Seamless Integrations
We've harmonized various tools and libraries to make your development experience a symphony of efficiency:
- **Preact**: A nimble alternative to React, guaranteeing lightning-fast performance.
- **Sitemap**: Seamlessly generate a sitemap for top-notch SEO, enhancing your project's discoverability.
- **Tailwind CSS**: A utility-first CSS framework, transforming styling into an art form.
- **Prefetch**: Say hello to lightning-fast page loading, thanks to preloaded essential assets.
- **Markdown and MDX**: Embrace content creation with Markdown and MDX formats, a flexible and developer-friendly approach.
- **Astro Islands**: Optimize your project's performance through advanced code splitting.
- **Netlify CMS**: Simplify content updates with a user-friendly content management system designed to keep your project agile and responsive.
## Getting Started
You can run the project locally with the following steps:
1. Clone the repository: `git clone https://github.com/yourusername/your-astro-project.git`
2. Install dependencies: `pnpm install` (For faster and more efficient package management, we recommend using pnpm)
3. Start the development server: `pnpm run dev`
4. Access the project locally in your browser at `http://localhost:4321`
## Commands
All commands are run from the root of the project, from a terminal:
| Command | Action |
| :----------------- | :------------------------------------------- |
| `pnpm install` | Installs dependencies |
| `pnpm run dev` | Starts local dev server at `localhost:4321` |
| `pnpm run build` | Build your production site to `./dist/` |
| `pnpm run preview` | Preview your build locally, before deploying |
## Configuration
You can customize and configure your project settings to match your vision. Add additional integrations or configurations as needed to create a project that's uniquely yours.
```js
export default defineConfig({
site: "https://nayan-m.vercel.app",
integrations: [mdx(), sitemap(), prefetch(), tailwind(), preact()],
});
```
## Deployment Made Easy
When you're ready to share your project with the world, consider deploying it on a hosting service that supports Astro, such as Netlify, Vercel, or your platform of choice. Ensure you configure the necessary environment variables and deployment settings for a smooth launch.
> **Note:** Netlify CMS will only work on netlify hosting. Due to this you might need to choose other CMS providers for hosting elsewhere.
## Feedback & Suggestions
If you have any questions, need further assistance, or want to discuss your vision for this project, feel free to contact me at nidhibelthangady@gmail.com.
Made with 🤍 by Nidhish Nayak.
| Nayan Malkhedkar's portfolio using Astro featuring both portfolio and blog functionalities. Consists of features such as CMS Admin Dashboard to add projects and blogs, personal details on his skills and experience. | astro,javascript,markdown,mdx,preact,scss,tailwindcss,typescript,blog,cms | 2023-10-19T11:14:15Z | 2024-01-06T12:55:35Z | 2023-10-31T18:52:20Z | 2 | 18 | 130 | 0 | 0 | 2 | null | null | Astro |
adsyam/Nukt-Stream--Collab- | main | #Live Links:
nukt.netlify.app
| A Multi-Stream Platform --- collab | firebase,javascript,react,nosql | 2023-10-23T15:10:48Z | 2023-12-15T11:32:50Z | null | 2 | 20 | 145 | 0 | 2 | 2 | null | null | JavaScript |
yosseferrazik/jukebox | main | # React + Vite
This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
Currently, two official plugins are available:
- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
| Pagina ambientada a una maquina antigua de musica, hecha con ReactJS. | javascript,jukebox,jukebox-application,react | 2023-11-06T14:10:07Z | 2023-12-17T16:04:07Z | null | 1 | 0 | 10 | 0 | 0 | 2 | null | null | JavaScript |
nfillip/nickFillip-portfolio | main |
# nickFillip-portfolio [](https://opensource.org/licenses/MIT)
---
## Description
My website to showcase my projects, work experience, and education
---
## Table of Contents
+ **[Installation](#installation)**
+ **[Usage](#usage)**
+ **[License](#license)**
+ **[Contributing](#contributing)**
+ **[Tests](#tests)**
---
## Installation
npm i
npm run start
---
## Usage
The reason behind the file is to display my ability to use REACT.js to build a stylistic page that is unique and attracts recruiters.
---
## License
MIT
[](https://opensource.org/licenses/MIT)
---
## Contributing
UDenver Bootcamp
---
## Tests
none
---
## Questions
**Contact Me:**
Email: [nick.m.fillip@gmail.com](nick.m.fillip@gmail.com)
Cell: (281) 216 - 2183
Github Profile: [https://github.com/nfillip](https://github.com/nfillip)
---
## Website
Github Repo: [https://github.com/nfillip/nickFillip-portfolio](https://github.com/nfillip/nickFillip-portfolio)<br>
Netlify Website Link: [https://nick-fillip-portfolio.netlify.app/](https://nick-fillip-portfolio.netlify.app/)
---
© 2023 nfillip LLC. All Rights Reserved. | (Fullstack) My Portfolio highlighting my skills, work experience, projects, and education. (REACT) | css,emailjs,html,javascript,react,react-bootstrap | 2023-10-25T22:17:46Z | 2024-01-19T17:59:50Z | null | 1 | 0 | 32 | 0 | 0 | 2 | null | MIT | JavaScript |
Alexandrbig1/sign-in-up-form | main | # **Sign In/Up Form**
<img align="right" src="https://media.giphy.com/media/du3J3cXyzhj75IOgvA/giphy.gif" width="100"/>
practising HTML & CSS and JavaScript while studying on [Udemy courses](https://www.udemy.com/) <img style="margin: 10px" src="https://findlogovector.com/wp-content/uploads/2022/04/udemy-logo-vector-2022.png" alt="HTML5" height="30" />
## Languages and Tools:
<div align="center">
<a href="https://en.wikipedia.org/wiki/HTML5" target="_blank"><img style="margin: 10px" src="https://profilinator.rishav.dev/skills-assets/html5-original-wordmark.svg" alt="HTML5" height="50" /></a>
<a href="https://www.w3schools.com/css/" target="_blank"><img style="margin: 10px" src="https://profilinator.rishav.dev/skills-assets/css3-original-wordmark.svg" alt="CSS3" height="50" /></a>
<a href="https://www.javascript.com/" target="_blank"><img style="margin: 10px" src="https://profilinator.rishav.dev/skills-assets/javascript-original.svg" alt="JavaScript" height="50" /></a>
</div>
## Connect with me:
<div align="center">
<a href="https://linkedin.com/in/alex-smagin29" target="_blank">
<img src=https://img.shields.io/badge/linkedin-%231E77B5.svg?&style=for-the-badge&logo=linkedin&logoColor=white alt=linkedin style="margin-bottom: 5px;" />
</a>
<a href="https://github.com/alexandrbig1" target="_blank">
<img src=https://img.shields.io/badge/github-%2324292e.svg?&style=for-the-badge&logo=github&logoColor=white alt=github style="margin-bottom: 5px;" />
</a>
<a href="https://stackoverflow.com/users/alex-smagin" target="_blank">
<img src=https://img.shields.io/badge/stackoverflow-%23F28032.svg?&style=for-the-badge&logo=stackoverflow&logoColor=white alt=stackoverflow style="margin-bottom: 5px;" />
</a>
<a href="https://dribbble.com/Alexandrbig1" target="_blank">
<img src=https://img.shields.io/badge/dribbble-%23E45285.svg?&style=for-the-badge&logo=dribbble&logoColor=white alt=dribbble style="margin-bottom: 5px;" />
</a>
<a href="https://www.behance.net/a1126" target="_blank">
<img src=https://img.shields.io/badge/behance-%23191919.svg?&style=for-the-badge&logo=behance&logoColor=white alt=behance style="margin-bottom: 5px;" />
</a>
</div>
| sign-in/up-form(HTML/CSS/JS) | computerscience,css3,frontend,hacktoberfest,hacktoberfest2023,html-css-javascript,html5,javascript,js,softwareengineer | 2023-10-25T18:10:57Z | 2023-10-25T18:15:16Z | null | 1 | 0 | 3 | 0 | 0 | 2 | null | null | CSS |
mohitsupolia/Donation-Website-Payment-Integration- | main | # Donation-Website-Payment-Integration
<img width="1118" alt="donation-home" src="https://github.com/mohitsupolia/Donation-Website-Payment-Integration-/assets/104218088/7032b85c-8ab0-44c9-99ec-150f63c17c8d">
## Description
Our web application empowers users to make donations securely and conveniently. Integrated with Razorpay, it ensures a safe and seamless payment experience. Users can effortlessly support various causes, contribute to charities, or fund initiatives with confidence. The application prioritizes simplicity, enabling users to make a positive impact through hassle-free and secure online donations.
## Key Features
1. Razorpay Integration: Secure and reliable payment processing through Razorpay, ensuring a trustworthy donation experience.
2. User-Friendly Interface: Intuitive design for a seamless and straightforward donation process, catering to users of all levels of tech-savviness.
3. Single Charity Donation: Streamlined process focused on supporting a single charity or cause per donation.
4. Transaction History: Maintain a transparent and accessible record of users' donation transactions for their reference.
5. Responsive Design: Ensure a responsive and adaptable design, allowing users to make donations conveniently from any device.
## Installation
Step 1: Firstly we install an `STS(Spring Tool Suite) IDE`.
Step 2: Open the STS IDE, We Create the `Spring Starter Project`.
Step 3: Write the Dependencies in `Pom.XML` File.
Step 4: Write the Database Connection in `application.properties`.
Step 5: Create the entity file in `src/main/java`.
Step 6: Create the Service file in `src/main/java`.
Step 7: Create the Controller in `src/main/java`.
Step 8: Start the Server.
Step 9: Open the Browser and navigate to http://localhost:8080
## Usage
1. Effortless Donations: Users can effortlessly contribute to a chosen charity or cause through a straightforward and user-friendly interface.
2. Secure Transactions: Ensure the security of financial transactions with Razorpay integration, providing users with a safe donation experience.
<img width="1120" alt="donation-entry1" src="https://github.com/mohitsupolia/Donation-Website-Payment-Integration-/assets/104218088/51f96b0e-969a-47ff-ac2a-9b624ff89443">
3. Transparent Records: Keep transparent records of all donation transactions, allowing users to track and verify their contributions.
4. Anytime, Anywhere Access: Access the application from various devices, enabling users to make donations anytime, anywhere.
<img width="1110" alt="donation-entry2" src="https://github.com/mohitsupolia/Donation-Website-Payment-Integration-/assets/104218088/cb635454-ea40-4951-95b6-ae5c0921a991">
5. Promote Social Impact: Empower individuals to make a positive impact by supporting charitable initiatives through simple and secure online donations.
<img width="1117" alt="donation-final" src="https://github.com/mohitsupolia/Donation-Website-Payment-Integration-/assets/104218088/3162c9b5-c3ec-4ee7-9ac6-58b89a682ef0">
## Acknowledgment
Thanks to Razorpay for secure transactions, React.js and Bootstrap communities for the user-friendly interface, and the open-source community for valuable contributions. Special gratitude to our development team and users for their dedication to creating a positive impact through our Donation Payment Integration Web Application.
| I Develop a Donation Website using SpringBoot, Java, HTML, CSS, JavaScript, API, MySQL. (Payment Integration) | api,css,html,java,javascript,mysql-database,spring-boot | 2023-10-26T12:48:53Z | 2024-04-30T13:13:02Z | null | 1 | 0 | 5 | 0 | 0 | 2 | null | null | JavaScript |
AmandaFernandes0701/Projeto-DTI | main | # DTI Project --> Pet Shop Case 🐶🐾
In summary, this project performs the following action: based on the data provided by the user, it checks which Pet Shop offers the best cost-benefit ratio for the customer, considering the inserted data. For the execution of this project, it is valid to emphasize that I worked on two fronts:
- Frontend that can be run in a web browser.
- JavaScript code that runs in the terminal.
## Summary
- [Assumptions Made](#assumptions-made)
- [Project Decisions](#project-decisions)
- [Frontend Code](#frontend-code)
- [Terminal Compiled Code](#terminal-compiled-code)
- [Unit Tests](#unit-tests)
- [Instructions to Run the System](#instructions-to-run-the-system)
## Assumptions Made
When developing the solution to determine the best pet shop for Eduardo to take his dogs based on cost and proximity criteria, the following assumptions were made:
1. **Stable Pricing:** It is considered that the price information provided for the pet shops "Meu Canino Feliz," "Vai Rex," and "ChowChawgas" remains constant during the program's execution, regardless of unspecified temporal variations. In other words, the prices quoted for small and large dog grooming services do not change beyond what is specified for weekdays and weekends.
2. **Cost-effectiveness as the Sole Predictive Factor:** The primary criterion for determining the best pet shop is the total grooming cost, considering the distance to Eduardo's kennel and the prices for small and large dogs. Other factors, such as service quality, waiting time, availability, or additional amenities that a pet shop may offer, are not considered.
3. **Accurate Location Information:** The distance between Eduardo's kennel and the pet shops (Meu Canino Feliz, Vai Rex, and ChowChawgas) is accurately provided and is static. Variable factors, such as traffic, which could affect the actual travel time, are not considered.
4. **Tiebreaker Resolved by Proximity:** In case of a tie between two or more pet shops in terms of total cost, the final decision will be based on physical proximity. The pet shop closest to Eduardo's kennel will be considered the best in case of a tie.
5. **Correct Input Data Provided:** It is assumed that the user will input the necessary information correctly and in the expected format, including the size of the dogs (small or large) and the date they intend to schedule the grooming.
These assumptions are essential for the correct execution of the algorithm to determine the best pet shop and help establish the system's criteria and limitations, providing a solid foundation for decision-making.
## Project Decisions
Throughout the project implementation, several decisions were made based on my preferences and knowledge in specific areas. Therefore, I chose to use the JavaScript language since it is a language I am already familiar with. Additionally, as mentioned earlier, I decided to go beyond what was proposed in the case and also implemented the frontend (responsive and accessible). Thus, the project decisions will be detailed in two aspects. Furthermore, regarding the logic of the functions to calculate the prices, I decided to use the same function for both the frontend code executed in the browser and the JavaScript code compiled in the terminal. This decision was significant for the project's development as it saved a lot of time.
Regarding code standardization, I paid attention to the following points:
- Folder structure and organization.
- Standardization of variable names, folders, and general files (CamelCase).
- Standardization of folder and file names in "pages" (PascalCase).
- Configuration of Eslint + Prettier + Editor config.
- Default language: English.
### Frontend Code
First of all, I decided to start with the system design since this is one of my favorite parts. For this reason, I used Figma to test different designs and chose a design inspired by the Rocketseat website. I like high-contrast colors and the combination of purple with black, which I found appealing. To do this, I inspected the elements of the Rocketseat website to capture specific values for each component.
[Rocketseat Website](https://www.rocketseat.com.br/)
Next, I added all the buttons and input fields in the JSX file. I considered using a library to get ready-made components, such as Bootstrap or Ant Design, for these elements, but I chose to create them manually since they were relatively simple. Then, I decided to build everything on a single page to facilitate error identification, logic failures, and overall code understanding. Following that, I created logic to increment or decrement the number of dogs when the buttons were clicked.
I also added some Eslint and Prettier configurations to streamline my work and improve code standardization and aesthetics. Additionally, I created a "Themes" folder in the "styles" directory to simplify style adjustments based on the web application's theme.
After that, I started structuring the system's logic. Initially, I tested if the function was correctly fetching the data. To do this, I used an extension called "Console Ninja," which conveniently displays the results of `console.log` directly in Visual Studio Code. I began by calculating the values only for "Meu Canino Feliz" to ensure the results were correct. Next, I developed the functions to calculate the prices for "Vai Rex" and "ChowChawgas." Since I hadn't performed unit tests until then, I manually calculated some values and compared them with what was printed in the console. When I confirmed that the results matched the expected ones, I started working on the logic for prioritization based on distance. To implement this functionality, I decided to create an object for each of the pet shops. These objects contained the following information: "name," "price," and "distance." Then, I created a function that generated an array with the objects that had the smallest values (in case of a tie). From there, I called a function to sort this array in ascending order based on the distance value contained in each of these objects.
After numerous tests and adjustments, I made some changes to the style to improve the responsiveness of the frontend. Up to this point, it was responsive for all screen sizes larger than the Galaxy Fold width (280px). In the future, I plan to improve the code and reduce the number of `@media` queries and unnecessary `<div>` elements.
Finally, I came up with the idea of using toasts to make the system more dynamic and attractive. For this, I used a library called React-Toastify. I read the documentation and looked for ways to style the toasts to match the colors of the web application's theme.
I was also considering adding an image next to the title, for which I searched for images on the [Storyset website](https://storyset.com/dog). However, due to time constraints, I chose to postpone this and focus on creating the code compiled in the terminal, as it is a fundamental requirement of the case.
In the future, I intend to style the date picker using the Material Design library, available [here](https://m3.material.io/components/date-pickers/specs). I didn't do this at the time due to time constraints.
Here's the image that shows the final result of my frontend project:
### Terminal Compiled Code
Once I finished creating the frontend code executed in the browser, I started working on the code compiled in the terminal. Since I already had a ready-made
function, I was able to complete this part much more quickly. I decided to create a file called `terminalFunction.js` exclusively for compiling the code in the terminal. Since I only had experience running code through the terminal using C++, creating JavaScript code in this way was a rewarding and challenging experience.
The first challenge I encountered was how to compile the code correctly in the terminal. Therefore, I researched and found an interesting way to do it. I used the `readline.createInterface` function and installed some necessary dependencies. Then, I made the necessary adaptations and tested the code several times.
Finally, when it was working perfectly, I decided to explore ways to style the terminal and make it visually appealing. I realized that I could further enhance the code, so I did the following:
- Restrict the format of the user's date input. To do this, I used a library called `date-fns`.
- Allow the user to call the function again after its completion (if desired).
## Unit Tests
Finally, when I finished the code for compilation, I started writing unit tests. I decided not to perform extensive testing because manually calculating the expected values would consume too much time. To run the `calculatePrices.test.js` file, I had to set up Babel. I installed the `jest` library to perform the tests and added the "test" command to the `package.json` file.
## Instructions to Run the System
To run this project locally, follow these steps:
1. Clone the repository to your local machine:
```bash
https://github.com/AmandaFernandes0701/Projeto-DTI.git
```
2. Navigate to the project directory:
```bash
cd Projeto DTI - Amanda
```
3. Install the project dependencies:
```bash
npm install
```
4. To start the development server and view the application locally, run:
```bash
npm run dev
```
5. If you wish to run the code through the terminal, navigate to the following directory:
```bash
Projeto DTI - Amanda\src\functions\terminalFunction.js
```
6. Once you've reached the directory mentioned in step 5, you can execute the following command in the terminal:
```bash
node terminalFunction.js
```
7. To run unit tests, use the following command:
```bash
npm test
```
| In summary, the project performs the following action: based on the data provided by the user, it checks which pet shop offers the best cost-benefit ratio for the client. | cost-benefit-analysis,cost-optimization,frontend,javascript,pet-project,petshop,react,responsive-web-design,terminal | 2023-10-19T12:45:33Z | 2024-05-02T02:52:01Z | null | 1 | 0 | 53 | 0 | 0 | 2 | null | null | JavaScript |
dilshankarunarathne/jewelry-shop-frontend | main | This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
## Getting Started
First, run the development server:
```bash
npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev
```
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
You can start editing the page by modifying `app/page.js`. The page auto-updates as you edit the file.
This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
## 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.
| null | javascript,nextjs,react,tailwindcss,typescript | 2023-10-23T05:58:04Z | 2023-11-11T13:36:12Z | null | 1 | 0 | 478 | 0 | 0 | 2 | null | NOASSERTION | TypeScript |
samagra44/StudyBud.com | main | # StudyBuddy: A Study-Oriented Social Platform (Discord Clone)
**StudyBuddy is a web application developed using Django that serves as a study-oriented social platform and chat system, with features akin to a Discord clone, coupled with a study room search engine. This README provides an in-depth description of the project, guiding you through the installation process and offering an extensive overview of its functionalities.**
## Project Description
**StudyBuddy is designed to facilitate collaborative learning and discussions. Here's a comprehensive breakdown of its features:**
### Chat Rooms
- **Create Study Rooms:** *Users can create study rooms focused on specific topics. For instance, if you're studying Django, you can set up a dedicated chat room for it.*
- **Join Study Rooms:** *Other users can find and join these study rooms to communicate with fellow learners.*
- **Chat Like Discord:** *Within these rooms, users can engage in real-time text conversations, similar to a Discord server, allowing for a dynamic and interactive learning experience.*
### Study Room Feed
- **Study Room Feed:** *Study rooms are displayed in a social networking-style feed. Users can see various study rooms created by the community.*
- **Room Details:** *The feed provides details about the study rooms, including the number of participants and when the room was created.*
- **Room Conversations:** *Users can access and participate in the conversations within a room, promoting knowledge sharing and collaboration.*
## Installation
**To set up StudyBuddy on your local machine, follow these detailed steps:**
### Clone the Repository:
```
git clone https://github.com/samagra44/StudyBud.com.git
```
### Change the directory:
```
cd StudyBuddy
```
### Virtual Environment:
*Create a virtual environment for the project:*
```
python -m venv venv
```
- **Activate the venv Environment:**
```
source venv/bin/activate
```
- **Activate the venv Environment on Windows:**
```
venv\Scripts\activate
```
- **Create the virtual environment using conda command:**
```
conda create -n venv
```
**Activate the venv Environment:**
```
conda activate venv/
```
**Verify that the virtual environment was activated correctly by running the following command:**
```
conda info
```
### Install Dependencies:
**Install the required Python packages:**
```
pip install -r requirements.txt
```
### Database Setup:
**Apply database migrations to set up the database schema:**
```
python manage.py migrate
```
### Create an Admin User:
**Create an admin superuser to manage the platform:**
```
python manage.py createsuperuser
```
### Launch the Development Server:
**Start the development server:**
```
python manage.py runserver
```
### Access the Application:
**Open a web browser and navigate to http://localhost:8000/ to access StudyBuddy.**
## Configuration
**StudyBuddy can be configured to meet your specific needs. Key configuration options are found in the settings.py file within the project directory. These settings include database configuration, secret keys, and other parameters that you can modify to suit your requirements.**
### Usage
**Once the application is running, users can:**
- Register for an account or log in.
- Create their own study rooms.
- Join existing study rooms to collaborate and learn.
- Explore the study room feed to discover and join other rooms.
- Interact in real-time chat within study rooms, similar to Discord.
- Update their user profiles to personalize their experience.
**StudyBuddy empowers users to seamlessly engage in collaborative learning and discussions within a social networking-style platform.**
## License
**This project is licensed under the MIT License, which means you are free to modify and use it according to your requirements. For a more in-depth understanding of the project and detailed usage instructions, consult the project's documentation and explore the codebase. We hope StudyBuddy enhances your study collaboration experience and provides a valuable tool for learners.**
## Project Images:
- Edit User Profile:
- User Profile:
- All rooms:
- Create room:
- Join Room:
- Search Romm:
| StudyBud.com (Discord Clone) using Django | css,database,django-rest-framework,html,javascript,python | 2023-10-17T14:23:35Z | 2024-01-10T14:49:45Z | null | 1 | 0 | 8 | 0 | 0 | 2 | null | null | HTML |
taexj/Facial-Recognition-Based-Attendance-System-For-Teachers-and-Students-Using-Machine-Learning | main | # Facial-Recognition-Based-Attendance-System-For-Teachers-and-Students-Using-Machine-Learning
Welcome to the GitHub repository for the project: a Facial Recognition-Based Attendance System designed for teachers and students. This project was developed in collaboration with a local non-profit organization aiming to bring sustainable, low computational cost solutions for automatic attendance systems to resource-limited schools in Pakistan.
## Project Overview
Our system leverages facial recognition technology to streamline the attendance process, making it more efficient and less time-consuming. By employing machine learning algorithms Haar cascade classifiers for face detection and k-Nearest Neighbors (k-NN) for face recognition, we've created a cost-effective and lightweight architecture. This ensures optimal performance across various devices, including both phones and PCs, making it accessible to schools with limited resources.
### Key Features
- **Low Computational Cost:** Designed with resource constraints in mind, ensuring it runs smoothly on minimal hardware.
- **Cross-Platform Compatibility:** Works seamlessly on both phones and PCs, providing flexibility in usage.
- **Sustainable Solution:** A collaboration with local non-profits to support educational institutions in Pakistan.
- **User-Friendly Interface:** Implemented using HTML, Bootstrap, and JavaScript for a smooth user experience.
- **Efficient Backend:** Powered by Flask, ensuring a robust and scalable application.
## Getting Started
To get started, please follow the instructions below:
### Prerequisites
Ensure you have the following installed:
- Python 3.x
- Flask
- OpenCV
- A suitable web browser (Chrome/Firefox)
### Installation
1. Clone the repository to your local machine:
```bash
git clone https://github.com/taexj/Facial-Recognition-Based-Attendance-System-For-Teachers-and-Students-Using-Machine-Learning.git
```
2. Navigate to the cloned repository:
```bash
cd Facial-Recognition-Based-Attendance-System-For-Teachers-and-Students-Using-Machine-Learning
```
3. Install the required dependencies:
```
pip install -r requirements.txt
```
5. Run the Flask application:
```
flask run
```
## Future Work
The current iteration of our system leverages traditional Machine Learning algorithms for facial detection and identification tasks. Moving forward, we aim to explore and integrate Deep Learning techniques to enhance the system's accuracy and efficiency.
| A low-cost, facial recognition based attendance system for Pakistani schools. Created as part of my final year project of Bs Computer Science | attendance-system,css,deep-learning,face-detection,face-recognition,flask,haar-cascade,html,javascript,knn-classification | 2023-10-13T22:43:00Z | 2024-04-05T16:05:51Z | null | 1 | 0 | 9 | 0 | 0 | 2 | null | MIT | Python |
PubData2XL/PubData2XL | main | # PubData2XL
It is a web application built with Django in Python, designed to facilitate the downloading of PubMed data into Microsoft Excel spreadsheets and XML files.
# Requirements
PubData2XL is compatible with any system that supports Python, including Windows, Mac, and Linux platforms. At present, it operates on an AlmaLinux server equipped with 2GB of RAM, accommodating approximately 400 monthly visitors. You may adjust the server capacity based on your specific requirements, scaling either upwards or downwards as necessary.
# How to install PubData2XL?
The provided instructions are tailored for setting up PubData2XL on an AlmaLinux minimal server from DigitalOcean, which is the configuration we currently utilize. However, analogous procedures will be required to install PubData2XL on different platforms. It’s important to adapt the steps to fit the specific environment and system requirements of the platform you are using.
################################################################################
## AlmaLinux Basic Setup
################################################################################
### Update the server
```sudo dnf update -y && sudo dnf upgrade -y && sudo dnf clean all```
### Create an user with sudo access, sammy can be replaced by anything you like.
```
adduser sammy
passwd sammy
usermod -aG wheel sammy
```
### Install Nano editor and SELinux Policy Core Python Utilities
```sudo dnf -y install nano policycoreutils-python-utils```
### Optional security recommendation: Change the SSH port from the default port 22 to one of your choice.
```
sudo nano /etc/ssh/sshd_config
```
Remove the # to activate the following configurations.
```
port 5555
PermitRootLogin no
PasswordAuthentication yes
```
```sudo semanage port -a -t ssh_port_t -p tcp 5555```
### Install Firewall and open ports for http, https and ssh
```
sudo dnf install -y firewalld
sudo systemctl start firewalld
sudo systemctl enable firewalld
sudo firewall-cmd --permanent --add-service=http
sudo firewall-cmd --permanent --add-service=https
sudo firewall-cmd --permanent --add-port=5555/tcp
sudo firewall-cmd --permanent --remove-service=ssh
sudo firewall-cmd --reload
sudo systemctl restart sshd
```
### Reboot the server and reconnect via SSH using either port 22 or the port you chosed above.
```sudo reboot```
### Create the directories for the application and where the CSS, JS, Images, etc. will be served from.
```
sudo mkdir /home/sammy/webapps
sudo mkdir /home/sammy/webapps/pubdata2xl/
sudo mkdir /home/sammy/webapps/pubdata2xl/media
sudo mkdir /home/sammy/webapps/pubdata2xl/static
```
### Create empty index files. This is a security measure don't skip.
```
sudo touch /home/sammy/webapps/pubdata2xl/media/index.html
sudo touch /home/sammy/webapps/pubdata2xl/static/index.html
```
################################################################################
## Install NGINX Web Server
################################################################################
```
sudo dnf install nginx -y
sudo systemctl enable nginx
sudo systemctl start nginx
```
### Make a copy of the default NGINX configuration file. If something goes wrong you can always restore this file.
```sudo cp /etc/nginx/nginx.conf /etc/nginx/nginx_original.conf```
### Remove or comment (#) the server lines starting at server { ... and ending in ... }
```sudo nano /etc/nginx/nginx.conf```
### Create and apply the web server configuration lines.
```sudo nano /etc/nginx/conf.d/pubdata2xl.conf```
```
server {
listen 80;
listen [::]:80; # use only if IPv6 is available.
#server_name _; # use this if running in localhost. e.g. virtual box.
server_name www.pubdata2xl.com pubdata2xl.com; # if domain is available use this instead.
location /static {
alias /home/sammy/webapps/pubdata2xl/static;
expires max;
}
location /media {
alias /home/sammy/webapps/pubdata2xl/media;
expires max;
}
location / {
proxy_pass http://127.0.0.1:8080/; #Important: This ip:port must match Gunicorn port.
proxy_pass_header Server;
proxy_set_header Host $host;
proxy_redirect off;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Scheme $scheme;
proxy_set_header X-Forwarded-Proto $scheme;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_connect_timeout 1800;
proxy_send_timeout 1800;
proxy_read_timeout 1800;
send_timeout 1800;
}
server_tokens off;
add_header Strict-Transport-Security "max-age=63072000; includeSubdomains; preload";
add_header Access-Control-Allow-Origin https://$host;
add_header Access-Control-Allow-Methods "GET, POST";
add_header X-Permitted-Cross-Domain-Policies none;
#deprecated add_header Expect-CT 'max-age=60, report-uri="https://$host/report"';
add_header "X-XSS-Protection" "1; mode=block";
add_header Referrer-Policy "same-origin";
add_header Feature-Policy "geolocation 'none'; camera 'none';
fullscreen 'none'; payment 'none';
midi 'none'; sync-xhr 'none';";
add_header Content-Security-Policy "default-src 'none'; manifest-src 'self'; script-src 'self';
style-src 'self'; img-src 'self' data:; connect-src 'self';
font-src 'self'; object-src 'none'; media-src 'self';
form-action 'self'; frame-ancestors 'self'; base-uri 'none';";
add_header X-Frame-Options SAMEORIGIN;
add_header X-Content-Type-Options nosniff always;
}
```
### Test if NGINX was configured correctly
```sudo nginx -t```
### Reload NGINX
```sudo systemctl reload nginx```
################################################################################
## Install and Configure Python, PIP, Gunicorn, Django
################################################################################
```
sudo dnf install python3.11 -y
cd /home/sammy/webapps/pubdata2xl
sudo python3.11 -m venv .venv
source .venv/bin/activate
sudo chown -R $USER /home/sammy/webapps/pubdata2xl
pip install --upgrade pip gunicorn django
```
################################################################################
## Install and Configure PubData2XL
################################################################################
```
sudo dnf install wget unzip -y
cd /home/sammy/webapps/pubdata2xl
sudo wget https://github.com/PubData2XL/PubData2XL/archive/refs/heads/main.zip
sudo unzip main.zip
sudo mv PubData2XL-main/* .
sudo rm -rf main.zip PubData2XL-main/
pip install -r src/requirements.txt
sudo mkdir /home/sammy/webapps/pubdata2xl/src/apps/pubdata2xl/temp/
```
### Create .env file. Keep this file secure and private.
```
cd /home/sammy/webapps/pubdata2xl/src
sudo nano .env
```
```
SECRET_KEY = "JUST_TYPE_A_LONG_RANDOM_LINE_OF_CHARACTERS_THIS_IS_A_SECURITY_FEATURE_DO_NOT_SHARE_THIS_WITH_ANYONE_ALL_THIS_CAN_BE_USED_azAZ123456789@#$%^&*()?><~"
NCBI_API_KEY = "YOUR_OWN_NCBIAPI_KEY"
```
### Create a Systemd file to manage Gunicorn.
The ip:port in the --bind configurations must match the port set in NGINX configuration file.
```sudo nano /etc/systemd/system/pubdata2xl.service```
```
[Unit]
Description=PubData2XL daemon
After=network.target
[Service]
User=sammy
Group=nginx
WorkingDirectory=/home/sammy/webapps/pubdata2xl/src
Environment="PATH=/home/sammy/webapps/pubdata2xl/.venv/bin"
ExecStart=/home/sammy/webapps/pubdata2xl/.venv/bin/gunicorn \
--preload \
--timeout 1800 \
--workers=4 \
--threads=4 \
--worker-class="sync" \
--worker-connections=1000 \
--error-logfile /home/sammy/webapps/pubdata2xl/src/config/error.log \
--access-logfile /home/sammy/webapps/pubdata2xl/src/config/access.log \
--bind 127.0.0.1:8080 config.wsgi:application
[Install]
WantedBy=multi-user.target
```
### Adjust the directories permissions
```
sudo usermod -a -G sammy nginx
sudo chown -R sammy:nginx /home
sudo chmod 755 -R /home
sudo semanage fcontext -a -t httpd_sys_content_t "/home/sammy/webapps/pubdata2xl/static(/.*)?"
sudo restorecon -R -v /home/sammy/webapps/pubdata2xl/static
sudo semanage fcontext -a -t httpd_sys_content_t "/home/sammy/webapps/pubdata2xl/media(/.*)?"
sudo restorecon -R -v /home/sammy/webapps/pubdata2xl/media
sudo chcon -R -t bin_t /home/sammy/webapps/pubdata2xl/.venv/bin
sudo chown -R sammy:nginx /home/sammy/webapps/pubdata2xl
sudo systemctl daemon-reload
sudo systemctl enable pubdata2xl
sudo systemctl restart pubdata2xl && sudo systemctl restart nginx
sudo systemctl status pubdata2xl
```
################################################################################
## Configure letsencrypt.org certificates.
################################################################################
This allows the site to be served securely from https. Not needed if running locally. This requires owning a domain name.
```
sudo dnf install epel-release -y
sudo dnf install certbot python3-certbot-nginx -y
sudo certbot --nginx -d www.pubdata2xl.com -d pubdata2xl.com
sudo firewall-cmd --permanent --remove-service=http
sudo firewall-cmd --reload
```
################################################################################
## Create Cronjob to restart gunicorn service if down.
################################################################################
```sudo nano /home/sammy/webapps/pubdata2xl/src/config/restart_gunicorn_if_not_alive.sh```
```
#!/bin/bash
SERVICENAME="pubdata2xl"
systemctl is-active --quiet $SERVICENAME
STATUS=$? # returned value is active if running
if [[ "$STATUS" -ne "active" ]]; then
echo "Service '$SERVICENAME' is not curently running... Starting now..."
sudo service $SERVICENAME start
fi
```
## Make the file executable
```sudo chmod +x /home/sammy/webapps/pubdata2xl/src/config/restart_gunicorn_if_not_alive.sh```
## Install cronjob
```
sudo dnf install crontabs cronie cronie-anacron -y
sudo systemctl start crond && sudo systemctl enable crond
sudo systemctl status crond
```
## Add a cronjob
```sudo EDITOR=nano crontab -e```
```
* * * * * /home/sammy/webapps/pubdata2xl/src/config/restart_gunicorn_if_not_alive.sh
```
################################################################################
# Periodically update PubData2XL to the newest version.
################################################################################
```
sudo dnf update -y && sudo dnf upgrade -y && sudo dnf clean all
cd /home/sammy/webapps/pubdata2xl
source /home/sammy/webapps/pubdata2xl/.venv/bin/activate
sudo wget https://github.com/PubData2XL/PubData2XL/archive/refs/heads/main.zip
sudo unzip main.zip
sudo rsync --partial -avvz PubData2XL-main/src/* src/.
sudo rm -rf main.zip PubData2XL-main/
pip install -r src/requirements.txt
sudo systemctl restart pubdata2xl && sudo systemctl restart nginx
```
| Is a Django Python web application to download PubMed data into a Microsoft Excel spreadsheet and XML files. | django,javascript,pubmed,pubmed-abstracts,pubmed-articles-grabber,pubmed-parser,pubmed-xml,python,excel,xlsx | 2023-11-04T18:07:46Z | 2024-05-14T15:52:27Z | null | 1 | 0 | 40 | 0 | 1 | 2 | null | Unlicense | HTML |
Hyperxq/Project-builder-cli | main | # Project Builder CLI
The Project Builder CLI is a versatile command-line interface tool designed to streamline and enhance the development workflow for Angular developers. By providing the capability to execute Angular schematics outside of an Angular workspace, create new Angular schematics project libraries, and automate complex project setups, this CLI tool offers a comprehensive solution for modern development challenges.
## Key Features
1. **Execute Angular Schematics Anywhere**: Run `builder exec [collection-name] [schematics-name]` from any directory, eliminating the need for a specific Angular workspace context. This feature enhances flexibility and efficiency in utilizing Angular schematics across diverse projects.
2. **Scaffolding for Schematics Libraries**: Easily create ready-to-publish Angular schematics project libraries with the command `builder new [project-name] [author]`. The CLI sets up all necessary configurations, allowing you to focus on developing your schematics.
3. **Automated Complex Project Setup**: Leverage the CLI's ability to orchestrate complex project setups with a single command. It integrates seamlessly with existing CLI tools like Angular CLI, NestJS CLI, or NX CLI to create the workspace, followed by executing defined schematics through Project Builder, streamlining the project initialization process.
## Requirements
- Node.js version 20 or higher.
## Installation
Install the Project Builder CLI globally using npm to make it accessible from anywhere in your system:
```sh
npm i -g @pbuilder/cli
```
## Usage
To get started, you can invoke the help command to explore the CLI's capabilities:
```sh
builder --help
```
## Contributing
We welcome contributions from the community! If you're interested in enhancing the Project Builder CLI, please review our [CONTRIBUTING.md](./CONTRIBUTING.md) guide for details on the contribution process, coding standards, and how to submit pull requests.
## How does it work?
Check the miro link to check:
[Flow diagram](https://miro.com/welcomeonboard/ZkZicUdSYlp2TlhuRG1FRDhkY1FJZnF2VGJ2dTlPSkFsY1Z1WU1NWWVYUk05MmVUUTFPQWZVTjNMWTJ0bTBObHwzNDU4NzY0NTY2NTc1MDcwODI0fDI=?share_link_id=741166420035)
| This CLI allows you to use angular schematics in any JS framework | cli,javascript,nodejs,schematics | 2023-10-21T00:42:14Z | 2024-05-21T02:48:38Z | null | 2 | 21 | 45 | 0 | 0 | 2 | null | MIT | TypeScript |
Hyperxq/Project-builder-cli | main | # Project Builder CLI
The Project Builder CLI is a versatile command-line interface tool designed to streamline and enhance the development workflow for Angular developers. By providing the capability to execute Angular schematics outside of an Angular workspace, create new Angular schematics project libraries, and automate complex project setups, this CLI tool offers a comprehensive solution for modern development challenges.
## Key Features
1. **Execute Angular Schematics Anywhere**: Run `builder exec [collection-name] [schematics-name]` from any directory, eliminating the need for a specific Angular workspace context. This feature enhances flexibility and efficiency in utilizing Angular schematics across diverse projects.
2. **Scaffolding for Schematics Libraries**: Easily create ready-to-publish Angular schematics project libraries with the command `builder new [project-name] [author]`. The CLI sets up all necessary configurations, allowing you to focus on developing your schematics.
3. **Automated Complex Project Setup**: Leverage the CLI's ability to orchestrate complex project setups with a single command. It integrates seamlessly with existing CLI tools like Angular CLI, NestJS CLI, or NX CLI to create the workspace, followed by executing defined schematics through Project Builder, streamlining the project initialization process.
## Requirements
- Node.js version 20 or higher.
## Installation
Install the Project Builder CLI globally using npm to make it accessible from anywhere in your system:
```sh
npm i -g @pbuilder/cli
```
## Usage
To get started, you can invoke the help command to explore the CLI's capabilities:
```sh
builder --help
```
## Contributing
We welcome contributions from the community! If you're interested in enhancing the Project Builder CLI, please review our [CONTRIBUTING.md](./CONTRIBUTING.md) guide for details on the contribution process, coding standards, and how to submit pull requests.
## How does it work?
Check the miro link to check:
[Flow diagram](https://miro.com/welcomeonboard/ZkZicUdSYlp2TlhuRG1FRDhkY1FJZnF2VGJ2dTlPSkFsY1Z1WU1NWWVYUk05MmVUUTFPQWZVTjNMWTJ0bTBObHwzNDU4NzY0NTY2NTc1MDcwODI0fDI=?share_link_id=741166420035)
| This CLI allows you to use angular schematics in any JS framework | cli,javascript,nodejs,schematics | 2023-10-21T00:42:14Z | 2024-05-21T02:48:38Z | null | 2 | 21 | 45 | 0 | 0 | 2 | null | MIT | TypeScript |
RafaRz76Dev/calculadora_stackXLabsII | master | ***
<div align="center">
[](https://git.io/typing-svg)
<img height="120em" src="image/ImagemDevRafa.png" align="center">
<a href="https://git.io/typing-svg" align="center"><img src="https://readme-typing-svg.herokuapp.com?font=Fira+Code&weight=700&size=24&pause=1000&color=120A2A¢er=true&vCenter=true&width=435&lines=Desenvolvedor+Front+End+Júnior" alt="Typing SVG" /></a> <img src="https://media.giphy.com/media/l1J9sBOqBIvnafnUc/giphy.gif" width="70">
***
## <img src="https://media.giphy.com/media/XwcRflO9HD0Sk6RaRM/giphy.gif" align="center" height="25" width="55"> Venho aqui apresentar <img src="https://media.giphy.com/media/LmqitTYGsNMiWu3VWO/giphy.gif" align="center" width="55">
# **_Calculadora_labsStackX_**
<div align="center">
<img src="https://media.giphy.com/media/9TFBxN300KpCUI6sBD/giphy.gif" align="center" height="45" width="45">
## [ (```Clique aqui para conhecer o Projeto```) ](https://rafarz76dev-calculadoralabs.netlify.app//)
<br>
<div align="left">
### Projeto do curso StackX, do módulo StackX Lab II, com o Professor Vinícius Takeo, onde consiste em desenvolver uma calculadora, onde o usuário vai interagir:
- Realizando assim todas as operações;
- Limpando a operação do Visor;
- Apagando o último caracter
- Com um histórico exibindo a operação da calculadora com data e hora atualizada;
- Dentro desse campo ```histórico``` vai vai ```salvar``` , ```deletar``` e clicar na ```operação retornando ao visor```;
- Limitar o histórico a 4 entradas, apagando a operação mais antiga;
- A calculadora apresenta as informações do histórico de maneira organizada em formato de tabela;
- A calculadora implementa responsividade total, permitindo que todos os elementos (calculadora e histórico) estejam de mesmo tamanho em diferentes tipos de tela.
<br>
<div align="center">
<img src= "https://media.giphy.com/media/3zSF3Gnr7cxMbi6WoP/giphy.gif" align="center" height="55" width="55"> [Demonstração-Calculadora]<img src= "https://media.giphy.com/media/E5DzZsofmgxc9wjbhX/giphy.gif" align="center" height="35" width="35">
<img height="480em" src="image/calc_LabsStackX.gif" align="center">
<div align="left">
<br>
***
<img src="https://media.giphy.com/media/iT138SodaACo9LImgi/giphy.gif" align="center" height="75" width="75"> Tecnologias utilizadas no projeto:
🎯 HTML
🎯 CSS
🎯 Javascript
<br>
***
<img src="https://media.giphy.com/media/SS8CV2rQdlYNLtBCiF/giphy.gif" align="center" height="35" width="45"> Ferramenta utilizada no projeto:
- [VsCode](https://code.visualstudio.com/download) (v1.80.1)
<br>
***
<img src="https://media.giphy.com/media/u2pmTWUi0MXjyrMaVj/giphy.gif" align="center" height="65" width="65"> Para rodar no `Front-End`:
- No arquivo `index.html` vai clicar com o botão direito para digitar:
```
Open With Live Server
```
- Assim vai abrir no navegador a `Calc_Labs`.
***
- Ou pelo `Deplopy Netlify`:
[ (```Clique aqui e acesse o Projeto```) ](https://rafarz76dev-calculadoralabs.netlify.app//)
<br>
***
<img src="https://media.giphy.com/media/ImmvDZ2c9xPR8gDvHV/giphy.gif" align="center" height="25" width="25"> Autor
<p>
<img align=left margin=10 width=80 src="https://avatars.githubusercontent.com/u/87991807?v=4"/>
<p>   RafaRz76Dev<br>
   <a href="https://api.whatsapp.com/send/?phone=47999327137">Whatsapp</a> | <a href="https://www.linkedin.com/in/rafael-raizer//">LinkedIn</a> | <a href="https://github.com/RafaRz76Dev">GitHub</a>| <a href="https://public.tableau.com/app/profile/rafael.raizer">Tableau</a>| <a href="https://portifolio-rafarz76dev.netlify.app/">Portfólio</a> </p>
</p>
| Lançado desafio Projeto Calculadora, que faz parte do Módulo StackX Lab II do Curso StackX, com as seguintes stacks aplicadas > HTML5, CSS e JS🙌🚀 | css3,html5,javascript | 2023-10-26T21:31:00Z | 2023-11-29T00:10:54Z | null | 1 | 0 | 23 | 0 | 0 | 2 | null | null | CSS |
chernyaevaia/hackathon-memory-game | master | # Благотворительный хакатон джунов, 2023
## Команда #43
* Ирина: @iridache
* Никита: @pedroresheto
* Михаил: @miketevelev
## Стек проекта
ReactJS, HTML, CSS
## Описание проекта:
Реализована браузерная игра Memory Game. <p>
Использовали тематические изображения, игра предполагает несколько уровней сложности.
## Реализованный функционал:
ВСЕ БАЗОВЫЕ ТРЕБОВАНИЯ, А ИМЕННО:
1. вывод поля с рандомно расположенными карточками (каждый раунд - новая позиция карточек);
2. возможность открывать карточки;
3. закрытие непарных карточек, парные - остаются открытыми;
4. возможность начать игру заново;
5. экран поздравления с окончанием игры (появляется когда все карточки открыты);
6. подсчет количества ходов;
<img width="804" alt="Снимок экрана 2023-11-25 в 13 59 56" src="https://github.com/chernyaevaia/hackathon-memory-game/assets/89077026/c51da971-ff80-4170-ac7a-cb5da1c523b6">
<br></br>
ДОПОЛНИТЕЛЬНЫЙ ФУНКЦИОНАЛ:
8. игра по таймеру (3 или 5 минут на партию)
9. ограничение количества ходов (отсутствует - 20 - 40)
11. выбор размера поля (есть варианты 4 на 4, 4 на 5 и 6 на 6)
12. при повышении указанного лимита ходов или заданного на таймере времени появляется модальное окно с сообщением об окончании игры
<img width="844" alt="Снимок экрана 2023-11-25 в 14 01 35" src="https://github.com/chernyaevaia/hackathon-memory-game/assets/89077026/541cd9a6-cf79-4cac-9ec0-b664e970766c">
## Как развернуть проект:
Склонировать репозиторий, установить зависимости командой npm install, запустить командой npm run dev
После проект запустится в браузере на порту 5173 (об этом будет сообщение в командной строке)
## Ссылка на деплой:
hhttps://hackathon-orpin-chi.vercel.app/
| cards memory game for hackathon 2023: choose field size, turns number, set timer and enjoy the game! built with ReactJS, css-modules and html | css-grid,functional-components,hooks,javascript,memory-game,react,vercel-deployment,vite,css-modules,react-portal | 2023-11-07T13:17:45Z | 2023-11-25T11:53:01Z | null | 3 | 11 | 64 | 0 | 0 | 2 | null | null | JavaScript |
aName2050/aOS-Web | main | # aOS-Web
A modern, web and cloud based operating system. No complex interfaces, simply straightforward and simple.
This project is a work in progress. Public testing should begin sometime next year.
# Languages
Currently supported languages are:
- English (en)
- Spanish (es)
<br />
More languages and possibly region based languages will be added later in development.
# Features
- None
| A modern, web and cloud based operating system. No complex interfaces, simply straightforward and simple. | cloud-os,css,html,javascript,os,react,typescript,web,web-os | 2023-11-07T04:22:04Z | 2023-12-20T20:49:10Z | null | 1 | 0 | 63 | 2 | 0 | 2 | null | GPL-3.0 | HTML |
xwilson03/right-bite | main | ## RightBite
We deployed our website on Vercel and have a custom domain name!
Try it out here: https://www.rightbite.co/
<img width="200" alt="image" src="https://github.com/xwilson03/right-bite/assets/91913752/2f8ba399-8028-492a-9bd3-affedf75f8a5">
<img width="200" alt="image" src="https://github.com/xwilson03/right-bite/assets/91913752/2f19e9b8-25f8-48ec-8a03-e2af24937b19">
<img width="200" alt="image" src="https://github.com/xwilson03/right-bite/assets/91913752/6cbddea8-4060-47da-aca3-bc16e52a9e44">
<img width="200" alt="image" src="https://github.com/xwilson03/right-bite/assets/91913752/f80a65e2-da20-476d-ae2d-b7968204ec64">
## Inspiration
Our inspiration for RightBite came from a shared commitment to food safety and informed eating. We recognized the need for a tool that empowers consumers to make healthier choices by providing essential safety information about the food they purchase.
## What it does
RightBite is a straightforward food safety awareness app. It allows users to scan product barcodes or input the barcode to receive key information about product ingredients. It assesses ingredient safety and provides a general safety rating for food items. Additionally, it displays an ingredient list ordered by proportion and flags potentially dangerous ingredients with harsher colors. Additionally, RightBite offers 1-2 sentence descriptions of each ingredient and their history, as well as manufacturer information for each product.
## How we built it
RightBite was built using a combination of technologies, including Typescript, Next.js, React.js, TailwindCSS, and Cheerio web-scraper to get product data in order to ensure a responsive and user-friendly interface. Additionally, we deployed the app on Vercel and configured it to our custom domain name from the GoDaddy Registry.
## Challenges we ran into
- We had to switch between multiple approaches of gathering product information using UPC.
- It also took multiple attempts to find a suitable React camera component as some were outdated and some were difficult to configure, but we finally found one that was able to successfully parse barcode information.
## Accomplishments that we're proud of
- We are proud of being able to figure out how to make the camera successfully scan a barcode.
- We're particularly proud of creating an app that puts the power of informed eating directly into the hands of consumers. RightBite has the potential to make a positive impact on the health and safety of individuals and communities in a fast, efficient way.
- We are also proud of being able to successfully register a domain name using GoDaddy Registry and deploying our app on Vercel.
- Lastly, half of the team had zero experience with the technology stack we used so there was a lot of fast-paced learning along the way.
## What we learned
- As mentioned previously, half of the team was new to the T3 stack and there was a steep learning curve. We are now able to confidently say that we understand Next.js.
## What's next for RightBite
- We want to be able to display macronutrient information so that the app is a one-stop shop for health and safety information of a product.
- Eventually, we want to convert our code to react-native code so it can be available as an app on all platforms.
- We want to be able to scan the barcodes of products without being confined to the products available with the UPC Food Searcher database. We would do this by implementing our own database instance and adding submission forms for any products that aren't already registered.
## Technologies Used
- React.js, Next.js, Vercel, TypeScript, TailwindCSS, Cheerio Web Scraper with UPC Food Search.
<p align = "center">
<img alt="Next.js" src= "https://img.shields.io/badge/next%20js-000000?style=for-the-badge&logo=nextdotjs&logoColor=white"/>
<img alt="React" src="https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB" />
<img alt="JavaScript" src= "https://img.shields.io/badge/JavaScript-323330?style=for-the-badge&logo=javascript&logoColor=F7DF1E" />
<img alt="Vercel" src="https://img.shields.io/badge/Vercel-000000?style=for-the-badge&logo=vercel&logoColor=white"/>
<img alt="TypeScript" src= "https://img.shields.io/badge/TypeScript-007ACC?style=for-the-badge&logo=typescript&logoColor=white"/>
<img alt="TailwindCSS" src= "https://img.shields.io/badge/Tailwind_CSS-38B2AC?style=for-the-badge&logo=tailwind-css&logoColor=white"/>
</p>
| Scan for smart food choices on the go with RightBite. | css,html,javascript,nextjs,react,tailwindcss,typescript,vercel,vercel-deployment | 2023-11-04T19:18:10Z | 2023-11-05T19:45:27Z | null | 4 | 0 | 14 | 0 | 0 | 2 | null | null | TypeScript |
prince4panwar/codeigniter | main | # codeigniter 🚀
Welcome to our dynamic tech hub! Explore the world of Java, PHP, C, C++, and more on our website.
## <a href = "https://prince4panwar.github.io/codeigniter/"> CODEIGNITER</a>
A comprehensive collection of PHP and Java topics and programs.
## Table of Contents
- [Introduction](#introduction)
- [Features](#features)
- [Getting Started](#getting-started)
- [PHP Topics](#php-topics)
- [Java Topics](#java-topics)
- [Contributing](#contributing)
- [License](#license)
## Introduction 💡
Welcome to the CodeIgniter repository! 🌐 This project is a comprehensive resource for anyone looking to dive into the worlds of PHP and Java. Whether you're a beginner eager to learn from scratch or an experienced developer seeking a quick reference, you'll find a wealth of topics, programs, and explanations here.
What to Expect 💡
In-Depth PHP Topics: Explore a curated collection of PHP topics, each accompanied by clear explanations and practical examples.
Java Programs and Explanations: Dive into Java with a variety of programs and detailed explanations, designed to enhance your understanding of Java concepts.
How to Get Started 🏁
To get started with this project, follow the simple instructions in the Getting Started section of this README. Clone the repository, navigate to the project directory, and you're ready to embark on your learning journey!
Let's Learn and Code Together! 👩💻👨💻
This project is not just a repository; it's a community of learners and contributors. Join us in exploring the exciting worlds of PHP and Java. Feel free to contribute, share your insights, and let's grow together!
Feel free to adjust the introduction based on the specific focus and goals of your project. Adding a personal touch and expressing enthusiasm can make it more inviting for potential users and contributors.
## Features 🌟
Highlight the key features of your website or the content included in the repository.
- In-depth PHP topics
- Java programs and explanations
- Many more
## Getting Started 🏁
Provide instructions on how users can get started with your project. Include any prerequisites, installation steps, or setup instructions.
```bash
# Clone the repository
git clone https://github.com/prince4panwar/codeigniter.git
| Welcome to our dynamic tech hub! Explore the world of Java, PHP, C, C++, and more on our website. | css,git,html5,javascript,version | 2023-11-03T17:22:23Z | 2024-02-04T06:02:59Z | null | 1 | 0 | 62 | 0 | 0 | 2 | null | null | HTML |
AbeeraTahir/crypto-trackr | main | <!-- TABLE OF CONTENTS -->
# 📗 Table of Contents
- [📖 CryptoTrackr](#cryptotrackr)
- [🛠 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)
- [👥 Author](#author)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [📝 License](#license)
<!-- PROJECT DESCRIPTION -->
# 📖 CryptoTrackr <a name="cryptotrackr"></a>
**CryptoTrackr** is a cryptocurrency tracking web application that provides users with real-time updates, statistics, and pricing history of different cryptocurrencies. Built with React, TypeScript, and Redux Toolkit Query, the app offers an intuitive user experience, making it easy to explore and analyze cryptocurrency data.
## 🛠 Built With <a name="built-with"></a>
### Tech Stack <a name="tech-stack"></a>
<details>
<summary>Client</summary>
<ul>
<li><a href="https://react.dev/">React</a></li>
<li><a href="https://www.typescriptlang.org/">TypeScript</a></li>
<li><a href="https://redux-toolkit.js.org/">Redux Toolkit</a></li>
<li><a href="https://tailwindcss.com/">Tailwind CSS</a></li>
</ul>
</details>
<!-- Features -->
### Key Features <a name="key-features"></a>
- **Cryptocurrency Tracking:** Provides real-time data, value statistics, and pricing history over the past 24 hours of different cryptocurrencies.
- **Searching:** User can search about a coin by its name.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- LIVE DEMO -->
## 🚀 Live Demo <a name="live-demo"></a>
- [Click here to see the live project](https://glistening-sprite-976d14.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:
- [Node.js](https://nodejs.org/en) installed.
### Setup
Clone this repository to your desired folder:
```sh
git clone https://github.com/AbeeraTahir/crypto-trackr.git
```
### Install
Install this project with:
```sh
npm install
```
### Usage
To run the project:
- Create a `.env` file in the root of the project.
- Inside that `.env` file, create a variable named `VITE_API_KEY` and assign your RapidAPI key to it. Then create a variable named `VITE_API_HOST` and assign your RapidAPI host to it.
- Run the following command to see the website:
```sh
npm run dev
```
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- AUTHORS -->
## 👥 Author <a name="author"></a>
👤 **Abeera Tahir**
- GitHub: [@AbeeraTahir](https://github.com/AbeeraTahir)
- LinkedIn: [Abeera Tahir](https://linkedin.com/in/abeera-tahir/)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- FUTURE FEATURES -->
## 🔭 Future Features <a name="future-features"></a>
- A feature for displaying different cryptocurrency exchnanges can be added.
<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>
Please give a ⭐️, if you like 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>
| CryptoTrackr is a cryptocurrency tracking web application that provides users with real-time updates, statistics, and pricing history of different cryptocurrencies. Built with React, TypeScript, and Redux Toolkit Query, the app offers an intuitive user experience, making it easy to explore and analyze cryptocurrency data. | javascript,react,tailwindcss,react-typescript,redux-toolkit,rtk-query,typescript | 2023-11-07T14:29:55Z | 2024-03-11T15:22:40Z | null | 1 | 2 | 44 | 0 | 0 | 2 | null | MIT | TypeScript |
LinThitHtwe/MovieTicketProject | master | # React + Vite
This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
Currently, two official plugins are available:
- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
| Movie Ticket Project With React JS | javascript,react,react-query | 2023-10-29T10:10:51Z | 2023-11-15T12:45:52Z | null | 1 | 0 | 40 | 0 | 0 | 2 | null | null | JavaScript |
MarcoDiaz2000/Front-End-Harley-Davidson | dev |
<a name="readme-top"></a>
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🚀 Back-end App](#back-end)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [👥 Authors](#authors)
- [📆 Kanban Board](#kanban-board)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgments](#acknowledgements)
- [📝 License](#license)
<!-- PROJECT DESCRIPTION -->
# 📖 Final group capstone - Book an Appointment <a name="about-project"></a>
**[Description]**
The project we built for the Final Project is based on an app to book an appointment to test ride a Harley-Davidson motorcycle.
## 🚀 Backend App <a name="back-end"></a>
- [Click here to navigate to the Backend ](https://github.com/MarcoDiaz2000/Back-End-Harley-Davidson)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 🛠 Built With <a name="built-with"></a>
### Tech Stack <a name="tech-stack"></a>
- Ruby on Rails >=7
- React
- Postgres
### Key Features <a name="key-features"></a>
- Connection between Ruby on Rails and React in different apps
- Book an appointment to try a motorcycle
- Motorcycles that you selected as a theme
- Reserve form
<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://harley-davidson-73po.onrender.com/)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- GETTING STARTED -->
## 💻 Getting Started <a name="getting-started"></a>
### Prerequisites
- [Ruby on Rails >=7](https://rubyonrails.org/)
- [React](https://reactjs.org/)
- [Postgres](https://www.postgresql.org/)
- [Git](https://git-scm.com/downloads)
### Install
```
git clone https://github.com/Salimer/Final-Capstone-Back-End.git
cd Final-Capstone-Back-End
bundle install
```
```
git clone https://github.com/Salimer/Final-Capstone-Front-End.git
cd Final-Capstone-Front-End
npm install
```
### Usage
\`\`\`
rails s
\`\`\`
\`\`\`
npm start
\`\`\`
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- AUTHORS -->
## 👥 Authors <a name="authors"></a>
👤 **Marco Díaz**
- GitHub: [@MarcoDiaz](https://github.com/MarcoDiaz2000)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/marco-diaz-0876a7268/)
👤 **Salim Bamahfoodh**
- GitHub: [@salimer](https://github.com/salimer)
- LinkedIn: [LinkedIn](https://linkedin.com/in/sbamahfoodh)
👤 **Sumeya Ibrahim**
- GitHub: [@isume295](https://github.com/isume295)
👤 **Tamoor Saeed**
- GitHub: [@githubhandle](https://github.com/tamoorsaeed22)
- Twitter: [@twitterhandle](https://www.linkedin.com/in/tamoor-saeed-58912a233/)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/tamoorsaeed/)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- Kanban Board -->
## 📆 Kanban Board <a name="kanban-board"></a>
- [Our kanban board](https://github.com/Salimer/Final-Capstone-Back-End/projects/1)
- [Kanban board initial state](https://user-images.githubusercontent.com/125866339/269276243-8a11c76f-a047-43ac-a45a-6bcf02e168be.jpg)
- We are a team of 4 members as stated in the authors section
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 🔭 Future Features <a name="future-features"></a>
- Add different categories of motorcycles
- Add online shopping
- Add extra styling
<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!
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 found this project helpful, consider giving a ⭐️!
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- ACKNOWLEDGEMENTS -->
## 🙏 Acknowledgments <a name="acknowledgements"></a>
### Acknowledgments
We would like to express our deepest gratitude to all the people and institutions that have contributed to make this project possible.
#### Development Team
- **Sumeya Ibrahim**: Thank you for your constant support and your incredible problem-solving skills. Your knowledge and experience have been invaluable.
- **Salim Bamahfoodh**: I appreciate your commitment and dedication. Your perspective has always been essential for the project's development.
- **Tamoor Saeed**: Thank you for your collaboration and meaningful contributions, which have helped shape and direct the project.
- **Marco Díaz**: Your technical skill and creative input have been pivotal in achieving our goals. Thank you for always being available.
#### Institution
- **Microverse**: My sincerest thanks for creating this bootcamp. The program's structure and the quality of education provided have been crucial for my growth as a developer.
#### Reference Design
- I would also like to thank [<a href="https://www.behance.net/muratk">Murat Korkmaz</a>] for the original design on Behance that served as inspiration for 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>
| The project we built is based on an app to book an appointment to test ride a Harley-Davidson motorcycle. | backend-api,front-end,full-stack-web-development,github,javascript,pair-programming,reactjs,rub,ruby,ruby-on-rails | 2023-10-12T10:27:38Z | 2023-10-12T10:58:46Z | null | 4 | 1 | 302 | 0 | 0 | 2 | null | MIT | JavaScript |
mthsoliveira7/meuFone | master | <h1 align="center">
meuFone
</h1>
<p align="center">
https://meu-fone.vercel.app/
</p>
A meuFone é um e-commerce fictício de venda de fones de ouvido, desenvolvido com Next.js e Tailwind CSS. O projeto consiste em três páginas principais: a página inicial, que serve como a porta de entrada do site, apresentando os produtos mais populares ou recentes:
O catálogo, que lista todos os produtos disponíveis para venda:
E por último a página de detalhes do produto que fornece informações detalhadas sobre um produto específico, incluindo descrição, preço, imagem e avaliações:
## Stack Usado
- [React](https://react.dev) - Biblioteca de JavaScript para criação de interfaces de usuário interativas e componentizadas
- [Next.js](https://nextjs.org/) - Framework do React que fornece um conjunto de ferramentas para facilitar a criação de aplicações web de alto desempenho, permitindo a renderização do lado do servidor e geração de sites estáticos.
- [Tailwind CSS](https://tailwindcss.com) - Framework de CSS orientado por utilitários para desenvolvimento rápido de interfaces de usuário
- [Cloudflare](https://pages.cloudflare.com) - Plataforma JAMstack usada pra publicação do site.
## Rodar localmente
```bash
$ git clone https://github.com/mthsoliveira7/meuFone.git
$ cd meuFone
$ npm install
$ npm run dev
```
## Figma
Se estiver procurando pelo design do Figma, você pode encontrá-lo **[aqui](https://www.figma.com/community/file/1298303959024363654/meufone)**.
## Autor
- Matheus Oliveira
- [Meu portfólio](https://mths-portfolio-website.pages.dev/) — [Meus links](https://linksta.cc/@mthsoliveira7)
## Licença
Licenciado sob a [licença MIT](https://github.com/mthsoliveira7/meuFone/blob/master/LICENSE).
| Loja de fones fictícia criada pro meu portfólio | javascript,next,nextjs,react,tailwind,tailwindcss | 2023-10-15T00:10:03Z | 2023-10-23T15:21:08Z | null | 1 | 0 | 19 | 0 | 0 | 2 | null | MIT | JavaScript |
mthsoliveira7/mths-portfolio-website | main | <h1 align="center">
Meu portfólio - v1
</h1>
<p align="center">
https://mths-portfolio-website.pages.dev/
</p>
<p align="center">Primeira versão do meu portfólio, feita inteiramente por mim.</p>
## Stack Usado
- [Svelte](https://svelte.dev/) - Biblioteca JavaScript que compila componentes para código JavaScript altamente otimizado
- [Tailwind CSS](https://tailwindcss.com) - Framework de CSS orientado por utilitários para desenvolvimento rápido de interfaces de usuário
- [unplugin-icons](https://github.com/unplugin/unplugin-icons) - Plugin que permite usar qualquer pacote de ícones em seu projeto
- [Cloudflare](https://pages.cloudflare.com) - Plataforma para a implantação e hospedagem de sites estáticos e aplicações Jamstack.
## Rodar localmente
```bash
$ git clone https://github.com/mthsoliveira7/mths-portfolio-website.git
$ cd mths-portfolio-website
$ npm install
$ npm run dev
```
## Figma
Se estiver procurando pelo design do Figma, você pode encontrá-lo **[aqui](https://media.tenor.com/CmcVmK0EC0kAAAAC/coming-soon-em-breve.gif)**.
## Autor
- Matheus Oliveira
- [Meu portfólio](https://mths-portfolio-website.pages.dev/) — [Meus links](https://linksta.cc/@mthsoliveira7)
## Licença
Licenciado sob a [licença MIT](https://github.com/mthsoliveira7/mths-portfolio-website/blob/master/LICENSE).
| Primeira versão do meu portfólio pessoal, codado por mim. | javascript,svelte,sveltekit,tailwind,tailwindcss | 2023-10-21T21:40:13Z | 2024-04-04T12:47:55Z | null | 1 | 0 | 6 | 0 | 0 | 2 | null | MIT | Svelte |
pandatix/gojs-cvss | main | <div align="center">
<h1>GoJS-CVSS</h1>
<p>Transpilation of <a href="https://github.com/pandatix/go-cvss">github.com/pandatix/go-cvss</a> into JS using <a href="https://github.com/gopherjs/gopherjs">gopherjs</a></p>
<a href="https://pkg.go.dev/github.com/pandatix/gojs-cvss"><img src="https://shields.io/badge/-reference-blue?logo=go&style=for-the-badge" alt="reference"></a>
<a href="https://goreportcard.com/report/github.com/pandatix/gojs-cvss"><img src="https://goreportcard.com/badge/github.com/pandatix/gojs-cvss?style=for-the-badge" alt="go report"></a>
<a href="https://coveralls.io/github/pandatix/gojs-cvss?branch=main"><img src="https://img.shields.io/coverallsCoverage/github/pandatix/gojs-cvss?style=for-the-badge" alt="Coverage Status"></a>
<br>
<a href=""><img src="https://img.shields.io/github/license/pandatix/gojs-cvss?style=for-the-badge" alt="License"></a>
<a href="https://github.com/pandatix/gojs-cvss/actions?query=workflow%3Aci+"><img src="https://img.shields.io/github/actions/workflow/status/pandatix/gojs-cvss/ci.yaml?style=for-the-badge&label=CI" alt="CI"></a>
<a href="https://github.com/pandatix/gojs-cvss/actions/workflows/codeql-analysis.yaml"><img src="https://img.shields.io/github/actions/workflow/status/pandatix/gojs-cvss/codeql-analysis.yaml?style=for-the-badge&label=CodeQL" alt="CodeQL"></a>
<br>
<a href="https://securityscorecards.dev/viewer/?uri=github.com/pandatix/gojs-cvss"><img src="https://img.shields.io/ossf-scorecard/github.com/pandatix/gojs-cvss?label=openssf%20scorecard&style=for-the-badge" alt="OpenSSF Scoreboard"></a>
</div>
It currently supports :
- [ ] [CVSS 2.0](https://www.first.org/cvss/v2/guide)
- [ ] [CVSS 3.0](https://www.first.org/cvss/v3.0/specification-document)
- [ ] [CVSS 3.1](https://www.first.org/cvss/v3.1/specification-document)
- [X] [CVSS 4.0](https://www.first.org/cvss/v4.0/specification-document)
## How to use
### API
The API provides multiple ways to handle CVSS v4.0:
- as an in-browser global script: `<script src="gojs-cvss.js"></script>`
- as a Node module: `m = require("./gojs-cvss.js")`
From the global/module import, you have:
- the `CVSS40` type that you can create either with `vec = new CVSS40()` or `vec = m.cvss40.New()`
- the `Rating` method that cou can call with `Rating(...)` or `m.Rating(...)`, takes a Number and returns a 2-objects slice composed of the rating (`String` or `null`) and an error message (`String` or `null`) if the value is out of bounds
The `CVSS40` object has multiple methods:
- `Parse(vector)`: takes a CVSS v4.0 string representation to parse it and returns an error message (`String` or `null`)
- `Vector()`: returns the string representation (`String`) of the CVSS v4.0 object.
- `Get(metric)`: takes the metric (`String`) to get and returns a 2-objects slice composed of the metric value (`String` or `null`) and an error message (`String` or `null`)
- `Set(metric, value)`: takes the metric and the value (`String`) to set it to, and returns an error message (`String` or `null`)
- `Score()`: returns the score of the CVSS v4.0 object (`Number`)
- `Nomenclature()`: returns the nomenclature of the CVSS v4.0 object (`String`)
The [examples](examples) are equivalent and shows how to parse a CVSS v4.0 string representation, change a metric value, compute its score+nomenclature and print the new vector.
| Transpilation of github.com/pandatix/go-cvss to JS | cvss,cvssv4,golang,javascript,transpilation | 2023-10-28T13:07:33Z | 2024-05-13T10:29:04Z | 2023-10-30T14:18:06Z | 1 | 15 | 26 | 0 | 0 | 2 | null | MIT | Go |
conductor-oss/conductor | main | 
[](https://GitHub.com/Netflix/conductor-oss/releases)
[](http://www.apache.org/licenses/LICENSE-2.0)
Conductor is a platform _originally_ created at Netflix to orchestrate microservices and events.
Conductor OSS is maintained by the team of developers at [Orkes](https://orkes.io/) along with the members of the open source community.
## Conductor OSS
This is the new home for the Conductor open source going forward (previously hosted at Netflix/Conductor).
> [!IMPORTANT]
> Going forward, all the bug fixes, feature requests and security patches will be applied and released from this repository.
The last published version of Netflix Conductor will be **3.15.0** which we will continue to support.
If you would like to participate in the roadmap and development, [please reach out](https://forms.gle/P2i1xHrxPQLrjzTB7).
## ⭐ This repository
Show support for the Conductor OSS. Please help spread the awareness by starring this repo.
[](https://GitHub.com/conductor-oss/conductor/)
## Update your local forks/clones
Please update your forks to point to this repo. This will ensure your commits and PRs can be send against this repository
```shell
git remote set-url origin https://github.com/conductor-oss/conductor
```
> [!IMPORTANT]
> **Follow the steps below if you have an active PR against the Netflix/Conductor repository**
> 1. Fork **this** repository
> 2. Update your local repository to change the remote to this repository
> 3. Send a PR against the `main` branch
## Conductor OSS Roadmap
[See the roadmap for the Conductor](ROADMAP.md)
## Releases
The latest version is [](https://GitHub.com/conductor-oss/conductor/releases)
## Resources
#### [Slack Community](https://join.slack.com/t/orkes-conductor/shared_invite/zt-2hmxn0i3n-_W~a9rWMbvMoYmlJo3Y15g)
We have an active [community](https://join.slack.com/t/orkes-conductor/shared_invite/zt-2hmxn0i3n-_W~a9rWMbvMoYmlJo3Y15g) of Conductor users and contributors on the channel.
#### [Documentation Site](https://docs.conductor-oss.org/)
[Documentation](https://docs.conductor-oss.org/) and tutorial on how to use Conductor
[Discussion Forum](https://github.com/conductor-oss/conductor/discussions): Please use the forum for questions and discussing ideas and join the community.
### Conductor SDKs
Conductor supports creating workflows using JSON and Code.
SDK support for creating workflows using code is available in multiple languages and can be found at https://github.com/conductor-sdk
## Getting Started - Building & Running Conductor
### From Source:
If you wish to build your own distribution, you can run ```./gradlew build``` from this project that products the runtime artifacts.
The runnable server is in server/ module.
### Using Docker (Recommended)
Follow the steps below to launch the docker container:
```shell
docker compose -f docker/docker-compose.yaml up
```
* Navigate to http://localhost:5000 once the container starts to launch UI.
* APIs are accessible at http://localhost:8080
* Swagger Docs:http://localhost:8080/swagger-ui/index.html?configUrl=/api-docs/swagger-config#/
## Database Requirements
* The default persistence used is Redis
* The indexing backend is [Elasticsearch](https://www.elastic.co/) (7.x)
## Other Requirements
* JDK 17+
* UI requires Node 14 to build. Earlier Node versions may work but are untested.
## Get Support
There are several ways to get in touch with us:
* [Slack Community](https://join.slack.com/t/orkes-conductor/shared_invite/zt-xyxqyseb-YZ3hwwAgHJH97bsrYRnSZg)
## Contributors
<a href="https://github.com/conductor-oss/conductor/graphs/contributors">
<img src="https://contrib.rocks/image?repo=conductor-oss/conductor" />
</a>
| Conductor is an event driven orchestration platform | distributed-systems,grpc,java,javascript,microservice-orchestration,orchestration-engine,orchestrator,reactjs,spring-boot,workflow-automation | 2023-12-08T06:06:09Z | 2024-05-12T19:01:07Z | 2024-04-10T17:23:48Z | 33 | 94 | 3,494 | 44 | 280 | 11,202 | null | Apache-2.0 | Java |
microsoft/Mastering-GitHub-Copilot-for-Paired-Programming | main | 
# Mastering GitHub Copilot for AI Paired Programming
A 7 Lesson course teaching everything you need to know about harnessing GitHub Copilot and an AI Paired Programing resource.
Unlock the power of collaborative coding with our comprehensive curriculum on Mastering GitHub Copilot for Paired Programming. This cutting-edge program seamlessly integrates AI-driven coding assistance through GitHub Copilot, empowering students to accelerate their coding skills in tandem with a partner. Over the course of 10 engaging hours, participants will navigate through essential setup procedures, leveraging Visual Studio Code and GitHub Copilot Chat for real-time collaboration. Dive deep into GitHub Copilot's autocompletion, customizable features, and advanced programming techniques, all while embracing AI-driven algorithms. From error handling to unit testing, this curriculum is tailored to instill best practices and enhance code quality. Immerse yourself in a transformative learning experience that fuses the latest AI technology with paired programming strategies, equipping you with the tools needed for success in today's dynamic software development landscape.
## 🌱 Getting Started
To get started, be sure to follow instructions on how to fork lessons to your own GitHub account to be able to change any code and complete the challenges. You can also [star (🌟) this repo](https://docs.github.com/en/get-started/exploring-projects-on-github/saving-repositories-with-stars?WT.mc_id=academic-113596-abartolo) to find it easier later.
Below are the links to each lesson. Feel free to explore and start at any lesson that interests you the most!
## 🧠 Want to learn more?
After completing this course, check out our [GitHub Copilot Learn Collection](https://learn.microsoft.com/collections/kkqrhmxoqn54?WT.mc_id=academic-113596-abartolo) to continue leveling up your AI Paired Programming knowledge!
## 🚀 Are you a startup or got an idea you want to launch?
Sign up for [Microsoft for Startups Founders Hub](https://foundershub.startups.microsoft.com/signup?WT.mc_id=academic-113596-abartolo) to receive **free OpenAI credits** and up to **$150k towards Azure credits to access OpenAI models through Azure OpenAI Services**.
## 🙏 Want to help?
Here are ways you can contribute to this course:
- Find spelling errors or code errors, [Raise an issue](https://github.com/microsoft/) or [Create a pull request](https://github.com/microsoft/)
- Send us your ideas, maybe your ideas for new lessons or exercises, and let us know how we can improve.
## 📂 Each lesson includes:
- a written lesson located in the README
- a challenge or assignment to apply your learning
- links to extra resources to continue your learning
## 🗃️ Lessons
| | Lesson Link | Concepts Taught | Learning Goal |
| :---: | :------------------------------------: | :---------------------------------------------------------: | ----------------------------------------------------------- |
| 01 | [Introduction to GitHub](./01-Introduction-to-GitHub/README.md?WT.mc_id=academic-113596-abartolo) | Get started using GitHub in less than an hour.| Introduction to repositories, branches, commits, and pull requests. |
| 02 | [Introduction to GitHub Codespaces](./02-Introduction-to-GitHub-Codespaces?WT.mc_id=academic-113596-abartolo) | Develop code using GitHub Codespaces and Visual Studio Code! | How to create a codespace, push code from a codespace, select a custom image, and customize a codespace. |
| 03 | [Introduction to GitHub Copilot](./03-Introduction-to-GitHub-Copilot?WT.mc_id=academic-113596-abartolo) | GitHub Copilot can help you code by offering autocomplete-style suggestions right in VS Code and Codespaces. | Creating files that will have code generated by Copilot AI for code and comment suggestions. |
| 04 | [Using GitHub Copilot with JavaScript](./04-Using-GitHub-Copilot-with-JavaScript?WT.mc_id=academic-113596-abartolo) | Use GitHub Copilot, an AI pair programmer that offers autocomplete-style suggestions as you code, to work with JavaScript. | Enable the GitHub Copilot extension in Visual Studio Code. Craft prompts that can generate useful suggestions from GitHub Copilot. Use GitHub Copilot to improve a JavaScript project. |
| 05 | [Using GitHub Copilot with Python](./05-Using-GitHub-Copilot-with-Python?WT.mc_id=academic-113596-abartolo) | Use GitHub Copilot, an AI pair programmer that offers autocomplete-style suggestions as you code, to work with Python. | Enable the GitHub Copilot extension in Visual Studio Code. Craft prompts that can generate useful suggestions from GitHub Copilot. Use GitHub Copilot to improve a Python project. |
| 06 | [Using GitHub Copilot with C#](./06-Using-GitHub-Copilot-with-CSharp?WT.mc_id=academic-113596-abartolo) | Use GitHub Copilot, an AI pair programmer that offers autocomplete-style suggestions as you code, to work with C#. | Enable the GitHub Copilot extension in Visual Studio Code. Craft prompts that can generate useful suggestions from GitHub Copilot. Use GitHub Copilot to improve a C# Minimal API project. |
| 07 | [Creating a Mini Game with GitHub Copilot](./06-Creating-Mini-Game-with-GitHub-Copilot?WT.mc_id=academic-113596-abartolo) | Use GitHub Copilot to assist you in building a Python based mini game. | Craft prompts that can generate useful suggestions from GitHub Copilot to incorporate gaming logic and improve your Python based game. |
## 🎒 Other Courses
Our team produces other courses! Check out:
- [Generative AI for Beginners](https://aka.ms/genai-beginners)
- [AI for Beginners](https://aka.ms/ai-beginners?WT.mc_id=academic-113596-abartolo)
- [Data Science for Beginners](https://aka.ms/datascience-beginners?WT.mc_id=academic-113596-abartolo)
- [ML for Beginners](https://aka.ms/ml-beginners?WT.mc_id=academic-113596-abartolo)
- [Cybersecurity for Beginners](https://github.com/microsoft/Security-101??WT.mc_id=academic-96948-sayoung)
- [Web Dev for Beginners](https://aka.ms/webdev-beginners?WT.mc_id=academic-113596-abartolo)
- [IoT for Beginners](https://aka.ms/iot-beginners?WT.mc_id=academic-113596-abartolo)
- [XR Development for Beginners](https://github.com/microsoft/xr-development-for-beginners?WT.mc_id=academic-113596-abartolo)
| A 7 Lesson course teaching everything you need to know about harnessing GitHub Copilot and an AI Paired Programing resource. | codespace,codespaces,copilot,csharp,dotnet,github,javascript,python | 2023-11-29T19:35:47Z | 2024-05-22T23:47:06Z | null | 10,000 | 17 | 95 | 0 | 552 | 4,307 | null | MIT | Python |
mouredev/roadmap-retos-programacion | main | 
# Roadmap retos de programación semanales 2024
### Ruta de estudio con ejercicios para mejorar tu lógica de programación y aprender cualquier lenguaje. Gratis, a tu ritmo y en comunidad.
#### [https://retosdeprogramacion.com/roadmap](https://retosdeprogramacion.com/roadmap)
[](https://github.com/mouredev/retos-programacion-web)
## Ranking de lenguajes y usuarios
#### ¿Estás participando en los retos? Ahora puedes consultar el ranking de usuarios y lenguajes según su número de contribuciones.
#### [https://retosdeprogramacion.com/roadmap/ranking](https://retosdeprogramacion.com/roadmap/ranking)
## Información importante
* Cada semana se publica un nuevo reto y se corrige en directo desde **[Twitch](https://twitch.tv/mouredev)** el ejercicio de la semana pasada.
* En la sección "Eventos" de nuestro servidor de **[Discord](https://discord.gg/mouredev)** encontrarás el día y horario por país de los directos.
* Puedes utilizar **cualquier lenguaje de programación**, y encontrar tanto mis correcciones como las de la comunidad en el directorio de cada reto.
* **¿Quieres participar?** Te lo explico en la sección **[Instrucciones](https://github.com/mouredev/roadmap-retos-programacion#instrucciones)** en este mismo documento.
* Los retos siguen un orden basado en su ruta de estudio pero si ya tienes conocimientos puedes resolverlos de manera totalmente independiente. Simplemente revisa su nivel de dificultad.
* Una vez se haya cumplido la semana de publicación del reto, podrás consultar mi corrección y las de la comunidad en cualquier lenguaje de programación.
> Consulta la [web](https://retosdeprogramacion.com/roadmap) para más información.
## Corrección y próximo ejercicio
> #### Lunes 27 de mayo de 2024 a las 20:00 (hora España) desde **[Twitch](https://twitch.tv/mouredev)**
> #### Consulta el **[horario](https://discord.gg/9Nxvfsfp?event=1239679210918903858)** por país y crea un **[recordatorio](https://discord.gg/9Nxvfsfp?event=1239679210918903858)**
## Roadmap
| # | Ejercicio | Corrección | Vídeo | Comunidad |
|---|-----------|------------|-------|-----------|
|00|[SINTAXIS, VARIABLES, TIPOS DE DATOS Y HOLA MUNDO](./Roadmap/00%20-%20SINTAXIS,%20VARIABLES,%20TIPOS%20DE%20DATOS%20Y%20HOLA%20MUNDO/ejercicio.md)|[📝](./Roadmap/00%20-%20SINTAXIS,%20VARIABLES,%20TIPOS%20DE%20DATOS%20Y%20HOLA%20MUNDO/python/mouredev.py)|[▶️](https://youtu.be/gEIBJ7rmLa0)|[👥](./Roadmap/00%20-%20SINTAXIS,%20VARIABLES,%20TIPOS%20DE%20DATOS%20Y%20HOLA%20MUNDO/)
|01|[OPERADORES Y ESTRUCTURAS DE CONTROL](./Roadmap/01%20-%20OPERADORES%20Y%20ESTRUCTURAS%20DE%20CONTROL/ejercicio.md)|[📝](./Roadmap/01%20-%20OPERADORES%20Y%20ESTRUCTURAS%20DE%20CONTROL/python/mouredev.py)|[▶️](https://youtu.be/DLSGCh9jdes)|[👥](./Roadmap/01%20-%20OPERADORES%20Y%20ESTRUCTURAS%20DE%20CONTROL/)
|02|[FUNCIONES Y ALCANCE](./Roadmap/02%20-%20FUNCIONES%20Y%20ALCANCE/ejercicio.md)|[📝](./Roadmap/02%20-%20FUNCIONES%20Y%20ALCANCE/python/mouredev.py)|[▶️](https://youtu.be/auxClgiX6UM)|[👥](./Roadmap/02%20-%20FUNCIONES%20Y%20ALCANCE/)
|03|[ESTRUCTURAS DE DATOS](./Roadmap/03%20-%20ESTRUCTURAS%20DE%20DATOS/ejercicio.md)|[📝](./Roadmap/03%20-%20ESTRUCTURAS%20DE%20DATOS/python/mouredev.py)|[▶️](https://youtu.be/brxtPtUbU7M)|[👥](./Roadmap/03%20-%20ESTRUCTURAS%20DE%20DATOS/)
|04|[CADENAS DE CARACTERES](./Roadmap/04%20-%20CADENAS%20DE%20CARACTERES/ejercicio.md)|[📝](./Roadmap/04%20-%20CADENAS%20DE%20CARACTERES/python/mouredev.py)|[▶️](https://youtu.be/CKzY7nHwulA)|[👥](./Roadmap/04%20-%20CADENAS%20DE%20CARACTERES/)
|05|[VALOR Y REFERENCIA](./Roadmap/05%20-%20VALOR%20Y%20REFERENCIA/ejercicio.md)|[📝](./Roadmap/05%20-%20VALOR%20Y%20REFERENCIA/python/mouredev.py)|[▶️](https://youtu.be/P2OQDT9Wrb0)|[👥](./Roadmap/05%20-%20VALOR%20Y%20REFERENCIA/)
|06|[RECURSIVIDAD](./Roadmap/06%20-%20RECURSIVIDAD/ejercicio.md)|[📝](./Roadmap/06%20-%20RECURSIVIDAD/python/mouredev.py)|[▶️](https://youtu.be/nTfDkLRrYiM)|[👥](./Roadmap/06%20-%20RECURSIVIDAD/)
|07|[PILAS Y COLAS](./Roadmap/07%20-%20PILAS%20Y%20COLAS/ejercicio.md)|[📝](./Roadmap/07%20-%20PILAS%20Y%20COLAS/python/mouredev.py)|[▶️](https://youtu.be/cBeRWS2X0CA)|[👥](./Roadmap/07%20-%20PILAS%20Y%20COLAS/)
|08|[CLASES](./Roadmap/08%20-%20CLASES/ejercicio.md)|[📝](./Roadmap/08%20-%20CLASES/python/mouredev.py)|[▶️](https://youtu.be/W4tv8WUbum4)|[👥](./Roadmap/08%20-%20CLASES/)
|09|[HERENCIA Y POLIMORFISMO](./Roadmap/09%20-%20HERENCIA/ejercicio.md)|[📝](./Roadmap/09%20-%20HERENCIA/python/mouredev.py)|[▶️](https://youtu.be/PVBs5PWjedA)|[👥](./Roadmap/09%20-%20HERENCIA/)
|10|[EXCEPCIONES](./Roadmap/10%20-%20EXCEPCIONES/ejercicio.md)|[📝](./Roadmap/10%20-%20EXCEPCIONES/python/mouredev.py)|[▶️](https://youtu.be/mfOzfj-BrQo)|[👥](./Roadmap/10%20-%20EXCEPCIONES/)
|11|[MANEJO DE FICHEROS](./Roadmap/11%20-%20MANEJO%20DE%20FICHEROS/ejercicio.md)|[📝](./Roadmap/11%20-%20MANEJO%20DE%20FICHEROS/python/mouredev.py)|[▶️](https://youtu.be/Bsiay2nax4Y)|[👥](./Roadmap/11%20-%20MANEJO%20DE%20FICHEROS/)
|12|[JSON Y XML](./Roadmap/12%20-%20JSON%20Y%20XML/ejercicio.md)|[📝](./Roadmap/12%20-%20JSON%20Y%20XML/python/mouredev.py)|[▶️](https://youtu.be/OwStihBItEg)|[👥](./Roadmap/12%20-%20JSON%20Y%20XML/)
|13|[PRUEBAS UNITARIAS](./Roadmap/13%20-%20PRUEBAS%20UNITARIAS/ejercicio.md)|[📝](./Roadmap/13%20-%20PRUEBAS%20UNITARIAS/python/mouredev.py)|[▶️](https://youtu.be/3WFQ2grp0h0)|[👥](./Roadmap/13%20-%20PRUEBAS%20UNITARIAS/)
|14|[FECHAS](./Roadmap/14%20-%20FECHAS/ejercicio.md)|[📝](./Roadmap/14%20-%20FECHAS/python/mouredev.py)|[▶️](https://youtu.be/EQIAhF7NNMI)|[👥](./Roadmap/14%20-%20FECHAS/)
|15|[ASINCRONÍA](./Roadmap/15%20-%20ASINCRONÍA/ejercicio.md)|[📝](./Roadmap/15%20-%20ASINCRONÍA/python/mouredev.py)|[▶️](https://youtu.be/YA8Ssd3AUwA)|[👥](./Roadmap/15%20-%20ASINCRONÍA/)
|16|[EXPRESIONES REGULARES](./Roadmap/16%20-%20EXPRESIONES%20REGULARES/ejercicio.md)|[📝](./Roadmap/16%20-%20EXPRESIONES%20REGULARES/python/mouredev.py)|[▶️](https://youtu.be/0L7IfEF19ow)|[👥](./Roadmap/16%20-%20EXPRESIONES%20REGULARES/)
|17|[ITERACIONES](./Roadmap/17%20-%20ITERACIONES/ejercicio.md)|[📝](./Roadmap/17%20-%20ITERACIONES/python/mouredev.py)|[▶️](https://youtu.be/X1ROaPH_ci8)|[👥](./Roadmap/17%20-%20ITERACIONES/)
|18|[CONJUNTOS](./Roadmap/18%20-%20CONJUNTOS/ejercicio.md)|[📝](./Roadmap/18%20-%20CONJUNTOS/python/mouredev.py)|[▶️](https://youtu.be/0auuM4GROVA)|[👥](./Roadmap/18%20-%20CONJUNTOS/)
|19|[ENUMERACIONES](./Roadmap/19%20-%20ENUMERACIONES/ejercicio.md)|[📝](./Roadmap/19%20-%20ENUMERACIONES/python/mouredev.py)|[▶️](https://youtu.be/0auuM4GROVA)|[👥](./Roadmap/19%20-%20ENUMERACIONES/)
|20|[PETICIONES HTTP](./Roadmap/20%20-%20PETICIONES%20HTTP/ejercicio.md)|[📝](./Roadmap/20%20-%20PETICIONES%20HTTP/python/mouredev.py)|[▶️](https://youtu.be/-pYMoPYSkgM)|[👥](./Roadmap/20%20-%20PETICIONES%20HTTP/)
|21|[CALLBACKS](./Roadmap/21%20-%20CALLBACKS/ejercicio.md)|[🗓️ 27/05/24](https://discord.gg/9Nxvfsfp?event=1239679210918903858)||[👥](./Roadmap/21%20-%20CALLBACKS/)
## Instrucciones
**Haz un [FORK](https://github.com/mouredev/roadmap-retos-programacion/fork) del proyecto y trabaja con Git para ir sincronizando las actualizaciones.**
1. En el proyecto tienes un directorio para cada ejercicio en la carpeta [Roadmap](./Roadmap). Dentro de cada directorio encontrarás un fichero llamado **ejercicio.md** con el enunciado de cada reto.
2. Si quieres compartir tu propia solución de un ejercicio con la comunidad, crea un fichero de código con tu nombre y extensión, y realiza una [**PULL REQUEST**](https://docs.github.com/es/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) contra el repositorio.
3. El fichero de código debe situarse dentro del directorio del reto, en la carpeta correspondiente al lenguaje de programación utilizado (si no existe la carpeta del lenguaje, créala con todas sus letras en minúsculas). Por ejemplo, si has resuelto el reto #00 utilizando el lenguaje de programación Python y tu usuario de GitHub se llama "mouredev", tu corrección deberá estar en **"Roadmap/#00/python/mouredev.py"**. El título de la Pull Request también debe seguir este formato: **"#[número] - [lenguaje_utilizado]"**. En el ejemplo anterior sería **"#00 - Python"**. Se rechazarán las Pull Request que no sigan este formato o contengan ficheros adicionales.
4. Cada **SEMANA** (consulta el día en el ejercicio correspondiente) realizaré una transmisión en directo desde **[Twitch](https://twitch.tv/mouredev)** corrigiendo el reto, revisando soluciones de la comunidad y publicando un nuevo ejercicio.
5. Si necesitas ayuda o quieres comentar cualquier cosa sobre los retos semanales, tienes el canal "reto-semanal” en nuestro servidor de **[Discord](https://discord.gg/mouredev)** (también el día y horario de corrección en la sección "Eventos").
6. Puedes proponer Pull Request con propuestas o correcciones sobre ejercicios del resto de la comunidad si estos poseen errores. De esta manera colaboraremos para crear un repositorio cada vez más valioso.
7. Si se te solicita un cambio/corrección en una Pull Request, y al cabo de 2 semanas no se muestra nueva actividad, se cerrará esa petición para mantener el repositorio limpio. Por supuesto, puedes volver a enviar la Pull Request cuando quieras.
## Aclaraciones
Si tienes dudas con el nombre del directorio de algún lenguaje, intenta consultar el nombre que se ha empleado en ejercicios anteriores. Algunos ejemplos que puedes llegar a dudar:
* c#, no csharp
* c++, no cplusplus
* go, no golang
* javascript, no js
## Guía rápida Git y GitHub
1. Realiza un [FORK](https://github.com/mouredev/roadmap-retos-programacion/fork) del repositorio de retos semanales desde GitHub.
2. CLONA ese repositorio a tu máquina local `git clone [TU-REPOSITORIO]`.
3. (Opcional) Crea una RAMA para la solución y desplázate a ella `git checkout -b [EL-NOMBRE-DE-TU-RAMA]`.
4. Añade el fichero de tu solución al STAGE `git add [FICHERO-DE-TU-RETO]`.
5. Haz COMMIT con el mensaje de la solución `git commit -m "#[NÚMERO-RETO] - [LENGUAJE-UTILIZADO]"`.
6. Haz PUSH `git push [EL-NOMBRE-DE-TU-RAMA]` (puede ser la "main" o la que creaste en el paso 3)
7. En el repositorio principal debes ir a la rama y hacer [PULL REQUEST](https://docs.github.com/es/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request).
8. CONTRIBUTE.
9. CREATE PULL REQUEST (cubre la plantilla que te aparecerá).
10. Si el proceso de entrega se ha realizado de forma correcta, se añadirá tu corrección al repositorio. En caso contrario, se te notificarán los cambios a realizar o los motivos del rechazo.
*He creado un curso completo gratis para aprender a trabajar con Git y GitHub desde cero.*
[](https://github.com/mouredev/hello-git)
## Más retos de programación
**Consulta los 101 retos de programación resueltos y las 12 aplicaciones para tu portfolio que ya hemos desarrollado.**
[](https://github.com/mouredev/retos-programacion-2023)
[](https://github.com/mouredev/Weekly-Challenge-2022-Kotlin)
[](https://github.com/mouredev/Monthly-App-Challenge-2022)
##  Hola, mi nombre es Brais Moure.
### Freelance full-stack iOS & Android engineer
[](https://twitch.tv/mouredev)
[](https://mouredev.com/discord)
[](https://moure.dev)
[](https://youtube.com/mouredevapps?sub_confirmation=1)
[](https://twitch.com/mouredev)
[](https://mouredev.com/discord)
[](https://twitter.com/mouredev)
Soy ingeniero de software desde 2010. Desde 2018 combino mi trabajo desarrollando Apps con la creación de contenido formativo sobre programación y tecnología en diferentes redes sociales como **[@mouredev](https://moure.dev)**.
### En mi perfil de GitHub tienes más información
[](https://github.com/mouredev) | Ruta de estudio basada en ejercicios de código semanales en 2024 de la comunidad MoureDev para aprender y practicar lógica usando cualquier lenguaje de programación. | javascript,python,c-sharp,c-plus-plus,dart,go,java,kotlin,php,ruby | 2023-12-18T10:59:18Z | 2024-05-23T10:02:39Z | null | 736 | 3,840 | 10,082 | 2 | 1,845 | 2,473 | null | Apache-2.0 | Python |
hawk86104/icegl-three-vue-tres | master | # 🧊🧊🧊 icegl-three-vue-tres 🧊🧊🧊
## 🎉🎉🎊 三维可视化项目快速落地の开源框架 🎊🎉🎉
<p align="center">
<a target="_black" href="https://space.bilibili.com/410503457">
<img alt="bilibili" src="https://img.shields.io/badge/dynamic/json?url=https://api.bilibili.com/x/relation/stat?vmid=410503457&query=data.follower&color=282c34&label=B站&labelColor=FE7398&logo=data%3Aimage%2Fpng%3Bbase64%2CiVBORw0KGgoAAAANSUhEUgAAAGAAAABgCAYAAADimHc4AAAD7ElEQVR4nO2dW9WrMBCFK6ESkFAJSKiESqgEHCABCZWAhEpAAhL2ecik5dDc%2FpXLBDLfWnlqy0xmJ5BMQnq5CIIgCIIgCIIgCIIgCEIBAHQAemYfrgCunD6wAKAHsEKxALgx+bCQD8%2FS9tmgVqeDr1lLigDgZvDhXso+K9TyTBQRwRJ8AHjntl0Flh5QRAQK%2FmKxPeayWx2OXpBNBKiHvi34b7T2MC4pAvW6twR%2FRwkRKPizBN8CgEcuESj4Lwm+BwBjahEk+H8EwJRKhOaCDzW8e1JLfkUUH1NgmR3XmHffHR1l+72BSs8d7w8U+JDAnZERQMcV+CtUi7dNqFqibB4J7vtrq7xKCuAasbTMXCL4T+5aVk6+2xHUrWdhruAR6HIJcOeu2UHI8zyAe2ytWfEdWz9PVvQ8YAmIQ5dDAB9LFsMVAv8oMO2zAGrC5WNIarRiAuKR9jYEd9pY08aa6uUzIHGRdkgKd8pY0yc1WjEBAqypDYoAG0QAZkQAZkQAZkQAZk4vANQenjsSzS3I%2FwcSbXU5jQBUkRtdf4Rar90v8kSv3+I3ffCCSpk8I%2Fw+lgDkdI%2Fv2rEp2CaiWm1AsDQLlDAD+dlFXLMeAaCSeLZdaSFE5VUQNot38cKuEeBgAsSuG0flVZBmEanbXfNQAsS0fgBYIn2fIu3%2FBBMHEyBmDXlFfA8IzeHb+Ems4WAChKykrVA9ZfsQTL57jXzRg4A5wC%2FA8N4ADiZAZwm2XjW75Qh2KOTfA0p4kygPw28OJcCVgn3nDnYo2EwEYRgGH0qAMyICMCMCMCMCMCMCMCMCMCMCfP3qwHDOQ4AAUekTk8FaBRihJnZdYbvtCGC7LvmkM63GjVDINPFrQgCq5ETXfmMzI90FXzPvfqt7x4rEu%2FZaEcCUxFvgz2zO+BUn6UkoaEEAsptiMSX5e8FoRYCN7cVgb4Vq7U%2FH50Pq4JNP7Qiw8UFnJwcK+tXy+Wj6PLEvPgHSHv5UgwA1IQIwwyFAyLJin9RoxYgAzAQIkPwNmf26busC+OIx5TDqo5nDT+F%2FSS%2F9CYzwb+No49zNy2evkYv0LywGGAXUvp6eSneycqOic0w20k7CNgKE7jJunSGLACTCxF27ylmQc98T5MQUH49swd+I0HPXslLKnT0N+wnkrTKi9JZL%2FL9i1SorMmdeQ4TQQ7OFMxIMzGD45w8nUL1im7efENZLJpgPSw0pfz0cdt4U3230Td%2FTvx2R6d2FrHhEWLkq5PELOMsRPHCPnAZGv1xJteL7jbJiaW3sB2nDvPC%2FosSYvjRQz4cJ6n7KO3rYQL7M+L6nVtfDVRAEQRAEQRAEQRAEIZ5%2FSAXmdfXaoQsAAAAASUVORK5CYII%3D&cacheSeconds=3600">
</a>
<a href="https://github.com/hawk86104/icegl-three-vue-tres" target="_blank">
<img src="https://img.shields.io/github/stars/hawk86104/icegl-three-vue-tres" />
</a>
<img alt="GitHub last commit" src="https://img.shields.io/github/last-commit/hawk86104/icegl-three-vue-tres">
<img src="https://img.shields.io/github/license/hawk86104/icegl-three-vue-tres" />
<a target="_black" href="https://gitee.com/ice-gl/icegl-three-vue-tres">
<img src="https://gitee.com/ice-gl/icegl-three-vue-tres/badge/star.svg?theme=dark" alt="gitee-starts" />
</a>
<a target="_black" href="https://afdian.net/@tvt_js">
<img src="https://img.shields.io/badge/爱发电-ICEGL-blue.svg?style=flat-square&color=027afd&logo=github-sponsors" alt="爱发电" />
</a>
</p>
## 🧊🧊🧊🧊🧊🧊🧊🧊🧊🧊🧊🧊🧊🧊🧊🧊🧊🧊🧊🧊
```shell
如果对您有帮助，您可以点右上角 “Star⭐” 收藏一下 ，您的star就是我开发的动力，感谢！
```
> B 站上对此项目的视频说明点击下方 👇🏻 跳转
<a href="https://www.bilibili.com/video/BV1LH4y1p7Yn"><img src="./preview/bilibili.gif" alt="tres.js webgl"></a>
# 生态 `@ThreeJS-@Vue3.x-@TresJS`
> icegl 出品，永久开源且免费商用，持续更新 ing，请点击右上角 start⭐ 关注
本项目融合于三大生态系统中：
- 🎲 ThreeJS \* [点击详情](https://threejs.org)
<a href="https://www.npmjs.com/package/three">
<img src="https://img.shields.io/npm/v/three?label=three">
</a>
ThreeJS 大名鼎鼎的基于浏览器渲染，JavaScript 语言的 3D 库。<br/><br/>
- 🍀 Vue3.x \* [点击详情](https://cn.vuejs.org)
<a href="https://www.npmjs.com/package/vue">
<img src="https://img.shields.io/npm/v/vue?label=vue&color=%2342b883">
</a>
易学易用，性能出色，适用场景丰富的 Web 前端框架。<br/><br/>
- ⚡ TresJS \* [点击详情](https://tresjs.org)
<a href="https://www.npmjs.com/package/@tresjs/core"><img src="https://img.shields.io/npm/v/@tresjs/core?color=%2382DBCA&label=%40tresjs%2Fcore&logo=data:image/svg%2bxml;base64,PHN2ZyB3aWR0aD0iMzIiIGhlaWdodD0iMzIiIHZpZXdCb3g9IjAgMCAzMiAzMiIgZmlsbD0ibm9uZSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj4KPHBhdGggZD0iTTExLjY4NTQgMy40MjkxNkMxMi4wNzM4IDIuNzgxODIgMTMuMDEyIDIuNzgxODIgMTMuNDAwNCAzLjQyOTE1TDE5LjE3NzEgMTMuMDU2OUMxOS41NzcgMTMuNzIzNSAxOS4wOTY5IDE0LjU3MTQgMTguMzE5NiAxNC41NzE0SDYuNzY2MjRDNS45ODg5NCAxNC41NzE0IDUuNTA4ODMgMTMuNzIzNSA1LjkwODc1IDEzLjA1NjlMMTEuNjg1NCAzLjQyOTE2WiIgZmlsbD0iIzgyREJDNSIvPgo8cGF0aCBkPSJNMTUuNjg1NyAxMC41NDI5QzE1LjY4NTcgOS45OTA1OSAxNi4xMzM0IDkuNTQyODggMTYuNjg1NyA5LjU0Mjg4SDI2QzI2LjU1MjIgOS41NDI4OCAyNyA5Ljk5MDU5IDI3IDEwLjU0MjlWMTkuODU3MkMyNyAyMC40MDk0IDI2LjU1MjIgMjAuODU3MiAyNiAyMC44NTcySDE2LjY4NTdDMTYuMTMzNCAyMC44NTcyIDE1LjY4NTcgMjAuNDA5NCAxNS42ODU3IDE5Ljg1NzJWMTAuNTQyOVoiIGZpbGw9IiM0RjRGNEYiLz4KPGNpcmNsZSBjeD0iMTYiIGN5PSIyMiIgcj0iNiIgZmlsbD0iI0VGQUMzNSIvPgo8L3N2Zz4K" alt="npm package"></a>
使用 Vue3.x 组件实现声明式的 ThreeJS，做属于前端的三维项目。<br/><br/>
## 🏕 点击预览：[🌏opensource.icegl.cn](https://opensource.icegl.cn)
- 如果访问太慢，请访问镜像站点：[🌏 ice-gl.gitee.io/icegl-three-vue-tres](https://ice-gl.gitee.io/icegl-three-vue-tres/)
- 如果还不行，来镜像站点 2：[🌏 http://myhome.217dan.com:8899](http://myhome.217dan.com:8899/)
- 如果有条件翻墙，也可直接访问 github 的镜像站:[🌏 https://hawk86104.github.io](https://hawk86104.github.io/)
```shell
因项目经常更新编译，如发现访问错误，请清空浏览器缓存。
```
更多演示请进入预览页面
# 优势
- 🌈 前端の基本素养 \* FesJS [点击详情](https://fesjs.mumblefe.cn)
<a href="https://www.npmjs.com/package/@fesjs/fes">
<img src="https://img.shields.io/npm/v/%40fesjs%2Ffes?label=%40fesjs%2Ffes">
</a>
集成封装项目落地的常用库：图标、多语言、API 接口调用、Vuex/Pinia、model 数据封装、页面 layout/权限 access、路由管理等。<br/>
- 🌠 像写 Vue3.x 一样写三维可视化项目[点击详情](https://tresjs.org/guide)
全功能版本追溯保持 threeJS 最新版本 \* TresJS
最新 Vue3.x 的语法糖写法，TS/JS 通吃，让你以最新最爽快的方式构建三维可视化项目
```html
<template>
<TresCanvas window-size>
<TresPerspectiveCamera />
<TresMesh>
<TresTorusGeometry :args="[1, 0.5, 16, 32]" />
<TresMeshBasicMaterial color="orange" />
</TresMesh>
</TresCanvas>
</template>
<script setup lang="ts">
import { useRenderLoop, useTexture } from '@tresjs/core'
//读取材质
const pTexture = await useTexture(['./**.jpg', './**.png'])
const { onLoop } = useRenderLoop()
onLoop(({ delta }) => {
//循环render
})
</script>
```
- 🧩 丰富的插件应用市场<br/>
插件中心包含各式各样的项目场景和功能。插件是 ICE 社区生态中重要的一环，在应用市场中完整应用和普通插件统一称为插件。
### 我们将会逐一把落地的项目以插件的形式加入到此开源框中...
### 敬请右上角一键三连: 关注 💛 点赞 ⭐ fork👣
# ✅ 快速开始
```
1、git clone 或者 直接下载 本项目
2、cd 到项目根目录
3、yarn //安装依赖
4、yarn pre.dev // 预览 下的调试模式
5、yarn dev // 自己项目 下的调试模式
6、yarn pre.build //预览 下的编译打包
7、yarn build //自己项目 下的编译打包
```
# 📖 文档
## 使用说明：[🌏docs.icegl.cn](https://docs.icegl.cn/)
# ❓ 问题反馈
在使用中有任何问题，请使用以下联系方式联系我们
- 问答社区: [图形学社区 icegl.cn](https://www.icegl.cn/ask)
<p align = "left">
<img src="https://icegl-1314935952.cos.ap-beijing.myqcloud.com/uploads/20230421/QQ20230421-121209.png" width="680" />
</p>
- 欢迎大家也加入微信群，已有几个群已满，一起学习讨论 webgl。加微信我拉进群
<p align = "left">
<img src="https://icegl-1314935952.cos.ap-beijing.myqcloud.com/uploads/20230731/17d59bab46815cce1f4f1e09dcbb6ccc.png" width="300" />
</p>
# ™️ 版权信息
本项目遵循 Apache2 开源协议发布，并提供永久免费使用以及商用。
> 如果您将此项目用于商业用途，请遵守 Apache2.0 协议并保留作者技术支持声明。
- 二次开发如用于商业性质或开源竞品请不要删除和修改 TvT.js 源码头部的版权与作者声明及出处
- 允许进行商用，但是不允许二次开源出来并进行收费
本项目包含的第三方源码和二进制文件之版权信息另行标注。
版权所有 Copyright © 2022-2025 by 🧊icegl (https://www.icegl.cn)
All rights reserved。
| 🎉🎉🎊 一款让你的三维可视化项目快速落地の开源框架 🎊🎉🎉 永久开源，免费商用 【 three vue ts js 】 | javascript,threejs,typescript,gis,tvt | 2023-11-09T06:37:08Z | 2024-05-23T07:56:49Z | null | 3 | 2 | 375 | 0 | 60 | 859 | null | Apache-2.0 | JavaScript |
Ilyas-Codes/eCourse | main | <p align="center">
<a href="https://ecourse.pockethost.io/" target="_blank" rel="noopener">
<img src="https://i.ibb.co/Sx7YmY6/ecourse.jpg" alt="eCourse - My Courses" />
</a>
</p>
eCourse is a self-hosted SPA designed to simplify course creation and management, some of the features include:
- ability to create video and text based content
- ability to assign courses to users
- ability to track users progress
[Demo](https://ecourse.pockethost.io/)
Use the following credentials for testing the demo:
**Username:** `ilyas`
**Password:** `ecourse123`
## Tech Stack
**UI Framework** - [Svelte](https://svelte.dev/)
**CSS** - [TailwindCSS](https://tailwindcss.com/)
**Icons** - [Iconify](https://iconify.design/)
**Backend** - [PocketBase](https://pocketbase.io/)
**Hosting** - [PocketHost](https://pockethost.io/)
## Getting Started
Get started by running the project locally, simply follow these steps:
1. Clone/download the repo
2. Grab the PocketBase executable for your OS from: https://pocketbase.io/docs/ and drop it at the root of the `pb` folder.
3. Start the PocketBase server
```bash
cd pb
./pocketbase serve
```
4. Start the Vite server
```bash
cd ui
npm install && npm run dev
```
## Customization
App name, logo, and colors can be customized using the `customize.json` file.
## Deployment
One neat thing about PocketBase is that it can also serve our static frontend assets. to do that simply follow these steps:
1. Add the server URL where your PocketBase instance is hosted to `VITE_PROD_PB_URL` in the `.env` file
2. Build a production-ready bundle
```bash
cd ui
npm run build
```
3. Copy the contents of the `dist` folder over to `pb_public`
### Using Docker
You can use the following Dockerfile to automate the steps above:
```dockerfile
FROM node:20.11.1-buster
WORKDIR /
RUN git clone https://github.com/Ilyas-Codes/eCourse.git
ARG PB_VERSION=0.21.3
ADD https://github.com/pocketbase/pocketbase/releases/download/v${PB_VERSION}/pocketbase_${PB_VERSION}_linux_amd64.zip /tmp/pb.zip
RUN unzip /tmp/pb.zip -d /eCourse/pb
WORKDIR /eCourse/ui
RUN sed -i 's/^VITE_PROD_PB_URL=.*/VITE_PROD_PB_URL=http:\/\/127.0.0.1:8090/' .env
RUN npm install
RUN npm run build
RUN mv dist/* /eCourse/pb/pb_public
EXPOSE 8090
CMD ["/eCourse/pb/pocketbase", "serve", "--http=0.0.0.0:8090"]
```
## Feedback & Suggestions
Feel free to open an issue/PR if you find any bugs or want to request new features.
## License
Licensed under the MIT License, Copyright © 2024
| A self-hosted SPA to simplify course creation and management | course,pocketbase,self-hosted,svelte,tailwindcss,template,css,customizable,e-learning,education | 2023-12-02T14:10:53Z | 2024-02-28T22:13:51Z | null | 3 | 2 | 9 | 3 | 28 | 391 | null | MIT | JavaScript |
W4G1/multithreading | main | <div align="center">
[](https://multithreading.io)
[](https://github.com/W4G1/multithreading/blob/main/LICENSE.md)
[](https://www.npmjs.com/package/multithreading)
[](https://www.npmjs.com/package/multithreading?activeTab=versions)
[&color=rgb(13%2C%2017%2C%2023))](https://github.com/W4G1/multithreading)
[](https://github.com/W4G1/multithreading/actions/workflows/node.js.yml)
</div>
# multithreading
Multithreading is a tiny runtime that allows you to execute JavaScript functions on separate threads. It is designed to be as simple and fast as possible, and to be used in a similar way to regular functions.
With a minified size of only 4.5kb, it has first class support for [Node.js](https://nodejs.org/), [Deno](https://deno.com/) and the [browser](https://caniuse.com/?search=webworkers). It can also be used with any framework or library such as [React](https://react.dev/), [Vue](https://vuejs.org/) or [Svelte](https://svelte.dev/).
Depending on the environment, it uses [Worker Threads](https://nodejs.org/api/worker_threads.html) or [Web Workers](https://developer.mozilla.org/en-US/docs/Web/API/Worker). In addition to [ES6 generators](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function*) to make multithreading as simple as possible.
### The State of Multithreading in JavaScript
JavaScript's single-threaded nature means that tasks are executed one after the other, leading to potential performance bottlenecks and underutilized CPU resources. While [Web Workers](https://developer.mozilla.org/en-US/docs/Web/API/Worker) and [Worker Threads](https://nodejs.org/api/worker_threads.html) offer a way to offload tasks to separate threads, managing the state and communication between these threads is often complex and error-prone.
This project aims to solve these challenges by providing an intuitive Web Worker abstraction that mirrors the behavior of regular JavaScript functions.
This way it feels like you're executing a regular function, but in reality, it's running in parallel on a separate threads.
## Installation
```bash
npm install multithreading
```
## Usage
#### Basic example
```js
import { threaded } from "multithreading";
const add = threaded(function* (a, b) {
return a + b;
});
console.log(await add(5, 10)); // 15
```
The `add` function is executed on a separate thread, and the result is returned to the main thread when the function is done executing. Consecutive invocations will be automatically executed in parallel on separate threads.
#### Example with shared state
```js
import { threaded, $claim, $unclaim } from "multithreading";
const user = {
name: "john",
balance: 0,
};
const add = threaded(async function* (amount) {
yield user; // Add user to dependencies
await $claim(user); // Wait for write lock
user.balance += amount;
$unclaim(user); // Release write lock
});
await Promise.all([
add(5),
add(10),
]);
console.log(user.balance); // 15
```
This example shows how to use a shared state across multiple threads. It introduces the concepts of claiming and unclaiming write access using `$claim` and `$unclaim`. This is to ensure that only one thread can write to a shared state at a time.
> Always `$unclaim()` a shared state after use, otherwise the write lock will never be released and other threads that want to write to this state will be blocked indefinitely.
The `yield` statement is used to specify external dependencies, and must be defined at the top of the function.
#### Example with external functions
```js
import { threaded, $claim, $unclaim } from "multithreading";
// Some external function
function add (a, b) {
return a + b;
}
const user = {
name: "john",
balance: 0,
};
const addBalance = threaded(async function* (amount) {
yield user;
yield add; // Add external function to dependencies
await $claim(user);
user.balance = add(user.balance, amount);
$unclaim(user);
});
await Promise.all([
addBalance(5),
addBalance(10),
]);
console.log(user.balance); // 15
```
In this example, the `add` function is used within the multithreaded `addBalance` function. The `yield` statement is used to declare external dependencies. You can think of it as a way to import external data, functions or even packages.
As with previous examples, the shared state is managed using `$claim` and `$unclaim` to guarantee proper synchronization and prevent data conflicts.
> External functions like `add` cannot have external dependencies themselves. All variables and functions used by an external function must be declared within the function itself.
### Using imports from external packages
When using external modules, you can dynamically import them by using `yield "some-package"`. This is useful when you want to use other packages within a threaded function.
```js
import { threaded } from "multithreading";
const getId = threaded(function* () {
/**
* @type {import("uuid")}
*/
const { v4 } = yield "uuid"; // Import other package
return v4();
}
console.log(await getId()); // 1a107623-3052-4f61-aca9-9d9388fb2d81
```
You can also import external modules in a variety of other ways:
```js
const { v4 } = yield "npm:uuid"; // Using npm specifier (available in Deno)
const { v4 } = yield "https://esm.sh/uuid"; // From CDN url (available in browser and Deno)
```
## Enhanced Error Handling
Errors inside threads are automatically injected with a pretty stack trace.
This makes it easier to identify which line of your function caused the error, and in which thread the error occured.
| ⚡ Multithreading functions in JavaScript to speedup heavy workloads, designed to feel like writing vanilla functions. | es6-generators,multithreading,threads,webworkers,worker-threads,concurrency,javascript,multi-threading,nodejs,parallel-processing | 2023-12-15T19:17:53Z | 2024-03-13T10:56:46Z | null | 1 | 0 | 57 | 1 | 10 | 296 | null | MIT | TypeScript |
galacean/effects-runtime | main | <div align="center"><a name="readme-top"></a>
<h1>Galacean Effects</h1>
It can load and render cool animation effects, The APIs provided by effects-core allow your engine to quickly access animation data such as layer and particle animation.
[Native](https://github.com/galacean/effects-native) · [Changelog](./CHANGELOG.md) · [Report Bug][github-issues-url] · [Request Feature][github-issues-url] · English · [中文](./README-zh_CN.md)
<h3>What you see is what you get</h3>
<img height="320" src="https://mdn.alipayobjects.com/huamei_klifp9/afts/img/A*BrMIQqkmbKEAAAAAAAAAAAAADvV6AQ/original">
<img height="320" src="https://mdn.alipayobjects.com/huamei_klifp9/afts/img/A*VHMAR6Vq_8wAAAAAAAAAAAAADvV6AQ/original">
<img height="320" src="https://mdn.alipayobjects.com/huamei_klifp9/afts/img/A*UwMWT4uY6jsAAAAAAAAAAAAADvV6AQ/original">
<!-- Copy-paste in your Readme.md file -->
<a href="https://next.ossinsight.io/widgets/official/compose-last-28-days-stats?repo_id=715920076" target="_blank" style="display: block" align="center">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://next.ossinsight.io/widgets/official/compose-last-28-days-stats/thumbnail.png?repo_id=715920076&image_size=auto&color_scheme=dark" width="655" height="auto">
<img alt="Performance Stats of galacean/effects-runtime - Last 28 days" src="https://next.ossinsight.io/widgets/official/compose-last-28-days-stats/thumbnail.png?repo_id=715920076&image_size=auto&color_scheme=light" width="655" height="auto">
</picture>
</a>
<!-- Made with [OSS Insight](https://ossinsight.io/) -->
[github-issues-url]: https://github.com/galacean/effects-runtime/issues
</div>
## Install
``` bash
npm install @galacean/effects
```
``` bash
pnpm add @galacean/effects
```
## Usage
``` html
<div id="J-Container"></div>
```
``` ts
import { Player } from '@galacean/effects';
// 1. Instantiate a player
const player = new Player({
container: document.getElementById('J-Container'),
});
// 2. Load and play the animation resource
player.loadScene('./demo.json');
```
> Get the `demo.json` by using the [Galacean Effects](https://galacean.antgroup.com/effects/) editor.
## Documentation
- [Development Documentation](https://galacean.antgroup.com/effects/#/user/dgmswcgk63yfngku)
- [Integration Guide](https://galacean.antgroup.com/effects/#/user/ti4f2yx1rot4hs1n)
- [API Documentation](https://galacean.antgroup.com/effects/#/api)
- Useful Links:
- [Developing](docs/developing.md)
| It can load and render cool animation effects | 2d,3d,animation,effects,html5,javascript,typescript,webgl,webgl2 | 2023-11-08T05:11:27Z | 2024-05-17T07:20:44Z | 2024-05-17T07:20:44Z | 21 | 358 | 334 | 4 | 0 | 251 | null | MIT | TypeScript |
good-lly/lowstorage | dev | <h1>
lowstorage | for Workers using R2
<br>
</h1>
> <strong>Simple, zero-dependency, object pseudo-database for Cloudflare Workers using R2 buckets, strongly inspired by lowdb 🤗(https://github.com/typicode/lowdb/).</strong> <br>  [](https://github.com/good-lly/lowstorage/issues/) [](https://github.com/good-lly/lowstorage/blob/master/LICENSE) <a href="https://github.com/good-lly/lowstorage/issues/"> <img src="https://img.shields.io/badge/contributions-welcome-red.svg" alt="Contributions welcome" /></a>
[[github](https://github.com/good-lly/lowstorage)] [[npm](https://www.npmjs.com/package/lowstorage)]
## Sponsors
<!--  -->
[Become a sponsor and have your company logo here](https://github.com/sponsors/good-lly) 👉 [GitHub Sponsors](https://github.com/sponsors/good-lly)
### Important Notice
While Cloudflare R2 operates on a strongly consistent model ([reference](https://developers.cloudflare.com/r2/reference/consistency/)), it's important to note that `lowstorage` is primarily designed for small, hobby, or personal projects. We advise extreme caution when using `lowstorage` for critical applications or production environments, as it may not offer the robustness or features required for such use cases.
### Usage
```js
import lowstorage from 'lowstorage';
// Initialize object and get users collection
const usersCol = await lowstorage(env, 'MY_TESTING_BUCKET').collection('users');
// Add new user
// you can provide _id or it will be generated as crypto.randomUUID(); -> https://developers.cloudflare.com/workers/runtime-apis/web-crypto/
const newUser = await usersCol.insert({
name: 'Kevin',
gender: 'whatever',
posts: [],
});
// Show all users
const allUsers = usersCol.find({});
// Find users with pagination (e.g., page 2, 10 users per page)
const secondPageUsers = await usersCol.find({}, { skip: 10, limit: 10 });
// Find user by ID and update name
await usersCol.update({ _id: id }, { name: 'Carlos' });
```
## Features
- **Lightweight**
- **Minimalist**
- **Familiar API**
- **Plain JavaScript**
- **Zero-dependency**
## Install
```sh
npm install lowstorage
```
#### Why Cloudflare R2?
> Seamless migration, robust free tier, Nonee gress fees. Dive into the future of data storage with Cloudflare R2 https://developers.cloudflare.com/r2/
#### Included features in Forever Free R2 tier
> - Storage: 10 GB/month
> - Class A operations (mutate state): 1,000,000 / month
> - Class B operations (read state): 10,000,000 / month
> - [more details on pricing R2](https://www.cloudflare.com/plans/developer-platform/#overview)
### Setup & binding R2 to your worker
1. In the Cloudflare console, go to R2 (left navigation)
2. Click Create Bucket
3. Enter any bucket name you want (we use testing-lowstorage)
4. Click Create Bucket (bottom)
5. Go to 'Worker & Pages'
6. Click on your worker (or create new one)
7. Go to 'Settings' -> Variables
8. In section 'R2 Bucket Bindings' click EDIT VARIABLES
9. Hit '+ Add Binding' and pick variable name (we use 'MY_TESTING_BUCKET') and select your R2 bucket
10. Click 'Save & Deploy'
Check out [wrangler.toml from examples](https://github.com/good-lly/lowstorage/blob/master/examples/wrangler.toml#L22)
> Insctructions with pictures https://github.com/gfodor/p2pcf/blob/master/INSTALL.md#set-up-the-r2-bucket
## API
**collection(colName)**
- **Input**: A string representing the name of the collection.
- **Behavior**: Creates or accesses a collection with the given name.
- **Returns**: An instance of the Collection class corresponding to the specified collection name.
- **insert(doc)**
- **insert(doc)**
- **Input**: A single object or an array of objects to insert into the collection.
- **Behavior**: Inserts the given document(s) into the collection. If an `_id` is not provided, a unique identifier is automatically generated using `crypto.randomUUID()`.
- **Returns**: The inserted document(s), with an `_id` property assigned to each if not already present.
- **find(query, options)**
- **Input**:
- `query`: A query object to match documents.
- `options`: An optional object for pagination, containing `skip` and `limit` properties.
- **Behavior**: Searches for documents matching the query. Supports pagination through `options`.
- **Returns**: A promise that resolves to an array of matching documents, considering any pagination specified.
- **findOne(query)**
- **Input**: A query object.
- **Behavior**: Similar to `find`, but it returns only the first matching document.
- **Returns**: A promise that resolves to a single document or `null` if no match is found.
- **update(query, update)**
- **Input**: A query object and an update object.
- **Behavior**: Updates all documents that match the query with the provided update data.
- **Returns**: A promise that resolves to the number of documents updated.
- **updateOne(query, update)**
- **Input**: A query object and an update object.
- **Behavior**: Updates the first document that matches the query with the provided update data.
- **Returns**: A promise that resolves to `1` if a document is updated, otherwise `0`.
- **delete(query)**
- **Input**: A query object to match documents for deletion.
- **Behavior**: Deletes documents matching the query.
- **Returns**: A promise that resolves to the number of documents deleted.
- **remove()**
- **Behavior**: Removes all documents from the collection.
- **Returns**: A promise that resolves to the number of documents removed.
- **count(query)**
- **Input**: A query object (optional).
- **Behavior**: Counts the number of documents that match the query. If no query is provided, it counts all documents in the collection.
- **Returns**: A promise that resolves to the count of matching documents.
**listCollections()**
- **Behavior**: Lists all collections stored in the Cloudflare R2 bucket associated with the lowstorage instance. (All files ending with .json)
- **Returns**: A promise that resolves to an array of collection names.
## Examples
Check out [dummy examples](https://github.com/good-lly/lowstorage/tree/master/examples)
Run:
```javascript
cd examples
npm install
npm run dev
```
for testing:
```javascript
npm run test
```
It starts local wrangler with ENV and toml config from your /examples folder to run tests.
## Limitations
- <s>no test coverage</s> (wip) lowstorage is using end to end tests via its examples
- response speed (no benchmarks so far)
- use carefully!
## Contribution
Feel free to dive in! [Open an issue](https://github.com/good-lly/lowstorage/issues/new) or submit PRs.
Standard Readme follows the [Contributor Covenant](http://contributor-covenant.org/version/1/3/0/) [Code of Conduct](https://github.com/good-lly/lowstorage/blob/master/CODE_OF_CONDUCT.md).
## License
[MIT](LICENSE)
| Simple, zero-dependency, object pseudo-database for Cloudflare Workers using R2 bucket. 🧡💾 | cloudflare,cloudflare-workers,database,javascript,json,cloudflare-r2,serverless | 2023-11-19T23:47:35Z | 2024-04-24T04:52:43Z | 2024-03-08T00:03:28Z | 3 | 9 | 59 | 2 | 6 | 207 | null | MIT | JavaScript |
luckrnx09/python-guide-for-javascript-engineers | main | # Python Guide for JavaScript Engineers
English | [简体中文](./README-zh_CN.md)
<img src="./static/img/book_cover.png" width="50%" />
<br>
The *Python Guide for JavaScript Engineers* is an open-source e-book based on [abook](https://github.com/luckrnx09/abook), covering everything from installing Python environment to project development. This book uses numerous examples to compare and contrast the similarities and differences between JavaScript and Python, helping JavaScript engineers quickly grasp the Python language.
## Online Reading
You can read this book online at the following link:
[https://luckrnx09.com/python-guide-for-javascript-engineers](https://luckrnx09.com/python-guide-for-javascript-engineers)
## Contributors
<a href="https://github.com/luckrnx09/python-guide-for-javascript-engineers/graphs/contributors">
<img src="https://contrib.rocks/image?repo=luckrnx09/python-guide-for-javascript-engineers&max=100" />
</a>
Contributions are welcome to supplement, correct, and translate the content of this book. Please submit PRs for any changes.
## License
See [LICENSE](./LICENSE) for details. | An open-source ebook helps JavaScript engineers quickly master the Python language | ebook,examples,javascript,python,tutorials,abook,ai,chatgpt,fullstack,book | 2023-12-07T09:12:16Z | 2024-02-19T07:38:06Z | null | 5 | 35 | 36 | 0 | 9 | 201 | null | NOASSERTION | TypeScript |
mme/beakjs | main | # 🐦 Beak.js [](https://twitter.com/mme_xyz) [](https://www.npmjs.com/package/@beakjs/react)
Beak.js contains everything you need to create custom AI-powered assistants for your React app.
**Key Features:**
- **Built-in UI** - Comes with a beautiful, fully customizable chat window.
- **Easy to Use** - Integrates with your existing React app in just a few lines of code.
- **Open Source** - Beak.js is open source and free to use.
<img src="https://github.com/mme/beakjs/raw/main/docs/img/screenshot.png" width="500" alt="Beak.js Screenshot">
## Getting Started
### Installation
First up, add Beak.js to your project:
```bash
npm install @beakjs/react --save
# or with yarn
yarn add @beakjs/react
```
### Setup
Next, wrap your app in the `Beak` component and add the assistant window:
```jsx
import { Beak } from "@beakjs/react";
const App = () => (
<Beak
__unsafeOpenAIApiKey__="sk-..."
instructions="Assistant is running in a web app and helps the user with XYZ."
>
<MyApp />
<AssistantWindow />
</Beak>
);
```
Now, you've got a chat window ready in the bottom right corner of your website. Give it a try!
**Note:** Don't expose your API key in public-facing apps - this is for development only. See [Deployment](#deployment) for information on how to securely deploy your app without compromising your API key.
### Making Beak.js work with your app
You can let the assistant carry out tasks in your app by setting up functions with `useBeakFunction`:
```jsx
import { useBeakFunction } from "@beakjs/react";
const MyApp = () => {
const [message, setMessage] = useState("Hello World!");
useBeakFunction({
name: "updateMessage",
description: "This function updates the app's display message.",
parameters: {
message: {
description: "A short message to display on screen.",
},
},
handler: ({ message }) => {
setMessage(message);
return `Updated the message to: "${message}"`;
},
});
return <div>{message}</div>;
};
```
Note that functions become available to the assistant as soon as their respective component is mounted. This is a powerful concept, ensuring that the assistant will be able to call functions relevant to the current context of your app.
### Let the Assistant Know What's Happening On Screen
You can easily let the assistant know what it currently on screen by using `useBeakInfo`:
```jsx
import { useBeakInfo } from "@beakjs/react";
const MyApp = () => {
const [message, setMessage] = useState("Hello World!");
useBeakInfo("current message", message);
// ...
};
```
By using `useBeakFunction` together with `useBeakInfo`, your assistant can see what's happening on the screen and take action within your app depending on the current context.
## Deployment
To keep your API key safe, we use a server side handler that forwards your assistant's requests to OpenAI. Furthermore, this handler can be used to add authentication and rate limiting to your assistant.
Currently, the following frameworks are supported:
- [Next.js](/docs/deployment/next.md)
- [Remix](/docs/deployment/remix.md)
- [Express](/docs/deployment/express.md)
Read more about secure deployment by clicking the links above.
## Run the Demo
To run the demo, build the project and start the demo app:
```bash
git clone git@github.com:mme/beakjs.git && cd beakjs
yarn && yarn build
cd demo/frontend/presentation
echo "VITE_OPENAI_API_KEY=sk-your-openai-key" > .env
yarn && yarn dev
```
Then go to http://localhost:5173/ to see the demo.
## Issues
Feel free to submit issues and enhancement requests.
## License
MIT
Copyright (c) 2023, Markus Ecker
| 🐦 Custom conversational assistants for your React app. | assistant,chatbot,chatgpt,copilot,openai,react,reactjs,typescript,web,frontend | 2023-11-08T19:47:16Z | 2023-12-12T16:15:26Z | null | 1 | 6 | 63 | 4 | 2 | 197 | null | MIT | TypeScript |
Zaki-1052/GPTPortal | main | # ChatBot Portal for Multi-Modal LLM APIs
Welcome to my **Chat-Bot Portal**, a full-featured *Node.js*-based web application that allows users to interact with a chatbot powered by *OpenAI*'s **GPT-4 API**, including the latest *Vision*, *Hearing*, and *Speaking* capabilities with *image-generation*, *file uploads*, and superior *Model Performance*. Now includes the **Google Gemini** & **Anthropic Claude** models via *free* API, plus **Mistral AI**, and a *native* **Code Environment** via **Assistants Mode** to reuse *files* and *instructions* from OpenAI's *Beta API*!
## Table of Contents
- [Features](#features)
- [Examples](#examples)
- [Structure](#structure)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Usage](#usage)
- [Assistants](#assistants-use)
- [Author Notes](#author-notes)
- [Further Explanations](#further-explanations)
- [Basic Guide](#guide-basic-setup--use)
- [Google Gemini](#8-optional-google-gemini-setup)
- [Mistral AI](#9-optional-mistral-ai-setup)
- [Anthropic Claude](#10-optional-anthropic-claude-setup)
- [Meta LLaMA AI](#11-optional-meta-llama-setup)
- [OpenRouter AI](#12-optional-open-router-setup)
- [Relevant Links](#relevant-links)
- [Author Links](#author-links--custom-gpts)
- [Research Papers](#research-papers)
- [FAQ](#faq)
- [Glossary](#glossary)
- [Updates](#updates)
- [Tokens](#token-costs-explained)
- [TODOs](#todos)
- [Quick-Start](#quick-start-guide)
- [Docker](#docker)
- [Contributions](#contributions)
- [License](#license)
## Features
- Interactive **chat interface** with support for *text messages*.
- **Voice Conversations** via *Whisper* transcriptions and *spoken responses*.
- **Image upload** functionality for *visual context* in discussions.
- Server-side integration with *OpenAI* **GPT-4 API**.
- **Basic authentication** for *secure access*.
- Customizable *System-Defined Instructions* and *Model Parameters*.
- Simple and intuitive **UI** with *copy-to-clipboard* feature.
- **Markdown** *rendering* for chat messages in *Marked* styles.
- **Export** as *HTML* **button** for *conversation history*.
- Integrated **shutdown** *functionality* at "**Bye!**"
- **Image Generation** with *DALL·E 3* at "**Generate:**".
- **File Uploads** via manual *concatenation* for **large texts**.
- **Assistants API Mode** for *reusable* files and *custom instructions*.
- Includes **Automatic Python Execution** in stateful *Jupyter Environment*.
- **Retrieval Augmented Generation** of *uploaded files*.
- New **Google Gemini** & **Mistral** Models...Ultra *Coming Soon*!
- **Keyboard Shortcuts** to control various *ChatGPT-like functions*.
- **Editable Custom Instructions** via a *frontend UI*.
- **Model Selector** of various *OpenAI APIs*. Includes:
- **GPT-4**: Default – Snapshot of the *Old* Version
- **GPT-4-32k**: Longer Context Window – More *Expensive*
- Must be hosted on Microsoft Azure for access.
- **GPT-4-Turbo**: Currently used in *ChatGPT Plus*
- *Cheaper* and Longest Context, with *Vision Analysis*.
- Maximum Token Window: *128,000*
- **GPT-3.5-Turbo**: *Cheapest* Model
- **Gemini-Pro**: Latest Google Model – GPT-3.5 Equivalent
- **Free** Until February 2024!
- **Gemini-Vision**: Multi-Modal Model – One-Time Use
- **Gemini-1.5-Pro**: Early Access Model – *1 Million Tokens*!
- **Gemini-Ultra**: Currently *Unreleased* – Largest Model
- **Claude Opus-Instant**:
- *Six* New *Anthropic* High *Performance* Models
- *Claude-Opus* is said to perform *better than GPT-4* at some tasks!
- A Description can be found under [**Anthropic AI Setup**](#10-optional-anthropic-claude-setup).
- **Mistral**: *Tiny-Medium*
- **Five** *New* **Mistral AI** Models
- *Intelligence* **Varies** by *Size*
- A Description can be found under [**Mistral AI Setup**](#9-optional-mistral-ai-setup).
## Examples
<details>
<summary>Images/Demos</summary>
### Latest [**Demo**](https://youtu.be/MvuxNr60u0M) Video
Fully showcases all installation, features, and model utilization.
Once again, the full demonstration and tutorial video can be found [**HERE**](https://youtu.be/MvuxNr60u0M).
Now released; see the release tag for v1 of GPTPortal for more details.
### Example
### Updated View
### Feature Demo
[**Feature Demo**](https://youtu.be/5Ge21SPhu4E) - *YouTube Link*
https://github.com/Zaki-1052/GPTPortal/assets/134018102/de7cb401-54f3-4cdd-a041-960a4b11770e
[**Video Showcase**](https://youtu.be/v3GVu0ZuXk4) - *Instructions*
[*Image Upload*](https://youtu.be/yO0II0KSJeg) - Showcase of the GPT-4V model receiving a 3.2 MB screenshot and describing it.
### Interface
</details>
## Structure
- **portal.html**: The main HTML file for user interaction. It includes the chat interface layout, a message input area, an image upload and export button for history, voice chat functionality, a model selector, and it links to the `script.js` file.
- **script.js**: Contains client-side logic for handling user inputs, sending messages and images to the server, and displaying marked responses in the chat interface. It also includes file selection for image uploads and a copy-to-clipboard function with support for exporting your current conversation history and changing models. Lastly, it handles voice conversations & text box formatting.
- **server.js**: The server-side Node.js file using Express.js. It processes POST requests to `/message`, `/gemini` and `/assistant`, interacts with the OpenAI GPT-4-Vision and Gemini/Mistral APIs, along with Whisper and TTS, and manages CORS, Multer, basic authentication, and static file serving. Lastly, it handles conversation history and image generation, while hosting custom instructions.
- **instructions.md** & **geminiMessage.txt**: The model's System and Custom Instructions, customized for optimal responses & contextual prompt enhancement. These can be modified by the user to include background profiles.
- **.env**: The *Environment Variable* file for your *sensitive passwords*. Must be modeled after the `.env.example` template.
- **chat.css**: The *stylesheet* for the portal's *look* and *formatting*.
## Prerequisites
- **Node.js** installed on your machine from [**nodejs.org**](https://nodejs.org/).
- Specifically, the download link for various devices can be seen [**here**](https://nodejs.org/en/download).
- [*Optional*] **Git** or **GitHub Desktop** to clone the repository.
- You can also simply download the repo as a `.zip` file and place it elsewhere.
- An OpenAI **API** key for accessing *GPT-4*. [Billing Credit](https://platform.openai.com/account/billing/) may be needed.
- See [**here**](https://platform.openai.com/api-keys) to *create your key*.
- [*Optional*] Google AI Key for accessing *Gemini*. **Free** temporarily.
- See [**here**](https://makersuite.google.com/app/apikey) to *create your key*.
- [*Optional*] Anthropic API Key for accessing *Claude*. $5 in **free credit** granted.
- See [**here**](https://console.anthropic.com/settings/keys) to *create your key* and set up [**billing**](https://console.anthropic.com/settings/keys).
- [*Optional*] Mistral AI Key for accessing *cheap* Mistral models.
- See [**here**](#9-optional-mistral-ai-setup) for further *setup*.
## Installation
### Vercel Deployment
[](https://vercel.com/new/clone?template=https://github.com/Zaki-1052/GPTPortal&env=OPENAI_API_KEY,USER_USERNAME,USER_PASSWORD,GOOGLE_API_KEY,MISTRAL_API_KEY,CLAUDE_API_KEY)
### Manual Build
1. **Clone the Repository**:
- Use *Git* to clone the repository to your local machine:
```sh
git clone https://github.com/Zaki-1052/GPTPortal.git
```
2. **Navigate to the Project Directory**:
- Change into the project's directory:
```sh
cd GPTPortal
```
3. **Install Dependencies**:
- Install the required Node.js packages:
```sh
npm install
```
4. **Set Up Environment Variables**:
- Create a `.env` file in the root directory.
- Format shown in `.env.example`
- Add your OpenAI API key and basic authentication:
```env
OPENAI_API_KEY=your_api_key_here
USER_USERNAME=Username
USER_PASSWORD=Password
GOOGLE_API_KEY=your_google_ai_key_here
MISTRAL_API_KEY=your_mistral_ai_key_here
CLAUDE_API_KEY=your_anthropic_ai_key_here
```
5. **Start the Server**:
- Launch the server with Node.js:
```sh
node server.js
```
6. **Access the Chat Interface**:
- Open a web browser and go to `http://localhost:3000/portal`.
- *Portal URL*:
```sh
http://localhost:3000/portal
```
## Usage
- **Sending a Message**:
- Type your message in the text box.
- Press Enter or click the Send button to submit.
- **Starting a Voice Conversation**:
- Click the 🎤 microphone icon to activate *voice input*.
- Speak your query or message, and toggle the button to end recording.
- It will be processed by the *Whisper API* and seen in the input box.
- The result will also be automatically copied to your clipboard.
- The model's response will be read back to you through a *text-to-speech API*.
- **Uploading an Image**:
- Click the 📋 button to open the *file selector*.
- Choose an image file. It will be sent with your next message.
- Use of the **GPT-4-Vision** Model is required to *analyze images*.
- If you would like to utilize the *Vision-Preview* model, which uses GPT-4-Turbo, as in ChatGPT, *select* the model.
- You can now simply choose your *preferred model* through the *dropdown menu* at the top of the interface.
- **Upload a Text File**:
- Like the *image upload*, simply choose a compatible *text-file* and *send*.
- The *name* and *contents* will be *added* to your query.
- **All** *UTF-8* encoded *text-based* file-types are *fully supported*.
- **Assistants API Mode**:
- Scroll under the main chat container to *toggle* **Assistants Mode**.
- An *indicator* will appear when it is *enabled*.
- Sending a new message and/or uploading a file will create a *new assistant* and *thread*.
- The former can be *reused* and the latter can be used to *continue the conversation* from where you left off.
- *GPT-4-Vision* is not currently supported by the *Assistants API*, but *retrieval* is enabled and can mimic it.
- Ask GPT to utilize *Python*, *Code Interpreter*, or *Advanced Data Analysis* in its response
- It will run the code in a native *Jupyter Notebook* and perform *file retrieval* operations under the hood.
- **Model Selector**:
- Click on the "*Select a Model*" button at the top.
- Hover your cursor over the options to view *descriptions*.
- Choose your preference based on current use-case.
- If no Model is chosen, the Portal will *Default* to the *GPT-4* snapshot.
- **Exporting Conversation**
- Click the 📤 to export the *Conversation History*.
- It will be an *HTML* document formatted in *Markdown*.
- Type: "**Bye!**" in the text input box in order to *end the conversation* and *kill the server*.
- This will also *Export* the *Conversation History*.
- **Keyboard Shortcuts**:
- `Shift + Esc`: Focuses the chat input box, allowing immediate typing.
- `Cmd/Ctrl + Shift + X`: Triggers the export chat history function.
- `Cmd/Ctrl + Shift + V`: Toggles the voice mode on and off.
- `Cmd/Ctrl + Shift + C`: Copies the text of the latest chat message to the clipboard.
- `Cmd/Ctrl + Shift + ;`: Copies the content of the latest code block to the clipboard.
- `Cmd/Ctrl + Shift + F`: Opens the file input dialog to allow file selection.
- `Cmd/Cntrl + Shift + A`: Toggles the Assistants Mode.
- **Image Generation**: *IMPORTANT!*
- Specific *Syntax* is needed to activate *DALL·E 3*:
- Type: "**Generate:**" followed by your prompt.
- The API will *produce the image* in the chat window, subsequently *download* it, and *end* the chat.
- Only *one image* can be generated per server *session*.
- **Cost**: *$0.080 / image*
### Assistants Use
- **Specify Assistants**:
- Go to the [*OpenAI Assistants Dashboard*](https://platform.openai.com/assistants).
- Create or choose an existing Assistant.
- Copy the ID into the `.env` file.
- Example:
```env
ASSISTANT_ID=asst_D3yVjKPahWhzCdZIy525nh8D
```
- **Specify Threads**:
- After using an Assistant through the portal, find the [Conversation Thread ID](https://platform.openai.com/threads).
- Select the Thread ID you'd like to continue, and copy into your `.env` file.
- Example:
```env
THREAD_ID=thread_0LhmZXMUOljwx8jojB2dcMyU
```
- **Base Functionality**
- Without any specification, your first message will create a **Custom Assistant** and start a **Conversation Thread**.
- These will both be stored on OpenAI's servers.
- You can continue the conversation with this assistant throughout the server instance, and **export** your *conversation* to end it.
- You may pick up where you left off by specifying their IDs in the `.env` file.
- Otherwise, your **Assistant** will take the qualities of the *System Prompt*, uploaded *files*, and run *Code Interpreter* natively.
- Ask the AI to use its Python, ADA, or Code Interpreter tools to write and execute code, read your files, and more!
- The **Assistants API** uses the same backend as *ChatGPT-Plus*, but you only pay for what you actually use.
## Author Notes
>**IMPORTANT**: *These warnings no longer apply as of commits made 11/15.*
[**~~Deprecated~~**]
- **Smartest Snapshot of ChatGPT**: This application uses the `gpt-4-turbo` model by default. However, users can switch to the old standard `gpt-4` model, which has a higher maxmimum completion output of 6000 tokens, rather than 4k.
- The Model Parameters, including the model itself, can be found on/around Line 200 in `server.js`, and has multiple comments to guide you if you're just getting started with customizing the API Responses.
- Be aware that although the API returns will be objectively better than what you receive on ChatGPT, usage adds up, and you may soon run out of credits.
- Always keep track of your token usage (relevant link found below); adjust instructions and/or parameters as needed.
- **Voice Chat**: Calls to OpenAI's proprietary *multi-modal APIs* via your key; be sure to keep an eye on your *expenses*.
- **Billing for API Use**: A $5 deposit is required to access the *paid tier* of the OpenAI API. See OpenAI *Documentation* for billing setup.
- **Custom Instructions**: If you'd like to adjust the model's *System Prompt*, you can modify the `instructions.md` file found in the **public** directory.
- It will be passed via *API*, so the model will follow these instructions at the expense of anything from the user!
- **Understanding GPT Parameters**: The *Basics*
- **Temperature**: Controls randomness. Lower values make responses more predictable.
- **Max Tokens**: Determines the length of each completion.
- **Other Parameters**: Explore prompt engineering and comments for custom behaviors.
- *In order*:
- `model`: Uses the `modelID` specified by the client.
- `messages`: `conversationHistory` includes the System Prompt, previous queries and responses, and your most recently sent message.
- `temperature`: `1` by default...Controls randomness: Lowering results in less random completions.
- As the temperature approaches zero, the model will become deterministic and repetitive.
- `max_tokens`: `4000` by default due to *output* limits on the *turbo* model.
- The maximum number of tokens to **generate** shared between the prompt and completion. Exact limits varies by model.
- (One token is roughly 4 characters for standard English text).
- `frequency_penalty`: `0` by default...
- How much to penalize new tokens based on their existing frequency in the text so far.
- Decreases the model's likelihood to repeat the same line verbatim.
- `presence_penalty`: `0` by default...
- How much to penalize new tokens based on whether they appear in the text so far.
- Increases the model's likelihood to talk about new topics.
- `stream`: `true`, streaming messages from server to api for better memory efficiency
- **Stop Sequences**: `stop: ["<YOUR_STOP_SEQUENCE_HERE>", "<ANOTHER_STOP_SEQUENCE>"],`
- Up to four sequences where the API will stop generating further tokens.
- The returned text will not contain the stop sequence.
- **Best Of** - returns the best one out of multiple generations: `best_of: 3,`
- This parameter allows you to generate multiple completions in the backend and return the best one.
- **Logprobs** - number of log probabilities to return: `logprobs: 10,`
- This parameter specifies the number of log probabilities to return.
- For example, setting logprobs: 10 will return the top 10 log probabilities for each token generated.
- **N** - number of completions to generate: `n: 2,`
- This parameter determines how many completions to generate for each prompt.
- If set to a number greater than 1, the model will return multiple responses,
- Useful if you want options.
- **Logit Bias** - adjusts likelihood of certain tokens:
- `logit_bias: {"<TOKEN_ID>": <BIAS_VALUE>, "<ANOTHER_TOKEN_ID>": <BIAS_VALUE>},`
- This allows you to increase or decrease the likelihood of certain tokens appearing in the output.
- It can be used to guide the model towards or away from specific themes or topics.
- **API Chat Completions**: Tailor chat completions to your specific use case.
- **Session Management**: Each page reload starts a new session. Session history isn't preserved.
- **Custom Instructions**: Found in `instructions.md`. Modify user profile and instructions as needed. These are optimized for GPT-4 based on extensive research.
- **Streaming** is currently *disabled*, but if you'd like to re-enable it, you can *uncomment* the marked lines in `server.js`.
- For *security reasons*, this *web portal* requires the user to do some work of their own: *installing* the necessary dependencies and packages, adding their own *environment variables* like *API Key* and *HTTP Auth Credentials* (you can simply make these up) in a `.env` file, and manually running the *server* in your terminal.
- Be assured that this repo is incapable of grabbing any information from the User, including their Key, but they should still be careful when experimenting with *Pull Requests*, regardless of the `.gitignore` file in the root of this repository.
- Instructions for setting up **Google Gemini** through *Vertex AI Studio* with your **API Key** is below.
### Further Explanations
The OpenAI **API**, or *Application Programming Interface*, directly sends **HTTP** requests to the unsanitized and original *GPT-4 model*, and lets you customize certain weights of the model’s responses, like randomness or "temperature", and length or "tokens". You'll need to monitor your usage of the more expensive but intelligent **GPT-4** model, which will cost just over *10-20 Cents* per session, and needs you to add *Five Dollars* in credit to be able to use your **API Key**.
Be aware that at base usage of this web application, you send roughly 1000 tokens for one message to GPT-4, or three cents, and another six cents will be used when it responds with over 1000 words. This is due to the information *concatenated* to the **System Prompt** in the *Custom Instructions*. This file will be sent in the **Conversation History** with each request.
Model behavior will be primarily influenced by whatever *context* is first provided to the API; it lacks a severe filter compared to ChatGPT with increased **steerability**, but is more *expensive* than the regular Chat Interface and will *restrict* you from sending messages once you are **rate-limited**.
- Consult the provided links and **documentation** for more guidance on *Setup* and *Prompting*.
- Users are encouraged to modify the **User Profile** in `instructions.md`, which can be found in the `public` directory, as well as the model name via `server.js`, found in the root of **GPTPortal**.
- More information will be added about *Model Behavior* and *API Usage* to the **ReadMe** in the future.
**IMPORTANT Note** : For the **Voice Functionality** *Feature*, due to *WebKit's*'s lack of codec support and firewalling, *Whisper* and *TTS* will **NOT** work on the **Safari** *Browser*; you will need to switch to Chrome (or any other Chromium fork, including Edge, Opera, Brave, etc.) or Firefox if you want to use the *Voice Chat*.
If you'd like to add Apple-Support to *MediaRecording* via *JavaScript* feel free to install the [RecordRTC](https://github.com/muaz-khan/RecordRTC) GitHub repo and fork this project, as according to *Stack Overflow* and *Apple Community*, that should fix the issue, but I don't want this repository to get bloated.
- If you know of a better way, feel free to submit a **Pull Request**!
- The Relevant *Stack Overflow* Links are in this [*Arc Folder*](https://arc.net/space/04350A44-1A64-49DD-8196-FEA54DF31BDF).
Lastly, if you have uploaded an image and are working with the Vision model, you may no longer switch models mid-conversation, as it will be unable to parse the content of the image in the conversation history. It is best to export the conversation and continue it separately.
### Guide: Basic Setup & Use
#### 1. **Understanding the Basics**
- **GitHub**: A platform for *hosting and sharing code*. Think of it as a library of code projects.
- **Node.js**: An *open-source*, cross-platform *JavaScript* runtime environment. It's the *engine* that will run the chatbot on your computer.
- **API Key**: A *unique identifier* used to authenticate requests to OpenAI's services.
#### 2. **Setting Up the Environment**
- **Create a GitHub Account**: Visit [GitHub](https://github.com/) and sign up for an account.
- **Install Git**: Download Git from [git-scm.com](https://git-scm.com/).
- *Git* is a tool that allows you to download and manage code from GitHub.
- **Install Node.js**: Download and install Node.js from [nodejs.org](https://nodejs.org/). This will also install **npm** (*Node Package Manager*), which is used to manage JavaScript packages.
#### 3. **Cloning the Repository**
- **Clone via Git**:
- On a Mac, open '*Terminal*'; on *Windows*, open '*Command Prompt*'. These programs allow you to interact with your computer using text commands.
- Type `git clone https://github.com/Zaki-1052/GPTPortal.git` and press Enter. This command copies the ChatBot Portal code from GitHub to your computer.
- **Navigate to the Directory**:
- In the same window, type `cd GPTPortal` and press Enter. This moves you into the folder where the ChatBot Portal code is stored.
- Be aware that in order to run the server for this repo, you will need to be in the root directory in your terminal. This means that if you rename and place it elsewhere (your Desktop, for example), you will need to `cd ~/Desktop/GPTPortal`, and use its new name before running.
#### 4. **Setting Up the ChatBot Portal**
- **Install Dependencies**:
- Still in Terminal or Command Prompt, ensure you're in the `GPTPortal` directory. Now, type `npm install` and press Enter. This installs additional code packages that the ChatBot Portal needs to function.
- **Configuration**:
- Find the `.env.example` file in the `GPTPortal` folder. Rename it to `.env`. This is where you'll put sensitive settings, like your OpenAI key.
- If you do not have a text editor like VSCode, use `CMD`+`SHIFT`+`.` to reveal the hidden files in `GPTPortal`, and select the file, renaming and editing it by double clicking and using the default installed *TextEdit* or *Notepad*.
- Open this `.env` file in a text editor and follow the format shown in the file to fill in your **OpenAI API Key** and **Login Credentials** (*Username and Password*).
- Be sure to fill out the **HTTP Authentication** shown in the environment example as well, where you can simply make up your credentials for signing into the port. This information cannot be accessed over the internet and runs locally on your machine.
#### 5. **Obtaining an OpenAI API Key**
- **Sign Up for OpenAI**:
- Visit [OpenAI's Website](https://openai.com/) and create an account.
- You may need to *Verify Your Phone Number* to create your **API Key**.
- **API Key Generation**:
- Once you're logged in, find the API section (linked below in *Relevant Links*) and generate a new API key. This key is like a password that lets your ChatBot Portal access OpenAI's features.
- You may need to *Buy Credits* from your [**Billing**](https://platform.openai.com/account/billing/overview) page.
- Create a new *secret key* from [**here**](https://platform.openai.com/api-keys).
- If your account is new, you will receive **5 Dollars** in **free** *billing credit* to use towards the **API**.
- In this case, you can simply **verify** your account and **Generate** the key.
- *Any free credits granted may expire after some time.*
- **Insert API Key**:
- Copy the generated API key and paste it into your `.env` file in the place of `your_api_key_here`.
- Never share your key with anyone. This is what is used to pay for the API. Their billing system is explained in the Relevant Links, but basically, you pay out of your API Credit Balance for what you actually use, and it carries over from month to month. Refer to your personal usage page for more information. Your API is private and cannot be accessed by anyone online.
#### 6. **Running the ChatBot Portal**
- **Start the Application**:
- Go back to *Terminal* or *Command Prompt*. Make sure you're in the `GPTPortal` directory and type `node server.js`, then press Enter. This starts the ChatBot Portal on your computer.
- **Accessing the Portal**:
- Open a web browser and type `http://localhost:3000/portal` in the address bar. Press Enter to access the ChatBot Portal.
- You will need to sign in with the "**Username**" and "**Password**" that you chose. If you simply copied or renamed the example template, the default settings are eponymously named.
#### 7. **Basic Troubleshooting**
- **Common Issues**:
- If the ChatBot doesn't start, check if you missed any steps like installing Node.js, running `npm install`, or correctly entering your API Key(s) or login credentials in the `.env` file.
- **Consult README**:
- The README file in the `GPTPortal` directory has more detailed instructions and troubleshooting tips. Refer to it if you encounter issues or need more information.
#### 8. [*OPTIONAL*] **Google Gemini Setup**
##### [**AI Studio Link**](https://makersuite.google.com/app/apikey)
- Click on the link provided above to navigate to *Google Gemini AI* Studio's **API Key** generation page.
- Once again, the link to the API page is [**here**](https://makersuite.google.com/app/apikey).
- Accept and "Continue" with the *Terms and Conditions*.
- After accepting the terms, click on the button labeled **"Create API Key in New Project"**.
- Once the API key is generated, it will be displayed on the screen.
- Click the **copy** icon or manually select and copy the key to your clipboard.
- Open the `.env` file and look for the line that reads `GOOGLE_API_KEY=your_google_ai_key_here`.
- Replace `your_google_ai_key_here` with the API key you copied from Google AI Studio.
- Ensure that the key is pasted correctly without any leading or trailing spaces.
- Until **March 2024**, *Google Gemini-Pro* will be completely **free**!
- This means that you do *not* need to set up any *billing* and can use this *Model API* immediately.
- **Gemini-Ultra** will be added to this Portal when released, but will require payment to *Google*.
#### 9. [*OPTIONAL*] **Mistral AI Setup**
##### [**API Creation Link**](https://console.mistral.ai/user/api-keys/)
##### [**Subscription Dashboard**](https://console.mistral.ai/billing/subscribe/)
- Click on the links provided above to navigate to the *Mistral AI* **API Key** *generation* and *subscription* pages.
- Once again, the link to the API page is [**here**](https://makersuite.google.com/app/apikey).
- And you can subscribe for mandatory *payment* [**here**](https://console.mistral.ai/billing/subscribe/)
- The APIs are *paid*; pricing can be found [**here**](https://docs.mistral.ai/platform/pricing/).
- The *Model Selection* can be found [**here**](https://docs.mistral.ai/guides/model-selection/).
###### Mistral Pricing Table
| Model | Endpoint | Input (USD) | Output (USD) |
|----------------|-------------------------|------------------|------------------|
| Mistral 7B | `open-mistral-7b` | $0.25 / 1M tokens | $0.25 / 1M tokens |
| Mixtral 8x7B | `open-mixtral-8x7b` | $0.75 / 1M tokens | $0.75 / 1M tokens |
| Mistral Small | `mistral-small-latest` | $2 / 1M tokens | $6 / 1M tokens |
| Mistral Medium | `mistral-medium-latest` | $2.75 / 1M tokens | $8.1 / 1M tokens |
| Mistral Large | `mistral-large-latest` | $8 / 1M tokens | $24 / 1M tokens |
- The [Mistral **Documentation**](https://docs.mistral.ai/redocusaurus/plugin-redoc-0.yaml) for **Chat Completions** is linked [**here**](https://docs.mistral.ai/api/#operation/createChatCompletion) as well.
- Please follow the same steps for inserting your **API Key** into the `.env` file.
- See the above instructions, applied to "`your_mistral_ai_key_here`".
- *Create a New Key*, and insert it into the correct **`MISTRAL_API_KEY`**.
- The largest *Mistral Model* is said to **beat** *Gemini Pro* at *most tasks*!
###### Mistral Model Descriptions
- [Mistral Small](https://docs.mistral.ai/guides/model-selection/#mistral-small-simple-tasks-that-one-can-do-in-bulk): Simple tasks that one can do in bulk
- [Mistral Medium](https://docs.mistral.ai/guides/model-selection/#mistral-medium-intermediate-tasks-that-require-language-transformation): Intermediate tasks that require language transformation
- [Mistral Large](https://docs.mistral.ai/guides/model-selection/#mistral-large-complex-tasks-that-require-large-reasoning-capabilities-or-are-highly-specialized): Complex tasks that require large reasoning capabilities or are highly specialized
#### 10. [*OPTIONAL*] **Anthropic Claude Setup**
##### [**Anthropic Console**](https://console.anthropic.com/dashboard)
##### [**API Creation Link**](https://console.anthropic.com/settings/keys)
##### [**Billing Subscription**](https://console.anthropic.com/settings/plans)
- Once again, navigate to the provided *API links* to create your key and manage your billing from **Anthropic**.
- The pricing for various *Claude API* models can be found [**HERE**](https://www.anthropic.com/api).
- [**Anthropic Dashboard**](https://console.anthropic.com/dashboard) is here.
- Create your **API Key** [*HERE*](https://console.anthropic.com/settings/keys).
- Add your **Billing Details** [*HERE*](https://console.anthropic.com/settings/plans).
###### Anthropic Pricing Table
| Model | Input Cost | Output Cost | Performance |
|---------------|-----------------|-----------------|--------------|
| Opus | $15 / MTok | $75 / MTok | Powerful |
| Sonnet | $3 / MTok | $15 / MTok | Hard-working |
| Haiku | $0.25 / MTok | $1.25 / MTok | Light & Fast |
| Claude 2.1 | $8 / MTok | $24 / MTok | 200k Context |
| Claude 2.0 | $8 / MTok | $24 / MTok | 100k Context |
| Claude Instant| $0.80 / MTok | $2.40 / MTok | 100k Context |
- The [**Claude Documentation**](https://docs.anthropic.com/claude/docs/intro-to-claude) is linked [*HERE*](https://docs.anthropic.com/claude/reference/messages_post) for **API Messages**.
- Anthropic's [**Prompt Library**](https://docs.anthropic.com/claude/prompt-library) is also linked.
- Anthropic claims that *Claude Opus* **beats** *GPT-4* in benchmarks!
#### 11. [*OPTIONAL*] **Meta LLaMA Setup**
##### [**Llama Console**](https://console.llama-api.com/account/my-account)
##### [**API Creation Link**](https://console.llama-api.com/account/api-token)
##### [**Billing**](https://console.llama-api.com/account/billing) & [**Payment**](https://console.llama-api.com/account/payment)
- First, **Create an Account** with the *Llama API*.
- **Refresh** your *API token* and **add billing**.
- **Paste** your *API Key* into the `.env` as normal.
- **Pricing**: $ 0.0032 / 1K Tokens
#### 12. [*OPTIONAL*] **Open Router Setup**
##### [**OpenRouter Credits**](https://openrouter.ai/credits)
##### [**API Creation Link**](https://openrouter.ai/keys)
- **Create** an *OpenRouter Account*
- **Buy Credits**
- **Paste** your *API Key*
- [**Supported Models**](https://openrouter.ai/docs#models)
## Relevant [Links](https://arc.net/folder/B777A318-2A95-4C36-86AA-156166895CC2)
- [Pricing](https://openai.com/pricing) - OpenAI's pricing details for different API Models.
- [API Keys](https://platform.openai.com/api-keys) - Where to create and manage your OpenAI API keys.
- [Models](https://platform.openai.com/docs/models/gpt-4-and-gpt-4-turbo) - Where to view the GPT-4 model documentation.
- [Billing Activity/Usage](https://platform.openai.com/usage) - Check your usage and billing activity for OpenAI models.
- [Account Limits](https://platform.openai.com/account/limits) - Information on billing and rate limits per tokens.
- [Payment Balance](https://platform.openai.com/account/billing/overview) - Check and increase your API Credit and add your information.
- [Rate Limiting](https://platform.openai.com/docs/guides/rate-limits) - Guide on rate limits for OpenAI API usage.
- [Usage Tiers](https://platform.openai.com/docs/guides/rate-limits/usage-tiers) - Details on different usage tiers and their limits.
- [Prompt Engineering](https://platform.openai.com/docs/guides/prompt-engineering) - A guide to effective prompt engineering with OpenAI models.
- [OpenAI Tokenizer](https://platform.openai.com/tokenizer) - Visit the OpenAI Token Counter to determine message lengths.
- [Vision Documentation](https://platform.openai.com/docs/guides/vision) - OpenAI insists that the Vision model called in this API Portal is no different from the regular GPT-4, but of course, if you'd like to be sure that you're using the old version that we all miss, please change the model name as specified.
- [Chat Completions](https://platform.openai.com/docs/api-reference/chat/create) - Documentation reference guide for GPT models on parameters and completion objects.
- [Google API Key](https://makersuite.google.com/app/apikey) - Gemini AI Studio; create your API Key and paste it in the `.env` file.
- [Model Parameters](https://ai.google.dev/docs/concepts#model_parameters) - Google's documentation on their Gemini model parameters.
- [Mistral API Key](https://console.mistral.ai/user/api-keys/) - Create your Mistral API Key here.
- [Mistral Documentation](https://docs.mistral.ai/) - Their Docs can be found here.
- [Claude API Key](https://console.anthropic.com/settings/keys)
- [Claude Documentation](https://docs.anthropic.com/)
- [Anthropic Prompts](https://docs.anthropic.com/claude/prompt-library)
### Author Links & Custom GPTs
- [Discord](https://discord.gg/BVQd7Kdngr) - Contact me on my *Discord* server!
- [Reddit: Zaki_1052_](https://www.reddit.com/user/Zaki_1052_) - My *Reddit* account for prompts and discussions.
- [My Website](http://www.nazalibhai.com) - Visit my *custom website* for a look at *web development*.
- [NotesGPT](https://chat.openai.com/g/g-btAKVGisd-notesgpt) - *Expert at creating clear, concise, and comprehensive bullet-point notes.*
- [Summary Specialist](https://chat.openai.com/g/g-apS8hdTpI-summary-specialist) - *Expert at creating clear, concise, and comprehensive advanced summaries.*
- [Chemistry Companion](https://chat.openai.com/g/g-gDkC33NG6-chemistry-companion) - *Expert Chemistry tutor offering detailed problem-solving explanations.*
- [Calculus Companion](https://chat.openai.com/g/g-CVy3YLpLY-calculus-companion) - *Expert Calculus tutor offering detailed explanations and guided problem-solving.*
- [GrammarGPT](https://chat.openai.com/g/g-4LlLCuKZ5-grammargpt) - *Expert proofreader and grammar checker, accurate to conventional linguistic standards.*
- [LogicGPT](https://chat.openai.com/g/g-Cu2jouFyb-logicgpt) - *Expert at logical puzzles, reasoning, and thoughtful analysis. Uses CoT and ToT.*
- [PromptGPT](https://chat.openai.com/g/g-MM7wxKtTg-promptgpt) - *Expert at designing and refining AI prompts for clarity and effectiveness.*
- [StudyGuideGPT](https://chat.openai.com/g/g-Y6DEVGgvf-studyguidegpt) - *Expert at creating detailed study guide explanations for various topics.*
- [Insightful Scholar](https://chat.openai.com/g/g-MEx354Wgq-insightful-scholar) - *Highly detailed assistant for a tech-savvy high school senior with a focus on BioTech and CompSci.*
### [Research Papers](https://arc.net/folder/AEE28E72-9795-42D7-9D49-D48ABA0ED00C)
Using **Chain and Tree of Thought Prompting**:
- [Chain of Thought Prompting Elicits Reasoning in Large Language Models](https://arxiv.org/pdf/2201.11903.pdf)
- [Tree of Thoughts: Deliberate Problem Solving with Large Language Models](https://arxiv.org/pdf/2305.10601.pdf)
- [Chain-of-Thought Style Prompting Increases Performance](https://arxiv.org/pdf/2305.14215v1.pdf)
- [Chain of Thought Prompting Assists LLM Reasoning](https://arxiv.org/pdf/2306.00550v1.pdf)
- [Zero-Shot CoT Prompting Aids in NLP Tasks](https://arxiv.org/pdf/2305.04091v3.pdf)
- [Reducing Hallucinations with CoT Verification](https://arxiv.org/pdf/2309.11495.pdf)
- [Google DeepMind: Attention Is All You Need](https://arxiv.org/pdf/1706.03762.pdf)
- [Reviewing Prompt Engineering in LLMs](https://arxiv.org/pdf/2310.14735.pdf)
- [CoT Reasoning Capabilities in GPTs](https://arxiv.org/pdf/2305.02897.pdf)
- [Emergent Abilities of Large Language Models](https://arxiv.org/pdf/2206.07682.pdf)
- [Enhancing LLMs with Dialog-Enabled Resolving Agents](https://arxiv.org/pdf/2303.17071.pdf)
- [GPT-4 Technical Report](https://arxiv.org/pdf/2303.08774.pdf)
- [Reflexion: Verbal Reinforcement Learning](https://arxiv.org/pdf/2303.11366.pdf)
- [Step-By-Step Verification](https://cdn.openai.com/improving-mathematical-reasoning-with-process-supervision/Lets_Verify_Step_by_Step.pdf)
- [Probabilistic Prompting Methods in NLP](https://arxiv.org/pdf/2107.13586.pdf)
- [Sparks of Artificial General Intelligence](https://arxiv.org/pdf/2303.12712.pdf)
- [Few-Shot Prompting](https://arxiv.org/pdf/2005.14165.pdf)
- [Zero-Shot Reasoning](https://arxiv.org/pdf/2205.11916.pdf)
- [Automatic CoT Prompting in LLMs](https://arxiv.org/pdf/2210.03493.pdf)
- [Self-Consistency Improvements in LLMs via CoT](https://arxiv.org/pdf/2203.11171.pdf)
- [GPT-4V System Card](https://cdn.openai.com/papers/GPTV_System_Card.pdf)
- [Optimizing Large Language Model Prompting](https://arxiv.org/pdf/2309.03409.pdf)
### FAQ
#### How do I obtain an OpenAI API key to use this portal?
To use the ChatBot Portal, you need an OpenAI API key. Register or log in to your account on [OpenAI's Website](https://platform.openai.com/docs/overview). Navigate to the [API](https://platform.openai.com/api-keys) section and generate a new key. Remember to keep this key confidential, as it is used for billing purposes. You can view your usage [here](https://platform.openai.com/usage); if your free credit expires, you can buy more [here](https://platform.openai.com/account/billing/overview) and see your rate limits [here](https://platform.openai.com/account/limits).
#### What are the system requirements for running this portal?
The ChatBot Portal requires Node.js, which is cross-platform and should run on most modern operating systems. Ensure your browser is up to date for the best experience. Refer to Node.js's official site for specific version requirements. Specifically, the download link can be found [**here**](https://nodejs.org/en/download) for various devices. You can either install the LTS (preferred) or build it manually from the binary if you're on a restricted device.
#### Can I customize the chatbot’s responses?
Yes, you can customize the chatbot's responses by adjusting the model parameters and system-defined instructions in the `server.js` and `instructions.md` / `geminiMessage.txt` files. These include settings for response length, style, and context sensitivity. Links to guides on prompting, research papers, and documentation from Google and OpenAI can be found above [**here**](#relevant-links).
Feel free to add details about yourself to the files for each respective model; I've left placeholders in each Custom Instructions bloc where you can edit them or play around with Prompt Engineering. The nice thing about repos like these are that they're all stored locally, so there's no need to worry about anyone accessing your info!
#### Is it possible to integrate this chatbot into my existing website?
Integrating this chatbot into your existing website requires some web development knowledge. You can embed the chat interface by referencing the `portal.html` in your site and ensuring that the server is correctly set up to handle requests from your domain.
#### How do I troubleshoot common issues during installation or operation?
For installation issues, ensure that all prerequisites are met and that you've followed the installation steps correctly. Common operational issues can often be resolved by checking your OpenAI API key and internet connection. For more specific problems, refer to the troubleshooting section in this README. Specifically, I've attached a more thorough guide of detailed steps for setup [**here**](#guide-basic-setup--use).
The most common mistake people make is not renaming/creating the `.env` to the specified format, either by leaving it as `.env.example`, or not copying the variables correctly. Be sure that your file is properly titled `.env` and matches the given example. If you've forgotten or done it incorrectly, you'll see an error message similar to this user [**here**](https://github.com/Zaki-1052/GPTPortal/issues/2), to which the solution is elucidated and shown in a YouTube clip [**here**](https://github.com/Zaki-1052/GPTPortal/issues/2#issuecomment-1817986058) and [**here**](https://youtube.com/clip/UgkxQl6762PzwyHpZ4ial0lrzLRjZecMxR5-?si=KwcMlk8Jb8Vzu2U5).
#### What are the costs associated with using this portal?
The costs depend on your usage of the OpenAI API. OpenAI charges based on the number of tokens processed. Monitor your usage on your OpenAI dashboard, and consider setting limits to control expenses. The API key section in this README has links to OpenAI's pricing details. Specifically, I explain token costs in great detail [**here**](#token-costs-explained).
#### Is my data secure when using this chatbot portal?
Yes. Once you clone this repository locally, the information is sent only through the APIs to the respective AI companies (OpenAI and Google), both of whom at least claim to respect data privacy via API (in contrast to publicly available frontends like ChatGPT and Bard). The `.env` file ensures your API key and other sensitive data are stored securely, as they are ignored via the `.gitignore` file, so even if you accidentally submit a Pull Request, nobody will see your key.
#### I don't see the `.env` file in my finder. Where do I add my key?
If you're using the OS to edit the file and add your credentials, you'll see the hidden files on a Mac with `CMD+Shift+.`. Windows should display the file regardless of its status. You can then use a simple text editor (no need for an IDE!) in order to add the necessary information. This can be done by right-clicking the file and using "Open In" to select the default "TextEdit", and pasting the required info. Remember to either make a new file to this effect or rename the `.env.example` file to `.env` so that the server knows to look for it!
#### Where can I find more resources to learn about GPT-4 and API integrations?
For more in-depth knowledge about GPT-4 and API integrations, visit [OpenAI's Documentation](https://platform.openai.com) and explore the various guides and tutorials available there. Additionally, the links provided in the 'Relevant Links' section of this README offer valuable resources. The respective sections can be found [here](#relevant-links), [here](#author-links--custom-gpts), and [here](#research-papers).
#### What browsers and devices are compatible with the ChatBot Portal?
This ChatBot Portal is designed to be widely compatible with modern web browsers. It functions optimally on browsers like Chrome, Firefox, Edge, Arc, Brave, Opera, Vivaldi, Beam, Thorium, DDG, LibreWolf, Sigma, Min, Mull, and any other Chromium fork, though the voice functionality feature may have limited support on Safari and Orion due to WebKit's codec restrictions. For the best experience, I'd recommend using the latest version of these browsers.
In terms of devices, the portal is responsive and should work seamlessly on desktops, laptops, and tablets. However, while the portal is accessible on smartphones, the user experience might be more constrained due to the smaller screen size. Also, you really shouldn't be wasting API credits on your phone, so just use it on Desktop; you wouldn't want to accidentally waste messages to GPT-4. If you are using a separate device, be sure that you're on the same network as your computer.
#### How can users update their ChatBot Portal to the latest version?
To update your ChatBot Portal to the latest version, follow these steps:
1. **Check for Updates**: Visit the GitHub repository for the ChatBot Portal to check if a new version is available. This will be clearly marked by a release tag.
2. **Download the Latest Release**: If an update is available, download the latest release from the repository.
3. **Backup Your Data**: Before updating, it's a good practice to backup your current portal configuration, including your `.env` file and any custom scripts or settings.
4. **Replace Files**: Replace the existing files in your ChatBot Portal directory with the new ones from the downloaded update. Be cautious not to overwrite your `.env` file or other customized configurations.
5. **Reinstall Dependencies**: If the update includes changes to dependencies, run `npm install` in your project directory to ensure all necessary packages are up to date.
6. **Restart the Server**: After updating the files and dependencies, restart the server to apply the updates.
Always refer to the release notes for specific updating instructions, as some updates may require additional steps.
#### I have a suggestion or issue with the ChatBot Portal. How can I raise it?
I'm open to all community feedback and suggestions. If you have any ideas for improvements or encounter any issues, please follow these steps to raise them:
1. **GitHub Issues**: For technical issues or bugs, please open an issue in the GitHub repository. Provide a detailed description of the problem, including steps to reproduce the issue, and any error messages or screenshots.
2. **GitHub Discussions**: For feature suggestions, discussions, or general feedback, use the GitHub Discussions section of the repository. This is a great place to share your ideas and connect with other users.
3. **Stay Updated**: After submitting an issue or suggestion, keep an eye on your GitHub notifications for any responses or queries from the development team or community members.
4. **Contribute**: If you're able to contribute a fix or improvement directly, consider forking the repository and submitting a pull request. Your contributions can help enhance the ChatBot Portal for everyone.
By participating in the community and sharing your feedback, you help improve the ChatBot Portal and ensure it continues to meet user needs and expectations.
Please fully review this entire ReadMe page before raising an issue. Thank you!
### Glossary
1. **API (Application Programming Interface)**: A set of protocols and tools for building software and applications. In the context of this project, it refers to OpenAI's and Google Gemini's interfaces that allow the ChatBot Portal to access their functionalities.
2. **Node.js**: An open-source, cross-platform JavaScript runtime environment that executes JavaScript code outside a web browser. This portal uses Node.js for its server-side operations.
3. **Git**: A version control system used for tracking changes in source code during software development. It's used to clone the repository of the ChatBot Portal.
4. **Repository (Repo)**: A digital directory or storage space where the project's files and each file's revision history are stored.
5. **.env File**: A configuration file used to store environment-specific variables, such as API keys and login credentials, in a secure and modular way.
6. **Model Selector**: A feature in the portal that allows users to choose from different AI models (like GPT-4, GPT-4-Vision, Gemini-Pro, etc.) for varied functionalities.
7. **Markdown**: A lightweight markup language with plain-text formatting syntax that's often used for writing messages in the chat interface of the portal.
8. **HTTP (Hypertext Transfer Protocol)**: The foundation of data communication for the World Wide Web. This portal uses HTTP requests to interact with APIs.
9. **Token**: In the context of APIs, a token is a part of the text that the model processes. API usage is often calculated based on the number of tokens.
10. **OpenAI GPT-4**: The latest version of the Generative Pre-trained Transformer (GPT) models by OpenAI, known for its advanced natural language processing capabilities.
11. **Google Gemini**: A set of AI models provided by Google, offering functionalities similar to OpenAI's GPT models.
12. **Whisper API**: An API for voice recognition and transcription, used in the ChatBot Portal for voice conversation features.
13. **TTS (Text-to-Speech)**: Technology that converts text into spoken voice output. Used in the ChatBot Portal to read responses aloud.
14. **CORS (Cross-Origin Resource Sharing)**: A security feature that allows or restricts requests for resources from other domains outside the domain from which the first resource was served.
15. **Multer**: A Node.js middleware used for handling multipart/form-data, primarily used for uploading files.
16. **DALL·E 3**: An AI model by OpenAI known for generating images from textual descriptions, integrated into your portal for image generation features.
17. **Frontend and Backend**: Referring to the client-side (frontend) and server-side (backend) parts of web applications. The frontend is what users interact with directly, while the backend is the server-side that processes requests and manages data.
18. **Prompt Engineering**: The art of crafting prompts to effectively communicate with AI models to elicit the desired response.
19. **Rate Limiting**: A feature that limits the number of API requests a user can make within a given time frame, used to control access and ensure fair usage.
20. **Session**: A period of interaction with the ChatBot, beginning when the user starts the conversation and ending when they terminate it or after a period of inactivity. Sessions begin when you run `node server.js` in your terminal and end either when writing, "*Bye!*" in the text box or manually ending the server with `Control`+`C`.
### Updates
**IMPORTANT**: To *update* your local copy of of the repository, run the following command after changing into the root directory:
```bash
git pull origin main
```
This will keep your `.env` configure file, but override the other code and bring the software *up-to-date* with the *latest updates*.
This **Updates** Section will showcase any further features added to the repository.
- **IMPORTANT UPDATE**: A *Model Selector* has now been added.
- This means that you will no longer need to adjust this parameter in `server.js`.
- **UPDATE #2**: Image Generation via the *DALL·E 3* API is now supported.
- Simply type "**Generate:**" and give your prompt to the model, which will automatically supply and download the image.
- Both the "*Bye!*" and "*Generate:*" commands are case sensitive.
- **Update #3**: Google's *Gemini* models have been added to the *model selector*.
- Gemini-Pro via the API will be completely **free** until *February 2024*!
- Follow instructions in the ReadMe to retrieve your Key from their *AI Studio*.
- Link to Makersuite Key Generation Page is [**HERE**](https://makersuite.google.com/app/apikey).
- More detailed installation instructions are [**HERE**](#8-optional-google-gemini-setup).
- **Update #4**: The **Mistral AI** models have been added to the *model selector*.
- Similarly to *Google Gemini*, you will need to follow the instructions to setup your **API Key** and **billing**.
- **Installation** *Instructions* and *Further* **Information** can be found [**HERE**](#9-optional-mistral-ai-setup).
- **Update #5**: *Anthropic's* **Claude** models have been added to the *model selector*.
- Follow the instructions [**HERE**](#10-optional-anthropic-claude-setup) to set it up.
- **Update #6**: An **Assistants Mode** for *OpenAI* has been added.
- Preliminary information on *usage* can be found [**HERE**](#assistants-use); more documentation will be added.
#### *Showcase* of **DALL·E 3**
https://github.com/Zaki-1052/GPTPortal/assets/134018102/289a8af8-cf9a-4199-8d4f-50ebde8efbbd
#### **Token Costs Explained**
In terms of API calls, they can certainly add up if you're running heavy sessions with GPT-4: the most intelligent (and expensive!) model. For now, this section will serve as a placeholder until I add full support for tracking your token and billing credit usage; I'll also explain mathematically how you can best budget your use of these models in order to get the best possible experience!
##### **Understanding the Costs and Usage Pattern**
1. **Base Cost**: Each API call has a base cost of 3 cents for the system prompt (at default).
2. **Token Costs**:
- Additional 1000 tokens in request: 3 cents.
- Each 1000 tokens in response: 6 cents.
- Audio adds a couple more cents (depending on length).
3. **Context Accumulation**: Using previous messages in the API request, which cumulatively increases token count.
4. **Spending**:
- Imagine a Monthly Budget: $10.
##### **Session Cost Breakdown**
###### **Cost Components**
1. **Base Cost**: 3 cents for the system prompt (fixed 1k tokens).
2. **Input Cost**: 3 cents per 1000 tokens.
3. **Output Cost**: 6 cents per 1000 tokens.
**Total for Initial Request**: 3 (base) + 3 (input) + 6 (output) = 12 cents.
###### **Second Request**
Now, let's say for the second request, you include the initial request and response as part of the input, which cumulatively increases the token count.
1. **Previous Input + Output**: 3000 tokens (2000 Input (1k System + 1k Query) + 1000 Output from the first request).
2. **New Input**: Let's assume 1000 tokens.
3. **Total Input #2**: 3000 (previous) + 1000 (new) = 4000 tokens ≈ 12 cents.
4. **Output Tokens #2**: Let's assume another 1000 tokens (6 cents).
**Total for Second Request**: 12 (input) + 6 (output) = 18 cents.
###### **Cumulative Session Cost**
- **First Request**: 12 cents.
- **Second Request**: 18 cents.
**Total Session Cost**: 12 + 18 = 30 cents.
##### **Key Considerations**
- **Cumulative Input**: Each subsequent request will have a larger input size due to the inclusion of previous inputs and outputs.
- **Managing Token Count**: Being strategic about the number of tokens used in each request and response can help manage costs. This includes frontloading requests with tokens or limiting the scope of each request to manage the token count.
- **Output Control**: While you have more control over the input size, the output size can vary. Planning for the maximum possible output cost in each session helps in staying within the budget.
- These can be managed in the "*parameters*" section on `server.js` (read the comments)
- **Final Thoughts**: By understanding how the costs accumulate and the impact of including previous inputs and outputs in new requests, you can more accurately predict and manage your session costs. This step-by-step breakdown should help in visualizing how each component contributes to the total cost.
##### **Monthly Budget Analysis**
1. **Total Monthly Budget**: $10 (1000 cents).
2. **Daily Session Cost**: 30 cents.
3. **Monthly Session Projection**:
- Every day for a month: 30 cents x 30 days = $9 (900 cents), which is under budget.
- Every other day for a month: 30 cents x 15 days = $4.50 (450 cents).
- If token use is restrained, you could have a budget of $5 per month.
- This means that you could only use two (longer) messages in a session by alternating days.
##### **Further Token Use**
- If a heavier final output is needed (2000 tokens), you will reach the "*Max Tokens"* set in the parameters. While the context length of the model is 8000 tokens, 6000 is set manually here for safety.
- This will mean an additional cost of 6 cents for 36 cents, and still need "chunking" of messages.
- Please read OpenAI's linked *Prompt Engineering* [Documentation](https://platform.openai.com/docs/guides/prompt-engineering) if you expect to modify this.
- If you do expect to modify the *parameters* to use more tokens, expect that your API credit use will increase exponentially.
- Example: A third request will mean an additional **15 cents** of input, and an output of up to an additional **20 cents** depending on the size of the response.
- This would then total up to **70 cents** per session if audio or images are included.
- Expect to budget the same amount as you are paying for **ChatGPT** if you are utilizing the API so heavily (*$20/month*).
#### TODOs
- [x] Add Token Cost Explanation
- [x] Add Model Selector
- [x] Make Updated Video Showcase
- [x] Added Export Functionality
- [x] Fixed Image Inputs
- [x] Added Image Generation
- [x] Increase Image Input Size
- [x] Stream Server Messages to API
- [x] Render Markdown on Portal
- [x] Set up Gemini API
- [x] New Gemini Chats
- [x] Add Handling for Gemini
- [x] Markdown
- [x] Exports
- [x] Images
- [x] Audio
- [x] Model Switching
- [ ] Implement RAG
- [x] Flask
- [ ] Vectors
- [ ] Embeddings
- [ ] Function Calling
- [x] Update ReadMe for Release
- [x] Add Demo Video
- [x] Added Mistral APIs
- [x] File Uploads
- [x] Integrate Assistants
- [x] Refactor
- [x] Start Documentation
- [ ] Finish docs
### Quick-Start Guide
Welcome to the ChatBot Portal Quickstart Guide! This guide is designed to help you get started with the ChatBot Portal, a Node.js-based web application integrated with OpenAI's GPT-4 API and Google Gemini models. Follow these steps to set up and start using the portal quickly.
- Ensure you have Node.js installed on your machine. Download it from [nodejs.org](https://nodejs.org/en/download).
- Obtain an OpenAI API key by registering at [OpenAI](https://platform.openai.com/api-keys). Keep this key confidential.
#### Step 2: Clone the Repository
- Open Terminal (Mac) or Command Prompt (Windows).
- Run the command:
```bash
git clone https://github.com/Zaki-1052/GPTPortal.git
```
- Navigate to the project directory:
```bash
cd GPTPortal
```
#### Step 3: Install Dependencies
- In the project directory, run:
```bash
npm install
```
#### Step 4: Set Up Environment Variables
- Create a `.env` file in the project root.
- Use the `.env.example` as a template.
- Fill in your OpenAI API key and basic authentication credentials (username and password).
- If using Google Gemini, add the Google AI Key here too.
#### Step 5: Start the Server
- Run the server with:
```bash
node server.js
```
#### Step 6: Access the Chat Interface
- Open a web browser and go to `http://localhost:3000/portal`.
- Log in with the username and password you set in the `.env` file.
#### Step 7: Using the Portal
- Type or speak your query in the chat interface.
- Select the AI model using the model selector if needed.
- For voice conversations, click the microphone icon.
- To upload an image, click the camera icon.
- Use the export button to save your conversation history.
- Type “Bye!” to end the session and shut down the server.
#### Troubleshooting Tips
- If the portal doesn't start, check your Node.js installation and `.env` file setup.
- For browser compatibility issues, try using Chrome or Firefox.
#### Quick Tips
- Keep an eye on your token usage to manage costs effectively.
- Customize the chatbot’s responses by adjusting model parameters in `server.js` and `instructions.md`.
- Explore the `README.md` file for detailed information and additional features.
This quickstart guide provides the essentials to get you up and running with the ChatBot Portal. For more detailed information, refer to the full README in the project repository. Enjoy your journey with this advanced AI-integrated chat interface!
## Docker
### Running the Application with Docker
This application supports Docker, which simplifies the setup and deployment process across different environments. Below are the instructions to get the application running with Docker.
#### Docker Prerequisites
- [Docker](https://docs.docker.com/get-docker/) must be installed on your system.
- [Docker Compose](https://docs.docker.com/compose/install/) for orchestrating multi-container Docker applications.
#### Using Docker Compose
For users who want to quickly start the application without manual Docker commands, Docker Compose can be used. Follow these steps:
1. **Clone the Repository** (if you haven't already):
```sh
git clone https://github.com/Zaki-1052/GPTPortal.git
cd GPTPortal
```
2. **Environment Variables**:
- Create a `.env` file in the root directory of the project.
- Add the necessary environment variables as key-value pairs.
- These are described in the [Installation](#installation) section of this ReadMe.
3. **Starting the Application**:
- Run the following command from the root directory of the project:
```sh
docker-compose up
```
- This will pull the necessary Docker image, set up the container, and start the application. The service defined in the `docker-compose.yml` file will be orchestrated accordingly.
4. **Accessing the Application**:
- Once the container is up and running, the application should be accessible via `http://localhost:3000/portal` on your browser.
5. **Stopping the Application**:
- To stop the application, you can press `Ctrl+C` in the terminal where the Docker Compose is running.
- To remove the containers along with their volumes, you can run:
```sh
docker-compose down
```
### Building and Running with Docker Manually
If you prefer to build and run the Docker image manually, follow these steps:
1. **Building the Docker Image**:
- Navigate to the root directory of the project where the `Dockerfile` is located.
- Execute the following command to build the Docker image:
```sh
docker build -t gptportal .
```
2. **Running the Docker Container**:
- After the image has been successfully built, you can run the container using:
```sh
docker run -p 3000:3000 --env-file ./.env --name gptportal-instance gptportal
```
- This will start a Docker container named `gptportal-instance` which exposes port 3000 to your local machine.
3. **Accessing the Application**:
- The application should now be running and accessible through `http://localhost:3000/portal`.
#### Additional Information
- The Docker setup is configured to use port `3000`. If you need to use a different port, you can modify the `ports` section in the `docker-compose.yml` file or adjust the `-p` flag in the `docker run` command accordingly.
- The Docker Compose setup assumes the presence of a `.env` file for environment variables. Ensure this file contains all the necessary configurations for the application to run properly.
## Contributions
Contributions are welcome! Please fork the repository and submit a pull request with your updates. Alternatively, if you encounter any errors, feel free to raise an issue through GitHub, and I'll get back to you shortly!
## License
This project is open source and available under the [MIT License](LICENSE).
---
*Jump to [**Table of Contents**](#table-of-contents)*.
| A feature-rich portal to chat with GPT-4, Claude, Gemini, Mistral, & OpenAI Assistant APIs via a lightweight Node.js web app; supports customizable multimodality for voice, images, & files. | ai,api,generative-ai,gpt,gpt-4,javascript,openai,tts-api,whisper-ai,chatbot | 2023-11-10T05:38:04Z | 2024-05-16T15:05:28Z | 2024-02-27T17:12:34Z | 2 | 5 | 251 | 2 | 28 | 185 | null | MIT | JavaScript |
shovoalways/JavaScript-Course | main | # JavaScript-Course
## 📝 Description
This comprehensive JavaScript course, designed for absolute beginners, takes you from the basics of syntax to building interactive web applications. Through clear explanations, practical exercises, and real-world projects, you'll gain a solid understanding of JavaScript concepts, write clean code, create interactive elements, and get started with popular frameworks and libraries. EVERY web developer has to know JavaScript.
এই Modern JavaScript Tutorial Bangla প্লেলিস্ট ফলো করলে আমি আশা করি আপনার আর কোথাও থেকে JavaScript শিখতে হবে না। আমি এই একটা প্লে-লিস্ট এ ডিটেইলে আপনাকে JavaScript শিখাব, ইনশাআল্লাহ্। তাই আপনি যদি আগ্রিহী হন দেখতে থাকুন। Learn JavaScript for the first time or brush up your JavaScript skills and dive in even deeper. EVERY web developer has to know JavaScript.
## ⏳ Prerequisite
You need the following skills to start with
- [HTML (Hyper Text Markup Language)](https://youtu.be/BSvo4i5t-Kg)
- [CSS](https://youtu.be/Kb76Pw2mGpE?si=oVvAX4xaypHtHDk8)
- NO JavaScript knowledge is required at all!
## 📚 What You will learn
- What is JavaScript
- Why JavaScript
- Basic as well as advanced JavaScript features
- Understand the concepts and theory behind JavaScript and certain JavaScript features
## Course URL (Playlist)👇
- [Modern JavaScript Tutorial Bangla](https://www.youtube.com/watch?v=KKr5_o4WA_Q)
## 🧑💻 Contributors
- [@Ali Hossain](https://github.com/shovoalways/)
## 🥰 Follow me
- [@Github](https://github.com/shovoalways/)
- [@Facebook](https://facebook.com/shovoalways/)
- [@Twitter](https://twitter.com/shovoalways/)
- [@Instagram](https://instagram.com/shovoalways/)
| Learn JavaScript for the first time or brush up your JavaScript skills and dive in even deeper. EVERY web developer has to know JavaScript. | es6,javascript,js,tutorial | 2023-11-27T20:30:02Z | 2024-05-12T15:15:48Z | null | 1 | 0 | 41 | 0 | 6 | 177 | null | null | JavaScript |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.