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 |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
egorantonov/sbg-enhanced | master | <h1 align="center"><img src="https://github.com/egorantonov/sbg-enhanced/raw/master/assets/script/64.png" width="32px" /> SBG Enhanced UI</h1>
<p align="center">
<a href="https://github.com/egorantonov/sbg-enhanced/releases"><img src="https://img.shields.io/github/package-json/v/egorantonov/sbg-enhanced?color=20bb20&style=flat-square" /></a>
<a href="https://github.com/egorantonov/sbg-enhanced/actions"><img src="https://img.shields.io/github/actions/workflow/status/egorantonov/sbg-enhanced/webpack.yml?style=flat-square" /></a>
<a href="https://github.com/egorantonov/sbg-enhanced/releases"><img src="https://img.shields.io/github/v/release/egorantonov/sbg-enhanced?color=%2310dd10&include_prereleases&style=flat-square" /></a>
<a href="https://github.com/egorantonov/sbg-enhanced/releases/latest"><img src="https://img.shields.io/github/release-date/egorantonov/sbg-enhanced?style=flat-square" /></a>
<a href="https://github.com/egorantonov/sbg-enhanced/releases"><img src="https://img.shields.io/github/downloads/egorantonov/sbg-enhanced/total?style=flat-square" /></a>
<a href="https://github.com/egorantonov/sbg-enhanced/releases/latest"><img src="https://img.shields.io/github/downloads/egorantonov/sbg-enhanced/latest/total?style=flat-square" /></a>
<img src="https://img.shields.io/github/languages/top/egorantonov/sbg-enhanced?color=%23200bb20&style=flat-square" />
<a href="https://sbg-game.ru/app"><img src="https://img.shields.io/website?label=sbg-game.ru/app&style=flat-square&url=https%3A%2F%2Fsbg-game.ru/app" /></a>
</p>
<p align="center">Пользовательский скрипт, созданный для улучшения интерфейса игры <a href="https://sbg-game.ru/app" target="_blank"> <img src="https://sbg-game.ru/assets/icons/64.png" width="16px" /> The Simplest Browser Geoloc</a></p>
<p align="center">
<a href="#особенности">✅ Особенности</a>
<a href="#скачать">⏬ Скачать</a>
<a href="#что-нового">🆕 Что нового</a>
<a href="#скриншоты">📱 Скриншоты</a>
<a href="#как-установить">❓ Как установить</a>
</p>
<p align="end"><a href="https://github.com/egorantonov/sbg-enhanced/wiki/English">Available in English <img src="https://kyber.gg/static/images/flags/gb.svg" width="16px" /></a></p>
<h2 align="center">Особенности</h2>
* Поиск рефов и сортировка по названию и расстоянию: `Inventory` (ОПРЦ) > `Сноски`
* Пользовательские темы: <span color="cyan" style="color:cyan">Ingress [REDACTED]</span>, Ingress Prime, Чёрно-белая (`Настройки` > `Цветовая схема`)
* Компактный режим: `Настройки` > `Компактный режим`
* Режим Дзен для максимального погружения: удерживайте кнопку атаки (`АТАКА`)
* Импорт/экспорт/облачное сохранение настроек игры и пользовательских скриптов: `Настройки` > `Импорт/экспорт настроек`
* Интерактивные анимации: `Настройки` > `Анимации`
* Высокий контраст: для яркого солнечного дня и экономии аккумулятора устройств с *OLED экраном (`Настройки` > `Высокий контраст`)
* Настраиваемая прозрачность линий: `Настройки` > `Прозрачность линий`
* Компактные слайдеры рисования, деплоя и атаки
* Кнопка `Исследования` показывает прогресс охлаждения
* Проверка сетевого подключения: `Настройки` > `Подключение` > `Показать`
* Быстрая очистка инвентаря: удерживайте кнопку `Inventory` (работает только с установленным скриптом [Custom UI](https://github.com/nicko-v/sbg-cui))
<h2 align="center">Скачать</h2>
Скачать, установить и обновить скрипт можно в [разделе релизов](https://github.com/egorantonov/sbg-enhanced/releases/latest) или по прямой ссылке:
[https://github.com/egorantonov/sbg-enhanced/releases/latest/download/eui.user.js](https://github.com/egorantonov/sbg-enhanced/releases/latest/download/eui.user.js)
<h2 align="center">Что нового</h2>
<a href="https://github.com/egorantonov/sbg-enhanced/releases">
<img src="https://img.shields.io/github/v/release/egorantonov/sbg-enhanced?color=%2320bb20&include_prereleases&style=for-the-badge" />
<img src="https://img.shields.io/github/release-date/egorantonov/sbg-enhanced?color=%2320bb20&style=for-the-badge" />
</a>
[Список обновлений](https://github.com/egorantonov/sbg-enhanced/releases)
<h2 align="center">Скриншоты</h2>
* Тема Ingress [REDACTED]
<img src="https://user-images.githubusercontent.com/16327320/230785245-8f01807d-c2ba-4e9c-9efb-c966cf694b12.png" width="240px" alt="Draw"/><img src="https://user-images.githubusercontent.com/16327320/230785249-a0123723-036b-44e4-9d77-7f53b698f3e7.png" width="240px" alt="Point"/><img src="https://user-images.githubusercontent.com/16327320/230785243-51f2a6e3-1c38-4f40-bdcd-d87bb6c917ee.png" width="240px" alt="Attack"/><img src="https://user-images.githubusercontent.com/16327320/230785241-d32f977d-f2fd-43fd-a45d-b09dc0e870da.png" width="240px" alt="Inventory"/>
* Тема Ingress Prime
<img src="https://github.com/egorantonov/sbg-enhanced/assets/16327320/2817468d-3aa6-41ff-86f7-969a00037ba3" width="240px" /><img src="https://github.com/egorantonov/sbg-enhanced/assets/16327320/c736d736-5fc9-4a07-aa93-87d1577977c7" width="240px" />
* Чёрно-белая тема:
<img src="https://github.com/egorantonov/sbg-enhanced/assets/16327320/53f8c772-d34a-40f0-956b-a1f42f3730ae" width="240px" /><img src="https://github.com/egorantonov/sbg-enhanced/assets/16327320/4485d5f3-c61c-4d1f-b149-d4bf50fddc31" width="240px" />
* Высокий контраст
<img src="https://user-images.githubusercontent.com/16327320/232873928-464b2c08-baef-46c5-a5c4-594da1090179.png" width="240px" alt="Dark"/><img src="https://user-images.githubusercontent.com/16327320/232873937-190cae9c-7235-4c87-b0d7-bcb31cd575ab.png" width="240px" alt="Light"/>
* Интерактивные анимации
https://www.youtube.com/embed/zrz7pwRhkXY
* Настройки: высокий контраст, прозрачность линий, анимации, тема Ingress
<img src="https://user-images.githubusercontent.com/16327320/233618862-a48d3076-7e4e-4cc6-af55-796a38210c29.png" width="240px" /><img src="https://github.com/egorantonov/sbg-enhanced/assets/16327320/ad4ce453-5a9d-4525-abdc-0cd7ffeb6ba8" width="240px" /><img src="https://github.com/egorantonov/sbg-enhanced/assets/16327320/88468d8c-1bef-4b35-b405-6494b7482ca8" width="240px" /><img src="https://github.com/egorantonov/sbg-enhanced/assets/16327320/8914f665-b549-4301-94d2-bd1cf6f0efaf" width="240px" /><img src="https://github.com/egorantonov/sbg-enhanced/assets/16327320/9f137332-2e16-44c4-a1f4-506e42fc32d8" width="240px" /><img src="https://github.com/egorantonov/sbg-enhanced/assets/16327320/f624282b-4497-4a29-aac2-9394e44a2a20" width="240px" />
<h2 align="center">Как установить</h2>
### Android
1. Установите один из браузеров:
[Яндекс Браузер](https://play.google.com/store/apps/details?id=com.yandex.browser) |
[Firefox](https://play.google.com/store/apps/details?id=org.mozilla.firefox) |
[Kiwi](https://play.google.com/store/apps/details?id=com.kiwibrowser.browser)
1. Установите расширение Tampermonkey:
* Для Firefox: `Настройки` > `Дополнения` > `Tampermonkey`
* Для Яндекс Браузер и Kiwi: установить расширение по [ссылке](https://chrome.google.com/webstore/detail/tampermonkey/dhdgffkkebhmkfjojejmpbldmpobfkfo )
1. В списке каталога дополнений выдать Tampermonkey разрешение открывать файлы по ссылкам
1. В браузере нажать на иконку плагина Tampermonkey и перейти в `Dashboard` (`Панель управления`)
1. На открывшейся странице плагина перейти справа во вкладку `Utilities` (`Утилиты`)
1. Внизу в поле `Import from URL` (`Импорт из URL`) вставить ссылку на скрипт <br/>
[`https://github.com/egorantonov/sbg-enhanced/releases/latest/download/eui.user.js`](https://github.com/egorantonov/sbg-enhanced/releases/latest/download/eui.user.js) <br/>
и нажать `Install` (`Установить`)
1. После открытия окна с кодом скрипта повторно нажать `Install` (`Установить`).
1. Обновить страницу с игрой. Скрипт должен запуститься и внести изменения.
Обновление скрипта осуществляется нажатием на `Last updated` (`Обновлён`) в строке скрипта на вкладке `Installed Userscripts` (`Установленные скрипты`) либо выбором скрипта (чекбокс слева) и запуска команды `Trigger Update` (`Обновить выбранное`).
***
### Android приложение (APK)
Скачайте и установите приложение Android :
[Ссылка на скачивание в официальном канале игры в Telegram](https://t.me/sbg_forum/91670/95835)
Известные проблемы:
- Импорт/экспорт настроек игры и скриптов не работает из-за отсутствующих разрешений у приложения
***
### iOS
1. Установить приложение [Userscripts](https://apps.apple.com/app/id1463298887)
1. Установить приложение [Команды](https://apps.apple.com/app/id1462947752)
1. В приложении **Файлы** создать папку `Userscripts` внутри `на iPhone`/`на iPad` (если ещё нет)
1. В приложении **Userscripts** нужно выбрать эту папку (нажать на кнопку `Set Userscripts Directory`)
1. Установить [команду скачивания скрипта](https://www.icloud.com/shortcuts/7a7ea83873f04d8d84fc820dd7baf816)
1. Запустить скачанную команду `Update SBG EUI`, скачается скрипт и выведется сообщение (_Загружена версия Х.Х.Х_), файл _eui.user.js_ должен появиться в папке Userscripts<br/>
_Также файл можно скачать вручную по [ссылке](https://github.com/egorantonov/sbg-enhanced/releases/latest/download/eui.user.js)_
1. Открыть Safari, нажать кнопку `aA` в левой части адресной строки (или кнопку расширений в правой части).
Нажать `Управлять расширениями`, включить расширение Userscripts.
1. Повторно нажать `aA` в адресной строке, в этом меню появится пункт `Userscripts`.
Нажать на него и выдать постоянное разрешение на доступ к сайту.
1. Обновить страницу с игрой. Скрипт должен запуститься и внести изменения.
Обновление скрипта осуществляется нажатием на кнопку обновления (иконка облака со стрелкой внутри) в расширении `Userscripts` либо с помощью ранее скачанной команды `Update SBG EUI`.
***
### Desktop (Windows/Linux)
1. Установите расширение Tampermonkey:
* Для [Firefox](https://addons.mozilla.org/firefox/addon/tampermonkey/)
* Для [Chromium браузеров](https://chrome.google.com/webstore/detail/tampermonkey/dhdgffkkebhmkfjojejmpbldmpobfkfo)
1. В списке каталога дополнений выдать Tampermonkey разрешение открывать файлы по ссылкам
1. В браузере нажать на иконку плагина Tampermonkey и перейти в `Dashboard` (`Панель управления`)
1. На открывшейся странице плагина перейти справа во вкладку `Utilities` (`Утилиты`)
1. Внизу в поле `Import from URL` (`Импорт из URL`) вставить ссылку на скрипт <br/>
[`https://github.com/egorantonov/sbg-enhanced/releases/latest/download/eui.user.js`](https://github.com/egorantonov/sbg-enhanced/releases/latest/download/eui.user.js) <br/>
и нажать `Install` (`Установить`)
1. После открытия окна с кодом скрипта повторно нажать `Install` (`Установить`).
1. Обновить страницу с игрой. Скрипт должен запуститься и внести изменения.
***
> GitHub [@egorantonov](https://github.com/egorantonov) ·
> Discord [@EYEMVX](https://discord.com/channels/@me) | A custom userscript created to improve the UX/UI of the The Simplest Browser Geoloc game | android,game,geolocation,ingress,ios,javascript,mobile,social,tampermonkey,userscript | 2023-03-24T17:44:23Z | 2024-05-14T21:17:37Z | 2024-05-14T21:17:37Z | 1 | 55 | 228 | 0 | 0 | 8 | null | null | JavaScript |
tannguyen208/chatgpt | main | <h1 align="center">ChatGPT AI</h1>
<h2 align="center">Premium quality UI for ChatGPT</h2>
<p align="center"><a href="https://tannguyen208.github.io/chatgpt/">Web App</a></p>
Recently, there has been a surge of UIs for ChatGPT, making it the new "to-do app" that everyone wants to try their hand at. ChatGPT AI sets itself apart with a broader vision - to become the ultimate interface for ChatGPT users.
### ⚡️ Free and open source
This app is provided for free and the source code is available on GitHub.
### 🔒 Privacy focused
No tracking, no cookies, no bullshit. All your data is stored locally.
### ✨ Best experience
Crafted with love and care to provide the best experience possible.
---
## Contribute
This is a React.js application. Clone the project, run `npm i` and `npm start` and you're good to go.
## Credits
- [ToDesktop](https://todesktop.com) - A simple way to make your web app into a beautiful desktop app
- [DexieJS](https://dexie.org) - A Minimalistic Wrapper for IndexedDB
- [Mantine](https://mantine.dev) - A fully featured React component library
| Not just another ChatGPT user-interface! | javascript,react,chatgpt,ai,docker | 2023-03-24T13:06:13Z | 2023-04-06T10:12:58Z | null | 2 | 0 | 17 | 0 | 2 | 8 | null | AGPL-3.0 | TypeScript |
itsyuimorii/--PROJECT--TripSpark-Node.js-Express-MongoDB-and-More | main | <div align=center>
<img src="https://github.com/itsyuimorii/TripSpark-Node.js-Express-MongoDB-and-More/blob/main/public/img/08%20(2).png">
<h1> ⛺️ TripSpark-Node.js-Express-MongoDB-and-More </h1>
</div>
<div align=center>
<a href="https://www.udemy.com/course/nodejs-express-mongodb-bootcamp/">Course Link</a> |
<a href=" ">Final Project</a> |
<a href=" ">Certification</a> |
</div>
Master Node by building a real-world RESTful API and web app (with authentication, Node.js security, payments & more)
<div align="center">
| Section | Topic | Problem Sets |
| --------- | --------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Section 0 | RestfulAPI | [code](https://github.com/itsyuimorii/Node.js--Express--MongoDB---More--The-Complete-Bootcamp-2023/tree/01_restfulapi) |
| Section 1 | Mongodb & mongoose | [code](https://github.com/itsyuimorii/Node.js--Express--MongoDB---More--The-Complete-Bootcamp-2023/tree/02_mongodb) |
| Section 2 | Error handling | [code](https://github.com/itsyuimorii/Node.js--Express--MongoDB---More--The-Complete-Bootcamp-2023/tree/03_error_handling) |
| Section 3 | Authentication_and_security | [code](https://github.com/itsyuimorii/Node.js--Express--MongoDB---More--The-Complete-Bootcamp-2023/tree/04_authentication_and_security) |
| Section 4 | Modelling_data_and_advanced_mongoose | [code](https://github.com/itsyuimorii/Node.js--Express--MongoDB---More--The-Complete-Bootcamp-2023/tree/05_modelling_data_and_advanced_mongoose) |
| Section 5 | Server_Side_Rendering-with_Pug_Templates | [code](https://github.com/itsyuimorii/Node.js--Express--MongoDB---More--The-Complete-Bootcamp-2023/tree/06_Server_Side_Rendering-with_Pug_Templates) |
| Section 6 | Advanced_Features_Payments_Email_File_Uploads | [code](https://github.com/itsyuimorii/Node.js--Express--MongoDB---More--The-Complete-Bootcamp-2023/tree/07_Advanced_Features_-Payments_Email_File-Uploads) |
| Section 7 | Setting_Up_Git_and_Deployment | [code](https://github.com/itsyuimorii/Node.js--Express--MongoDB---More--The-Complete-Bootcamp-2023/tree/08_Setting_Up_Git_and_Deployment) |
<div align="left">
## ☻ Starting a Node.js Project
1. Install Project Dependencies:
- Run `npm install` in the project's root directory to download and install all the required dependencies.
- You can use the `--dev` flag with `npm install` to install development dependencies.
2. Configure Environment Variables and Configuration Files:
- If your project requires environment variables or configuration files, follow the project documentation to configure them.
- Create a `.env` file and fill in the necessary variables or modify relevant sections in the project's configuration files.
3. Start the Project:
- In the project's root directory, run `npm start` to start the project.
- This will execute the command specified in the `"start"` script in the `package.json` file.
4. `package.json`:
- The `package.json` file contains metadata about your project and its dependencies.
- It includes scripts that can be executed using `npm run <script-name>`.
- The `"start"` script is used to start the project using `nodemon` to automatically restart the server on file changes.
- The `"start:prod"` script starts the project in production mode.
- The `"debug"` script can be used for debugging with `ndb`.
5. `config.env`:
- The `config.env` file contains environment variables used in the project.
- It defines variables like `NODE_ENV`, `PORT`, and `DATABASE`.
- The `DATABASE_PASSWORD` variable is specific to your MongoDB connection.
6. `server.js`:
- The `server.js` file is the entry point of your application.
- It imports necessary modules like `mongoose` and `dotenv`.
- It sets up a connection to the MongoDB database using the `mongoose.connect()` method.
- The `dotenv.config()` method loads environment variables from the `config.env` file.
- The `app` module is imported from the `app.js` file.
- The server listens on the specified `port` and logs a success message.
- Error handling is implemented for unhandled exceptions and rejections.
```bash
echo ".cache/" >> .gitignore
rm -rf node_modules
rm -rf .cache
npm install deasync@latest --save-dev
```
These steps and code snippets provide a basic structure for starting a Node.js project with dependencies, environment variables, and server setup.
> **config.env**
```bash
NODE_ENV=development
PORT=3000
DATABASE=mongodb+srv://itsyuimorii:<PASSWORD>@cluster0.r7nrqwu.mongodb.net/Yumekobo?retryWrites=true&w=majority
DATABASE_PASSWORD=lX0f8LolPcIEQvOk
```
> **server.js**
```js
const mongoose = require('mongoose');
const dotenv = require('dotenv');
process.on('uncaughtException', err => {
console.log('UNCAUGHT EXCEPTION! 💥 Shutting down...');
console.log(err.name, err.message);
process.exit(1);
});
dotenv.config({ path: './config.env' });
const app = require('./app');
const DB = process.env.DATABASE.replace(
'<PASSWORD>',
process.env.DATABASE_PASSWORD
);
mongoose
.connect(DB, {
useNewUrlParser: true,
useCreateIndex: true,
useFindAndModify: false,
useUnifiedTopology: true
})
.then(() => console.log('DB connection successful!'));
const port = process.env.PORT || 3000;
const server = app.listen(port, () => {
console.log(`App running on port ${port}...`);
});
process.on('unhandledRejection', err => {
console.log('UNHANDLED REJECTION! 💥 Shutting down...');
console.log(err.name, err.message);
server.close(() => {
process.exit(1);
});
});
```
## 📗 Takeaway
### Configuring `scripts` in package.json
In your `package.json` file, you can configure the `scripts` section to define custom commands for running your server. Here's an example of how you can configure the `start` and `start:prod` scripts:
```json
"scripts": {
"start": "nodemon server.js",
"start:prod": "NODE_ENV=production nodemon server.js"
}
```
**"start:prod": "NODE_ENV=production nodemon server.js"**
This is a customised command to start the application in production environment mode. The command NODE_ENV=production sets the environment variable NODE_ENV to "production" so that specific settings or configurations can be made in the application based on this variable. Next, use the nodemon package to monitor and automatically restart the server.js file. Such a command is typically used to run an application in a production environment.
**"start": "nodemon server.js"**
This is another custom command to start the application in default mode. It simply uses the nodemon package to monitor and automatically restart the server.js file. Commands like this are typically used to run an application in a development environment.
Using the npm start command will run the command specified by the start attribute, i.e. "nodemon server.js", and use the nodemon package to run the server.js file in the development environment.
Use the npm start start:prod command to run the command specified by the start:prod attribute, "NODE_ENV=production nodemon server.js", and use the nodemon package to run the server.js file in the production environment with the environment variable NODE_ENV set to "production". and set the environment variable NODE_ENV to "production".
With the above configuration, you can run the server using the following commands:
> Start server in development mode
```bash
npm start
```
This command will use `nodemon` to run the `server.js` file, allowing automatic server restarts whenever changes are made to the code during development.
> Start server in production mode
```bash
npm run start:prod
```
> mongoose
```bash
npm i mongoose --legacy-peer-deps
```
```
npm run watch:js
```
This command will set the `NODE_ENV` environment variable to `"production"` and then use `nodemon` to run the `server.js` file. Running the server in production mode may involve additional optimizations and configurations specific to your application.
Note that when using `npm run` to execute a script, you need to prefix the script name with `run`.
Now, you can start your server by using either `npm start` or `npm run start:prod`, depending on the desired mode.
### Configuring ESLint and Prettier
With the above configuration, you can run the server using the following commands:
In the root directory of your project, run the following command to install the necessary dependencies:
```bash
npm install eslint prettier eslint-config-prettier eslint-plugin-prettier eslint-config-airbnb eslint-plugin-node eslint-plugin-jsx-a11y eslint-plugin-import eslint-plugin-react --save-dev
```
### Configuring MongoDB Atlas
1. Visit the MongoDB Atlas website: https://www.mongodb.com/cloud/atlas.
2. Create an account or log in to your existing account.
3. In the Atlas dashboard, click on "Create New Cluster".
4. Choose your preferred cloud provider (e.g., AWS, Azure, or Google Cloud Platform).
5. Select the region (geographic location) where you want your data to be stored.
6. Configure cluster options, including cluster name, cluster size, and storage capacity.
7. Advanced options such as authentication, virtual private cloud (VPC), network connectivity, etc., can be configured even if you're using the free M0 cluster.
8. Click on "Create Cluster".
9. On the cluster overview page, click on "Connect".
10. Choose "Connect your application".
11. Copy the connection string from the "Connection String Only" tab.
### [MVC architecture](https://www.freecodecamp.org/news/the-model-view-controller-pattern-mvc-architecture-and-frameworks-explained/)
**APPLICATION LOGIC** (controller)
- 👉 Code that is only concerned about the application’s implementation, not the underlying business problem we’re trying to solve (e.g. showing and selling tours);
- 👉 Concerned about managing requests and responses;
- 👉 About the app’ s more technical aspects;
- 👉 Bridge between model and view layers.
**BUSINESS LOGIC**(model)
- 👉 Code that actually solve sthe business problem we set
out to solve;
- 👉 Directly related to business rules, how the business works,and business needs;
- 👉 Examples:
- 👉 Creating new tours in the database;
- 👉 Checking if user’s password is correct;
- 👉 Validating user input data;
- 👉 Ensuring only users who bought a tour can review it.
**Fat models/thin controllers:** offload as much logic as possible into the models, and keep the controllers as simple and lean as possible.
### Mongoose(https://mongoosejs.com/docs/guide.html)
- [Model methods](https://mongoosejs.com/docs/models.html)
- [Queries methods](https://mongoosejs.com/docs/queries.html)
### Mongoose query middleware(https://mongoosejs.com/docs/middleware.html#types-of-middleware)
- [Document middleware](https://mongoosejs.com/docs/middleware.html#types-of-middleware)
- [Query middleware](https://mongoosejs.com/docs/middleware.html#types-of-middleware)
- [Aggregate middleware](https://mongoosejs.com/docs/middleware.html#types-of-middleware)
### `toJSON` and `toObject`
This code sets the `toJSON` and `toObject` options on the `tourSchema` object, enabling it to include virtual properties when converting to a JSON string or a regular JavaScript object.
Here are the comments for this code:
```javascript
const tourSchema = new mongoose.Schema(
{
// Schema definitions...
},
{
toJSON: { virtuals: true }, // Include virtual properties when converting to JSON string
toObject: { virtuals: true } // Include virtual properties when converting to regular JavaScript object
}
);
```
This code is typically used within the Mongoose schema definition. By setting the `virtuals` property of the `toJSON` and `toObject` options to `true`, it instructs Mongoose to include the defined virtual properties when converting the document to a JSON string or a regular JavaScript object.
Virtual properties are properties that are not stored in the database but are computed or derived based on existing properties. They can be used to provide additional data or calculated property values without the need to explicitly store them in the database.
With the `toJSON` and `toObject` options set, when you convert the document to a JSON string using `JSON.stringify()` or to a regular JavaScript object using the `toObject()` method, the virtual properties will be included in the result.
### import import-dev-data.js into mongodb
```bash
node dev-data/data/import-dev-data.js --import
node dev-data/data/import-dev-data.js --delete
```
> import-dev-data.js
```js
const fs = require('fs');
const mongoose = require('mongoose');
const dotenv = require('dotenv');
const Tour = require('./../../models/tourModels');
dotenv.config({ path: './config.env' });
const DB = process.env.DATABASE.replace(
'<PASSWORD>',
process.env.DATABASE_PASSWORD
);
const connectDB = async () => {
try {
await mongoose.connect(DB, {
useNewUrlParser: true,
useCreateIndex: true,
useFindAndModify: false,
useUnifiedTopology: true
});
console.log('DB connection successful!');
} catch (err) {
console.error('DB connection failed:', err);
process.exit(1);
}
};
// READ JSON FILE
const tours = JSON.parse(
fs.readFileSync(`${__dirname}/tours-simple.json`, 'utf-8')
);
// IMPORT DATA INTO DB
const importDevData = async () => {
try {
await connectDB();
await Tour.create(tours);
console.log('Data successfully loaded!');
} catch (err) {
console.error('Error loading data:', err);
}
process.exit();
};
// DELETE ALL DATA FROM DB
const deleteDevData = async () => {
try {
await connectDB();
await Tour.deleteMany();
console.log('Data successfully deleted!');
} catch (err) {
console.error('Error deleting data:', err);
}
process.exit();
};
if (process.argv[2] === '--import') {
importDevData();
} else if (process.argv[2] === '--delete') {
deleteDevData();
}
```
### APIFeatures
```js
class APIFeatures {
constructor(query, queryString) {
this.query = query; // Initialize the query property with the query parameter
this.queryString = queryString; // Initialize the queryString property with the queryString parameter
}
filter() {
const queryObj = { ...this.queryString }; // Create a copy of the queryString object
const excludedFields = ['page', 'sort', 'limit', 'fields']; // Specify the fields to be excluded from the query
// Remove the excluded fields from the queryObj
excludedFields.forEach(el => delete queryObj[el]);
// Advanced filtering
let queryStr = JSON.stringify(queryObj); // Convert the queryObj to a string
queryStr = queryStr.replace(/\b(gte|gt|lte|lt)\b/g, match => `$${match}`); // Replace certain operators with MongoDB operators
this.query = this.query.find(JSON.parse(queryStr)); // Update the query with the filtered results
return this;
}
sort() {
if (this.queryString.sort) {
const sortBy = this.queryString.sort.split(',').join(' '); // Extract the sort criteria from the queryString and format it
this.query = this.query.sort(sortBy); // Sort the query based on the sortBy criteria
} else {
this.query = this.query.sort('-createdAt'); // If no sort criteria provided, sort by 'createdAt' field in descending order
}
return this;
}
limitFields() {
if (this.queryString.fields) {
const fields = this.queryString.fields.split(',').join(' '); // Extract the fields to be included from the queryString and format it
this.query = this.query.select(fields); // Select only the specified fields in the query
} else {
this.query = this.query.select('-__v'); // Exclude the '__v' field from the query result
}
return this;
}
paginate() {
const page = this.queryString.page * 1 || 1; // Extract the page number from the queryString, convert to number, default to 1 if not provided
const limit = this.queryString.limit * 1 || 100; // Extract the limit from the queryString, convert to number, default to 100 if not provided
const skip = (page - 1) * limit; // Calculate the number of documents to skip based on the page and limit
this.query = this.query.skip(skip).limit(limit); // Skip the specified number of documents and limit the result to the specified number
return this;
}
}
module.exports = APIFeatures; // Export the APIFeatures class for external use
```
### Aggregation Pipeline: Matching and Grouping Documents
> [Aggregation document](https://docs.mongodb.com/manual/aggregation/)
### Vitual Properties
> https://mongoosejs.com/docs/tutorials/virtuals.html
### [Mongoose middleware](https://mongoosejs.com/docs/middleware.html)
- QUERY MIDDLEWARE
- MODEL MIDDLEWARE
- DOCUMENT MIDDLEWARE
- AGGREGATION MIDDLEWARE
### DATA validation
### Error handling with Express
```bash
npm i ndb --save-dev
```
```json
"scripts": {
"start": "nodemon server.js",
"start:prod": "NODE_ENV=production nodemon server.js",
"debug": "ndb npm start"
}
```
### Error handling
- operational errors
Problems that we can predict will happen at some point, so we just need to handle them in advance.
👉 Invalid path accessed;
👉 Invalid user input (validator error
from mongoose);
👉 Failed to connect to server;
👉 Failed to connect to database;
👉 Request timeout;
- programming errors
Bugs that we developers introduce into our code. Difficult to find and handle.
👉 Reading properties on undefined;
👉 Passing a number where an object
is expected;
👉 Using await without async;
👉 Using req.query instead of req.body;
### JWT authentication
reference: [jsonwebtoken](https://www.npmjs.com/package/jsonwebtoken) ｜ jwt.io(https://jwt.io/)
> install
```
$ npm install jsonwebtoken
```
> usage
```
jwt.sign(payload, secretOrPrivateKey, [options, callback])
```
👇The input parameter id of the function is a unique identifier for the user (e.g. user ID) and is used as the content in the payload of the JWT.
```js
//--------------**GENERATE TOKEN**----------------
const signToken = id => {
//payload, secret, options
return jwt.sign({ id }, process.env.JWT_SECRET, {
expiresIn: process.env.JWT_EXPIRES_IN
});
};
```
Inside the function, the jwt.sign method is called to generate the JWT, and it accepts three parameters:
**payload:** this is an object { id } containing the user's ID, which serves as the JWT's payload.
**secret:** this is the key used to sign the JWT, process.env.JWT_SECRET. The key should be a secure random string to ensure that only the server with the correct key can authenticate and decode the JWT.
**options:** this is an object containing options to set the attributes of the JWT, such as the expiration time (expiresIn). process.env.JWT_EXPIRES_IN should be a string indicating the expiration time, which can be a time interval (e.g., '2d' for 2 days) or a specific date/time.
Finally, the signToken function returns the generated JWT and assigns it to the variable token in the following code, which may be used after a successful user authentication or registration to generate and provide the JWT to the user for further authorisation or authentication.
👇This code defines a function called createSendToken that creates and sends a JWT (JSON Web Token) to the user.
```js
//--------------**CREATE TOKEN & SEND TOKEN**----------------
const createSendToken = (user, statusCode, res) => {
//create token
const token = signToken(user._id);
res.status(statusCode).json({
status: 'success',
token,
data: {
user
}
});
};
```
The input parameters of the function are as follows:
**user:** user object containing information about the user.
**statusCode:** HTTP status code, used to set the status code of the response.
**res:** the response object, used to send the response to the client.
Inside the function, it first calls the signToken function and passes in the user's \_id to generate the JWT, then uses the res.status() method to set the status code of the response, which is usually the value of the statusCode parameter.
Next, it uses the res.json() method to send a JSON-formatted response to the client. The response contains the following:
**status:** a string indicating the status of the operation, here it is set to 'success'.
**token:** the generated JWT, the value returned by the signToken function.
**data:** an object containing the user's data. Here, the user parameter is passed into the data attribute.
The purpose of this function is to generate a JWT after user authentication or registration, and respond to the client with the user data. The client can save the JWT and use it in future requests to authenticate and obtain authorisation.
> Testing: generate token
```
post: 127.0.0.1:3000/api/v1/users/signup
```
```json
body JSON
{
"name": "test3",
"email":"test3@yuimorii.com",
"password":"11111111",
"passwordConfirm":"11111111"
}
```
```json
{
"status": "success",
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjY0YjBiNTljZjkyZTg0ZWY4MmFmN2YxYSIsImlhdCI6MTY4OTMwMjQyOCwiZXhwIjoxNjk3MDc4NDI4fQ.nFDpacNCRnhyRtBhjA4oqJprDd6yQQrLwwI7eVdgiE4",
"data": {
"user": {
"role": "user",
"active": true,
"_id": "64b0b59cf92e84ef82af7f1a",
"name": "test3",
"email": "test3@yuimorii.com",
"password": "$2a$12$PpQtl4bBQBEYkKj03aUGJu3VpO8mxh1L9Y1c0q7vbV7Lkfa6/R10C",
"__v": 0
}
}
}
```
### Environments setup @postman
**Dev:yumekobo** -> http://127.0.0.1:3000/
**Prod:yumekobo** -> ??
> eg. {{URL}}api/v1/tours
According to the provided code, it is a method to **set an environment variable** in the Postman testing tool using a **pre-request script.**
```javascript
pm.environment.set('jwt', pm.response.json().token);
```
The purpose of this code is to extract a value named "token" from the response of a request and set it as the value of an environment variable in Postman named "jwt".
Let's break down each part:
- `pm.environment.set`: This is one of the built-in functions in the Postman script, used to set the value of an environment variable.
- `"jwt"`: This is the name of the environment variable that is being set, the variable name that will be assigned the value.
- `pm.response.json()`: This is a combination of Postman built-in objects and methods used to access the response of a request and parse it as JSON format.
- `.token`: Assuming the response is a JSON object, this code retrieves the value of the property named "token" from the JSON object using the `.token` syntax.
Therefore, the purpose of this code is to extract the value of "token" from the request response and set it as the value of the "jwt" environment variable in Postman. This allows you to reference this environment variable in subsequent requests or scripts.
### Nodemailer
> [Nodemailer](https://nodemailer.com/about/)
```bash
npm i nodemailer
```
> [SendGrid](https://sendgrid.com/)
> [mailtrap](https://mailtrap.io/home)
1. create inbox
2. copy SMTP settings
3. paste in .env file
```bash
EMAIL_USERNAME= fde41408f46031
EMAIL_PASSWORD=4bf6283683be45
EMAIL_HOST=sandbox.smtp.mailtrap.io
EMAIL_PORT=25
```
> /utils/email.js
```js
/**
* @description: This file is used to send emails to the user
*/
const nodemailer = require('nodemailer');
//----------------**SEND EMAIL**----------------
const sendEmail = async options => {
// 1) Create a transporter
const transporter = nodemailer.createTransport({
host: process.env.EMAIL_HOST,
port: process.env.EMAIL_PORT,
auth: {
user: process.env.EMAIL_USERNAME,
pass: process.env.EMAIL_PASSWORD
}
});
// 2) Define the email options
const mailOptions = {
from: 'yui morii <user@yuimorii.com>',
to: options.email,
subject: options.subject,
text: options.message
};
// 3) Actually send the email
await transporter.sendMail(mailOptions);
};
module.exports = sendEmail;
```
### Forget password
> controllers/authController.js
```js
//--------------**FORGOT PASSWORD**----------------
/**
* Creates a password reset token and sends it to the user's email.
* @param {Object} req - The request object.
* @param {Object} res - The response object.
* @param {function} next - The next middleware function.
* @returns {Object} - The response object.
* @throws {AppError} - If there is no user with the email address.
* @throws {AppError} - If there is an error sending the email.
*/
exports.forgotPassword = catchAsync(async (req, res, next) => {
// 1) Get user based on POSTed email
const user = await User.findOne({ email: req.body.email });
if (!user) {
return next(new AppError('There is no user with email address.', 404));
}
// 2) Generate the random reset token
const resetToken = user.createPasswordResetToken();
await user.save({ validateBeforeSave: false });
// 3) Send it to user's email
const resetURL = `${req.protocol}://${req.get(
'host'
)}/api/v1/users/resetPassword/${resetToken}`;
const message = `Forgot your password? Submit a PATCH request with your new password and passwordConfirm to: ${resetURL}.\nIf you didn't forget your password, please ignore this email!`;
try {
await sendEmail({
email: user.email,
subject: 'Your password reset token (valid for 10 min)',
message
});
res.status(200).json({
status: 'success',
message: 'Token sent to email!'
});
} catch (err) {
user.passwordResetToken = undefined;
user.passwordResetExpires = undefined;
await user.save({ validateBeforeSave: false });
return next(
new AppError('There was an error sending the email. Try again later!'),
500
);
}
});
```
> routes/userRoutes.js
```
router.post('/forgotPassword', authController.forgotPassword);
router.patch('/resetPassword/:token', authController.resetPassword);
```
> models/userModel.js
```js
// models/userModel.js
const crypto = require('crypto');
const mongoose = require('mongoose');
const validator = require('validator');
const bcrypt = require('bcryptjs');
const userSchema = new mongoose.Schema({
name: {
type: String,
required: [true, 'Please tell us your name!']
},
email: {
type: String,
required: [true, 'Please provide your email'],
unique: true,
lowercase: true,
validate: [validator.isEmail, 'Please provide a valid email']
},
photo: String,
role: {
type: String,
enum: ['user', 'guide', 'lead-guide', 'admin'],
default: 'user'
},
password: {
type: String,
required: [true, 'Please provide a password'],
minlength: 8,
select: false
},
passwordConfirm: {
type: String,
required: [true, 'Please confirm your password'],
validate: {
// This only works on CREATE and SAVE!!!
validator: function(el) {
return el === this.password;
},
message: 'Passwords are not the same!'
}
},
passwordChangedAt: Date,
passwordResetToken: String,
passwordResetExpires: Date,
active: {
type: Boolean,
default: true,
select: false
}
});
//----------------**MIDDLEWARE: ENCRYPT PASSWORD**----------------
userSchema.pre('save', async function(next) {
// Only run this function if password was actually modified
if (!this.isModified('password')) return next();
// Hash the password with cost of 12
this.password = await bcrypt.hash(this.password, 12);
// Delete passwordConfirm field
this.passwordConfirm = undefined;
next();
});
//----------------**INSTANCE METHOD: COMPARE PASSWORD**----------------
/**
*
* @param {string} candidatePassword
* @param {string} userPassword
* @returns {boolean}
*/
userSchema.methods.correctPassword = async function(
candidatePassword,
userPassword
) {
return await bcrypt.compare(candidatePassword, userPassword);
};
//----------------**INSTANCE METHOD: CHECK IF PASSWORD CHANGED AFTER JWT ISSUED**----------------
/**
*
* @param {number} JWTTimestamp
* @returns {boolean}
*/
userSchema.methods.changedPasswordAfter = function(JWTTimestamp) {
if (this.passwordChangedAt) {
//Convert password change times to timestamps
const changedTimestamp = parseInt(
this.passwordChangedAt.getTime() / 1000,
10
);
// If the JWT timestamp is earlier than the password change timestamp, the password has been changed after the JWT was issued
return JWTTimestamp < changedTimestamp;
}
// False means NOT changed
return false;
};
//----------------**INSTANCE METHOD: CREATE PASSWORD RESET TOKEN**----------------
/**
* @returns {string} resetToken
*/
userSchema.methods.createPasswordResetToken = function() {
// Create a random token
const resetToken = crypto.randomBytes(32).toString('hex');
// Encrypt the token and store it in the database
this.passwordResetToken = crypto
.createHash('sha256')
.update(resetToken)
.digest('hex');
// Set the token expiration date
console.log({ resetToken }, this.passwordResetToken);
// 10 minutes
this.passwordResetExpires = Date.now() + 10 * 60 * 1000;
return resetToken;
};
const User = mongoose.model('User', userSchema);
module.exports = User;
```
Here is the flow of the `exports.forgotPassword` function across the `authController.js`, `userModel.js`, and `userRoutes.js` files:
1. In the `authController.js` file, the `exports.forgotPassword` function is defined to handle the logic for the forgot password feature.
2. In the `authController.js` file, the `User` model is imported using the `require` statement, which is located in the `userModel.js` file.
3. In the `exports.forgotPassword` function, the `User.findOne` method is called to search for the user in the database using the provided email address.
4. In the `userModel.js` file, the `userSchema.methods.createPasswordResetToken` method is called to generate a password reset token and store it in the `passwordResetToken` field of the user model.
5. In the `userModel.js` file, the `createPasswordResetToken` method is exported as `createPasswordResetToken`.
6. In the `authController.js` file, the `user.createPasswordResetToken()` method is called to generate the password reset token.
7. In the `authController.js` file, the `sendEmail` function is called, passing an options object containing the user's email, subject, and message, to send an email to the user.
8. In the `userRoutes.js` file, the `exports.forgotPassword` function is bound to the `/forgotPassword` route using `router.post('/forgotPassword', authController.forgotPassword)`.
9. When a user accesses the `/forgotPassword` route, the `exports.forgotPassword` function is triggered, and the logic within it is executed.
Summary: The `exports.forgotPassword` function is defined in the `authController.js` file, which retrieves user information by importing the `User` model from the `userModel.js` file. The function calls `user.createPasswordResetToken()` to generate a password reset token and uses the `sendEmail` function to send the reset password email. In the `userRoutes.js` file, the `exports.forgotPassword` function is bound to the corresponding route. When a user visits that route, the logic within the `exports.forgotPassword` function is executed.
### Reset password
```js
//--------------**RESET PASSWORD**----------------
exports.resetPassword = catchAsync(async (req, res, next) => {
// 1) Get user based on the token
const hashedToken = crypto
.createHash('sha256')
.update(req.params.token)
.digest('hex');
const user = await User.findOne({
passwordResetToken: hashedToken,
passwordResetExpires: { $gt: Date.now() }
});
// 2) If token has not expired, and there is user, set the new password
if (!user) {
return next(new AppError('Token is invalid or has expired', 400));
}
user.password = req.body.password;
user.passwordConfirm = req.body.passwordConfirm;
user.passwordResetToken = undefined;
user.passwordResetExpires = undefined;
await user.save();
// 3) Update changedPasswordAt property for the user
// 4) Log the user in, send JWT
createSendToken(user, 200, res);
});
```
### Update password
> models/userModel.js
```js
//----------------**MIDDLEWARE: SET PASSWORD CHANGED AT**----------------
userSchema.pre('save', function(next) {
if (!this.isModified('password') || this.isNew) return next();
this.passwordChangedAt = Date.now() - 1000;
next();
});
//----------------**MIDDLEWARE: FILTER OUT INACTIVE USERS**----------------
userSchema.pre(/^find/, function(next) {
// this points to the current query
this.find({ active: { $ne: false } });
next();
});
```
> controllers/authController.js
```js
//--------------**UPDATE PASSWORD**----------------
/**
* Updates the user's password.
* @throws {AppError} - If the user is not found.
* @throws {AppError} - If the POSTed password is incorrect.
* @throws {AppError} - If the POSTed password and passwordConfirm do not match.
*/
exports.updatePassword = catchAsync(async (req, res, next) => {
// 1) Get user from collection
const user = await User.findById(req.user.id).select('+password');
// 2) Check if POSTed current password is correct
if (!(await user.correctPassword(req.body.passwordCurrent, user.password))) {
return next(new AppError('Your current password is wrong.', 401));
}
// 3) If so, update password
user.password = req.body.password;
user.passwordConfirm = req.body.passwordConfirm;
await user.save();
// User.findByIdAndUpdate will NOT work as intended!
// 4) Log user in, send JWT
createSendToken(user, 200, res);
});
```
> routes/userRoutes.js
```js
router.patch(
'/updateMyPassword',
authController.protect,
authController.updatePassword
);
```
### Cookie and JWT
```js
//--------------**GENERATE TOKEN**----------------
const signToken = id => {
//payload, secret, options
return jwt.sign({ id }, process.env.JWT_SECRET, {
expiresIn: process.env.JWT_EXPIRES_IN
});
};
//--------------**CREATE TOKEN & SEND TOKEN*ne*----------------
/**
* Creates and sends a JWT token as a cookie in the response.
* @param {Object} user - The user object.
* @param {number} statusCode - The HTTP status code.
* @param {Object} res - The response object.
*/
const createSendToken = (user, statusCode, res) => {
// Generate a JWT token for the user
const token = signToken(user._id);
// console.log(token);
// Set cookie options for the JWT token
const cookieOptions = {
expires: new Date(
Date.now() + process.env.JWT_COOKIE_EXPIRES_IN * 24 * 60 * 60 * 1000
),
httpOnly: true
};
// Set secure cookie option in production
if (process.env.NODE_ENV === 'production') {
cookieOptions.secure = true;
}
// Set the JWT token as a cookie in the response
res.cookie('jwt', token, cookieOptions);
// Remove the password field from the user object to avoid exposing it
user.password = undefined;
// Send the response with the JWT token and user data
res.status(statusCode).json({
status: 'success',
token,
data: {
user
}
});
};
```
### Limiting Field
```bash
npm i express-rate-limit
```
```js
const rateLimit = require('express-rate-limit');
// Limit requests from the same IP address
const limiter = rateLimit({
max: 100, // 100 requests per hour
windowMs: 60 * 60 * 1000, // 1 hour
message: 'Too many requests from this IP, please try again in an hour!'
});
// Apply to all requests to the API
app.use('/api', limiter);
```
### Setting security HTTP headers
```bash
npm i helmet
```
### Data sanitization against NoSQL query injection
```js
npm i express-mongo-sanitize
```
```js
// Data sanitization against NoSQL query injection
app.use(mongoSanitize());
// Data sanitization against XSS
app.use(xss());
//Prevent parameter pollution
app.use(
hpp({
whitelist: [
'duration',
'ratingsQuantity',
'ratingsAverage',
'maxGroupSize',
'difficulty',
'price'
]
})
);
```
### Mongodb data modeling
> [Mongoose Populate](https://mongoosejs.com/docs/populate.html)
Embedding vs Referencing
- 1 : many reference
- few:few embeded
> Data model
### - Modelling Location
> [GeoJSON](https://mongoosejs.com/docs/geojson.html)
```js
// models/tourModel.js
startLocation: {
// GeoJSON
type: {
type: String,
default: 'Point',
enum: ['Point']
},
coordinates: [Number],
address: String,
description: String
},
```
### - Modelling Tour Guides: Embedding
```js
// models/tourModel.js
guides: Array;
tourSchema.pre('save', async function(next) {
const guidesPromises = this.guides.map(async id => await User.findById(id));
this.guides = await Promise.all(guidesPromises);
next();
});
```
### - Modelling Tour Guides: Child Referencing
> this pre-save middleware is responsible for fetching the `User` documents associated with the `guides` array (which are represented as `ObjectId` references) and replacing those `ObjectId`s with the actual `User` documents in the `guides` array before saving the tour document to the database. This allows for easy embedding of the `User` documents into the tour document, simplifying future querying and population of related data.
```js
// models/tourModel.js
const User = require('./userModel');
guides: [
{
type: mongoose.Schema.ObjectId,
ref: 'User'
}
];
```
### - Populating Tour Guides
In the given code snippet, `populate` is a method used in Mongoose, which is an Object Data Modeling (ODM) library for MongoDB and Node.js. The `populate` method is used to populate references in a document with the actual objects from other collections.
In the context of the code:
```javascript
const tour = await Tour.findById(req.params.id).populate('guides');
```
Here, `Tour` is the Mongoose model representing the collection of tours in the MongoDB database. The `findById` method is used to find a tour document with the specified ID. The `populate('guides')` method is then used to populate the `guides` field in the `tour` document, which is likely a reference to another collection, such as a collection of users representing tour guides.
By using `populate`, the `guides` field in the `tour` document will be replaced with the actual objects from the referenced collection, making it easier to access the details of the guides without having to perform an additional database query. This is particularly useful when you want to retrieve related data from different collections in a single query.
### Modelling Tour Guides: Parent Referencing
### Review Model: Parent Referencing
```js
// models/reviewModel.js
reviewSchema.pre(/^find/, function(next) {
// this.populate({
// path: 'tour',
// select: 'name'
// }).populate({
// path: 'user',
// select: 'name photo'
// });
this.populate({
path: 'user',
select: 'name photo'
});
next();
});
```
### Review Model: Virtual Populate
> [Virtual Populate](https://mongoosejs.com/docs/populate.html#populate-virtuals)
- Virtual population allows us to fill comments into the tour document without storing comment IDs in the tour document.
- It provides an efficient way to access all comments of a tour without manual querying or storing comment IDs in the tour document.
- Virtual population improves code readability and maintainability by simplifying the access to comments for each tour.
- Comments are not persistently stored in the database through virtual population, avoiding database bloat.
```js
// models/reviewModel.js
reviewSchema.virtual('comments', {
ref: 'Comment',
foreignField: 'review',
localField: '_id'
});
// models/commentModel.js
//virtual populate
reviewSchema.virtual('durationWeeks').get(function() {
return this.duration / 7;
});
//virtual populate
tourSchema.virtual('reviews', {
ref: 'Review',
foreignField: 'tour',
localField: '_id'
});
```
### Modelling Locations: Geospatial Data
### API documentation
[JapantourAPI](https://documenter.getpostman.com/view/24568930/2s9Xy5LVem#a436068c-2d53-4738-a0d9-a8d7aa574dfe)
### Server-side Rendering with pug
```js
const path = require('path');
app.set('view engine', 'pug');
app.set('views', path.join(__dirname, 'views'));
// 1) GLOBAL MIDDLEWARES
// Serving static files
app.use(express.static(`${__dirname}/public`));
// 3) ROUTES
app.get('/', (req, res) => {
res.status(200).render('base');
});
```
## Deployment
### Deploying Node.js to Heroku
| 💥building a comprehensive real-world RESTful API 🌐 and server-side rendered website 🖥️, mastering authentication 🔑, security 🔐, payments 💰, and more! 🚀 | javascript,expressjs,jwt-authentication,model-view-controller,mongodb,nodejs | 2023-03-22T04:50:48Z | 2023-11-12T02:32:15Z | null | 1 | 1 | 277 | 0 | 5 | 8 | null | null | JavaScript |
gsmalik030/covid19-worldometer | main | <a name="readme-top"></a>
# 📗 Table of Contents
- [📗 Table of Contents](#-table-of-contents)
- [📖 covid19-worldometer ](#-covid19-worldometer-)
- [🛠 Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Key Features ](#key-features-)
- [🚀 Live Demo ](#-live-demo-)
- [💻 Getting Started ](#-getting-started-)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#deployment)
- [👥 Author ](#-author-)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [📝 License ](#-license-)
# 📖 covid19-worldometer <a name="about-project"></a>
**covid19-worldometer** is a showcase for books.
## 🛠 Built With <a name="built-with"></a>
### Tech Stack <a name="tech-stack"></a>
<details>
<summary>Build With</summary>
<ul>
<li><a href="https://html.com/">HTML</a></li>
<li><a href="https://developer.mozilla.org/en-US/docs/Web/CSS">CSS</a></li>
<li><a href="https://www.javascript.com/">JavaScript</a></li>
<li><a href="https://reactjs.org/">React.js</a></li>
</ul>
</details>
### Key Features <a name="add components"></a>
- Showcase covid 19 statistics
- Show details stats about covid
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 🚀 Live Demo <a name="live-demo"></a>
- [Live Demo](https://covid19-worldometer.onrender.com)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 💻 Getting Started <a name="getting-started"></a>
### Prerequisites
### Setup
Clone this repository to your desired folder:
```sh
cd covid19-worldometer
git clone https://github.com/gsmalik030/covid19-worldometer
```
### Install
Install this project with:
```sh
cd covid19-worldometer
git clone https://github.com/gsmalik030/covid19-worldometer
npm install
```
### Usage
Use this app by runing:
```sh
cd covid19-worldometer
git clone https://github.com/gsmalik030/covid19-worldometer
npm install
npm start
```
### Run tests
Test this app by runing:
```sh
cd covid19-worldometer
git clone https://github.com/gsmalik030/covid19-worldometer
npm install
npm test
```
### Deployment
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 👥 Author <a name="authors"></a>
👤 **Ghulam Subbhani(Malik)**
- GitHub: [@githubhandle](https://github.com/gsmalik030)
- Twitter: [@twitterhandle](https://twitter.com/gsmalik030)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/gsmalik030)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 🔭 Future Features <a name="future-features"></a>
- [ ] **Use react hooks**
- [ ] **Implement full website**
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 🤝 Contributing <a name="contributing"></a>
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/gsmalik030/covid19-worldometer/issues).
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## ⭐️ Show your support <a name="support"></a>
If you like this project, please, give a star.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 🙏 Acknowledgments <a name="acknowledgements"></a>
I would like to thank [Nelson Sakwa](https://www.behance.net/sakwadesignstudio)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 📝 License <a name="license"></a>
This project is [MIT](MIT.md) licensed.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
| Covid-19 Worldometer is a mobile web application which provide the covid-19 statistics in the world. Built with React and Redux-toolkit. | axios,css,javascript,react,redx-toolkit | 2023-03-13T09:46:33Z | 2023-03-17T07:14:50Z | null | 1 | 6 | 26 | 0 | 0 | 8 | null | MIT | JavaScript |
forLoop94/Personal-Portfolio_project | main | null | This is a personal portfolio website that will potentially be a platform for me to showcase my future projects. I built this using HTML, CSS and Javascript. | css,html,javascript | 2023-03-22T20:23:07Z | 2024-01-28T15:02:41Z | null | 5 | 18 | 207 | 3 | 0 | 8 | null | MIT | JavaScript |
pigeonposse/stylegpt | main | <!-- PIGEONPOSSE START MARK -->
<!--
██████╗ ██╗ ██████╗ ███████╗ ██████╗ ███╗ ██╗
██╔══██╗██║██╔════╝ ██╔════╝██╔═══██╗████╗ ██║
██████╔╝██║██║ ███╗█████╗ ██║ ██║██╔██╗ ██║
██╔═══╝ ██║██║ ██║██╔══╝ ██║ ██║██║╚██╗██║
██║ ██║╚██████╔╝███████╗╚██████╔╝██║ ╚████║
╚═╝ ╚═╝ ╚═════╝ ╚══════╝ ╚═════╝ ╚═╝ ╚═══╝
██████╗ ██████╗ ███████╗███████╗███████╗
██╔══██╗██╔═══██╗██╔════╝██╔════╝██╔════╝
██████╔╝██║ ██║███████╗███████╗█████╗
██╔═══╝ ██║ ██║╚════██║╚════██║██╔══╝
██║ ╚██████╔╝███████║███████║███████╗
╚═╝ ╚═════╝ ╚══════╝╚══════╝╚══════╝
█████╗█████╗█████╗█████╗█████╗█████╗█████╗█████╗
╚════╝╚════╝╚════╝╚════╝╚════╝╚════╝╚════╝╚════╝
███████╗████████╗██╗ ██╗██╗ ███████╗ ██████╗ ██████╗ ████████╗
██╔════╝╚══██╔══╝╚██╗ ██╔╝██║ ██╔════╝██╔════╝ ██╔══██╗╚══██╔══╝
███████╗ ██║ ╚████╔╝ ██║ █████╗ ██║ ███╗██████╔╝ ██║
╚════██║ ██║ ╚██╔╝ ██║ ██╔══╝ ██║ ██║██╔═══╝ ██║
███████║ ██║ ██║ ███████╗███████╗╚██████╔╝██║ ██║
╚══════╝ ╚═╝ ╚═╝ ╚══════╝╚══════╝ ╚═════╝ ╚═╝ ╚═╝
VERSION: 1.3.6
REPOSITORY: https://github.com/pigeonposse/stylegpt
AUTHORS:
- Angelo (https://github.com/angelespejo)
- Alejo (https://github.com/alejomalia)
DEVELOPED BY PIGEONPOSSE 🐦🌈
-->
<!-- PIGEONPOSSE END MARK -->
# styleGPT - A _Browser extension_ for ChatGPT
<!-- PIGEONPOSSE START HEADER -->
[](https://www.youtube.com/watch?v=Nh1DvI3p0p8)
[](https://pigeonposse.com)
[](https://pigeonposse.com/?popup=about)
[](https://pigeonposse.com/?popup=donate)
[](https://github.com/pigeonposse)
[](https://twitter.com/pigeonposse_)
[](https://www.instagram.com/pigeon.posse/)
[](https://medium.com/@pigeonposse)
[](/LICENSE)
[](https://github.com/pigeonposse/stylegpt/releases)
[](https://addons.mozilla.org/firefox/addon/stylegpt/)
[](https://chrome.google.com/webstore/detail/stylegpt/khoggafmiibmeihpkpbkllkkdfhmokoj)
[](https://microsoftedge.microsoft.com/addons/detail/gkcagmallcghkmmidopechceeibnojmb)
🤖🧩 StyleGPT is an extension that will provide you with tools to customize the appearance of ChatGPT according to your preferences. 🐦🌈
Discover the aesthetic evolution with styleGPT, the extension that redefines the appearance of ChatGPT. 🚀 Immerse yourself in a unique experience by blending elegance and functionality in every interaction. Explore the magic of artificial intelligence through an interface that transcends the ordinary. Illuminate your conversations and elevate your interaction with ChatGPT to a new aesthetic level. ✨💬 Join the revolution of the user experience with styleGPT and experience an unparalleled visual standard.✨💻🌈
[View demo](https://www.youtube.com/watch?v=Nh1DvI3p0p8)
Updated functions:
- ✅ Improved interface.
- ✅ Interactive menu.
- ✅ Hide/show menu button.
- ✅ Dark mode button.
- ✅ New chat button.
- ✅ Customize chat menu.
- ✅ Color, text and background choice options for user or AI.
- ✅ Change styles to the code editor
- ✅ Change styles to sidebar
## 🧩 Download
### Browser stores
[](https://chrome.google.com/webstore/detail/stylegpt/khoggafmiibmeihpkpbkllkkdfhmokoj)
[](https://microsoftedge.microsoft.com/addons/detail/gkcagmallcghkmmidopechceeibnojmb)
[](https://addons.mozilla.org/firefox/addon/stylegpt/)
### Manual Installation Links
[](https://github.com/pigeonposse/stylegpt/releases/download/1.3.6/chrome-stylegpt-1.3.6.zip)
[](https://github.com/pigeonposse/stylegpt/releases/download/1.3.6/edge-stylegpt-1.3.6.zip)
[](https://github.com/pigeonposse/stylegpt/releases/download/1.3.6/firefox-stylegpt-1.3.6.zip)
[](https://github.com/pigeonposse/stylegpt/releases/download/1.3.6/safari-stylegpt-1.3.6.zip)
[](https://github.com/pigeonposse/stylegpt/releases/download/1.3.6/brave-stylegpt-1.3.6.zip)
[](https://github.com/pigeonposse/stylegpt/releases/download/1.3.6/opera-stylegpt-1.3.6.zip)
[](https://github.com/pigeonposse/stylegpt/releases/download/1.3.6/opera-gx-stylegpt-1.3.6.zip)
[](https://github.com/pigeonposse/stylegpt/releases/download/1.3.6/chromium-stylegpt-1.3.6.zip)
[-grey?style=for-the-badge&logo=googlechrome&logoColor=white)](https://github.com/pigeonposse/stylegpt/releases/download/1.3.6/chromium-mv2-stylegpt-1.3.6.zip)
[](https://github.com/pigeonposse/stylegpt/releases)
<!-- PIGEONPOSSE END HEADER -->
## ⚙️ Usage
1. Go to _<https://chat.openai.com/>_
2. You will see a right menu on page
|  |  |
| ------------------------- | ------------------------- |
### Demo
> ℹ️ Video demo for v1.3
[](https://www.youtube.com/watch?v=Nh1DvI3p0p8)
### Change chat styles
<!--  -->
### Hide/Show Sidebar
### New chat button
### Dark mode button
<!-- PIGEONPOSSE START ORG -->
## 👨💻 Development
You can contribute via **_Github_**.
[](https://github.com/pigeonposse/stylegpt/issues)
[](https://github.com/pigeonposse/stylegpt/pulls)
## ☕ Donate
Help us to develop more interesting things.
[](https://pigeonposse.com/?popup=donate)
## 📜 License
This software is licensed with **[GPLv3](/LICENSE)**.
[](/LICENSE)
## 🐦 About us
_PigeonPosse_ is a ✨ **code development collective** ✨ focused on creating practical and interesting tools that help developers and users enjoy a more agile and comfortable experience. Our projects cover various programming sectors and we do not have a thematic limitation in terms of projects.
[](https://github.com/PigeonPosse/PigeonPosse)
### Collaborators
| | Name | Role | GitHub |
| ---------------------------------------------------------------------------------- | ----------- | ------------ | ---------------------------------------------- |
| <img src="https://github.com/angelespejo.png?size=72" alt="Angelo" style="border-radius:100%"/> | Angelo | Author & Development | [@Angelo](https://github.com/angelespejo) |
| <img src="https://github.com/alejomalia.png?size=72" alt="Alejo" style="border-radius:100%"/> | Alejo | Author & Design | [@Alejo](https://github.com/alejomalia) |
| <img src="https://github.com/PigeonPosse.png?size=72" alt="PigeonPosse" style="border-radius:100%"/> | PigeonPosse | Collective | [@PigeonPosse](https://github.com/PigeonPosse) |
</br>
<p align="center">
[](https://pigeonposse.com)
[](https://pigeonposse.com/?popup=about)
[](https://pigeonposse.com/?popup=donate)
[](https://github.com/pigeonposse)
[](https://twitter.com/pigeonposse_)
[](https://www.instagram.com/pigeon.posse/)
[](https://medium.com/@pigeonposse)
</p>
<!-- PIGEONPOSSE END ORG -->
| 🤖🧩 StyleGPT is an extension that will provide you with tools to customize the appearance of ChatGPT according to your preferences. 🐦🌈 | ai,browser-extension,chat-gpt,chrome-extension,extension,firefox-extension,gpt,gpt4,javascript,npm | 2023-03-15T19:54:22Z | 2024-05-20T15:29:59Z | 2024-04-10T00:36:24Z | 2 | 1 | 187 | 0 | 0 | 8 | null | GPL-3.0 | JavaScript |
PixelRocket-Shop/vault-html-tailwind | main | # Vault - Tailwind CSS HTML Responsive Saas Landing Page Template
## Overview
Unlock your website's potential with Vault - the ultimate Tailwind CSS HTML landing page template. With its sleek design and responsive layout, Vault is the perfect solution for businesses and individuals looking to make a lasting impression online. Featuring customizable HTML code and easy-to-use features such as customer testimonials, pricing table, and powerful call-to-action buttons, Vault is the key to unlocking your website's success.
<strong><a href="https://vault-html-tailwind.vercel.app/">View Demo</a> | <a href="https://github.com/PixelRocket-Shop/vault-html-tailwind/archive/main.zip">Download ZIP</a></strong>
## Table of contents
- [Requirements](#requirements)
- [Quick Start](#quick-start)
- [Contact Me](#contact-me)
## Requirements
If you do not intend to work with the template source code (and that means you will not be compiling it), you do not need to install anything. You can simply navigate to the public folder and take the HTML snippets directly from there.
Most developers will be editing the source code and will also recompile the template files. If that's the case, then ensure that you have Node.js installed. [You can download it from here](https://nodejs.org/en/download/)
If you are going to customise the template or add new pages, you need to familiar with Pug, the template engine used. [You can read more about Pug here](https://pugjs.org/)
## Quick Start
Project's source files are placed in ./src/ directory.
* ./src/assets - default static files (eg. image placeholders). You should replace them with your own files.
* ./src/tailwind/ - Tailwind config file used to build the theme.
All your pages (templates) are stored in separated .pug files
* ./src/pug/*.pug
NOTE: npm commands overwrite the ./public directory.
```
# Install dependencies
npm install
# Run dev server with live preview (Browsersync)
npm run watch
# Or make a production build
npm run build
```
## Contact Me
You can find my website [here](https://www.pixelrocket.store) or you can email me at support@pixelrocket.store | Vault is a free HTML Tailwind CSS Saas landing page template | css,free-tailwind-template,free-template,free-templates,html-template,javascript,saas-template,tailwind-css,tailwind-template,tailwindcss | 2023-03-22T09:32:17Z | 2023-03-22T13:04:18Z | 2023-03-22T09:50:23Z | 2 | 1 | 5 | 0 | 3 | 8 | null | null | Pug |
onukwilip/gopack | main | # <img src="./gopack_logo_new.png" alt="logo" title="logo" width="45px" style="width: 45px;" > GOPACK
- [Introduction][intro]
- [Installation][install]
- [Usage][use]
- [Initialization][init]
- [Starting the development server][start]
- [Starting the production server][serve]
- [Bundling your project][build]
- [Using the `gopack.config.js` file][gopackconfig]
- [Other libraries and frameworks][other]
- [Supporting React Js][react]
- [Supporting Vue Js][vue]
- [Supporting Angular Js][angular]
- [Supporting Typescript][typescript]
- [Supporting jQuery][jquery]
- [Supporting SASS/SCSS][sass]
- [Supporting Ejs][ejs]
- [Supporting Pug][pug]
- [Supporting Handlebars][handlebars]
- [Node Js Support][node]
[intro]: #introduction
[install]: #installation
[use]: #usage
[init]: #initialization
[start]: #start
[serve]: #serve
[build]: #build
[gopackconfig]: #gopackconfig
[other]: #libraries
[react]: #react
[vue]: #vue
[angular]: #angular
[typescript]: #typescript
[jquery]: #jquery
[sass]: #sass
[ejs]: #ejs
[pug]: #pug
[handlebars]: #handlebars
[node]: #nodejs
[//]: #122333444455555/this/shouldn't/be/repeated/in/the/readme
## Introduction
GOPack is a pre written javascript bundler, which was created using webpack. It configures your project to use the already existing webpack loaders and plugins to generate static files.
## Installation
Inorder to install this package you need to have Node Js running on your system. If you don't have Node Js you can install it from their website [https://nodejs.org](https://nodejs.org). If you have Node Js installed, navigate to your project root folder and run `npm i @go-pack/gopack` in your terminal.
## Usage
### Initialization
To initialize the project (Set up the project files), run `npx gopack init`. This command will create the files you need for webpack to work, and install the `devDependencies` into your `node_modules` folder.
The files that will be created are:
- package.json (This will merge existing package.json contents into a new package.json file)
- webpack.config.js
- .browserslistrc
- postcss.config.js
- gopack.config.js
When you run `npx gopack init`, it will initialize your project and create some files, but if it files any existing file it will ask for permission to overwrite it. It will also ask for permission to run `npm install -f` in your project. To skip the permissions you can run `npx gopack init -y`
### Start
Inorder to start the development server, you can run `npx gopack start`, the equivalent of this is `npx webpack` + `npx webpack serve`. Your server will run on `http://localhost:8080` by default. Make sure you have the `gopack.config.js` file in your project's root folder and export an object as default, unless this will throw an error.
### Serve
Inorder to start the production server, you can run `npx gopack serve`, the equivalent of this is `npx cross-env MODE=production webpack` + `npx cross-env MODE=production webpack serve`. Your server will run on `http://localhost:8080` by default. Make sure you have the `gopack.config.js` file in your project's root folder and export an object as default, unless this will throw an error.
### Build
Inorder to bundle your project into static files, you can run `npx gopack build`, the equivalent of this is `npx cross-env MODE=production webpack`. Doing this will bundle your project without starting the production server. Make sure you have the `gopack.config.js` file in your project's root folder and export an object as default, unless this will throw an error.
### GopackConfig
The `gopack.config.js` file is written to help developers who are not familiar with webpack to customize the build output to their taste.
It comprises of key value pairs that enables flexibility in one's project. Which are:
- [generateCSSFiles][generatecssfiles]
- [devtool][devtool]
- [useCoreJs][usecorejs]
- [entry][entry]
- [outputFilenameFormat][outputfilenameformat]
- [outputImageNameFormat][outputimagenameformat]
- [outputFilename][outputfilename]
- [outputFolder][outputfolder]
- [pages][pages]
- [assetsFolder][assetsfolder]
- [mapPlugins][mapplugins]
- [libraries][libraries]
- [node][node]
- [target][target]
- [copy][copy]
[generatecssfiles]: #generatecssfiles
[devtool]: #devtool
[usecorejs]: #usecorejs
[entry]: #entry
[outputfilenameformat]: #outputfilenameformat
[outputimagenameformat]: #outputImageNameFormat
[outputfilename]: #outputfilename
[outputfolder]: #outputfolder
[pages]: #pages
[assetsfolder]: #assetsfolder
[mapplugins]: #mapplugins
[libraries]: #libraries
[node]: #node
[target]: #target
[copy]: #copy
#### generateCSSFiles
This accepts a boolean `true` or `false`. It indicates if webpack should inject CSS styles into the style tags `<style></style>` of every HTML page or if it should generate CSS files and them to various HTML pages.
#### devtool
This accepts the same parameters the webpack devtool does. It must be the same parameter that would be inserted into the webpack `devtool` key, unless webpack will throw an error upon build.
The most common used options are either `false` which is a `boolean` or `source-map` which is a `string`. If the `source-map` is inserted, it generates javascript and CSS map files which will be used to trace code using the browser's `devtool`. The `source-map` option is best used for `development` mode, while the `false` option is best used for `production` mode.
#### useCoreJs
This accepts a boolean. It signifies if `babel.config.js` should generate code to support older browser versions when bundling using the `core-js` npm package. It is `false` by default.
**NB: This feature generates a lot of code for backwards compatibility, which will end up making your bundled javascript code large. use at your own risk**
#### entry
This accepts either a `string` or an `object`. It is indicates where webpack should start building our files from. The default value is `./src/index.js`. To specify multiple entrypoint, you create an object with key value pairs. the key being the `chunk` and the value being the _path to the file_. E.g.
```javascript
entry: {
chunk: "path/to/file.js";
}
```
### outputFilenameFormat
This is the format in which webpack should name our bundled files - `chunks`. It is used if the `entry` parameter is an `object`. It accepts a string. It is written in this format `[name].bundle.js`. The `[name]` block is a variable which signifies the name each generated file `chunk`. The `bundle` extension is optional, but the `js` extension is compulsory. Therefore, if you specify the entry file as:
```javascript
entry: {
index: "./src/index.js";
}
```
The output will be `index.bundle.js`
### outputImageNameFormat
This is the format in which webpack should name our bundled assets/images. It accepts a string. It is written in this format `[name][hash][ext][query]`. The `[name]` block is a variable which signifies the name each generated file/image. The `[hash]` block is the unique hash webpack generates for each file. The `[ext]` block is the file extension. The `[query]` block is optional. Therefore, if you specify the entry file as:
```javascript
entry: {
index: "./src/index.js";
}
```
The output will be `index.bundle.js`
#### outputFilename
This is the name you want to give your bundled javascript file. This is used if the `entry` parameter is a `string` or not specified. This key accepts a `string`, which must end with the `.js` extension. E.g. `index.js`
#### outputFolder
This specifies the folder where all the webpack generated files should be located. It accepts a `string`. E.g. `public`
#### pages
This is used if you have any HTML file/files which you want to be bundled. It accepts an `array` of `objects`. E.g.
```javascript
public: [
{
template: path.resolve(__dirname, "src/index.html"),
filename: "index.html",
},
];
```
The template key signifies the path to the HTML document, the filename signifies the name it should give the generated HTML document during build.
Each object also accepts a parameter called `chunk`, which is an array of generated JavaScript/CSS file links to be inserted into the HTML document. The items passed as values to the `chunk` array must be same as the keys passed into the `entry` object. E.g
```javascript
entry: {
index: './src/index.js',
about: './src/about.js',
contact: './src/contact.js',
},
public: [
{
template: path.resolve(__dirname, "src/about.html"),
chunk:["index","about"],
filename: "about.html",
}
]
```
The `chunks` specifies which bundled javascript files should be included in the HTML page. I.e
- `gopack.config.js`
```javascript
entry: {
index: './src/index.js',
about: './src/about.js',
contact: './src/contact.js',
},
public: [
{
template: path.resolve(__dirname, "src/index.html"),
chunk:["index"],
filename: "index.html",
}
]
```
- `index.html`
```html
<!DOCTYPE html>
<html lang="en">
<head>
<title>Index</title>
<!-- Automatic import -->
<script defer src="index.js"></script>
</head>
</html>
```
#### assetsFolder
This accepts a string which is the name or path to the folder the bundled images and assets will be stored. E.g. `images` or `path/to/images`.
#### mapPlugins
This accepts an `object`. The value of this is passed to the `webpack.ProvidePlugin()` class. This automatically load modules instead of having to **import** or **require** them everywhere in your project.
Here is an example of it's possible values:
```javascript
{
identifier: "module";
// OR
identifier: path.resolve(path.join(__dirname, "path/to/module.js"));
}
```
The identifier is a user-defined value/key, while the module is either the name of a library in the `node_modules` folder or path to a javascript/typescript file. The **module** is automatically loaded and the **identifier** is filled with the exports of the loaded module (or property in order to support named exports).
Common usages of this option are:
- [jQuery][jquery]
[jquery]: #jquery
##### jQuery
To automatically load jQuery we can point both variables it exposes to the corresponding node module:
```js
{
$: 'jquery',
jQuery: 'jquery',
}
```
Then in any of our source code:
```js
// in a module
$("#item"); // <= works
jQuery("#item"); // <= also works
// $ is automatically set to the exports of module "jquery"
```
#### libraries
This accepts an `array` of `string` or `objects`. It specifies which libraries webpack should support when bundling your project. If you are adding an object to the list, you should do so in this format.
```js
{
name: "name-of-library",
...//other properties specified
}
```
Here are it's possible values to be inserted into the list:
- react
- vue
- angular **OR** `{name: "angular", src: "path/to/your/source/folder"}`
- typescript
- pug
- hbs
Examples are:
- Let's say you want to support React Js, you specify
```js
{
...,
libraries: ["react"]
}
```
- If you want to support multiple libraries e.g. Typescript, Angular you specify:
```js
{
...,
libraries: ["typescript", {name: "angular", src: "path/to/your/source/folder"}]
}
```
**N.B: The values are case-sensitive so make sure you use exactly what's specified in the list of possible values**
#### node
This is passed into the `webpackConfig.node` object. It accepts an `object` as a value. It specifies certain Node Js globals to polyfill. It should be used if you are running on a Node Js environment. To learn more visit [https://webpack.js.org/configuration/node/](https://webpack.js.org/configuration/node/).
#### target
This tells webpack the environment it should target when building your project. It defaults to `browserslist`. It should be set to `node` to support a Node Js environment, it should be set to `web` or `browserslist` to support a web environment. To learn more visit [https://webpack.js.org/configuration/target/](https://webpack.js.org/configuration/target/)
#### copy
This specifies individual files or entire directories which already exist, that webpack should copy to the build directory. It's value is being passed to the `new CopyWebpackPlugin()` class.
It accepts an `object` of keys. I.e
- patterns (Array)
- options (Object)
The `patterns` property accepts a list of `objects` which properties are:
[`from`, `to`, `context`, `globOptions`, `filter`, `toType`, `force`, `priority`, `transform`, `transformAll`, `noErrorOnMissing`, `info`]. We will only explain the `from` and `to` properties, to learn more visit [https://webpack.js.org/plugins/copy-webpack-plugin](https://webpack.js.org/plugins/copy-webpack-plugin).
- from:
This is an object that accepts a `string`, i.e. The path to the file/folder to be copied.
- to:
This is an object that accepts a `string`, i.e. The destination of the copied file or folder.
E.g
```js
{
copy: {
patterns: [
{
from: "path/to/file.js",
to: "path/to/destination/file.js",
},
{
from: "path/to/folder",
to: "path/to/destination/folder",
},
{
from: path.resolve(__dirname, "folder").replace(/\\/g, "/"),
to: path.resolve(__dirname, "folder").replace(/\\/g, "/"),
},
];
}
}
```
> **N.B: Don't use directly `\\` in `from` or `to` option if it is a glob (i.e `path\to\file.ext`) option because on UNIX the backslash is a valid character inside a path component, i.e., it's not a separator. On Windows, the forward slash and the backward slash are both separators. Instead please use `/`.**
To learn more please visit [https://webpack.js.org/plugins/copy-webpack-plugin](https://webpack.js.org/plugins/copy-webpack-plugin).
## Libraries
GOPack also supports the use of other libraries which are:
### React
GOPack has built-in support for react. It uses the `@babel/preset-react` library to transpile JSX to javascript. If you need to use React Js in your project you just have to install both the `react` and `react-dom` libraries. Then create a root node in your HTML file where `react` will inject the transpiled JSX code. To learn more about React Js, visit [https://legacy.reactjs.org/docs/getting-started.html](https://legacy.reactjs.org/docs/getting-started.html).
### Vue
GOPack has built-in support for vue. It uses `vue-loader`, `VueLoaderPlugin`, `vue-style-loader`, `vue-template-compiler` to handle `.vue` files. If you need to use Vue Js in your project you just have to install the `vue` library. Then create one or multiple root nodes in your HTML file where `vue` will inject the transpiled Vue Js code. To learn more about Vue Js, visit [https://vuejs.org/guide/introduction.html](https://vuejs.org/guide/introduction.html).
**N.B: To make use of Vue Js, make sure you have at least 1 `.vue` file in your project folder, unless webpack will throw an error**
### Angular
GOPack has built-in support for angular. It doesn't use any extra loader to handle angular projects. But, it does add one plugin to the webpack `plugins` array which is the `new webpack.ContextReplacementPlugin()`, in order to support angular core and skip all system imports angular does by itself. It also adds one property to the webpack `devServer` object which is the `historyApiFalback` and sets it to `true`, in order to support angular js routing.
If you need to use Angular Js in your project you just have to install the necessary angular libraries, and add `angular` to the list of libraries you want to support in `gopackConfig.libraries` array. I.e.
```js
{
...,
libraries: ["angular"]
}
```
You can also add an `object` if you want to specify the link to your project's source folder. I.e
```js
{
...,
libraries: [{
name: "angular",
src:"path/to/your/project's/source/folder"
}]
}
```
The `src` value is optional, but if provided it will be added to the `new webpack.ContextReplacementPlugin()` plugin as the path to the project's source folder, else the value `./src` will be used instead.
For more detailed information on how to use Angular Js, visit [https://docs.angularjs.org/guide](https://docs.angularjs.org/guide).
### Typescript
GOPack has built-in support for typescript. It uses the `ts-loader` loader to handle both `.ts` and `.tsx` files. If you need to use Typescript in your project you just need to install the `typescript` library and create a `tsconfig.json` file in your project's root folder. To learn more about Typescript, visit [https://www.typescriptlang.org/docs/handbook/typescript-from-scratch.html](https://www.typescriptlang.org/docs/handbook/typescript-from-scratch.html).
### JQuery
GOPack has built-in support for jQuery. If you need to use jQuery in your project you just need to install the `jQuery` library in your project. To learn more about jQuery, visit [https://api.jquery.com/](https://api.jquery.com/).
### SASS
GOPack has built-in support for SASS. It uses the `sass-loader` loader to handle both `.sass` and `.scss` files. If you need to use SASS in your project you just need to install the `sass` library in your project. To learn more about SASS, visit [https://sass-lang.com/documentation/](https://sass-lang.com/documentation/).
### Ejs
GOPack has built-in support for ejs. It uses the `HTMLWebpackPlugin` library to handle `.ejs` files. There is one problem with using `.ejs` files, the `html-loader` doesn't parse images/files imported in `.ejs` files. Therefore, to use import images you have to do it this way.
```html
// WRONG
<img src="./images/picture.jpg" />
// CORRECT <img src="<%= require("./images/picture.jpg") %>" />
```
You can also add dynamic variables using the `<%= htmlWebpackPlugin.options.variable_name %>` syntax. Then specify `variable_name` in the object passed into the `pages` array in `gopack.config.js`. E.g.
In the index.ejs file
```html
<head>
<title><%= htmlWebpackPlugin.options.variable_name %></title>
</head>
```
Then in the `gopack.config.js`
```js
{
...,
pages: [
{
template: path.resolve(__dirname, "src/index.ejs"),
filename: "index.html",
variable_name: "Index page"
}
]
}
```
To learn more about ejs, visit [https://ejs.co/#docs](https://ejs.co/#docs).
### Pug
GOPack has built-in support for pug. It uses the `pug-loader` library to handle `.pug` files. There is one problem with using `.pug` files, just like `.ejs` files the `html-loader` doesn't parse images/files imported in `.pug` files. Therefore, to use import images you have to do it this way.
```js
// WRONG
img((src = "./images/picture.jpg"));
// CORRECT
img((src = require("./images/picture.jpg")));
```
You can also add dynamic variables by just assigning htmlWebpackPlugin.options.variable_name to an element. Then specify `variable_name` in the object passed into the `pages` array in `gopack.config.js`. E.g.
In the index.pug file
```js
head;
title = htmlWebpackPlugin.options.variable_name;
```
Then in the `gopack.config.js`
```js
{
...,
pages: [
{
template: path.resolve(__dirname, "src/index.pug"),
filename: "index.html",
variable_name: "Index page"
}
]
}
```
To learn more about pug, visit [https://pugjs.org/api/getting-started.html](https://pugjs.org/api/getting-started.html).
### Handlebars
GOPack has built-in support for handlebars. It uses the `handlebars-loader` library to handle `.hbs` files. There is one problem with using `.hbs` files, just like the other non-html files, the `html-loader` doesn't parse images/files imported in `.hbs` files. But, you don't need to do any extra configuration because GOPack has added the object below in the `rules` array for `.hbs` files.
```js
{
test: /\.hbs$/,
use: [
{
loader: "handlebars-loader",
// CODE RESPONSIBILE FOR PARSING LINKS TO IMAGES
query: {
inlineRequires: `/${gopackConfig?.assetsFolder || "images"}/`,
},
},
],
}
```
You can also add dynamic variables using the `{{ htmlWebpackPlugin.options.variable_name }}` syntax. Then specify `variable_name` in the object passed into the `pages` array in `gopack.config.js`. E.g.
In the index.hbs file
```html
<head>
<title>{{ htmlWebpackPlugin.options.variable_name }}</title>
</head>
```
Then in the `gopack.config.js`
```js
{
...,
pages: [
{
template: path.resolve(__dirname, "src/index.hbs"),
filename: "index.html",
variable_name: "Index page"
}
]
}
```
To learn more about handlebars, visit [https://handlebarsjs.com/guide/](https://handlebarsjs.com/guide/).
## NodeJs
In order to support a Node js environment, you need to set the `target` option in the gopackConfig to `node`. It defaults to `browserslist`. You can add some key value pairs to the `node` option in the gopackConfig file to configure Node Js polyfill. To learn more about the `target` and `node` options visit [https://webpack.js.org/configuration/target/](https://webpack.js.org/configuration/target/) and [https://webpack.js.org/configuration/node/](https://webpack.js.org/configuration/node/) respectively.
# General
If you need to add any configuration to webpack which is not present in the `gopack.config.js`, add it to the `module.exports` object in the `webpack.config.js` or better still to the variable belonging to that configuration. E.g.
```js
//OUTPUT
const output = {
filename: gopackConfig?.entry
? gopackConfig?.outputFilenameFormat || "[name].bundle.js"
: gopackConfig?.outputFilename || "bundle.js",
path: path.resolve(gopackConfig?.outputFolder || "public"),
assetModuleFilename: `${
gopackConfig?.assetsFolder || "images"
}/[hash][ext][query]`,
clean: true,
};
```
**The `output` constant belongs to the `output` key in the webpack configuration**
```js
module.exports = {
...,
output: output,
...
};
```
<a href="https://www.producthunt.com/posts/gopack?utm_source=badge-featured&utm_medium=badge&utm_souce=badge-gopack" target="_blank"><img src="https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=385947&theme=dark" alt="GOPack - Javascript bundler and transpiler using webpack and babel | Product Hunt" style="width: 250px; height: 54px;" width="250" height="54" /></a>
| This is a webpack compiler developed for bundling projects into static files | es6,gopack,javascript,react,typescript,webpack,babel,babel-plugin,html,loaders | 2023-03-23T09:47:04Z | 2023-04-14T12:15:53Z | null | 1 | 3 | 69 | 3 | 0 | 7 | null | MIT | JavaScript |
jicamargo/first-mobile-portfolio | main | <a name="readme-top"></a>
<div align="center">
<br/>
<h1><b>Mobile First Portfolio</b></h1>
<br/>
</div>
<!-- TABLE OF CONTENTS -->
# 📗 Table of Contents
- [📗 Table of Contents](#-table-of-contents)
- [📖 Portfolio ](#-portfolio-)
- [🛠 Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [⭐️ Key Features ](#️-key-features-)
- [🚀 Live Demo ](#-live-demo-)
- [💻 Getting Started ](#-getting-started-)
- [Walkthrough Video](#walkthrough-video)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#deployment)
- [👥 Authors ](#-authors-)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [📝 License ](#-license-)
<!-- PROJECT DESCRIPTION -->
# 📖 Portfolio <a name="about-project"></a>
**[Portfolio]** is a site, applying "fisrt mobile" design and RWD (Responsive Web Design).
## 🛠 Built With <a name="built-with"></a>
### Tech Stack <a name="tech-stack"></a>
<details>
<summary>Client</summary>
<ul>
<li>HTML</li>
<li>CSS</li>
</ul>
</details>
## ⭐️ Key Features <a name="key-features"></a>
- **["First mobile" design]**
- **["Contact me form with data validation]**
- **[Responsive Web Design]**
- **[Animations and transitions]**
- **["pop-up window to view project detail]**
- **[Local storage of the user information]**
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- LIVE DEMO -->
## 🚀 Live Demo <a name="live-demo"></a>
[View live Demo](https://jicamargo.github.io/first-mobile-portfolio/)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- GETTING STARTED -->
## 💻 Getting Started <a name="getting-started"></a>
Open this site in your browser and enjoy.
### Walkthrough Video
[View Walkthrough Video](https://www.loom.com/share/769b77a8efcf42198808fac6cbf7060d)
### Prerequisites
In order to run this project you need:
A modern browser for like Mozilla, Chrome, Edge, etc. that supports HTML5 and CSS
### Setup
This application runs directly (it does not need any setup process)
### Install
Install this project with:
This application runs directly (it does not need any install process)
### Usage
Enter to index.html web page
### Run tests
No tests needed, you can enter directly to index.html
### Deployment
No deployment needed, you can enter directly to index.html
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- AUTHORS -->
## 👥 Authors <a name="authors"></a>
👤 **Jorge Camargo**
- GitHub: [@jicamargo](https://github.com/jicamargo)
- Twitter: [@ji_camargo](https://twitter.com/ji_camargo)
- LinkedIn: [LinkedIn](https://linkedin.com/in/jorgecamargog)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- FUTURE FEATURES -->
## 🔭 Future Features <a name="future-features"></a>
- [ ] **[Fancy animations]**
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- CONTRIBUTING -->
## 🤝 Contributing <a name="contributing"></a>
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- SUPPORT -->
## ⭐️ Show your support <a name="support"></a>
If you like this project, please give a ⭐️ (Thank you)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- ACKNOWLEDGEMENTS -->
## 🙏 Acknowledgments <a name="acknowledgements"></a>
- Microverse team
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 📝 License <a name="license"></a>
This project is [MIT](./LICENSE) licensed.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
| Portfolio: A Responsive and Mobile-First Webpage Design Welcome to my portfolio webpage! This project showcases my skills, experiences, and projects in a responsive and mobile-first design. Explore my work, learn more about me, and get in touch to discuss collaboration opportunities. | css,first-mobile-app,html,javascript,responsive,responsive-web-design | 2023-03-23T00:12:08Z | 2023-09-25T21:58:37Z | null | 3 | 14 | 120 | 0 | 0 | 7 | null | MIT | CSS |
kudzaiprichard/online-assessment-portal | main |
<a name="readme-top"></a>
<!-- PROJECT LOGO -->
<br />
<div align="center">
<a href="https://github.com/kudzaiprichard/online-assessment-portal">
<img src="images/logo/logo.png" alt="Logo" width="80" height="80">
</a>
<h3 align="center">Online Assessment Portal</h3>
<p align="center">
An online portal for assessing students on internship
<br />
</p>
<br/>
</div>
<!-- TABLE OF CONTENTS -->
<details>
<summary>Table of Contents</summary>
<ol>
<li>
<a href="#about-the-project">About The Project</a>
<ul>
<li><a href="#project-scope">Project Scope</a></li>
<li><a href="#project-design">Project Design</a></li>
<li><a href="#built-with">Built With</a></li>
</ul>
</li>
<li>
<a href="#getting-started">Getting Started</a>
<ul>
<li><a href="#prerequisites">Prerequisites</a></li>
<li><a href="#installation">Installation</a></li>
<li><a href="#contributing">Contributing</a></li>
</ul>
</li>
<li><a href="#license">License</a></li>
<li><a href="#contact">Contact</a></li>
<li><a href="#acknowledgments">Acknowledgments</a></li>
</ol>
</details>
<!-- ABOUT THE PROJECT -->
# About The Project
### Project Scope
Online internship assessment is the process of conducting a student assessment through reports, communicating with the
students work supervisor on students progress and grading the student online. Online assessments comprise a series of
tasks and reports that assess multiple aspects of a task-taker and are created based on the job role, level and competency
requirements. Such assessments offer an objective evaluation of a student’s capabilities and predict on-the-job performance.
* Students, supervisors and assesses should be able to create and manage there accounts
* Supervisors should be able to assign tasks to students, grade and comment on the performance of each task
* Student should write weekly reports and submit them to their assesses after there approved by the supervisor
* Supervisor should be able to communicate with the student assessor via chat
* Supervisor should also be able to view the students progress on the platform
## Project Design
### Architecture
MVC (Model-View-Controller) is an `architectural design pattern` that encourages improved `application organization` through
a `separation of concerns`. It divides an interactive application into `three components`: `Model` / `View` and `Controller`.
It enforces the isolation of business data (Models) from user interfaces (Views), with a third component (Controllers)
traditionally managing logic, user-input and coordinating both the models and views. The goal of MVC is to help structure
the `separate the concerns` of an application into `three parts`:
<div align="center">
<img src="images/MVC3.png" alt="architecture Diagram" >
</div>
1. `Model`
* The model is the layer that keeps data for the application. The layer is responsible for storing and retrieving data
from the database, and it is also responsible for validating the data.
> For example, if you want to create a new user, you will have to create a new user model and save it to the database.
2. `View`
* It is the layer used to present the application. It is used to display the data to the end-user.
> For instance, if you want to create a user view, you will have to create UI components that the user interacts with, such as a login form in an easy-to-understand format.
3. `Controller`
* The controller is the logic layer of the application. It is responsible for processing the user’s request and generating the response. It links the view and the model.
### MVC Sequence Diagram
Suppose an application that let you search for persons. The UI must have a `text field` where the user can enter a `search
string`, and it might have a button to start the search. Finally, it must have an area where the search `results are displayed`.
In our case, it is implemented with a `list component`.
The `Search for Persons` use case Scenario is:
* The user enters a search string in the text field
* The user clicks the search button.
* The search result is displayed in the result list.
<div align="center">
<img src="images/mvc-sequence-diagram-example-1.png" alt="sequence diagram">
</div>
> The sequence diagram above shows how the user’s button click moves through the application until the result gets finally
displayed in the list component.
### UML Diagram
<div align="center">
<img src="images/portal3.png" alt="UML Diagram">
</div>
> Above is the UML design of the system including relationships between the difference objects that make up the system
### Built With
Used `PHP`, `JavaScript`, `HTML`, `CSS` and `MySQL`.
<div>
<a href="https://php.net/" title="PHP"><img src="https://github.com/get-icon/geticon/raw/master/icons/php.svg" alt="PHP" width="40px" height="40px"></a>
<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript" title="JavaScript"><img src="https://github.com/get-icon/geticon/raw/master/icons/javascript.svg" alt="JavaScript" width="40px" height="40px"></a>
<a href="https://www.w3.org/TR/html5/" title="HTML5"><img src="https://github.com/get-icon/geticon/raw/master/icons/html-5.svg" alt="HTML5" width="40px" height="40px"></a>
<a href="https://www.w3.org/TR/CSS/" title="CSS3"><img src="https://github.com/get-icon/geticon/raw/master/icons/css-3.svg" alt="CSS3" width="40px" height="40px"></a>
<a href="https://dev.mysql.com/" title="MySQL"><img src="https://github.com/get-icon/geticon/raw/master/icons/mysql.svg" alt="MySQL" width="40px" height="40px"></a>
</div>
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- GETTING STARTED -->
## Getting Started
### Prerequisites
You should have the below software installed in your pc :
* PHP 8
* xampp 8
* MySQL
* and your preferred IDE or text editor
### Installation
1. Get a free API Key at [https://github.com/settings/tokens](https://github.com/settings/tokens)
2. Clone the repo
```sh
git clone https://github.com/kudzaiprichard/online-assessment-portal
```
3. Make sure you copy the project to
```
c:/xampp/htdocs
```
4. Open project in IDE or text editor
5. Run xampp and start apache and mysql
6. Create and import database in php my admin
> NB: To run the system, open desired browser and on the url bar write
```
localhost/system-folder-name
```
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!--CONTRIBUTING-->
## Contributing
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
### :fire: Contribution
Your contributions are always welcome and appreciated. Following are the things you can do to contribute to this project.
1. **Report a bug** <br>
If you think you have encountered a bug, and I should know about it, feel free to report it [here]() and I will take care of it.
2. **Request a feature** <br>
You can also request for a feature [here](), and if it will viable, it will be picked for development.
3. **Create a pull request** <br>
It can't get better than this, your pull request will be appreciated by the community. You can get started by picking up any open issues from [here]() and make a pull request.
> If you are new to open-source, make sure to check read more about it [here](https://www.digitalocean.com/community/tutorial_series/an-introduction-to-open-source) and learn more about creating a pull request [here](https://www.digitalocean.com/community/tutorials/how-to-create-a-pull-request-on-github).
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- LICENSE -->
## License
> Distributed under the MIT License. See `LICENSE.txt` for more information.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- CONTACT -->
## Contact
> Kudzai P Matizirofa - [linkedin.com/in/kudzai-prichard](https://linkedin.com/in/kudzai-prichard) - <kudzaiprichard@gmail.com>
Project Link: [https://github.com/kudzaiprichard/online-assessment-portal](https://github.com/kudzaiprichard/online-assessment-portal)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- ACKNOWLEDGMENTS -->
## Acknowledgments
list of resources I found helpful and would like to give credit to.
* [Choose an Open Source License](https://choosealicense.com)
* [MVC Framework - Introduction](https://www.tutorialspoint.com/mvc_framework/mvc_framework_introduction.htm)
* [PHP Documentation](https://www.php.net/docs.php)
* [GitHub Pages](https://pages.github.com)
* [MySql docs](https://dev.mysql.com/doc/)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
| Online student assessment portal with PHP | architecture,bootstrap,css,html,javascript,mvc,mvc-architecture,mysql,oop,oop-principles | 2023-03-19T22:27:52Z | 2023-10-14T21:53:36Z | null | 1 | 0 | 12 | 0 | 0 | 7 | null | NOASSERTION | PHP |
patreeceeo/hot_mod | main | # hot_mod
https://user-images.githubusercontent.com/578371/224897357-0119a373-5f50-4b46-b3de-5f158d7c8591.mp4
An ESM-HMR client and server, allowing for hot-reloading client-side (and maybe server-side? untested) ESModules, as described by https://github.com/FredKSchott/esm-hmr.
## Usage with Deno
These modules are published at https://deno.land/x/hot_mod
In each client-side module:
```javascript
import { useClient } from "hot_mod/dist/client/mod.js";
useClient(import.meta);
// The following is just my best idea so far of how to write hot-reloadable modules :)
export const hotExports = {
// Add more identifiers here
drawPlayers // example
}
if (import.meta.hot) {
import.meta.hot.accept([], ({ module }) => {
for(const key of Object.keys(hotExports) as Array<keyof typeof hotExports>) {
hotExports[key] = module.hotExports[key]
}
});
}
// In app code, write hotExports.drawPlayers() instead of drawPlayers()
```
`import.meta.hot` will available in development (well, as long as serving from localhost. I mean to support some kind of configuration or environment variables for deciding when HMR should be enabled.)
Then, in the dev server, import the HMR engine and wire it up:
```typescript
import { serve } from "http";
import { relative } from "path";
import { debounce } from "async";
import { EsmHmrEngine } from "hot_mod/src/server/mod.ts";
interface ModuleEventHandler {
(paths: IterableIterator<string>): void;
}
let listenerCount = 0;
const modifiedModuleUrls = new Set<string>();
async function addModuleEventHandler(
handler: ModuleEventHandler,
absPaths: Array<string>,
) {
const watcher = Deno.watchFs(absPaths, { recursive: true });
const debouncedListener = debounce(() => {
const copy = new Set(modifiedModuleUrls);
handler(copy.values());
modifiedModuleUrls.clear();
}, 200);
listenerCount++;
console.log(
`Module event handler #${listenerCount} for ${absPaths.join(", ")}`,
);
for await (const event of watcher) {
if (event.kind === "modify") {
for (const path of event.paths) {
// These strings must correspond to those created on the client:
// The pathname to the full URL to the module subject to hot reloading,
// e.g. new URL(import.meta.url).pathname;
const moduleId = "/" + relative(Deno.cwd(), path);
modifiedModuleUrls.add(moduleId);
}
}
if (modifiedModuleUrls.size > 0) {
debouncedListener();
}
}
}
const engine = new EsmHmrEngine((emitModuleModifiedEvent) => {
addModuleEventHandler((paths) => {
for (const path of paths) {
emitModuleModifiedEvent(path);
}
}, [Deno.cwd() + "/public"]);
});
serve((request) => {
const { socket, response } = Deno.upgradeWebSocket(request);
engine.addClient(socket);
return response;
}, { port: 12321 });
```
And run it with:
```sh
deno run --allow-net --allow-read --watch "path/to/dev_server.ts"
```
## API
See https://github.com/FredKSchott/esm-hmr
## Contributing
GitHub issues and pull requests welcome!
| HMR for ES Modules | deno,developer-tools,esm,esmodules,hmr,hot-module-replacement,javascript,typescript,rapid-development,rapid-prototyping | 2023-03-12T02:42:43Z | 2023-03-19T23:21:48Z | null | 1 | 0 | 34 | 2 | 0 | 7 | null | null | TypeScript |
Rayzaleew/chatbot | master | # [ChatBot]
**Simple chatbot implementation using OpenAI API**
---
## Overview
What's ready?
* Understanding and responding to any text prompt
* Storing messages in database and remembering context of dialogue
* Responsive user interface
* This applications provides basic API, which means you can customize frontend as much as you want without changing logic of backend
**Below**: *Screenshot of the project*
![Screenshot][image]
## Requirements
* Python 3.6+
* Django 3.1+
* djangorestframework 3.12+
* python-dotenv
* openai
I **highly recommend** using the latest patch release of all these packages.
## Installation
--> First of all, clone this repository:
git clone https://github.com/Rayzaleew/chatbot
--> Move into the directory where we have the project files :
cd chatbot
--> Create a virtual environment :
```bash
# Let's install virtualenv first
pip install virtualenv
# Then we create our virtual environment
virtualenv env #or python -m virtualenv if you're using Windows
```
--> Activate the virtual environment :
```bash
env\scripts\activate #or env\Scripts\activate.bat if you're using Windows
```
--> Install the requirements :
```bash
pip install -r requirements.txt
```
## Database configuration
--> Change name of the chatbot/.env.sample file to chatbot/.env and specify data of your database. For example:
```
SECRET_KEY = 'some-secret-key'
OPENAI_API_KEY = 'YOUR-API-KEY' #specify your OpenAI API key, that you can get on https://platform.openai.com/account/api-keys
#DATABASES
ENGINE = 'django.db.backends.sqlite3'
NAME = 'chat.db'
```
*For detailed explanation of how to connect to specific SQL database visit [Django documentation][django-docs]*
--> Apply migrations to your database:
```bash
python manage.py makemigrations
python manage.py migrate
```
--> Create superuser:
python manage.py createsuperuser
#
## Running development server
--> To run the ChatBot, use :
```bash
python manage.py runserver
```
> ⚠ Then, the development server will be started at http://127.0.0.1:8000/
## Deployment
You can use nginx + gunicorn (Linux) or mod_wsgi + Apache (Windows) to deploy this application.
Don't forget change DEBUG option to False in settings.py and collect all static files to one place:
python manage.py collectstatic
## *To-Do:*
* Create DockerFile for fast deployment
* ~Add public registration and replace login template~
* Add support for different dialogues (it's only one room for now)
* Optimise storing messages and context of dialogue (it's just adding previous messages to current prompt)
* Improve user interface
[demo]: https://chat.w3b.dedyn.io/chat
[image]: https://user-images.githubusercontent.com/104368253/226906808-c055a331-4d33-44db-817b-27b47e191d7d.png
[django-docs]: https://docs.djangoproject.com/en/4.1/ref/databases/
| Chatbot based on gpt3.5 built using Django and REST framework | api,django,django-rest-framework,gpt-3,javascript,gpt | 2023-03-21T12:45:37Z | 2023-03-24T12:05:11Z | null | 1 | 0 | 14 | 0 | 0 | 7 | null | null | Python |
ankitt26/Portfolio-setup | develop | <a name="readme-top"></a>
<!--
HOW TO USE:
This is an example of how you may give instructions on setting up your project locally.
Modify this file to match your project and remove sections that don't apply.
REQUIRED SECTIONS:
- Table of Contents
- About the Project
- Built With
- Live Demo
- Getting Started
- Authors
- Future Features
- Contributing
- Show your support
- Acknowledgements
- License
OPTIONAL SECTIONS:
- FAQ
After you're finished please remove all the comments and instructions!
-->
<div align="center">
<!-- You are encouraged to replace this logo with your own! Otherwise you can also remove it. -->
<!-- <img src="murple_logo.png" alt="logo" width="140" height="auto" /> -->
<h2>Ankit</h2>
<br/>
<h3><b> Portfolio-setup </b></h3>
</div>
<!-- TABLE OF CONTENTS -->
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#triangular_flag_on_post-deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ (OPTIONAL)](#faq)
- [📝 License](#license)
<!-- PROJECT DESCRIPTION -->
# 📖 [Portfolio-setup ] <a name="about-project"></a>
**[Portfolio-setup ]** is a Html and Css based project
## 🛠 Built With <a name="built-with"></a>
1- HTML.
2- CSS.
3- Linters
### Tech Stack <a name="tech-stack"></a>
<details>
<summary>Client</summary>
<ul>
<li><a href="https://reactjs.org/">HTML</a></li>
<li><a href="https://reactjs.org/">CSS</a></li>
<li><a href="https://reactjs.org/">Javascript</a></li>
</ul>
</details>
<!-- Features -->
### Key Features <a name="key-features"></a>
-added index.html file
-added styles.css file
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- LIVE DEMO -->
## 🚀 Live Demo <a name="live-demo"></a>
> https://ankitt26.github.io/Portfolio-setup/
<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
1. Web browser
2. Code editor.
3. git-smc.
### Setup
Clone this repository to your desired folder:
Run this command
```sh
cd my-project
git clone https://github.com/ankitt26/Portfolio-setup.git
```
--->
### Install
Install this project with:
<!--
Example command:
```sh
cd my-project
npm install
```
--->
### Usage
To run the project, execute the following command:
Open index.html using live server extension
### Run tests
coming soon
### Deployment
https://ankitt26.github.io/Portfolio-setup/
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- AUTHORS -->
## 👥 Authors <a name="authors"></a>
👤 **Ankit**
- GitHub: [@githubhandle](https://github.com/ankitt26)
- Twitter: [@twitterhandle](https://twitter.com/ankit26k)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/ankit26k/)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- FUTURE FEATURES -->
## 🔭 Future Features <a name="future-features"></a>
- [ ] Add javascript
- [ ] Add links
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- CONTRIBUTING -->
## 🤝 Contributing <a name="contributing"></a>
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- SUPPORT -->
## ⭐️ Show your support <a name="support"></a>
If you like this project give it a star
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- ACKNOWLEDGEMENTS -->
## 🙏 Acknowledgments <a name="acknowledgements"></a>
I would like to thank Microverse
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- LICENSE -->
## 📝 License <a name="license"></a>
This project is [MIT](./LICENSE) licensed.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
| Portfolio setup a project to showcase your skills, achievements, and projects to clients, employers, or collaborators to learn more about your work and accomplishments. | css,html,javascript | 2023-03-23T15:20:20Z | 2023-11-20T08:32:13Z | null | 6 | 20 | 133 | 0 | 0 | 7 | null | MIT | JavaScript |
Huniko519/ChatGPT-VsCode-Extension | master | <p>
Hi everyone - Thank you for your interest in this extension.
<a href="https://github.com/Huniko519/ChatGPT-Extension-Vsix">Extension Resource</a>.
</p>
| 🗣 ChatGPT Extension | ai,chatgpt,javascript,openai,typescript,vscode-extension | 2023-03-20T01:44:42Z | 2023-03-20T01:26:39Z | null | 1 | 0 | 1 | 0 | 1 | 7 | null | ISC | TypeScript |
euyogi/Problems-CS50x | main | # Problems-CS50x
<img alt="Header" width=100% src="https://capsule-render.vercel.app/api?type=waving&color=b03955&height=100§ion=header">
* <h2>Week 0: Scratch</h3>
* <h3>Problem Set 0:</h3>
* <a href="https://scratch.mit.edu/projects/779404799">Scratch Project</a>
* <h2>Week 1: C</h2>
* <h3>Lab 1:</h3>
* <a href="population">Population</a>
* <h3>Problem Set 1:</h3>
* <a href="hello">Hello</a>
* <a href="mario/less">Mario Less</a>
* <a href="mario/more">Mario More</a>
* <a href="cash">Cash</a>
* <a href="credit">Credit</a>
* <h2>Week 2: Arrays</h2>
* <h3>Lab 2:</h3>
* <a href="scrabble">Scrabble</a>
* <h3>Problem Set 2:</h3>
* <a href="readability">Readability</a>
* <a href="bulbs">Bulbs</a>
* <a href="caesar">Caesar</a>
* <a href="substitution">Substitution</a>
* <s>Wordle50</s> <- 2023 Only
* <h2>Week 3: Algorithms</h2>
* <h3>Lab 3:</h3>
* <a href="sort">Sort</a>
* <h3>Problem Set 3:</h3>
* <a href="plurality">Plurality</a>
* <a href="runoff">Runoff</a>
* <a href="tideman">Tideman</a>
* <h2>Week 4: Memory</h2>
* <h3>Lab 4:</h3>
* <a href="smiley">Smiley</a>
* <a href="volume">Volume</a>
* <h3>Problem Set 4:</h3>
* <a href="filter-less">Filter Less</a>
* <a href="filter-more">Filter More</a>
* <a href="recover">Recover</a>
* <a href="reverse">Reverse</a>
* <h2>Week 5: Data Structures</h2>
* <h3>Lab 5:</h3>
* <a href="inheritance">Inheritance</a>
* <h3>Problem Set 5:</h3>
* <a href="speller">Speller</a>
* <h2>Week 6: Python</h2>
* <h3>Lab 6:</h3>
* <a href="world-cup">World Cup</a>
* <h3>Problem Set 6:</h3>
* <a href="sentimental-hello">Hello</a>
* <a href="sentimental-mario-less">Mario Less</a>
* <a href="sentimental-mario-more">Mario More</a>
* <a href="sentimental-cash">Cash</a>
* <a href="sentimental-credit">Credit</a>
* <a href="sentimental-readability">Readability</a>
* <a href="dna">DNA</a>
* <h2>Week 7: SQL</h2>
* <h3>Lab 7:</h3>
* <a href="songs">Songs</a>
* <h3>Problem Set 7:</h3>
* <a href="movies">Movies</a>
* <a href="fiftyville">Fiftyville</a>
* <h2>Week 8: HTML, CSS, JavaScript</h2>
* <h3>Lab 8:</h3>
* <a href="https://github.com/euyogi/Prototipo-Trivia/">Trivia</a>
* <h3>Problem Set 8:</h3>
* <a href="https://github.com/euyogi/Projeto-Homepage/">Homepage</a>
* <h2>Week 9: Flask</h2>
* <h3>Lab 9:</h3>
* <a href="https://github.com/euyogi/Prototipo-Birthdays/">Birthdays</a>
* <h3>Problem Set 9:</h3>
* <a href="https://github.com/euyogi/Projeto-Finance/">Finance</a>
<p align="center">
Problemas/Labs feito por: Yogi Nam de Souza Barbosa
</p>
<img alt="Footer" width=100% src="https://capsule-render.vercel.app/api?type=waving&color=b03955&height=100§ion=footer">
| All problems/labs from CS50’s Introduction to Computer Science solved | 2023,bootstrap,c,course,cs50,cs50x,css,exercise,flask,harvard | 2023-03-16T01:04:56Z | 2024-02-14T03:31:19Z | null | 1 | 0 | 10 | 0 | 3 | 7 | null | null | C |
sanidhyy/jobs-react-native | main | # Job Finder - Find your perfect job
<p align="center">
<img src="/.github/images/img_main.jpeg" alt="A React Native Job Finder App" height="700" title="A React Native Job Finder App" />
</p>
[](https://github.com/Technical-Shubham-tech "Ask Me Anything!")
[](https://github.com/Technical-Shubham-tech/jobs-react-native/blob/main/LICENSE.md "GitHub license")
[](https://github.com/Technical-Shubham-tech/jobs-react-native/commits/main "Maintenance")
[](https://github.com/Technical-Shubham-tech/jobs-react-native/branches "GitHub branches")
[](https://github.com/Technical-Shubham-tech/jobs-react-native/commits "Github commits")
[](https://github.com/Technical-Shubham-tech/jobs-react-native/issues "GitHub issues")
[](https://github.com/Technical-Shubham-tech/jobs-react-native/pulls "GitHub pull requests")
## :pushpin: How to use this App?
1. Make sure [Git](https://git-scm.com "Git") and [NodeJS](https://nodejs.org "NodeJS") are installed.
2. Clone this repository to your local computer.
3. Type and Run `npm install` or `yarn install` to install required packages.
4. Install **Expo Cli** using `npm i -g expo-cli` or `yarn global add expo-cli` to deploy your app on Expo.
5. Create `.env` file in root directory.
6. Contents of `.env`:
```
RAPID_API_KEY=XXXXXXXXXXXXXXXXXXX
```
7. Now, to setup API, go to [Rapid API Website](https://rapidapi.com/ "Rapid API Website") and create an account.
8. Enable this API to fetch job data: [API: JSearch by OpenWeb Ninja](https://rapidapi.com/letscrape-6bRBa3QguO5/api/jsearch "API: JSearch by OpenWeb Ninja").
9. Once project has been set up, you can start this app using `npm start` or `yarn start`.
10. Now app is fully configured and you can start using this app :+1:.
:books: **More Info** related [How to start Expo App](https://www.reactnative.dev/docs/environment-setup "How to start Expo App")
## :camera: Screenshots:
<p align="center">
<img src="/.github/images/img1.jpeg" alt="Job Categories" height="700" title="Job Categories" />
<img src="/.github/images/img2.jpeg" alt="Search various jobs" height="700" title="Search various jobs" />
</p>
<p align="center">
<img src="/.github/images/img3.jpeg" alt="Supports Pagination" height="700" title="Supports Pagination" />
<img src="/.github/images/img4.jpeg" alt="View more about jobs" height="700" title="View more about jobs" />
</p>
<p align="center">
<img src="/.github/images/img5.jpeg" alt="Job Qualifications" height="700" title="Job Qualifications" />
<img src="/.github/images/img6.jpeg" alt="Job Responsibilities" height="700" title="Job Responsibilities" />
</p>
## :gear: Built with
[<img src="https://img.shields.io/badge/JavaScript-323330?style=for-the-badge&logo=javascript&logoColor=F7DF1E" width="150" height="40" />](https://www.javascript.com/ "JavaScript")
[<img src="https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB" width="150" />](https://reactjs.org/ "React JS")
[<img src="https://img.shields.io/badge/React_Native-20232A?style=for-the-badge&logo=react&logoColor=61DAFB" width="150" />](https://www.reactnative.dev/ "React Native")
[<img src="http://ForTheBadge.com/images/badges/built-with-love.svg" alt="Built with Love">](https://github.com/Technical-Shubham-tech "Built with Love")
## :raised_hands: Contribute
You might encounter some bugs while using this app. You are more than welcome to contribute. Just submit changes via pull request and I will review them before merging. Make sure you follow community guidelines.
## Buy Me a Coffee 🍺
[<img src="https://img.shields.io/badge/Buy_Me_A_Coffee-FFDD00?style=for-the-badge&logo=buy-me-a-coffee&logoColor=black" width="200" />](https://www.buymeacoffee.com/sanidhy "Buy me a Coffee")
## :rocket: Follow Me
[](https://github.com/Technical-Shubham-tech "Follow Me")
[](https://twitter.com/intent/tweet?text=Wow:&url=https%3A%2F%2Fgithub.com%2FTechnical-Shubham-tech%2Fmedical-chat-app "Tweet")
[](https://www.youtube.com/channel/UCNAz_hUVBG2ZUN8TVm0bmYw "Subscribe my Channel")
## :star: Give A Star
You can also give this repository a star to show more people and they can use this repository.
## :red_circle: Expo Router Example
Use [`expo-router`](https://expo.github.io/router "expo-router") to build native navigation using files in the `app/` directory.
## :rocket: How to use
```sh
npx create-react-native-app -t with-router
```
## :page_with_curl: Notes
- [Expo Router: Docs](https://expo.github.io/router "Expo Router: Docs")
- [Expo Router: Repo](https://github.com/expo/router "Expo Router: Repo")
- [Request for Comments](https://github.com/expo/router/discussions/1 "Request for Comments")
| Job Finder App using React Native | app,application,css,expo,expo-cli,javascript,js,modern,react,react-native | 2023-03-25T05:02:15Z | 2024-05-20T08:57:13Z | null | 1 | 199 | 242 | 0 | 2 | 7 | null | MIT | JavaScript |
s1owjke/js-bundler-benchmark | master | # JS Bundler Benchmark
Performance benchmark for most popular javascript bundlers in various configurations
- [esbuild](https://esbuild.github.io/)
- [parcel](https://parceljs.org/) (babel + terser)
- [rollup](https://rollupjs.org/) (babel + terser, esbuild, swc)
- [rspack](https://rspack.dev/) (swc)
- [vite](https://vitejs.dev/) (esbuild)
- [webpack](https://webpack.js.org/) (babel + terser, esbuild, swc)
Available test projects (all of them based on React):
- empty project
- project containing five big libraries
- all components from Material UI
- synthetic test with 5000 small components
## Results
All tests were done on a 6-core 2019 MacBook Pro with 16gb of RAM, Mac OS 11.5.2 and Node 16.20.0, production build, no cache, configs are as close as possible
Time in sec (average time for 3 runs)
| | **Empty** | **Libraries** | **Mui** | **Synthetic** |
|-----------------------------|-----------|---------------|---------|---------------|
| **Esbuild** | 0.046 | 0.142 | 0.192 | 0.685 |
| **Parcel: babel + terser** | 3.737 | 11.529 | 8.892 | 57.232 |
| **Rollup: babel + terser** | 3.121 | 13.056 | 9.495 | 37.689 |
| **Rollup: esbuild** | 1.874 | 5.553 | 5.746 | 14.612 |
| **Rollup: swc** | 1.788 | 5.966 | 5.802 | 14.644 |
| **Rspack** | 0.192 | 1.308 | 0.607 | 5.730 |
| **Vite** | 1.418 | 6.632 | 7.957 | 36.735 |
| **Webpack: babel + terser** | 2.471 | 11.529 | 6.406 | 23.889 |
| **Webpack: esbuild** | 0.808 | 3.145 | 2.665 | 8.798 |
| **Webpack: swc** | 0.849 | 4.033 | 2.927 | 9.134 |
Bundle size in KiB
| | **Empty** | **Libraries** | **Mui** | **Synthetic** |
|-----------------------------|-----------|---------------|---------|---------------|
| **Esbuild** | 164.60 | 1239.04 | 607.99 | 1008.50 |
| **Parcel: babel + terser** | 348.28 | 1546.24 | 950.09 | 1351.68 |
| **Rollup: babel + terser** | 157.85 | 1454.08 | 592.64 | 786.78 |
| **Rollup: esbuild** | 163.61 | 1239.04 | 621.77 | 816.58 |
| **Rollup: swc** | 166.95 | 1351.68 | 712.35 | 1064.96 |
| **Rspack** | 167.08 | 1382.40 | 755.95 | 1638.40 |
| **Vite** | 159.97 | 1239.04 | 598.18 | 832.59 |
| **Webpack: babel + terser** | 158.33 | 1464.32 | 593.95 | 868.48 |
| **Webpack: esbuild** | 166.17 | 1617.92 | 613.37 | 891.19 |
| **Webpack: swc** | 163.00 | 1454.08 | 600.74 | 878.15 |
Bundle size after gzip in KiB
| | **Empty** | **Libraries** | **Mui** | **Synthetic** |
|-----------------------------|-----------|---------------|---------|---------------|
| **Esbuild** | 54.75 | 367.50 | 183.51 | 132.16 |
| **Parcel: babel + terser** | 106.91 | 424.13 | 264.39 | 139.05 |
| **Rollup: babel + terser** | 52.81 | 353.12 | 173.57 | 67.34 |
| **Rollup: esbuild** | 54.68 | 368.10 | 185.70 | 84.23 |
| **Rollup: swc** | 54.24 | 368.08 | 190.88 | 93.57 |
| **Rspack** | 54.38 | 376.50 | 199.42 | 140.82 |
| **Vite** | 53.29 | 366.32 | 179.32 | 82.73 |
| **Webpack: babel + terser** | 52.90 | 407.58 | 175.36 | 84.42 |
| **Webpack: esbuild** | 56.04 | 445.32 | 185.35 | 86.71 |
| **Webpack: swc** | 54.49 | 409.35 | 178.29 | 93.34 |
## How to run it
First you must install the npm dependencies (don't forget to install them for each project), after that you can use following commands
- `npm run build:esbuild`
- `npm run build:parcel`
- `npm run build:rollup`
- `npm run build:rspack`
- `npm run build:vite`
- `npm run build:webpack`
Common options
- `--project <string>` project from `./projects` directory
- `--entrypoint <string>` project entry point, default `src/index.tsx`
Rollup and Webpack support various presets
- `--preset <babel|esbuild|swc>` preset used for bundling, default `babel`
Examples
```shell
npm run build:esbuild -- --project react-empty --entrypoint src/index.tsx
npm run build:webpack -- --project react-empty --preset swc --entrypoint src/index.tsx
```
Don't forget to add `--` after npm script to [pass arguments](https://docs.npmjs.com/cli/v6/commands/npm-run-script#description)
| Performance comparison of popular javascript bundlers | benchmark,esbuild,javascript,parcel,performance,rollup,webpack,bundler,typescript,swcpack | 2023-03-14T19:41:30Z | 2023-08-28T17:44:37Z | null | 1 | 2 | 15 | 0 | 0 | 7 | null | MIT | TypeScript |
khanjanov/first-react-app | master | null | first react app | javascript,reactjs,scss,html5 | 2023-03-24T01:16:41Z | 2023-04-03T01:06:32Z | null | 1 | 0 | 9 | 0 | 0 | 7 | null | null | JavaScript |
jaythecree8tor/Walletech | master | # Walletech
A fintech company operating in Nigeria
# 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)
| A fintech company frontend design built with react and tailwind css | banking-applications,fintech-design,javascript,reactjs,responsive-design,single-page-app,taiwindcss,ui-design | 2023-03-17T10:51:02Z | 2023-03-17T10:52:22Z | null | 1 | 0 | 3 | 0 | 1 | 7 | null | null | JavaScript |
ShotMeow/kanban | main | # Kanban Board
This project is a **Kanban board** developed using **TypeScript** and **React**. The purpose of this project is to provide a simple and intuitive way to manage tasks and workflows using the Kanban methodology.
## Features
- Authentication system
- Create, edit, and delete tasks
- Move tasks between columns
- Create independent boards
## Getting Started
To get started with this project, follow these steps:
1. Clone the repository to your local machine.
2. Install the dependencies by running `npm install` or `yarn install` in the project directory.
3. Start the development server by running `npm dev` or `yarn dev`.
4. Open [http://localhost:5173](http://localhost:5173) in your browser to view the app.
## Dependencies
This project uses the following dependencies:
- React: a JavaScript library for building user interfaces.
- React Router: routing library built on top of react.
- TypeScript: a typed superset of JavaScript that compiles to plain JavaScript.
- Redux Toolkit: a Predictable State Container for JS Apps.
- Redux Persist: persist and rehydrate a redux store.
- Firebase: cloud platform for backend.
- Framer Motion: production-ready motion library for React.
- Swiper: the most modern free mobile touch slider with hardware accelerated transitions and amazing native behavior.
- Vite: a build tool that aims to provide a faster and leaner development experience for modern web projects.
- SASS: the most mature, stable, and powerful professional grade CSS extension language in the world.
- TailwindCSS: CSS-framework offering an extensive catalog of classes and tools to facilitate the styling of a website or application.
- Prettier: opinionated code formatter.
- ESLint: statically analyzes your code to quickly find problems.
- Jest: delightful JavaScript Unit Testing Framework with a focus on simplicity.
## Contributing
If you'd like to contribute to this project, please follow these guidelines:
1. Fork the repository and create a new branch.
2. Make your changes and test them locally.
3. Create a pull request with a clear description of your changes.
## Credits
- Developer: Danila 'ShotMeow' Mavrin
- Distributed under [MIT License](https://opensource.org/licenses/MIT)
| Keeping a list of tasks has become even easier | eslint,firebase,framer-motion,javascript,prettier,react,react-router,redux-toolkit,sass,swiper | 2023-03-21T09:29:15Z | 2023-05-05T14:54:14Z | 2023-04-17T12:05:20Z | 1 | 1 | 121 | 0 | 0 | 7 | null | MIT | TypeScript |
JoelDeonDsouza/Spotter | main | # Spotter
## Appendix
A react-native app which Help user feed tools and file into the app, So it can be located back in the time of need.
## Demo
## Run Locally
Clone the project
```bash
git clone https://github.com/JoelDeonDsouza/Spotter.git
```
Go to the project directory
```bash
cd Spotter
```
Install dependencies
```bash
npm install
```
Start the server
```bash
npm run start
```
| Home Stuff finder and feeder Hybrid app built with expo and react native. | expo,expo-router,javascript,npm,react,react-native | 2023-03-17T00:17:26Z | 2023-03-23T05:55:07Z | null | 1 | 2 | 10 | 0 | 2 | 7 | null | MIT | JavaScript |
rmxzyz/random_js | main | # random Javascripts
----------------------
I did not make all of these, credit to the owners of some of the bookmarklets. This is just a storage of (most) of the bookmarklets I have in my folders and some that I made.
# How to install
Copy a bookmarklet that you have, create a bookmark and click "More" then
change the url to the bookmarklet you copied. Click it whenever you want.
Bookmarklets don't work on all websites. Some may have policies, or just don't work.
# What is A bookmarklet?
A bookmarklet is like a bookmark for those websites, but it contains javascript that can be run on the current webpage. They only have one line. if you want to turn javascript into one line, use a javascript compresser then add javascript: infront of the js that was compressed.
javascript:alert("Hello, world!")
# Links
-----------------
More bookmarklets page 1
https://docs.google.com/document/d/1lWIx-PQDRpd3GBmM2TMDs2VKFTzlcpG-eN-p5_FU7w0
----
More bookmarklets page 2
https://docs.google.com/document/d/1WSuXiAgFsh3eg17S5beAFezGV48OXghk7ieEEpUlEUQ
----
Google Drive Files
https://drive.google.com/drive/folders/139QIektdovS5D_XuzxE3T7fzVFPI603pQgIk9vxVxuXAV8hqL4FVR3X_iNcvJU5TNbh5sAB1
----
For drive (untested)
DMG TO EXE 1
https://anyconv.com/dmg-converter/
Other Converter
https://www.converter365.com/archive-converter/rar/rar-to-dmg
| Some bookmarklets. Credit to the owners for some of the bookmarklets. I cannot list all of them because of my brain with terribly bad memory. Some are mine, Some are random ones from the internet.. I have a secondary list here: https://github.com/pmzxyx/random_javascripts | bookmarklet,cheat,fun,javascript,javascript-bookmarklet,javascript-bookmarklets,js,school,school-hacks,troll | 2023-03-17T19:05:24Z | 2023-08-14T18:58:43Z | null | 3 | 3 | 743 | 0 | 5 | 7 | null | null | JavaScript |
BANCUNGUYE66/Festival | main |
<a name="readme-top"></a>
<div align="center">
<br/>
<h3><b>capstone_project</b></h3>
</div>
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#triangular_flag_on_post-deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ (OPTIONAL)](#faq)
- [📝 License](#license)
## 📖 Festival concert website <a name="about-project"></a>
> Building a responsive festival mobile project using HTML/CSS from a Bihance design template
>[Click here for the website video presentation](https://www.loom.com/share/b99799ab89854f1cb83c42aed71acfd4)
<img width="1440" alt="Screenshot 2023-02-09 at 15 26 10" src="https://user-images.githubusercontent.com/111200646/217812517-5b3fb531-09c9-4d27-933d-4b4a457214b6.png">
## 🛠 Built With Figma, VSCode, Bihance and Github <a name="Built With Figma, VSCode, Bihance and Github"></a>
### HTML/CSS, Github and Figma <a name="tech-stack"></a>
>
<details>
<summary>Client</summary>
<ul>
<li><a href="https://reactjs.org/">HTML</a></li>
</ul>
</details>
<details>
<summary>Styling</summary>
<ul>
<li><a href="https://expressjs.com/">CSS</a></li>
</ul>
</details>
<details>
<summary>UI Design</summary>
<ul>
<li><a href="https://www.postgresql.org/">Figma</a></li>
</ul>
</details>
### Key Features <a name="key-features"></a>
- **Responsive Design**
- **Linters integration**
- **Mobile menu functionality with Javascript**
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- LIVE DEMO -->
## 🚀 Live Demo <a name="live-demo">bancunguye66.github.io/Festival/</a>
- [Live Demo Link](https://bancunguye66.github.io/Festival/)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- GETTING STARTED -->
## 💻 Getting Started <a name="getting-started"></a>
> A beginner developer can use this template as a starting point for creating other HTML projects that are properly set up with CSS and have ESLint configured.
### Prerequisites
In order to run this project you need:
- Node
- ESlint set up
- Web template from Bihance
<!--
Example command:
```sh
gem install rails
```
-->
### Setup
Clone this repository to your desired folder:
<br>
<br>gh repo clone https://github.com/BANCUNGUYE66/Festival.git
### Install
Install this project with:
### Usage
To run the project, execute the following command:
- install the server with
```sh
npm install -g serve
```
```sh
serve -s .
```
### Run tests
To run tests, run the following command:
```sh
npx stylelint "**/*.{css,scss}"
```
```sh
npx hint .
```
```sh
npx eslint .
```
<p align="right">(<a href="#readme-top">back to top</a>)</p>
### Deployment
- github pages
<!-- AUTHORS -->
## 👥 BANCUNGUYE66 <a name="authors"></a>
👤 **BANCUNGUYE66**
- GitHub: [@githubhandle](https://github.com/BANCUNGUYE66)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/Aimable-BANCUNGUYE/)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- FUTURE FEATURES -->
## 🔭 Future Features <a name="future-features"></a>
> I'll add the following section to the webpage.
- [ ] **work section**
- [ ] **abaout page**
- [ ] **partners section**
- [ ] **footer section**
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- CONTRIBUTING -->
## 🤝 Contributing <a name="contributing"></a>
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- SUPPORT -->
## ⭐️ Show your support <a name="support"></a>
If you like this project... Kindly leave a star ⭐
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- ACKNOWLEDGEMENTS -->
## 🙏 Acknowledgments <a name="acknowledgements"></a>
> Give credit to everyone who inspired your codebase.
I would like to thank Microverse and my studying partners and Cindy Shin for the amazing UI design.
Original design idea by Cindy Shin in Behance
<img width="1440" alt="Screenshot 2023-02-09 at 15 27 51" src="https://user-images.githubusercontent.com/111200646/217812845-a6c177fc-d2e4-41d0-b5d9-09339ab8d00b.png">
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- FAQ (optional) -->
## ❓ FAQ (OPTIONAL) <a name="faq"></a>
- **Did you intergrate linters to your project**
- Yes
- **[Did you run all the tests**
- Yes
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- LICENSE -->
## 📝 License <a name="license"></a>
This project is [MIT](./LICENSE) licensed.
_NOTE: we recommend using the [MIT license](https://choosealicense.com/licenses/mit/) - you can set it up quickly by [using templates available on GitHub](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository). You can also use [any other license](https://choosealicense.com/licenses/) if you wish._
<p align="right">(<a href="#readme-top">back to top</a>)</p>
| This project is for selling ticket and show the location of concert | css,html,javascript | 2023-03-13T08:52:53Z | 2023-04-04T08:13:37Z | null | 1 | 2 | 28 | 2 | 1 | 7 | null | MIT | CSS |
crimson-projects/text-animation-with-javascript | main | <div align="center">
# Letter Form with JavaScript | Crimson
<img src="admin/base.jpg">
### by <a href="https://github.com/guli2103">Gulbakhor Ergasheva</a>
</div>
| Letter Form with JavaScript | animation,css,javascript,forms | 2023-03-16T23:45:36Z | 2023-03-18T05:05:05Z | null | 3 | 0 | 5 | 0 | 0 | 7 | null | null | JavaScript |
newhoteng/Capstone-1 | main | # :open_book: Capstone-1
This project creates a webpage(home and about page) for a fictional Engineer's Conference. It is based on a design by Cindy Shin in Behance.
See a short [Project Presentation](https://www.loom.com/share/373c078d61c149fe90f650f1c9799c00)
## :hammer_and_wrench: Build With
### Tech Stack
<details><summary>Client</summary>
<ul>
<li><a href="https://html.com/">HTML</a></li>
<li><a href="https://www.w3.org/TR/CSS/#css">CSS</a></li>
</ul>
</details>
### Key Features
- **Mobile Version**
- Home page
- About page
- Hamburger menu
- **Desktop Version**
- Home page
- About page
<p align="right">(<a href="https://github.com/newhoteng/Capstone-1#readme">back to top</a>)</p>
## :rocket: Live Demo
- [Live link](https://newhoteng.github.io/Capstone-1/)
<p align="right">(<a href="https://github.com/newhoteng/Capstone-1#readme">back to top</a>)</p>
## :computer: Getting Started
To get a local copy up and running, follow these steps.<br>
**Prerequisites**<br>
In order to run this project you need:
- Text editor
- GitHub account<br>
**Setup**<br>
Clone this repository to your desired folder:<br>
```
git clone https://github.com/newhoteng/Capstone-1.git
```
**Install**<br>
Install this project with:<br>
```
npm install
```
<p align="right">(<a href="https://github.com/newhoteng/Capstone-1#readme">back to top</a>)</p>
## :busts_in_silhouette: Authors
:bust_in_silhouette: **Harriet Oteng**
- GitHub: [@githubhandle](https://github.com/newhoteng)
- Twitter: [@twitterhandle](https://twitter.com/HarrietOteng1)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/harriet-oteng-75554666/)
<p align="right">(<a href="https://github.com/newhoteng/Capstone-1#readme">back to top</a>)</p>
## :telescope: Future Features
- [x] **Desktop version**
- [ ] **Ticketing page**
- [ ] **Schedule page**
<p align="right">(<a href="https://github.com/newhoteng/Capstone-1#readme">back to top</a>)</p>
## :handshake: Contributing
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/newhoteng/Capstone-1/issues).
<p align="right">(<a href="https://github.com/newhoteng/Capstone-1#readme">back to top</a>)</p>
## :star: Show your support
If you like this project follow me on GitHub.
<p align="right">(<a href="https://github.com/newhoteng/Capstone-1#readme">back to top</a>)</p>
## :pray: Acknowledgements
Original design by Cindy Shin
<p align="right">(<a href="https://github.com/newhoteng/Capstone-1#readme">back to top</a>)</p>
## :memo: License
[License](https://github.com/newhoteng/Capstone-1/blob/main/LICENSE)
<p align="right">(<a href="https://github.com/newhoteng/Capstone-1#readme">back to top</a>)</p>
| A webpage for a fictional Conference that provides relevant information to potential attendees. It is based on a design by Cindy Shin in Behance. It is built with HTML, CSS and JavaScript | css,html5,javascript | 2023-03-16T17:04:21Z | 2023-05-18T04:56:46Z | null | 1 | 6 | 39 | 0 | 0 | 7 | null | MIT | CSS |
redmarverick/Portfolio | main | <a name="readme-top"></a>
<h3><b>My Portfolio</b></h3>
</div>
<!-- TABLE OF CONTENTS -->
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [🚀 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)
- [👥 Author](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)
<!-- PROJECT DESCRIPTION -->
# 📖 My Portfolio <a name="about-project"></a>
**My Portfolio** is a growing project that, as the name describes it, is my portfolio.
## 🛠 Built With <a name="built-with"></a>
### Tech Stack <a name="tech-stack"></a>
- Major languages:
HTML ,
CSS
- Technologies used:
Linters ( Webhint, Stylelint) ,
Github ,
Visual Code
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- LIVE DEMO -->
## 🚀 Live Demo <a name="live-demo"></a>
- [Live Website](https://redmarverick.github.io/Portfolio/)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 💻 Getting Started <a name="getting-started"></a>
To get a local copy up and running with latest features, follow these simple example steps.
Run
git clone https://github.com/redmarverick/Set-up-a--Hello-Microverse--project.git
### Prerequisites
Basic Knowledge of HTML and CSS
### Install
install any editor VScode or Atom.
### Usage
Just a simple html and css made for testing github functionalities.
### Run tests
Open the HTML file on your browser.
### Deployment
You can deploy this project using visual code or github itself on Settings > pages > Deploy from a Branch
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 👥 Authors <a name="authors"></a>
👤 **Nylbert Victor**
- GitHub: [@redmarverick](https://github.com/redmarverick)
- Twitter: [@MarverickRed]("https://twitter.com/MarverickRed)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/nylbert-victor-397951120/)
👤 **Gabriel Rozas**
- GitHub: [@EmiLoKiJu](https://github.com/EmiLoKiJu)
- Twitter: [@GabrielRozas12](https://twitter.com/GabrielRozas12)
- LinkedIn: [grozas](https://www.linkedin.com/in/grozas/)
👤 **Benjamin**
- GitHub: [@githubhandle](https://github.com/BenjaminMatembe)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- FUTURE FEATURES -->
## 🔭 Future Features <a name="future-features"></a>
- [ ] **Working hamburguer menu**
- [ ] **Working carroussel of projects**
<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>
Give a ⭐️ if you like this project!
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- ACKNOWLEDGEMENTS -->
## 🙏 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.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
| This website was built to show my projects, following guidelines provided by microverse. | css,html,javascript | 2023-03-22T15:42:43Z | 2023-04-14T22:07:44Z | null | 3 | 9 | 62 | 2 | 0 | 7 | null | MIT | JavaScript |
Otegaa/IWES-Conference-2023 | main | <a name="readme-top"></a>
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#triangular_flag_on_post-deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ (OPTIONAL)](#faq)
- [📝 License](#license)
# 📖 [IWES conference 2023] <a name="about-project"></a>
- This project is called IWES-Conference-2023. It is based on a conference that is to happen towards the end of this year in Abuja, Nigeria for women all over the world. This project contains all information about the coming conference and the previous ones as well.
**[IWES conference 2023]** is a website that is used to tell women about this program and at the same time invite them for the program.
## 🛠 Built With <a name="HTML and CSS and JS"></a>
### Tech Stack <a name="Front end (Javascript)"></a>
- This is a mobile and desk-top browser responsive website.
<details>
<summary>Client</summary>
<ul>
<li><a href="https://www.w3schools.com/html/">HTML</a></li>
</ul>
<ul>
<li><a href="https://www.w3schools.com/css/">CSS</a></li>
</ul>
<ul>
<li><a href="https://www.w3schools.com/js/">JS</a></li>
</ul>
</details>
### Key Features <a name="key-features"></a>
- **[It is a two paged website ]**
- **[It has a navbar for navigation to the pages]**
- **[There is a join button that when focused on tells you the amount of slots remaining for the program]**
- **[This website is mobile and desktop responsive and this conclusion came from testing it on most devices]**
- **[There is an active class that shows what page you are currently on]**
<p align="right">(<a href="#readme-top">back to top</a>)</p>
🚀 Live Demo
- [Github Pages](https://otegaa.github.io/IWES-Conference-2023/)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## Image view:
## 💻 Getting Started <a name="getting-started"></a>
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
- Git
- An IDE (VsCode, Atom, etc)
### Setup
Clone this repository to your desired folder:
```sh
git clone https://github.com/Otegaa/IWES-Conference-2023.git
cd IWES-Conference-2023
```
### Install
Install this project with:
- npm Install
## 👥 Authors <a name="authors"></a>
👤 **Author1**
- GitHub: [@githubhandle](https://github.com/Otegaa)
- Twitter: [@twitterhandle](https://twitter.com/O_tegaaa)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/blessing-ekiugbo/)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 🔭 Future Features <a name="future-features"></a>
- Create a ticket page for people to buy tickets for program reservations.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 🤝 Contributing <a name="contributing"></a>
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/Otegaa/IWES-Conference-2023/issues).
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## ⭐️ Show your support <a name="support"></a>
If you like this project, please give it a star, and if you would love to tell me ways to improve it, contact me on LinkedIn or Twitter. It will be a pleasure to hear from you.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 🙏 Acknowledgments <a name="acknowledgements"></a>
I would like to thank Microverse community for giving me the guide to building this project.
- The original design of this work is credited to Cindy Shin.
- The Creative license is also credited to (https://www.behance.net/adagio07).
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 📝 License <a name="license"></a>
This project is [MIT](https://github.com/Otegaa/IWES-Conference-2023/blob/main/LICENSE) licensed.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
| This project is based on a conference that is to happen towards the end of 2023, in Abuja, Nigeria for women all over the world. This project contains all information about the coming conference and the previous ones as well. It is built with HTML, CSS and JS. | css3,html,javascript | 2023-03-13T08:26:33Z | 2023-05-29T11:44:19Z | null | 1 | 3 | 39 | 0 | 1 | 6 | null | MIT | CSS |
CodingWithEnjoy/React-GitHub-Profile-Finder | main | <h2 align="center">پیدا کننده اکانت گیتهاب | GitHub Account Finder</h2>
###
<h4 align="center">دمو | Demo 😁<br><br>https://codingwithenjoy.github.io/React-GitHub-Profile-Finder</h4>
###
<p align="left"></p>
###
<p align="left"></p>
###
<div align="center">
<img height="350" src="https://user-images.githubusercontent.com/113675029/226109539-cece5d13-6dea-4f09-b1ea-c50b55291ae8.png" />
</div>
###
<p align="left"></p>
###
<div align="center">
<img height="350" src="https://user-images.githubusercontent.com/113675029/226109519-bfcf6b70-88f6-4532-ace4-5c6128096c8a.png" />
</div>
###
<p align="left"></p>
###
<div align="center">
<img height="350" src="https://user-images.githubusercontent.com/113675029/226109554-db019a81-5021-46ea-8a80-d467f26d31b6.png" />
</div>
###
<p align="left"></p>
###
<p align="left"></p>
###
<div align="center">
<a href="https://www.instagram.com/codingwithenjoy/" target="_blank">
<img src="https://raw.githubusercontent.com/maurodesouza/profile-readme-generator/master/src/assets/icons/social/instagram/default.svg" width="52" height="40" alt="instagram logo" />
</a>
<a href="https://www.youtube.com/@codingwithenjoy" target="_blank">
<img src="https://raw.githubusercontent.com/maurodesouza/profile-readme-generator/master/src/assets/icons/social/youtube/default.svg" width="52" height="40" alt="youtube logo" />
</a>
<a href="mailto:codingwithenjoy@gmail.com" target="_blank">
<img src="https://raw.githubusercontent.com/maurodesouza/profile-readme-generator/master/src/assets/icons/social/gmail/default.svg" width="52" height="40" alt="gmail logo" />
</a>
<a href="https://twitter.com/codingwithenjoy" target="_blank">
<img src="https://raw.githubusercontent.com/maurodesouza/profile-readme-generator/master/src/assets/icons/social/twitter/default.svg" width="52" height="40" alt="twitter logo" />
</a>
</div>
###
<p align="left"></p>
###
<h4 align="center">توسعه داده شده توسط برنامه نویسی با لذت</h4>
###
| پیدا کننده اکانت گیتهاب | GitHub Account Finder 👋😉🤩 | api,css,daily,daisyui,fetch,fetch-api,github,github-api,html,javascript | 2023-03-15T07:20:05Z | 2023-04-13T09:05:21Z | null | 1 | 0 | 3 | 0 | 1 | 6 | null | MIT | JavaScript |
sapomaro/yandex-algorithm-training-3b-js | main | # Прохождение [Тренировок по алгоритмам 3.0 от Яндекса](https://yandex.ru/yaintern/algorithm-training), дивизион B (JavaScript / NodeJS), февраль-март 2023 г.
## Всего решено 40 задач, охватывающих следующие темы:
- Стеки
- Очереди, деки и приоритетные очереди
- Динамическое программирование с одним параметром
- Динамическое программирование с двумя параметрами
- Обход графов в глубину
- Обход графов в ширину
| Мои решения задач от Тренировок по алгоритмам 3.0 (дивизион B) от Яндекса (JavaScript / NodeJS) | algorithms,javascript,nodejs,yandex,yandex-algorithm,yandex-algorithm-trainings,yandex-contest | 2023-03-13T19:23:59Z | 2023-05-27T05:28:32Z | null | 1 | 0 | 6 | 0 | 2 | 6 | null | null | JavaScript |
krutoo/fetch-tools | main | # fetch-tools
Set of utilities for JS [fetch](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API/Using_Fetch) function.
## Goals
- do not change `fetch` behavior, just add some features
- ability to run in browser, Node.js, Deno, Bun, WinterJS (...any runtime that implements Fetch API)
- zero dependencies
## Installation
```bash
# in Node.js
npm add @krutoo/fetch-tools
# in Node.js via yarn
yarn add @krutoo/fetch-tools
# in Bun
bun add @krutoo/fetch-tools
```
## Usage
Creating fetch with some extra features.
```ts
import { configureFetch, applyMiddleware } from '@krutoo/fetch-tools';
import { validateStatus, defaultHeaders, log } from '@krutoo/fetch-tools/middleware';
// configure your own fetch...
const myFetch = configureFetch(
fetch,
applyMiddleware(
// validate status (like in axios)
validateStatus(status => status >= 200 && status < 300),
// add default headers
defaultHeaders({
'user-agent': 'test',
}),
// log request stages (before request, after response, on catch)
log({
onCatch: ({ error }) => console.error(error),
}),
),
);
// ...and using it like normal fetch
myFetch('posts/1')
.then(res => res.json())
.then(data => console.log(data));
```
## Middleware
Middleware are just functions and you can write your own.
```ts
async function myMiddleware(request, next) {
try {
// [do something before request here]
const response = await next(request);
// [do something after response here]
return response;
} catch (error) {
// [do something on error here but don't forget throw error or return response]
throw error;
}
}
```
## Builtin middleware
### `validateStatus`
Returns a middleware that will validate status.
```ts
import { configureFetch, applyMiddleware } from '@krutoo/fetch-tools';
import { validateStatus } from '@krutoo/fetch-tools/middleware';
const myFetch = configureFetch(
fetch,
applyMiddleware(
// fetch promise will be rejected when status is not valid
validateStatus(status => status >= 200 && status < 300),
),
);
```
### `defaultHeaders`
Returns a middleware that will set default headers to request.
```ts
import { configureFetch, applyMiddleware } from '@krutoo/fetch-tools';
import { defaultHeaders } from '@krutoo/fetch-tools/middleware';
const myFetch = configureFetch(
fetch,
applyMiddleware(
// all requests will contain declared headers
defaultHeaders({ 'user-agent': 'spy' }),
),
);
```
### `log`
Returns a middleware that will log phases by handler.
```ts
import { configureFetch, applyMiddleware } from '@krutoo/fetch-tools';
import { log } from '@krutoo/fetch-tools/middleware';
const myFetch = configureFetch(
fetch,
applyMiddleware(
// each phase of request will be logged
log({
onRequest({ request }) {
console.log(request);
},
onResponse({ request, response }) {
console.log(response);
},
onCatch({ request, error }) {
console.error(error);
},
}),
),
);
```
### `proxy`
Returns simple proxy middleware. Useful for servers based on Fetch API.
```ts
import { applyMiddleware } from '@krutoo/fetch-tools';
import { proxy } from '@krutoo/fetch-tools/middleware';
const enhance = applyMiddleware(
proxy({
// pathname(s) of incoming request URL which will be proxied
filter: ['/api/v2/', '/api/v3/'],
// define target URL
target: 'https://www.my-site.com/',
}),
);
Deno.serve(
enhance(req => {
return new Response('<h1>Main page</h1>');
}),
);
```
## Server utilities
You can use utils for simply configure your HTTP server.
### In Deno
```ts
import { router } from '@krutoo/fetch-tools';
const handler = router
.builder()
.get('/', () => new Response('Home page'))
.put('/about', () => new Response('About page'))
.post('/news', () => new Response('News page'))
.all('/stats', () => new Response('Some stats'))
.build();
await Deno.serve({
port: 8080,
handler: handler,
});
```
### In Bun
```ts
import { router } from '@krutoo/fetch-tools';
const handler = router
.builder()
.get('/', () => new Response('Home page'))
.put('/about', () => new Response('About page'))
.post('/news', () => new Response('News page'))
.all('/stats', () => new Response('Some stats'))
.build();
Bun.serve({
port: 8080,
fetch: handler,
});
```
### In Node.js (`node:http` or `express`)
Currently there is no builtin server implementation based on Fetch API in Node.js.
It is possible to use _adapter_ for `node:http` or `express` from [@whatwg-node/server](https://www.npmjs.com/package/@whatwg-node/server).
```ts
import { router } from '@krutoo/fetch-tools';
import { createServer } from 'node:http';
import { createServerAdapter } from '@whatwg-node/server';
const handler = router
.builder()
.get('/', () => new Response('Home page'))
.put('/about', () => new Response('About page'))
.post('/news', () => new Response('News page'))
.all('/stats', () => new Response('Some stats'))
.build();
const server = createServer(createServerAdapter(handler));
server.listen(8080);
```
### Middleware for servers
You can use middleware for server handlers too:
```ts
import { router, applyMiddleware } from '@krutoo/fetch-tools';
import { log } from '@krutoo/fetch-tools/middleware';
const enhance = applyMiddleware(
log({
onCatch: ({ error }) => console.error(error),
}),
);
const handler = router
.builder()
.get('/', () => new Response('Home page'))
.put('/about', () => new Response('About page'))
.post('/news', () => new Response('News page'))
.all('/stats', () => new Response('Some stats'))
.build();
Bun.serve({
port: 8080,
fetch: enhance(handler), // just wrap handler to enhancer for apply middleware
});
```
### Working with HTTP cookie on server
Cookies can be used in different ways on the server.
### Browser like behavior
If you want to imitate browser behavior as much as possible in terms of working with cookies, you can use `@krutoo/fetch-tools` together with `fetch-cookie`.
To use **fetch-cookie** as an middleware, follow [these](https://github.com/valeriangalliat/fetch-cookie/issues/79#issuecomment-1672188226) instructions.
### Microfrontends
Server part of the microfrontend can make requests to some HTTP API on behalf of the user, sending his cookies in requests.
In this case you can use just `defaultHeaders` middleware:
```js
import { configureFetch, applyMiddleware } from '@krutoo/fetch-tools';
import { defaultHeaders } from '@krutoo/fetch-tools/middleware';
// example of server handler
async function handler(request: Request) {
const myFetch = configureFetch(
fetch,
applyMiddleware(
// forward cookie from incoming request to all outgoing requests
defaultHeaders({ cookie: request.headers.get('cookie') }),
),
);
// this request will contain cookies from the incoming request
const orders = await myFetch('http://something.com/api/user/orders').then(res => res.json());
return new Response(JSON.stringify({ orders }), { 'content-type': 'application/json' });
}
```
## To do
- JWT middleware
- ~~retry middleware~~
- ~~ability to use with Bun's `Bun.serve` and Deno's `serve` from `std/http`~~
| Set of utilities for JS Fetch API | axios,bun,deno,fetch,javascript,nodejs,typescript,http,middleware,fetch-tool | 2023-03-17T10:59:24Z | 2024-05-14T03:33:45Z | 2024-04-19T12:55:40Z | 1 | 7 | 81 | 0 | 0 | 6 | null | Apache-2.0 | TypeScript |
Silent-Watcher/random-user-profile- | master |
# Random profile finder
a simple project that creating random user profiles using api calls
## Demo 🤗
https://user-profile-finder.pages.dev/
## Run Locally
```bash
git clone shorturl.at/pxBN3
cd random-user-profile-
```
Install dependencies
```bash
npm install
yarn install
```
Start the server
```bash
npm run dev
```
## Screenshots
## License
[MIT](https://choosealicense.com/licenses/mit/)
| a simple project that creating random user profiles using api calls | api,css3,html5,javascript,random-user-generator-api,trends,vitejs | 2023-03-18T17:19:23Z | 2023-03-24T06:46:17Z | null | 1 | 0 | 13 | 0 | 0 | 6 | null | MIT | SCSS |
SobrancelhaDoDragao/Sistema-Biblioteca | master | <div align="center">
<img src="https://github.com/SobrancelhaDoDragao/Sistema-Biblioteca/blob/Alpha-3.0/biblioteca/public/img/meninoLendo.png" alt="Menino lendo um livro na lua" width="200">
</div>
<h1 align="center">Sistema Biblioteca</h1>
<h3 align="center">Gereciamento de livros, empréstimos e acervo de biblioteca</h3>
<div align="center">
</div>
<h4 align="center">Status: em progresso</h4>
<div align="center">
<img src="https://github.com/SobrancelhaDoDragao/Sistema-Biblioteca/blob/master/screenshots/aprensentacao2.gif">
</div>
-----------------------------------------------------------------------------------------------------------------
1. [Sobre](#sobre)
2. [Funcionalidades](#funcionalidades)
3. [Tecnologias usadas](#tecnologias-usadas)
4. [Banco de dados](#banco-de-dados)
5. [End-points da api](#end-points-da-api)
6. [Testes](#testes)
7. [Instalação](#instalação)
8. [Licensa](#licensa)
## Sobre
Este projeto tem como objetivo criar uma aplicação web completa para gerenciar o acervo, empréstimos e devoluções de livros em uma biblioteca. A aplicação conta com funcionalidades de login cadastro de usuários, cadastro de livros e bibliotecários.
Durante o meu aprendizado em Vue.js, percebi que o Vue.js carrega a página em branco antes de carregar o JavaScript e, consequentemente, o conteúdo da página. Após pesquisar sobre soluções para este problema, descobri o Server Side Rendering (SSR). Decidi utilizar o Nuxt, um framework baseado em Vue, para facilitar a renderização no lado do servidor e aplicar meus novos conhecimentos.
## Funcionalidades
- [x] Cadastro de usuários e bibliotecários
- [x] Autenticação de usuários e bibliotecários com JWT (JSON Web Token)
- [x] Gerenciamento de livros (adicionar, remover, editar e visualizar)
- [x] Gerenciamento de empréstimos (adicionar, remover, editar e visualizar)
- [x] Gerenciamento de arquivos de imagens para livros e fotos de usuários
- [x] Hierarquia de funcionalidades: a edição de livros e empréstimos é permitida apenas para administradores, enquanto os usuários comuns têm acesso a requisições seguras, como GET, HEAD e OPTIONS.
- [x] Responsividade
- [ ] Pesquisa de livros e empréstimos
## Tecnologias usadas
- Front-End
- Nuxt
- Vue.js
- Javascript
- Html
- CSS
- Pinia
- Back-End
- Python
- Django rest framework
- uWsgi
- Nginx
- SqlLite (Pretendo trocar no futuro para o Postgresql)
## Banco de dados
### Diagrama do banco de dados relacional
<img src="https://github.com/SobrancelhaDoDragao/Sistema-Biblioteca/blob/master/screenshots/diagrama_banco.png" alt="Diagrama do banco de dados">
### End-points da Api
#### Cadastro de usuario
- <code>POST /cadastro/</code> End-poit para cadastro de usuario
#### Autenticação JWT(JSON Web Token)
- <code>POST /token/</code> Para efetuar o login
- <code>POST /token/refresh/ </code> End-point para renovar o tokens
- <code>POST /VerifyAuthenticated/</code> End-point para verificar se o usuarios está autenticado
#### User autenticado
##### Permissões: Apenas usuarios autenticados.
- <code>GET /user/</code> Retorna dados do usuario autenticado do request
- <code>PUT /user/{id}/</code> Para editar dados do usuario autenticado do resquest
- <code>PATCH /user/{id}/</code>Para editar parcialmente dados do usario autenticado do resquest
- <code>DELETE /user/{id}/</code> Para deletar usuario logado
#### Gerenciamento de usuarios
##### Permissões: Apenas usuarios admins tem acesso.
- <code>GET /all_users/</code> Para visualizar todos os usuarios do sistema
- <code>POST /all_users/</code> Para cadastro de um novo usuario
- <code>GET /all_users/{id}/</code> Para recuperar um usuario pelo id
- <code>PUT /all_users/{id}/</code> Para alterar dados de um usuario
- <code>PATCH /all_users/{id}/</code> Para alterar parcialmente dados de um usuario
- <code>DELETE /all_users/{id}/</code> Para deletar um usuario
#### Livros
##### Permissões: Cadastro, editar, excluir permitido apenas para admins. Usuarios comum permitdo apenas visualização.
- <code>GET /livros/</code> Para visualizar todos os livros
- <code>POST /livros/</code> Para cadastrar um novo livro
- <code>GET /livros/{id}/</code> Para recuperar um livro pelo id
- <code>PUT /livros/{id}/</code> Para editar dados de um livro
- <code>PATCH /livros/{id}/</code> Para editar parcialmente dados de um livro
- <code>DELETE /livros/{id}/</code> Para deletar um livro
- <code>GET /novoslivros/</code> Retorna os cinco ultimos livros retornado pelo sistema
- <code>GET /recomendacao/</code> Retorna cinco livros aleatorios
#### Empréstimo
##### Permissões: Cadastro, editar, excluir permitido apenas para admins. Usuarios comum permitdo apenas visualização.
- <code>GET /emprestimos/</code> Para todos visualizar emprestimos do sistema
- <code>POST /emprestimos/</code> Para cadastrar um novo emprestimo
- <code>GET /emprestimos/{id}/</code> Para recuperar um emprestimo especifico
- <code>PUT /emprestimos/{id}/</code> Para editar um emprestimo
- <code>PATCH /emprestimos/{id}/</code> Para editar parciamente um emprestimo
- <code>DELETE /emprestimos/{id}/</code> Para deletar em emprestimo
- <code>GET /usuarios/{id}/emprestimos/</code> Retorna todos os emprestimos relacionado ao usuario
## Estrutura do servidor / Projeto
Em andamento
## Testes
Para executar testes unitários entre na pasta ApiBiblioteca e digite o comando:<code>python manage.py test</code>
## Instalação
### Requisitos
- Python 3.11.4
- Venv
- Pip
- Node 18.16.0
### Instalação Front-End
1. Entre na pasta <code>biblioteca</code> pelo terminal.
2. Instale as dependências com o comando <code>npm install</code> .
3. Crie um arquivo .env para configurar a url do servidor, e adicione a seguinte linha no arquivo. <code>NUXT_PUBLIC_API_BASE_URL = "http://127.0.0.1:8000/"</code> Essa linha poderá mudar dependendo do seu computador.
4. Para inciar o servidor: <code>npm run dev</code>.
### Instalação Back-end
1. Entre na pasta <code>ApiBiblioteca</code> pelo terminal
2. Digite: <code>python -m venv env</code>, para criar um ambiente virtual para instalar as bibliotecas
3. Ative o ambiente virtual: <code>source env/bin/activate</code>
4. Agora digite: <code>pip install -r requirements.txt</code>, para instalar as bibliotecas
5. E finalmente rode o projeto:<code>python manage.py runserver</code>
6. Para cadastrar 55 livros apartir do backup <code>python manage.py loaddata livros_backup.json</code>
## Licensa
[MIT](https://github.com/SobrancelhaDoDragao/Sistema-Biblioteca/blob/master/LICENSE.md)
| Um sistema para gerenciar livros e emprestimos de livros feitos em uma biblioteca | css3,django-rest-framework,html5,javascript,nuxt,nuxt3,python,vue,vuejs | 2023-03-23T14:44:12Z | 2023-06-21T20:08:45Z | 2023-05-08T15:14:26Z | 1 | 5 | 152 | 3 | 1 | 6 | null | MIT | JavaScript |
oakcommunity/p2p-commerce | main | # OAK
## Thanks
- Big thanks to [uniswap wallet](https://github.com/Uniswap/wallet). I spent more than a few hours in their `package.json` figuring out which integrations to use and saving a lot of lead time on implementation details
- Big thanks to GPT-4 for helping us save a lot of time (4x more productive)
- Contributors: Ben Kim, Ian, Fred Zaw
## Getting Started
- install expo go on mobile app, install expo cli
- `npm install` - install those dependencies
- `npx expo start` - get the dev server running
- scan QR code on dev server with camera app/expo go
## Implementation Documentation
Framework Set Up
- https://reactnative.dev/docs/environment-setup
React Native + Ethers Context Specific
- https://docs.ethers.org/v5/cookbook/react-native/
Private Key Storage
- https://docs.expo.dev/versions/latest/sdk/securestore/
Mobile App Navigation
- https://reactnavigation.org/docs/hello-react-navigation
- https://reactnavigation.org/docs/tab-based-navigation/
State Management
- https://redux-toolkit.js.org/introduction/getting-started
QR Code Scanner
- https://www.npmjs.com/package/react-native-qrcode-scanner
User Authentication SMS + Database
- [twilio sms provider](https://supabase.com/docs/guides/auth/phone-login/twilio) - ben has creds
- [supabase auth sms](https://supabase.com/docs/guides/getting-started/tutorials/with-expo) - ben has creds
- [supabase database](https://supabase.com/docs/guides/database) - ben has creds
- Design System
- [tailwind-lite](https://www.nativewind.dev/)
## Feature Work
Phase 1
- User Onboarding
- Mobile App Set Up
- navigation + routing (done)
- state management (done)
- authentication (done)
- protected routes (done)
- autoroute user to sign in/sign up flow if local wallet record not found
- Wallet Management
- New Wallet creation (in progress)
- wallet generation (done)
- get user to write down seed phrase and delete seed phrase from local store (TODO)
- Ben: we should defer this for a potential iCloud backup instead
- Wallet Generation from Seed Phrase (done)
- Delete local wallet store (done)
- store keys on local device via mobile encrypted storage (keychain) (done)
- Supabase (Auth + Database)
- username
- public key (wallet address)
- phone number (done)
Phase 2
- Wallet Interactions
- send USDC + pay MATIC to 0x address (done)
- name alias look up -> 0x address for payment
Phase 3
- Payment UX: make it easy to send USDC
- QR Code generation (done)
- NFC payment enabled
## Testing
Testing for iOS is such a pain... my goodness
### IOS only
- find your device UDID # (https://udid.tech/) (your mobile phone only please)
- send it to me, I'll register you (I only have 100 slots, non transferrable...) (Ill add you here: https://developer.apple.com/account/resources/devices/add)
- great, you're now provisioned.
-
| crypto wallet 'venmo' | blockchain,crypto,ethers,javascript,react-native,venmo,wallet | 2023-03-22T20:48:39Z | 2023-03-25T04:48:23Z | null | 3 | 5 | 50 | 0 | 0 | 6 | null | null | JavaScript |
CodingWithEnjoy/React-Password-Generator | main | <h2 align="center">پسوورد ساز | Password Generator</h2>
###
<h4 align="center">دمو | Demo 😁<br><br>https://codingwithenjoy.github.io/React-Password-Generator</h4>
###
<h4 align="center">🤩🚀 همراه با تنظیمات اعداد، حروف کوچک و بزرگ، سمبول ها و فاصله 🚀🤩</h4>
###
<p align="left"></p>
###
<p align="left"></p>
###
<div align="center">
<img height="350" src="https://user-images.githubusercontent.com/113675029/224552501-c2fe3bf6-1bb2-46e1-b46a-5f81bd2d7828.png" />
</div>
###
<p align="left"></p>
###
<div align="center">
<img height="350" src="https://user-images.githubusercontent.com/113675029/224552517-879569d8-f3d9-4050-821b-e1812de89765.png" />
</div>
###
<p align="left"></p>
###
<p align="left"></p>
###
<div align="center">
<a href="https://www.instagram.com/codingwithenjoy/" target="_blank">
<img src="https://raw.githubusercontent.com/maurodesouza/profile-readme-generator/master/src/assets/icons/social/instagram/default.svg" width="52" height="40" alt="instagram logo" />
</a>
<a href="https://www.youtube.com/@codingwithenjoy" target="_blank">
<img src="https://raw.githubusercontent.com/maurodesouza/profile-readme-generator/master/src/assets/icons/social/youtube/default.svg" width="52" height="40" alt="youtube logo" />
</a>
<a href="mailto:codingwithenjoy@gmail.com" target="_blank">
<img src="https://raw.githubusercontent.com/maurodesouza/profile-readme-generator/master/src/assets/icons/social/gmail/default.svg" width="52" height="40" alt="gmail logo" />
</a>
<a href="https://twitter.com/codingwithenjoy" target="_blank">
<img src="https://raw.githubusercontent.com/maurodesouza/profile-readme-generator/master/src/assets/icons/social/twitter/default.svg" width="52" height="40" alt="twitter logo" />
</a>
</div>
###
<p align="left"></p>
###
<h4 align="center">توسعه داده شده توسط برنامه نویسی با لذت</h4>
###
| پسوورد ساز | Password Generator 😉🚀🤩 | css,html,js,generator,javascript,password,password-generator,react,reactjs,tailwind | 2023-03-12T14:39:50Z | 2023-04-13T09:06:59Z | null | 1 | 0 | 3 | 0 | 1 | 6 | null | MIT | CSS |
devvsakib/social-profile | main | # <p align="center"><img src="./public/assets/Logo.png" alt="SocialProfile" width="200"/></p>
<br/>
<img src="./public/assets/socialprofiles.png" />
<br/>
SocialProfile is a social platform that allows users to create a profile and share their all social media links in one place. Anyone can view your profile. You can also view other users' profiles.
<br/>
## Features
> will be added soon
- [x] Creating profile
- [x] Viewing profile
- [x] Viewing other users' profile
- [] Updating profile
- [] Deleting profile
- [x] Authentication | A community for social sharing and showcase | community,community-project,javascript,reactjs | 2023-03-20T11:36:35Z | 2023-05-26T16:46:24Z | null | 1 | 0 | 78 | 0 | 0 | 6 | null | null | JavaScript |
Booze33/Capstone | main | # Capstone
# Fitness-capstone
<a name="readme-top"></a>
<div align="center">
</div>
<!-- TABLE OF CONTENTS -->
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#triangular_flag_on_post-deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)
<!-- PROJECT DESCRIPTION -->
# 📖 [Capstone: Html-JavaScript capstone] <a name="about-project"></a>
**[Capstone: Html-JavaScript capstone]** is a project for week 5.
## 🛠 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/">HTML and CSS</a></li>
</ul>
</details>
<details>
<ul>
<li><a href="https://expressjs.com/">Express.js</a></li>
</ul>
</details>
<details>
<ul>
<li><a href="https://www.postgresql.org/">PostgreSQL</a></li>
</ul>
</details>
<!-- LIVE DEMO -->
## Live Demo <a name="live-demo"></a>
-[Live Demo Link]( https://booze33.github.io/Capstone/)
<!-- Features -->
### Key Features <a name="key-features"></a>
- **Install stylelint for CSS**
- **Install Webhint**
- **Design your page**
<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.
- Copy branch URL
- Choose a local folder at the destination
- Paste the URL
- Clone the branch
### Prerequisites
In order to run this project you need:
<!--
Example command:
```sh
gem install rails
```
-->
### Setup
Clone this repository to your desired folder:
### Install
Install this project with:
- Copy the code and run it in your terminal
- Wait for it to install
- Then run the npm code in your terminal
### Usage
To run the project, execute the following command:
-Right click on the html file
-Click on live previeew
-A new tab will open on your browser running the page
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 👥 Authors <a name="authors"></a>
👤 **Author1**
- GitHub: [@Booze33](https://github.com/Booze33)
- Twitter: [@twitterhandle](https://twitter.com/twitterhandle)
- LinkedIn: [LinkedIn](https://linkedin.com/in/linkedinhandle)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 🔭 Future Features <a name="future-features"></a>
- [ ] **Add javascript to make page interactive**
- [ ] **Add more sttling to the page**
- [ ] **Keep the page simple**
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 🤝 Contributing <a name="contributing"></a>
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## ⭐️ Show your support <a name="support"></a>
If you like this project...
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 🙏 Acknowledgments <a name="acknowledgements"></a>
I would like to thank... [Cindy Shin](https://www.behance.net/adagio07) for the original design.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 📝 License <a name="license"></a>
This project is [GNU](https://github.com/Booze33/Capstone/blob/set-up/LICENSE) licensed.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
### Video
- Here is a video on my work [video link](https://www.loom.com/share/588078922c674990b23e2ef0ffb6e769)
## Original design
- Design idea by [Cindy Shin](https://www.behance.net/adagio07)
| This is a website for a fitness and health sumit. I made the mobile version first then the desktop version. I used HTML, CSS for the styling and JavaScript for the functionality. | css,html,javascript | 2023-03-17T23:49:02Z | 2023-03-18T11:13:38Z | null | 1 | 1 | 16 | 0 | 0 | 6 | null | GPL-3.0 | JavaScript |
Bjorn86/react-mesto-auth | main | # Проект: Место (React, с авторизацией и регистрацией)
Учебный проект выполненный в рамках курса "Веб-разработчик" от Яндекс Практикум. Проект представляет из себя фото-блог с возможностью добавления карточек интересных мест.
## Оглавление
- [Обзор проекта](#обзор-проекта)
- [Задачи проекта](#задачи-проекта)
- [Функциональность проекта](#функциональность-проекта)
- [Screenshot](#screenshot)
- [Директории проекта](#директории-проекта)
- [Запуск проекта](#запуск-проекта)
- [Ссылки](#ссылки)
- [Ход выполнения проекта](#ход-выполнения-проекта)
- [Используемые технологии](#используемые-технологии)
- [Чему я научился работая над проектом](#чему-я-научился-работая-над-проектом)
- [Автор](#автор)
## Обзор проекта
### Задачи проекта
Проект был призван изучить основы фреймворка React, разработки SPA, и работе с React Router.
### Функциональность проекта
Продолжение работы над проектом Место. Проект сохранил всю свою исходную функциональность, с которой можно ознакомиться [здесь](https://github.com/Bjorn86/mesto-react). В проект добавлена возможность регистрации и аутентификации пользователя, созданы соответствующие роуты для этих операций. Произведена интеграция с ещё одним REST API для регистрации и аутентификации пользователей.
### Screenshot
### Директории проекта
- `src/blocks` — директория с CSS файлами
- `src/components` — директория с компонентами
- `src/contexts` — директория с элементами контекста
- `src/fonts` — директория со шрифтами
- `src/images` — директория с файлами изображений
- `src/utils` — директория со вспомогательными файлами
- `src/vendor` — директория с файлами библиотек
### Запуск проекта
- `npm run build` — запуск проекта в режиме продакшн, с формированием файлов подготовленных к деплою в директории `/build`
- `npm start` — запуск проекта в режиме разработки
### Ссылки
- [Ссылка на репозиторий проекта](https://github.com/Bjorn86/react-mesto-auth)
- [Ссылка на демо-страницу проекта](https://bjorn86.github.io/react-mesto-auth/)
- [Ссылка на ветку собранного проекта](https://github.com/Bjorn86/react-mesto-auth/tree/gh-pages)
## Ход выполнения проекта
### Используемые технологии
- HTML
- CSS
- JS
- [React](https://react.dev/)
- [React Router](https://reactrouter.com/en/main)
- [Create React App](https://create-react-app.dev/)
- Адаптивная вёрстка
- Семантическая вёрстка
### Чему я научился работая над проектом
- Работе с JWT-токеном
- Работе с React Router
## Автор
**Данила Легкобытов**
- e-mail: [legkobytov-danila@yandex.ru](mailto:legkobytov-danila@yandex.ru)
- Telegram: [@danila_legkobytov](https://t.me/danila_legkobytov)
| Проект Место создан с помощью React, и представляет из себя фото-блог с возможностью добавления карточек интересных мест, регистрации и аутентификации пользователей | adaptive,css,flexbox,grid,html,javascript,react,react-router | 2023-03-19T14:10:17Z | 2023-05-08T14:37:28Z | null | 1 | 0 | 12 | 0 | 0 | 6 | null | null | JavaScript |
Juanescacha/Portfolio | main | null | Portfolio Landing Page with React, Vite, TailwindCSS, Threejs, React Three Fiber, React Router, Emailjs, React Tilt, Framer Motion | javascript,nodejs,npm,react,vite,emailjs,framer-motion,portfolio,react-router,react-three-drei | 2023-03-16T22:40:14Z | 2024-02-01T19:08:20Z | null | 1 | 0 | 31 | 0 | 2 | 6 | null | null | JavaScript |
BrightDaniel/Code9ja | main | # Code9ja E-Learning Platform
Code9ja is an e-learning platform designed to provide users with an opportunity to learn coding and other tech-related courses in Nigerian Pidgin. The platform offers a wide range of courses, blog posts, and a user-friendly interface to enhance the learning experience. With Code9ja, users can apply for courses, track their application status, access the latest tech-related blog posts, and interact with the admin through the contact page.
## Features
- **User Dashboard:** Users have access to a personalized dashboard where they can view the status of their course applications. The dashboard provides an overview of applied courses, application status, and important notifications.
- **Admin Dashboard:** The admin dashboard offers administrative capabilities, allowing the admin to manage courses, quizzes (in development), blog posts, and user applications. The admin can add new courses, edit existing courses, accept/reject user applications, and perform various administrative tasks.
- **Course Management:** The admin can easily add new courses, provide detailed information about each course, set application deadlines, and manage course content. Users can browse and apply for courses directly from the platform.
- **Blog Posts:** Code9ja features a collection of tech-related blog posts that users can explore. These blog posts cover a wide range of topics and provide valuable insights and knowledge for the users.
- **Application Status:** Users can track the status of their course applications through the user dashboard. The status can be "Pending," "Paid," or "Cancelled," depending on the admin's decision.
- **Contact Page:** Code9ja offers a contact page where users can reach out to the admin for inquiries, support, or general feedback. Users can fill out a contact form and expect a response from the admin.
## Website Sections
- **Admin Area:** The admin area provides access to the admin dashboard, where administrative tasks can be performed. The admin can manage courses, blog posts, user applications, and other administrative functions.
- **User Area:** The user area is dedicated to registered users. Users can access their personalized dashboard, view course applications, track application status, and interact with the platform.
- **Public Area:** The public area of the website is accessible to everyone. It includes landing pages, the blog section, and the contact page. Users can explore the available courses, read blog posts, and get in touch with the admin through the contact page.
## Work in Progress
Code9ja is an ongoing project, and there are several features and enhancements planned for the future. Some of the upcoming features include:
- **Assessment Tests:** Implementation of assessment tests to evaluate the knowledge and progress of the users.
- **Payment Features:** Integration of payment gateways to facilitate course payments and improve the overall user experience.
- **Expanded User Registration and Application:** Enhancements to the user registration and application process to provide more comprehensive information and streamline the application workflow.
- **Collaboration and Open Source:** Code9ja welcomes collaboration and is an open-source project. Developers can contribute to the project, suggest improvements, and help shape the future of the platform.
## Technologies Used
Code9ja is built using the following technologies:
- **Python Flask:** A Python web framework used for developing the back-end of the platform.
- **MySQL:** A relational database management system used for storing application and user data.
- **HTML, CSS, JavaScript:** Front-end technologies used for designing and creating the user interface.
- **Bootstrap:** A popular CSS framework that provides responsive design and pre-built components to enhance the visual appearance of the platform.
- **FontAwesome:** A comprehensive icon set used to add visually appealing icons to the platform.
- **SCSS:** A CSS preprocessor that improves code maintainability and provides additional features such as variables and mixins.
## Deployment
Code9ja is currently hosted on Heroku, providing easy access and availability for users. The hosted version of Code9ja can be found [here](https://code9ja-cb567a167dcd.herokuapp.com/).
## Run Locally
Code9ja can be run on your local machine by following these steps:
1. Clone the repository to your local machine:
```
git clone https://github.com/BrightDaniel/Code9ja.git
```
2. Navigate to the project directory:
```
cd Code9ja
```
3. Create a virtual environment:
```
python -m venv venv
```
4. Activate the virtual environment:
- For Windows:
```
venv\Scripts\activate
```
- For macOS and Linux:
```
source venv/bin/activate
```
5. Install the required dependencies:
```
pip install -r requirements.txt
```
6. Set up the database:
- Create a MySQL database for the project.
- Update the database configuration in the `.env` file with your database details:
```python
DB_URI=mysql://username:password@localhost/database_name
```
7. Run the database migrations:
```
flask db upgrade
```
8. Start the development server:
```
flask run --debug
```
9. Open your web browser and visit `http://localhost:5000` to access the Code9ja platform.
Note: Make sure you have Python, MySQL, and pip installed on your machine before running the above commands.
## Screenshots
Here are some screenshots of key pages within the Code9ja platform:
- Homepage
- User Dashboard
- Admin Dashboard
- Course Page
- Blog Page
- Contact Page
## Authors and Credits
Code9ja is developed by [Bright Daniel](https://github.com/BrightDaniel). We would like to express our gratitude to the open-source community and peers for their valuable contributions and support in making Code9ja a reality.
## Contributing
Code9ja welcomes contributions from the developer community. If you're interested in contributing to the project, please send a mail to the [Bright Daniel](brightdaniel5050@gmail.com) for more information.
## License
Code9ja is released under the [MIT License](LICENSE). Please refer to the License file for more details.
---
We hope you enjoy using Code9ja and find it valuable for your learning journey. If you have any questions, feedback, or suggestions, please feel free to reach out to us through the contact page on the platform. Happy learning!
| Code9ja is an e-learning platform designed to provide users with an opportunity to learn coding and other tech-related courses in Nigerian Pidgin. The platform offers a wide range of courses, blog posts, and a user-friendly interface to enhance the learning experience. | admin-dashboard,blog-post,bootstrap,contact-us,course-management,css3,flask,flask-application,flask-login,flask-sqlalchemy | 2023-03-19T13:15:06Z | 2023-07-12T12:13:29Z | null | 1 | 0 | 28 | 0 | 6 | 6 | null | null | Python |
Denver04/Agri-Cure | main | # Agri-Cure: A Website for Crop Disease Detection and Management
Agri-Cure is a project that provides a website for farmers to help them find and manage crop diseases using machine learning models. It allows farmers to upload images of their crops and get instant diagnosis and recommendations for treatment.
## Features
- Crop disease detection using deep learning models
- Crop disease management using best practices and guidelines
- Crop disease information and prevention tips
- User-friendly interface and easy navigation
- Compatible with web and mobile devices
## Project Snapshots
## How to use Agri-Cure?
To use Agri-Cure, you need to register an account on the website and log in. Then, you can access the following features:
- Upload: You can upload an image of your crop and select the crop type. The website will analyze the image and display the results, including the disease name, severity, and confidence score.
- Diagnosis: You can view the detailed diagnosis of your crop disease, including the symptoms, causes, and effects. You can also see the images of similar diseases for comparison.
- Treatment: You can view the recommended treatment for your crop disease, including the chemical and biological methods, dosage, frequency, and precautions. You can also see the alternative treatments and their pros and cons.
- Information: You can view the general information about crop diseases, such as their types, categories, distribution, and impact. You can also see the prevention tips and best practices for healthy crops.
- Feedback: You can provide feedback on the website's performance, accuracy, and usability. You can also report any errors or bugs you encounter.
## Technologies used
Agri-Cure is built using the following technologies:
- Front-end: Vite-ReactJS App
- Back-end: NodeJS
- ML Model: TensorFlow, Keras, PyTorch
## Installation
To install and run Agri-Cure on your local machine, you need to follow these steps:
1. Clone the git repository using the command `git clone https://github.com/Denver04/Agri-Cure.git`.
2. Install all the dependencies for python listed in requirements.txt file using `pip install -r requirements.txt`.
3. Navigate to the frontend directory using the command `cd frontend`.
4. Install the dependencies using the command `npm install`.
5. Start the vite react app using the command `npm run dev`.
6. Navigate to the backend directory using the command `cd ../backend`.
7. Install the dependencies using the command `npm install`.
8. Start the nodejs server using the command `npm run dev`.
9. Open your browser and go to the URL `http://localhost:5173` to view the website.
## Contributing
If you would like to contribute to Agri-Cure, please fork the repository and submit a pull request.
Came this down, please take a moment to star this repo. 🙃
| Agri-Cure: A Website for Crop Disease Detection and Management | css,html,javascript,machine-learning,python3,react,django-rest-framework,framer-motion,rest-framework,tensorflow | 2023-03-19T13:12:19Z | 2023-05-31T11:02:11Z | null | 3 | 0 | 29 | 0 | 2 | 6 | null | null | JavaScript |
Silent-Watcher/Firebase-user-CRUD | master |
# Firebase user CRUD
implement user crud operations using firebase database and api calls
## Demo 🤗
https://2259bf5d.firebase-user-crud.pages.dev/
## Run Locally
Clone the project
```bash
git clone https://github.com/Silent-Watcher/Firebase-user-CRUD
```
Go to the project directory
```bash
cd Firebase-user-CRUD
```
Install dependencies
```bash
npm install
yarn install
```
Start the server
```bash
npm run dev
yarn dev
```
## Screenshots
## License
[MIT](https://choosealicense.com/licenses/mit/)
<a target="_blank" rel="noopener noreferrer nofollow" href="https://camo.githubusercontent.com/6038c8f1fd8f60de75477470e5a87210e9256202e01dfba9986446304a0f0254/68747470733a2f2f63617073756c652d72656e6465722e76657263656c2e6170702f6170693f747970653d776176696e6726636f6c6f723d6772616469656e74266865696768743d36302673656374696f6e3d666f6f746572"><img src="https://camo.githubusercontent.com/6038c8f1fd8f60de75477470e5a87210e9256202e01dfba9986446304a0f0254/68747470733a2f2f63617073756c652d72656e6465722e76657263656c2e6170702f6170693f747970653d776176696e6726636f6c6f723d6772616469656e74266865696768743d36302673656374696f6e3d666f6f746572" data-canonical-src="https://capsule-render.vercel.app/api?type=waving&color=gradient&height=60&section=footer" style="max-width: 100%;"></a>
| implement user crud operations using firebase database and api calls | crud-application,firebase,firebase-database,html,css3,javascript,vite,vitejs | 2023-03-21T00:03:16Z | 2023-04-07T12:31:48Z | null | 1 | 0 | 29 | 0 | 0 | 6 | null | MIT | HTML |
sylvester-wamaya/portfolio-website | main | <a name="readme-top"></a>
<div align="center">
<img src="media/favicon_io/favicon.ico" alt="logo" width="140" height="auto" />
<br/>
<h3><b>My Portfolio Website</b></h3>
</div>
<!-- TABLE OF CONTENTS -->
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#triangular_flag_on_post-deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)
<!-- PROJECT DESCRIPTION -->
# 📖 My Portfolio Website <a name="about-project"></a>
My Portfolio Website is a project that describes me as a programmer, my skills, projects built and social media contacts. I created the project using HTML and CSS.
## 🛠 Built With <a name="built-with"></a>
1- HTML.
2- CSS.
### Tech Stack <a name="tech-stack"></a>
<details>
<summary>Client</summary>
<ul>
<li><a href="https://html.com/">HTML</a></li>
<li><a href="https://developer.mozilla.org/en-US/docs/Web/CSS/">CSS</a></li>
</ul>
</details>
<!-- Features -->
### Key Features <a name="key-features"></a>
- Added HTML file.
- Added style.css file.
- Added header.
- Added headline section.
- Added Works section
- Added About me section
- Added Contact form section
- Added Footer.
- Added responsivenes css.
- Added animation
- Added favicon
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- LIVE DEMO -->
## 🚀 Live Demo <a name="live-demo"></a>
Watch the live demo at the following link:
https://www.loom.com/share/d80db0f90ea64bec85b71e169705256d
<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:
1- Web browser
2- Code editor
3- Git-smc
### Setup
Clone this repository to your desired folder:
Run this command:
```sh
git clone git@github.com:sylvester-wamaya/portfolio-website.git
```
### Install
Install this project with:
Run this command:
```sh
cd my-project
npm install
```
### Usage
To run the project, execute the following command:
```sh
Open index.html
```
or
```sh
explorer.exe index.html
```
### Run tests
> Coming soon
### Deployment
The project is deployed by github pages under the following link:
https://sylvester-wamaya.github.io/portfolio-website/
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- AUTHORS -->
## 👥 Authors <a name="authors"></a>
👤 Sylvester Wamaya
- GitHub: [@githubhandle](https://github.com/sylvester-wamaya)
- Twitter: [@twitterhandle](https://twitter.com/The_Seal_)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/sylvester-wamaya-b11a93112/)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- FUTURE FEATURES -->
## 🔭 Future Features <a name="future-features"></a>
- [ ] Add Projects section.
- [ ] Add mobile version menu.
- [ ] Add more styling.
- [ ] Add Javascript to the project.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- CONTRIBUTING -->
## 🤝 Contributing <a name="contributing"></a>
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- SUPPORT -->
## ⭐️ Show your support <a name="support"></a>
If you like this project give it a ⭐.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- ACKNOWLEDGEMENTS -->
## 🙏 Acknowledgments <a name="acknowledgements"></a>
I would like to thank Microverse for their continued support and inspiration.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- LICENSE -->
## 📝 License <a name="license"></a>
This project is [MIT](./LICENSE) licensed.
<p align="right">(<a href="#readme-top">back to top</a>)</p> | A portfolio website that provides a brief profile description about me and showcase a sample of exceptional projects I have developed. A user can still contact me through the website platform. Developed using Javascript. | css,html,javascript | 2023-03-22T20:34:50Z | 2023-11-10T23:25:21Z | null | 4 | 17 | 163 | 4 | 2 | 6 | null | MIT | CSS |
MDeLuise/ytsms | main | <p align="center">
<img width="200px" src="images/ytsms-logo.png" title="YTSMS">
</p>
<p align="center">
<img src="https://img.shields.io/github/checks-status/MDeLuise/ytsms/main?style=for-the-badge&label=build&color=%23DC143C" />
<img src="https://img.shields.io/github/v/release/MDeLuise/ytsms?style=for-the-badge&color=%23DC143C" />
</p>
<p align="center"><i><b>[Still under "initial" development, some features may be unstable or change in the future, although database schemas should be stable. A first release version is planned to be packed soon].</b></i></p>
<p align="center">YTSMS is a <b>self-hosted youtube subscription management service.</b><br>Useful to keep track of new uploaded video of the followed channels, even without having a Google account.</p>
<p align="center"><a href="https://github.com/MDeLuise/ytsms/#why">Why?</a> • <a href="https://github.com/MDeLuise/ytsms/#features-highlight">Features highlights</a> • <a href="https://github.com/MDeLuise/ytsms/#getting-started">Quickstart</a> • <a href="https://github.com/MDeLuise/ytsms/#configuration">Configuration</a> • <a href="https://github.com/MDeLuise/ytsms/#faq">FAQ</a> • <a href="https://github.com/MDeLuise/ytsms/#contribute">Contribute</a></p>
<p align="center">
<img src="/images/screenshot-desktop.png" width="45%" />
<img src="/images/screenshot-mobile.png" width="45%" />
</p>
## Why?
I've always enjoyed spending some time viewing YouTube videos. The problem is that YouTube keeps track of a lot of data about you.
Ytsms takes care of this problem allowing you to get updated about new videos from followed channels without having a Google account or having it but using the official API (that is still better then using directly the subscription system of the Google account, since you can view the video logged out).
## Features highlight
* Add channels to followed list
* Get notified about every new video published by the followed channels
* Filter videos by channel
* Chose between YouTube backend or an [Invidious](https://invidious.io/) instance
* Dark/Light mode
* 🔜 Create playlists of videos
### Quickstart
Installing ytsms is pretty straight forward, in order to do so follow these steps:
1. Create a folder where you want to place all ytsms related files.
1. Inside that folder, create the following files:
* Create a directory `mkdir certificates`
* Give the permission of the directory `chmod 777 ./certificates`
* `docker-compose.yml`:
```yaml
version: "3"
name: ytsms
services:
backend:
image: msdeluise/ytsms-backend:latest
env_file: backend.env
depends_on:
- db
restart: unless-stopped
volumes:
- "certs:/certificates"
ports:
- "8080:8080"
db:
image: mysql:8.0
restart: always
env_file: backend.env
volumes:
- "./db:/var/lib/mysql"
frontend:
image: msdeluise/ytsms-frontend:latest
env_file: frontend.env
links:
- backend
ports:
- "3000:3000"
volumes:
- "certs:/certificates"
volumes:
certs:
driver: local
driver_opts:
type: none
o: bind
device: ./certificates
```
* `backend.env`:
```properties
#
# DB
#
MYSQL_HOST=db
MYSQL_PORT=3306
MYSQL_USERNAME=root
MYSQL_PSW=root
MYSQL_ROOT_PASSWORD=root
MYSQL_DATABASE=bootdb
#
# JWT
#
JWT_SECRET=putTheSecretHere
JWT_EXP=1
#
# Server config
#
USERS_LIMIT=-1 # <= 0 means no limit
YOUTUBE_KEY=
VIDEO_REFRESH=0 0 * * * *
#
# SSL
#
SSL_ENABLED=false
CERTIFICATE_PATH=/certificates/
```
* `frontend.env`:
```properties
PORT=3000
API_URL=http://localhost:8080/api
WAIT_TIMEOUT=10000
BROWSER=none
SSL_ENABLED=false
CERTIFICATE_PATH=/certificates/
```
1. Run the docker compose file (`docker compose -f docker-compose.yml up -d`), then the service will be available at `localhost:3000`, while the REST API will be available at `localhost:8080/api` (`localhost:8080/api/swagger-ui/index.html` for the documentation of them).
Run the docker compose file (`docker compose -f <file> up -d`), then the service will be available at `localhost:8080`, while the REST API will be available at `localhost:8080/api` (`localhost:8080/api/swagger-ui/index.html` for the documentation of them).
<details>
<summary>Run on a remote host (e.g. from mobile)</summary>
Please notice that running the `docker-compose` file from another machine change the way to connect to the server. For example, if you run the `docker-compose` on the machine with the local IP `192.168.1.100` then you have to change the backend url in the `API_URL` variable to `192.168.1.100:8080/api`. In this case, the frontend of the system will be available at `192.168.1.100:8080`, and the backend will be available at `192.168.1.100:8080/api`.
</details>
### Fetching mode
The service offers two video retrieval options:
* `scraping`: videos are retrieved without the need of a YouTube API key, although there are [some restrictions](#FAQ)
* `official YouTube api`: video are retrieved using a YouTube API key, which means [more metadata can be fetched but less anonymization is provided](#FAQ)
In order to choose between one of the retrieval option, the `YOUTUBE_KEY` property in the [configuration file](#Configuration) must be filled or left empty.
## FAQ
* How can I get the `channel id` of a youtube channel?
You can do it in two ways:
* go to the channel homepage and run in the javascript console `ytInitialData.metadata.channelMetadataRenderer.externalId`
* go to the channel homepage, view the page source and search for the value `browse_id`
* What distinguishes `official youtube api` and `scraping` modes?
The `official youtube api` mode offers the following advantages:
* retrieve the video duration
* retrieve the channels image thumbnails
* retrieve more old video
The `scraping` mode offers the following advantages:
* no need to use any YouTube API key
* no [quota restrictions](https://developers.google.com/youtube/v3/getting-started#quota)
* increased anonymization
* How can I create a YouTube API key?
You can create a key following the [official guide](https://developers.google.com/youtube/v3/getting-started).
* Why sometime the `Channel Name` method for adding a subscription does not works?
This is a pretty known problem ([1](https://stackoverflow.com/questions/71062188/youtube-listchannels-with-usernameforusername-is-not-working), [2](https://stackoverflow.com/questions/35051882/youtube-api-v3-channels-list-method-doesnt-work-for-some-channels-names), [3](https://stackoverflow.com/questions/39378768/youtube-api-3-channels-by-username-and-id-inconsistant), [4](https://stackoverflow.com/questions/64299967/how-to-find-the-forusername-parameter-for-a-specific-channel)). It's caused by the inconsistence of some YouTube channel's `custom URL` and `username` parameters.
## Contribute
Feel free to contribute and help improve the repo.
### Bug Report, Feature Request and Question
You can submit any of this in the [issues](https://github.com/MDeLuise/ytsms/issues/new/choose) section of the repository. Chose the right template and then fill the required info.
### Bug fix
If you fix a bug, please follow the [contribution-guideline](https://github.com/MDeLuise/ytsms# contribution-guideline) in order to merge the fix in the repository.
### Feature development
Let's discuss first possible solutions for the development before start working on that, please open a [feature request issue](https://github.com/MDeLuise/ytsms/issues/new?assignees=&labels=&projects=&template=fr.yml).
### Contribution guideline
To fix a bug or create a feature, follow these steps:
1. Fork the repo
1. Create a new branch (`git checkout -b awesome-feature`)
1. Make changes or add new changes.
1. Commit your changes (`git add -A; git commit -m 'Awesome new feature'`)
1. Push to the branch (`git push origin awesome-feature`)
1. Create a Pull Request
#### Conventions
* Commits should follow the [semantic commit](https://www.conventionalcommits.org/en/v1.0.0/) specification, although not mandatory.
| 📺 Self-hosted, open source YouTube subscription management system | java,javascript,privacy,self-hosted,spring-boot,youtube,reactjs,springboot,typescript,docker | 2023-03-20T09:18:43Z | 2024-04-02T06:23:45Z | 2024-02-26T11:48:42Z | 2 | 1 | 3 | 0 | 2 | 6 | null | null | Java |
bouzenaali/reactjs-calculator | 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:
### `yarn 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.
### `yarn 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.
### `yarn 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.
### `yarn 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)
### `yarn 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)
| 🔢 react.js calculator with all the operations and the logic in it coded by me (didn't use any library for that) | javascript,reactjs,usereducer | 2023-03-18T11:38:14Z | 2023-11-29T23:31:43Z | null | 1 | 1 | 6 | 0 | 0 | 6 | null | null | JavaScript |
SX-9/codedit-web | main | # CodedIt Web
Run NodeJs **ENTIRELY** In The Browser!
[Live Site](https://codedit.is-an.app/)
# How?
I Use The Power Of [WebContainers](https://webcontainers.io)
| CodedIt In The Web With WebContainers | js,vercel,webcontainers,javascript,nodejs | 2023-03-25T06:28:55Z | 2024-01-01T09:30:19Z | null | 2 | 18 | 52 | 0 | 0 | 6 | null | null | Vue |
adeola003/Ruby-on-rails-bootcamp | main | # Ruby-on-rails-bootcamp
<a name="readme-top"></a>
<div align="center">
<img src="assets/deola_logo.png" alt="logo" width="140" height="auto" />
<br/>
<h3><b>Ruby on rails bootcamp capstone 1</b></h3>
</div>
<!-- TABLE OF CONTENTS -->
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#triangular_flag_on_post-deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ (OPTIONAL)](#faq)
- [📝 License](#license)
<!-- PROJECT DESCRIPTION -->
# 📖 [your_project_name] <a name="about-project"></a>
> This a website for a Ruby on rails bootcamp. This project is being carried out as part of the capstone project for Module 1 of the Microverse full stack training program. The capstone project is like the evaluation of everything you learnt during the module.Every Module features a Capstone Project, that takes place in the last week. These projects are meant to mimic real-world projects where we must apply what we learned throughout the entire Module, and are built with business specifications. If it is made in a very professional way, this project can be a very good asset in our portfolio.
**[Ruby_on_Rails_Bootcamp]** is a project
## 🛠 Built With <a name="HTML, CSS, Bootstrap and Javascript"></a>
### Tech Stack <a name="tech-stack"></a>
<details>
<summary>Client</summary>
<ul>
<li><a href="https://html.com/#What_is_HTML">"index.html" and "about.html"</a></li>
<li><a href="https://html.com/css/#What_is_CSS">"style.css" and "about.css"</a></li>
<li><a href="https://www.javascript.com/">"script.js"</a></li>
<li><a href="https://getbootstrap.com/docs/5.2/getting-started/introduction/">Bootstrap</a></li>
</ul>
</details>
<details>
<summary>Server</summary>
<ul>
<li><a href="https://github.com/">Github</a></li>
</ul>
</details>
<details>
<summary>Database</summary>
<ul>
<li><a href="https://www.postgresql.org/">PostgreSQL</a></li>
</ul>
</details>
<!-- Features -->
### Key Features <a name="key-features"></a>
- **[Responsiveness]**
- **[Good_UI]**
- **[Accessibility_passed]**
- **[Accessibility_passed]**
- **[No_linters_errors]**
- **[Use_of_correct_github_workflow]**
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- LIVE DEMO -->
## 🚀 Live Demo <a name="live-demo"></a>
- [https://adeola003.github.io/Ruby-on-rails-bootcamp/](#)
<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:
- **Visual Studio Code**
- **Git Bash**
### Setup
Clone this repository to your desired folder:
- **cd your-folder**
- **git clone https://github.com/adeola003/Ruby-on-rails-bootcamp.git**
### Install
Install this project with:
- **sh cd my-project gem install**
### Usage
To run the project, execute the following command:
- **sh rails server**
### Run tests
To run tests, run the following command:
- **sh rails test/**
### Deployment
You can deploy this project using:
- **GitHub Pages**
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- AUTHORS -->
## 👥 Authors <a name="authors"></a>
> Mention all of the collaborators of this project.
👤 **Abdel-Khafid SALAOU**
- GitHub: [@githubhandle](https://github.com/adeola003)
- Twitter: [@twitterhandle](https://twitter.com/khadaf6)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/abdel-khafid-salaou-a18396161)
👤 **Author2**
- GitHub: [@githubhandle](https://github.com/githubhandle)
- Twitter: [@twitterhandle](https://twitter.com/twitterhandle)
- LinkedIn: [LinkedIn](https://linkedin.com/in/linkedinhandle)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- FUTURE FEATURES -->
## 🔭 Future Features <a name="future-features"></a>
> Describe 1 - 3 features you will add to the project.
- [ ] **[new_feature_1]**
- [ ] **[new_feature_2]**
- [ ] **[new_feature_3]**
<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 feel free to follow me on github and give this project a star..
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- ACKNOWLEDGEMENTS -->
## 🙏 Acknowledgments <a name="acknowledgements"></a>
> Give credit to everyone who inspired your codebase.
I would like to thank **Cindy Shin** the original designer of this website
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- FAQ (optional) -->
## ❓ FAQ (OPTIONAL) <a name="faq"></a>
> Add at least 2 questions new developers would ask when they decide to use your project.
- **[How_to_start]**
- [Register_for_a_full_stack_program_like_Microverse]
- **[How_to_contact_you]**
- [Follow_me_on_Github]
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- LICENSE -->
## 📝 License <a name="license"></a>
This project is [MIT](./LICENSE.md) licensed.
_NOTE: we recommend using the [MIT license](https://choosealicense.com/licenses/mit/) - you can set it up quickly by [using templates available on GitHub](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository). You can also use [any other license](https://choosealicense.com/licenses/) if you wish._
<p align="right">(<a href="#readme-top">back to top</a>)</p>
| This a website for a Ruby on rails bootcamp. This project is being carried out as part of the capstone project for Module 1 of the Microverse full stack training program. The capstone project is like the evaluation of everything you learnt during the module. Every Module features a Capstone Project, that takes place in the last week. | css,html,javascript | 2023-03-12T17:00:18Z | 2023-03-16T16:00:54Z | null | 1 | 1 | 9 | 0 | 0 | 6 | null | MIT | HTML |
nileshkr17/web3.0--js | main | # web3.0--js
# Blockchain Course Project
🔗 Learn Blockchain Programming with JavaScript
## Description
🚀 This project provides a comprehensive introduction to blockchain technology and its effective implementation using JavaScript. You will gain hands-on experience in programming your own blockchain, understanding its core concepts, deploying it to the cloud, and achieving decentralization. This project was developed independently, focusing on topics such as cryptocurrencies, centralized and distributed ledgers, public and private keys, and mining. You will dive into implementing the blockchain core engine and web API, followed by the steps required to decentralize your blockchain.
## Features
✅ Create and host a blockchain using Node.js and Express.js.
🔒 Secure data integrity using sha-256 hashing.
🔄 Conflict resolution through the longest node selection method.
📡 API endpoints:
- `/resolve`: Resolve conflicts between nodes.
- `/nodes/register`: Register new nodes in the network.
- `/transaction`: Add new transactions to the blockchain.
- `/blockchain`: Get the current state of the blockchain.
- `/mine`: Mine new blocks and add them to the blockchain.
## Installation
1. Clone the repository: `git clone https://github.com/nileshkr17/web3.0--js.git`
2. Navigate to the project directory: `cd web3.0--js`
3. Install dependencies: `npm install`
4. Start the application: `npm start`
## Goals
⚡️ The goal of this project is to demonstrate the effective use of blockchain technology in JavaScript, ensuring data security, integrity, and decentralization. The project is designed to be scalable and flexible, allowing for further exploration and expansion.
-add-block
#above code transfer to express
-res.json(blockchain)
#app.post working Fine!
| Blockchain Programming in JavaScript | blockchain,expressjs,javascript,sha256-hash,web3js | 2023-03-20T19:53:34Z | 2023-05-27T09:22:56Z | null | 1 | 0 | 23 | 0 | 2 | 6 | null | null | JavaScript |
AbbasSarwar/BooksList | main | <a name="readme-top"></a>
<h3><b>Book-List README Template</b></h3>
</div>
<!-- TABLE OF CONTENTS -->
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#triangular_flag_on_post-deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ (OPTIONAL)](#faq)
- [📝 License](#license)
<!-- PROJECT DESCRIPTION -->
# 📖 [Abbas Portfolio] <a name="about-project"></a>
> Hello , This is a simple Book list program.
**[Book List]** is a simple shelf where you can add books with author names and also you can delete it.
## 🛠 Built With <a name="built-with"></a>
### Tech Stack <a name="tech-stack"></a>
<details>
<summary>HTML</summary>
</details>
<details>
<summary>HTML</summary>
</details>
<details>
<summary>JAVASCRIPT</summary>
</details>
<!-- Features -->
### Key Features <a name="key-features"></a>
- **[Simple Template]**
- **[addition books with author methods]**
- **[removal of books]**
- **[Classes refactor]**
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- LIVE DEMO -->
## 🚀 Live Demo <a name="live-demo"></a>
- [Not Available]
<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:
## Recommendation
1. A good Computer
2. Having proper knowledge about Css and Html **necessary**
* git clone https://github.com/AbbasSarwar/Abbas-Portfolio.git
* cd Book-List
* Go live through in VS code for further.
* Here we Go....
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- AUTHORS -->
## 👥 Authors <a name="authors"></a>
> Mention all of the collaborators of this project.
👤 **Author1**
- GitHub: [@AbbasSarwar](https://github.com/AbbasSarwar)
- Twitter: [@Abbas_sDev](https://twitter.com/Abbas_sDev)
- LinkedIn: [Abbas-Sarwar](https://www.linkedin.com/in/abbas-sarwar-4a0b16257/)
👤 **Author2**
- GitHub: [@Naledi-Dikgale](https://github.com/Naledi-Dikgale)
- LinkedIn: [Naledi-Dikgale](https://www.linkedin.com/in/naledi-dikgale-068423159/)
👤 **Author3**
- GitHub: [@Kanyi](https://github.com/jkanyi-web)
<!-- FUTURE FEATURES -->
## 🔭 Future Features <a name="future-features"></a>
- [ ] **[Complete Navigation]**
- [ ] **[Interface ]**
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- CONTRIBUTING -->
## 🤝 Contributing <a name="contributing"></a>
Contributions, issues, and feature requests are welcome!
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- SUPPORT -->
## ⭐️ Show your support <a name="support"></a>
If you like my Portfolio statup project kindly comment or Follow me on LinkedIn, Twitter & twitter and always Your feedback will be really appreciated I have created issue if you want to share.
Thanks.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- ACKNOWLEDGEMENTS -->
## 🙏 Acknowledgments <a name="acknowledgements"></a>
I would like to thank you All Microverse community.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- LICENSE -->
## 📝 License <a name="license"></a>
This project is [MIT](/MIT.md) licensed.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
| "A bookshelf where you can add and remove books, including author names, and also have different sections. | css,html5,javascript | 2023-03-20T07:39:10Z | 2023-03-22T14:36:35Z | null | 3 | 4 | 30 | 0 | 1 | 6 | null | null | JavaScript |
baqar-abbas/JavascriptCapstone | development | # JavascriptCapstone
<a name="readme-top"></a>
<div align="center">
<br/>
<h3><b>Javascript Casptone Project</b></h3>
</div>
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#triangular_flag_on_post-deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)
# 📖 JavascriptCapstone <a name="about-project"></a>
**JavascriptCapstone** is a Project which is fetching images through base API (NASA API) and displaying them on the homepage. User can interact by clicking likes and comments. User likes and comments are fetch and posted through involvement api which increases the likes everytime user clicks on a like button. When a user clicks on a comment button a modal popup appears where user can add his/her comments which will be added and displayed in the comments area.
## 🛠 Built With <a name="built-with"></a>
HTML CSS JavaScript Webpack and API
### Tech Stack <a name="tech-stack"></a>
### Key Features <a name="key-features"></a>
- **[html css with JavaScript and usage of API ]**
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 🚀 Live Demo <a name="live-demo"> </a>
- [Live Demo](https://baqar-abbas.github.io/JavascriptCapstone/dist/)
- [Project Video Demo](https://drive.google.com/file/d/1kDYmcjAirb-yj66bkMc0kkCsyNSACBa2/view?usp=sharing)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 💻 Getting Started <a name="getting-started"></a>
To get a local copy up and running, follow these steps.
### Prerequisites
Web Browser, Code Editor.
### Setup
Clone this repository to your desired folder:
Example commands:
```sh
cd my-folder
git clone https://github.com/baqar-abbas/JavascriptCapstone
```
### Install
VS CODE, Dev Dependencies (Linters), npm Package Manager, Webpack and Jest (for unit testing)
### Usage
Able to see the Data fetched through API and able to update likes and comments section through Post on API.
### Run tests
Add and update likes and comments and see whether likes are increasing and comments are added and displayed.
### Deployment
The Project has been deployed in the link below.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 👥 Author <a name="authors"></a>
👤 **Baqar Abbas**
- GitHub: [@Baqar](https://github.com/baqar-abbas)
- Twitter: [@BaqarAbbas9](https://twitter.com/BaqarAbbas9)
- LinkedIn: [Baqar Abbas](https://www.linkedin.com/in/baqarlinkedin/)
**Ghulam hyder Dar**
- GitHub: [@codeWithHyder](https://github.com/codeWithHyder)
- Twitter: [@Hyder](https://twitter.com/@hyder3512)
- LinkedIn: [Hyder](https://www.linkedin.com/in/ghulam-hyder-dar-165653206/)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 🔭 Future Features <a name="future-features"></a>
- [ ] **[Functionality of fetching Data from APIs and Posting likes and comments on API has been implemented. In future we can add more features like contact sesction**
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 🤝 Contributing <a name="contributing"></a>
Contributions, issues, and feature requests are welcome!
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## ⭐️ Show your support <a name="support"></a>
If you like this project please consider leaving a review.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 🙏 Acknowledgments <a name="acknowledgements"></a>
I would like to thank my coding partner [@CodeWithHyder] for his contributions to this project with me.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 📝 License <a name="license"></a>
This project is [MIT](./LICENSE.md) licensed.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<a name="readme-top"></a>
| This is our Javascript Capstone Project built as a group project along with my coding partner Hyder (@codeWithHyder). This Project uses APIs to fetch images from base API (NASA API) and adds interactivity through involvement API to add likes, opening Popop Modal and add comments. | api,css3,html5,javascript,jest-tests,webpack | 2023-03-20T17:51:50Z | 2023-03-23T17:42:57Z | null | 2 | 5 | 16 | 21 | 0 | 6 | null | MIT | JavaScript |
Yashmerino/online-shop | master | [](https://github.com/Yashmerino/online-shop/actions/workflows/maven.yml) [](https://github.com/Yashmerino/online-shop/actions/workflows/node.js.yml) [](https://sonarcloud.io/summary/new_code?id=Yashmerino_online-shop)
<h1 align="center"><strong><em>Online Shop</strong></em></h1>
<p align="center"><img src="https://static.vecteezy.com/system/resources/previews/009/848/288/original/verified-shop-online-store-3d-illustration-for-ecommerce-icon-free-png.png" alt="sms logo" height=225 width=225></p>
Online Shop is a pet project made using Spring Boot and React. It uses a MySQL database to store the user, seller and products data. Online shop uses JWT for the authorization system and supports 3 languages:
* English
* Romanian
* Russian
## Prerequisites:
* Java 17+
* Node.js 21+
* Maven
* MySQL Database
<br>
## To run the Spring server application:
* Execute the `mvn clean install` command in the `online-shop\online-shop-server` directory.
* Modify the `online-shop-server\src\main\resources\application.properties` file.
```properties
# Database properties
spring.jpa.hibernate.ddl-auto=create
spring.datasource.url=jdbc:mysql://localhost:3306/online_shop
spring.datasource.username=root
spring.datasource.password=1234
# JWT
jwt.secret=640762F165320F52408DAFED313C106346575273C66013DE94B8D13E9ED20316640762F165320F52408DAFED313C106346575273C66013DE94B8D13E9ED20316640762F165320F52408DAFED313C106346575273C66013DE94B8D13E9ED20316640762F165320F52408DAFED313C106346575273C66013DE94B8D13E9ED20316640762F165320F52408DAFED313C106346575273C66013DE94B8D13E9ED20316640762F165320F52408DAFED313C106346575273C66013DE94B8D13E9ED20316640762F165320F52408DAFED313C106346575273C66013DE94B8D13E9ED20316640762F165320F52408DAFED313C106346575273C66013DE94B8D13E9ED20316
# Algolia
algolia.usage=true
algolia.app.id=KLFWXPOEHY
algolia.api.key=87c939ac9269c88a17beeaacca28567a
algolia.index.name=online-shop-dev
```
* Execute the `mvn spring-boot:run` command in the `online-shop\online-shop-server` directory.
<br>
# To run the React client application:
* Execute the `npm install` command in the `online-shop\online-shop-ui` directory.
* Modify the `online-shop-ui\src\env-config.ts` file.
```ts
export const API_BASE_URL = "http://localhost:8080";
export const JWT_SECRET = "640762F165320F52408DAFED313C106346575273C66013DE94B8D13E9ED20316640762F165320F52408DAFED313C106346575273C66013DE94B8D13E9ED20316640762F165320F52408DAFED313C106346575273C66013DE94B8D13E9ED20316640762F165320F52408DAFED313C106346575273C66013DE94B8D13E9ED20316640762F165320F52408DAFED313C106346575273C66013DE94B8D13E9ED20316640762F165320F52408DAFED313C106346575273C66013DE94B8D13E9ED20316640762F165320F52408DAFED313C106346575273C66013DE94B8D13E9ED20316640762F165320F52408DAFED313C106346575273C66013DE94B8D13E9ED20316";
export const ALGOLIA_APP_ID = "KLFWXPOEHY";
export const ALGOLIA_API_KEY = "87c939ac9269c88a17beeaacca28567a";
export const ALGOLIA_INDEX_NAME = "online-shop-dev";
export const ALGOLIA_USAGE = true;
```
* Execute the `npm start` command in the `online-shop\online-shop-ui` directory.
<b>NOTE</b>: If you don't want to use the Algolia search and therefore to not display the search page, you don't have to define any Algolia properties.
<br>
# Selenium Integration Tests
* Online Shop also has a separate module for Selenium integration tests. It resides here: `online-shop/online-shop-it`
* Modify the `online-shop-it\src\test\resources\it-test.properties` file.
```properties
db.url=jdbc:mysql://localhost:3306/online_shop
db.username=root
db.password=1234
```
* Make sure to turn on the Spring server and React client to run the integration tests.
<b>NOTE</b>: If you run any integration test, it will dump all the existing data from your database.
<br>
#### Feel free to create issues and pull requests :)
| Online Shop made using Spring Boot and React | java,react,spring,spring-boot,javascript,redux,online-shop,typescript,e-commerce | 2023-03-20T19:37:05Z | 2024-04-08T11:15:56Z | null | 1 | 21 | 208 | 0 | 4 | 6 | null | MIT | Java |
nganesh197/website_workshop | main | # Website workshop
As part of holding a technical workshop, I have created an easy to use website template that solely uses HTML, CSS, JS for attendees to jumpstart their personal website building journey. The [live version of this website can be found via this link](https://nirajganesh.org/website_workshop/).
## Forewarning!!!
I tried to make use of this template as simple as possible with all of the bells and whistles of a well-made website. By no means, do I expect it to 100% work all of the time but I hope that issues that do arise can be solved with a quick Google Search and/or reference to StackOverflow.
## Tl:dr
Clone website to your personal repository --> Make edits --> Verify on your localhost (your computer) --> Deploy to GitHub pages --> Have a good personal website
## Get Started
You will need:
* Terminal\*
- If you are using Windows, I recommend using [GitBash](https://gitforwindows.org/).
- If you are using Linux, pressing Ctrl+Alt+T will open up terminal
- If you are using Mac, pressing Command+Spacebar will open up terminal
* GitHub Desktop\*
- Download [GitHub Desktop](https://desktop.github.com/)
* GitHub account
* Code editor
- I recommend [VSCode](https://code.visualstudio.com/).
* Internet Browser
- Google Chrome
- Microsoft Edge
- Safari
\* If you find Terminal hard to use, then please use GitHub Desktop. This application created by GitHub will do the same work that is done on Terminal.
Terminal/GitHub Desktop will help us with cloning the repository (repo), sending updates to the online repo, and general maintainence of our local repo. The code editor is primarily how we will make updates. The browser is to see how the website/webpage will look like as well as inspect elements to debug.
## Cloning
Using Terminal
1. Open terminal
2. Go to the folder where this repository will reside.
a. Use the cd ~/<FOLDERPATH> command to get to that location (example: cd ~/Documents/Github will get me to my GitHub folder in the Documents folder).
3. Type "git clone https://github.com/nganesh197/website_workshop.git" to start the cloning process.
4. Terminal will say if the cloning was successful and will allow you to type a command.
For more information on how to clone on GitHub via Terminal, [here is the GitHub tutorial cloning a repo](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository).
Using GitHub Desktop
1. Open the application
2. Open the left bar which shows the repository you have on your computer
3. Click "Add" then "Clone repository..."
4. Go to the "URL" tab
5. Type in the text field "nganesh197/website_workshop"
6. GitHub Desktop will say if the cloning was successful and return to main page albeit in the "website_workshop" repo.
- To verify if you are in the website_workshop repo, check if the current repository says "website_workshop."
For more information on how to clone on GitHub Desktop, [here is the GitHub Desktop tutorial cloning a repo](https://docs.github.com/en/desktop/contributing-and-collaborating-using-github-desktop/adding-and-cloning-repositories/cloning-a-repository-from-github-to-github-desktop).
## Code Structure
```
├── images
| └── gallery_img.jpg
| └── profile.jpg
| └── profile_1_main.jpg
| └── profile_2_main.jpg
| └── profile_3_main.jpg
| └── project2_sub1.jpg
| └── project2_sub2.jpg
| └── project2_sub3.jpg
├── 404.html
├── contact.html
├── footer.html
├── index.html
├── index.js
├── interests.html
├── nav_footer.js
├── navigation.html
├── projects.html
├── README.md
├── resume.html
└────── style.css
```
Think of index.html as the home page and where a user will typically arrive to when clicking on your website URL.
## Make edits
1. Open up your code edtior
2. Open up your repository in the code editor
3. All design/aesthetics components of the website is in the style.css
4. All of the conten reside in each of the html files.
5. The javascript files deal with adding in the webpage's navigation and footer content into the HTML file and allowing for the mobile navigation bar to open and close properly.
6. Once an edit has been, please save the file.
## Deploying website on localhost
To view the changes on the website on your computer, go either via your File Explorer or where your website repository is located and click on the index.html page. Technically this counts as deploying on your local machine/localhost/computer (these three terms in our case mean the same thing).
## Update your online repository
Changes made on your computer will not update what is on GitHub.
[Follow this link to push changes via GitHub Desktop](https://docs.github.com/en/desktop/contributing-and-collaborating-using-github-desktop/making-changes-in-a-branch/pushing-changes-to-github)
For pushing changes via terminal, follow these commands:
```
git add . //adds all of your changes
git commit -m "INSERT A MESSAGE" //takes a snapshot of what your local repo looks like
git push //send the snapshot to the remote (online reppo)
```
If the steps were done correctly, you should see changes made to the online repository.
## Getting your free GitHub URL
1. Take the your copy of the repository and rename it as your GitHub Username.
2. Go to Setting > Pages
3. Make sure you are deploying from source and from the main branch (you can also deploy from different branches too!)
4. Ensure that the "Enforce HTTPS" is checked
5. Once those steps have been done, you should be able to see your website at \<YOUR-USERNAME\>.github.io
| This website template was created for a 2 part website workshop that I held at USC. | css,css3,html,html5,javascript,template,website | 2023-03-22T21:26:37Z | 2023-04-12T05:22:53Z | null | 1 | 1 | 22 | 0 | 0 | 6 | null | null | HTML |
AbdusSattar-70/Leaderboard | dev | # Leaderboard
<!-- TABLE OF CONTENTS -->
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#triangular_flag_on_post-deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)
<!-- PROJECT DESCRIPTION -->
## 📖 Leaderboard <a name="about-project"></a>
This project is a Single Page Application (SPA) that interacts with a Leaderboard API to display a list of players' names and scores. Users can add new players' scores to the list, which is then stored in the API.
The project uses Webpack for bundling and optimizing code. Webpack allows you to combine all your JavaScript modules into a single file, reducing the number of HTTP requests required to load a web page. This results in a faster and more responsive web page for users.
The project is designed to provide a hands-on learning experience for those interested in learning about APIs, Git workflow, and Webpack. Through this project, users will learn how to fetch data from a remote server, manipulate the DOM to display the data, and send data back to the server to be stored. They will also learn how to use Git for version control, including creating and managing branches, committing changes, and merging them back into the main branch.
Overall, this project is a great way to gain practical experience in web development and gain valuable knowledge that can be applied to other projects in the future.
## 🛠 Built With <a name="built-with"></a>
## Tech Stack <a name="tech-stack"></a>
<details>
<summary>Client</summary>
<b>This project only works client side right now.</b>
<ul>
<li>HTML</li>
<li>CSS</li>
<li>JS</li>
<li>Webpack</li>
<li>API</li>
</ul>
</details>
<!-- Features -->
## Key Features <a name="key-features"></a>
- **Allows add players**
- **Allows add score**
- **shows recent score by name**
<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://glittering-lily-6961e8.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 <a name="prerequisites"></a>
In order to run this project you need:
# It would be best if you had some familiarity with `HTML`, `CSS`, and `JS`.
- A Computer (MAC or PC)
- code editor (VSCode,Atom etc...)
- A browser (Chrome,Mozilla,Safari etc...)
- Version Control System (Git and Github)
## Setup <a name="setup"></a>
Clone this repository to your desired folder:
``` bash
git clone https://github.com/AbdusSattar-70/Leaderboard.git
cd Leaderboard
```
## Install <a name="install"></a>
Install this project with:
``` bash
npm install
```
## Usage <a name="usage"></a>
You can use it to store game data in a remote location and see when you want for fun!
## Run tests <a name="run-tests"></a>
To run tests, run the following command:
- To check Styelint error:-
``` bash
npx stylelint "\*_/_.{css,scss}"
```
- To check Eslint error:-
```bash
npx exlint .
```
- To check webhint error:-
```bash
npx hint .
```
## Deployment <a name="triangular_flag_on_post-deployment"></a>
You can deploy this project using:
```bash
npm run build
```
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- AUTHORS -->
## 👥 Authors <a name="authors"></a>
## 👤 Abdus Sattar
- GitHub: [AbdusSattar-70](https://github.com/AbdusSattar-70)
- Twitter: [Abdus Sattar](https://twitter.com/Abdus_Sattar70)
- LinkedIn: [Abdus Sattar](https://www.linkedin.com/in/abdus-sattar-a41a26215/)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- FUTURE FEATURES -->
## 🔭 Future Features <a name="future-features"></a>
- Implement the ability to delete data from the Leaderboard API.
- Implement PUT and PATCH requests to update existing data in the API.
- Improve the visual design of the application to create a more aesthetically pleasing and user-friendly experience.
- This could include the use of advanced CSS techniques, animations, and custom graphics to make the application look more luxurious and modern.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- CONTRIBUTING -->
## 🤝 Contributing <a name="contributing"></a>
Everybody is welcome to suggest, changes,Contributions, issues, and feature request in this repo.
In order to do it, fork this repository, create a new branch and open a Pull Request from your branch.
Feel free to check the [issues page](../../issues/).
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- SUPPORT -->
## ⭐️ Show your support <a name="support"></a>
If you like this project, Please give me ⭐️ and you can use it following [MIT](./LICENSE) license.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- ACKNOWLEDGEMENTS -->
## 🙏 Acknowledgments <a name="acknowledgements"></a>
Thanks ❤️ to all of my coding partners, team members, and specifically Microverse code reviewers to help me to figure issues out.
I would like to thank and appreciate who contributes this project.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- LICENSE -->
## 📝 License <a name="license"></a>
This project is under [MIT](./LICENSE) licensed.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
| It's a demo project for learning the usage of API and Git workflow it is a SPA that displays a list of players' names and scores from Leaderboard API and allows you to add name and score info to the list. All data is stored in the API. | api,css3,github-actions,gitworkflow,html5,javascript,webpack | 2023-03-12T18:25:17Z | 2023-04-19T17:28:00Z | null | 1 | 6 | 39 | 0 | 0 | 6 | null | MIT | CSS |
Neil-Burgoyne/Shares-Portfolio-Application | main | # CodeClan - JavaScript Group Project
<kbd>
<img width="250" alt="Atlas Wealth Logo" src="https://github.com/Neil-Burgoyne/Shares-Portfolio-Application/blob/main/client/public/atlaslogo.png">
</kbd>
<br></br>
Atlas Wealth is a full-stack web application intended to help the client to record the held shares and track the market value changes.
This project was built using:
- React JS
- Express.js
- MongoDB
- Styled with MaterialUI
- TDD - Mocha | Cypress
- Finnhub API
<span>
<img hspace="5" height="50px" src="https://github.com/devicons/devicon/blob/v2.15.1/icons/react/react-original.svg">
<img hspace="5" height="50px" src="https://github.com/devicons/devicon/blob/v2.15.1/icons/javascript/javascript-original.svg">
<img hspace="5" height="50px" src="https://github.com/devicons/devicon/blob/v2.15.1/icons/mongodb/mongodb-original.svg">
<img hspace="5" height="50px" src="https://github.com/devicons/devicon/blob/v2.15.1/icons/materialui/materialui-plain.svg">
<img hspace="5" height="50px" src="https://github.com/devicons/devicon/blob/v2.15.1/icons/mocha/mocha-plain.svg">
</span>
<br>
<hr>
## Brief
A local trader has come to you with a portfolio of shares. She wants to be able to analyse it more effectively. She has a small sample data set to give you and would like you to build a Minimum Viable Product that uses the data to display her portfolio so that she can make better decisions.
### MVP
A user should be able to:
- View total current value.
- View individual and total performance trends.
- Retrieve a list of share prices from an external API and allow the user to add shares to her portfolio.
- View a chart of the current values in her portfolio.
## Project Setup
#### Inside Server Folder:
Install required node modules:
```
npm i
```
Run seed file to populate app with template data:
```
npm run seeds
```
Create .env file in the server folder, add the following code and insert the API key from [Finnhub](https://finnhub.io/):
API_KEY="api key"
Start the server:
```
npm run server:dev
```
#### Inside Client Folder:
Install required node modules:
```
npm i
```
Start the app:
```
npm start
```
## Contributors:
<a href="https://github.com/Neil-Burgoyne/Shares-Portfolio-Application/graphs/contributors">
<img src="https://contrib.rocks/image?repo=Neil-Burgoyne/Shares-Portfolio-Application" />
</a>
[Tim Henderson](https://github.com/TimoHenderson) | [Chris Barclay](https://github.com/doublerdiner) | [Neil Burgoyne](https://github.com/Neil-Burgoyne) | [Ross Condie](https://github.com/rosscondie)
| CodeClan: JavaScript React App Group Project | client-server,create-react-app,javascript,material-ui,api,mocha,mongodb,cypress | 2023-03-22T17:04:16Z | 2023-04-07T11:09:16Z | null | 4 | 124 | 354 | 0 | 3 | 6 | null | null | JavaScript |
kudzaiprichard/injury-on-duty-management | main |
<a name="readme-top"></a>
<!-- PROJECT LOGO -->
<br />
<div align="center">
<a href="https://github.com/kudzaiprichard/online-assessment-portal">
<img src="images/logo/logo.jpg" alt="Logo" width="80" height="80">
</a>
<h3 align="center">injury management system `IMS`</h3>
<p align="center">
A system to record, manage and process on duty injuries
<br />
</p>
<br/>
</div>
<!-- TABLE OF CONTENTS -->
<details>
<summary>Table of Contents</summary>
<ol>
<li>
<a href="#about-the-project">About The Project</a>
<ul>
<li><a href="#project-scope">Project Scope</a></li>
<li><a href="#project-design">Project Design</a></li>
<li><a href="#built-with">Built With</a></li>
</ul>
</li>
<li>
<a href="#getting-started">Getting Started</a>
<ul>
<li><a href="#prerequisites">Prerequisites</a></li>
<li><a href="#installation">Installation</a></li>
<li><a href="#contributing">Contributing</a></li>
</ul>
</li>
<li><a href="#license">License</a></li>
<li><a href="#contact">Contact</a></li>
<li><a href="#acknowledgments">Acknowledgments</a></li>
</ol>
</details>
<!-- ABOUT THE PROJECT -->
# About The Project
### Project Scope
An injury management system (IMS) is a documented description of detailed steps to be followed in a workplace injury case.
It incorporates the employer, the medical team, and the insurance. These parties ensure that affected workers regain from
injuries as soon as possible and return to work. It provides safe and timely support to workers in case of illness or
injury while on duty. Injury management systems will differ depending on the working environment and the industry in
which the company is operating. Any organization with employees IMS and an effective return to work program. An injury management
system will commonly feature an Incident from, Hazard Identification, Near Miss Reporting and Hazard Reporting.
System should be able to do the following:
* Users should be able to create and manage there accounts
* User should be able to enter records of an injury including taking claimants personal info
* User should also record claimants doctors reports as proof for injury
* After processing the records claimant should be able to get paid
## Project Design
### Architecture
MVC (Model-View-Controller) is an `architectural design pattern` that encourages improved `application organization` through
a `separation of concerns`. It divides an interactive application into `three components`: `Model` / `View` and `Controller`.
It enforces the isolation of business data (Models) from user interfaces (Views), with a third component (Controllers)
traditionally managing logic, user-input and coordinating both the models and views. The goal of MVC is to help structure
the `separate the concerns` of an application into `three parts`:
<div align="center">
<img src="images/architecture.png" alt="architecture Diagram" width="800">
</div>
1. `Model`
* The model is the layer that keeps data for the application. The layer is responsible for storing and retrieving data
from the database, and it is also responsible for validating the data.
> For example, if you want to create a new user, you will have to create a new user model and save it to the database.
2. `View`
* It is the layer used to present the application. It is used to display the data to the end-user.
> For instance, if you want to create a user view, you will have to create UI components that the user interacts with, such as a login form in an easy-to-understand format.
3. `Controller`
* The controller is the logic layer of the application. It is responsible for processing the user’s request and generating the response. It links the view and the model.
### MVC Sequence Diagram
Suppose an application that let you search for persons. The UI must have a `text field` where the user can enter a `search
string`, and it might have a button to start the search. Finally, it must have an area where the search `results are displayed`.
In our case, it is implemented with a `list component`.
The `Search for Persons` use case Scenario is:
* The user enters a search string in the text field
* The user clicks the search button.
* The search result is displayed in the result list.
<div align="center">
<img src="images/mvc-sequence-diagram-example-1.png" alt="sequence diagram">
</div>
> The sequence diagram above shows how the user’s button click moves through the application until the result gets finally
displayed in the list component.
### UML Diagram
<div align="center">
<img src="images/claimant.png" alt="UML Diagram">
</div>
> Above is the UML design of the system including relationships between the difference objects that make up the system
### Built With
Used `PHP`, `JavaScript`, `HTML`, `CSS` and `MySQL`.
<div>
<a href="https://php.net/" title="PHP"><img src="https://github.com/get-icon/geticon/raw/master/icons/php.svg" alt="PHP" width="40px" height="40px"></a>
<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript" title="JavaScript"><img src="https://github.com/get-icon/geticon/raw/master/icons/javascript.svg" alt="JavaScript" width="40px" height="40px"></a>
<a href="https://www.w3.org/TR/html5/" title="HTML5"><img src="https://github.com/get-icon/geticon/raw/master/icons/html-5.svg" alt="HTML5" width="40px" height="40px"></a>
<a href="https://www.w3.org/TR/CSS/" title="CSS3"><img src="https://github.com/get-icon/geticon/raw/master/icons/css-3.svg" alt="CSS3" width="40px" height="40px"></a>
<a href="https://dev.mysql.com/" title="MySQL"><img src="https://github.com/get-icon/geticon/raw/master/icons/mysql.svg" alt="MySQL" width="40px" height="40px"></a>
</div>
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- GETTING STARTED -->
## Getting Started
### Prerequisites
You should have the below software installed in your pc :
* PHP 8
* xampp 8
* MySQL
* and your preferred IDE or text editor
### Installation
1. Get a free API Key at [https://github.com/settings/tokens](https://github.com/settings/tokens)
2. Clone the repo
```sh
git clone https://github.com/kudzaiprichard/injury-on-duty-management
```
3. Make sure you copy the project to
```
c:/xampp/htdocs
```
4. Open project in IDE or text editor
5. Run xampp and start apache and mysql
6. Create and import database in php my admin
> NB: To run the system, open desired browser and on the url bar write
```
localhost/system-folder-name
```
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!--CONTRIBUTING-->
## Contributing
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
### :fire: Contribution
Your contributions are always welcome and appreciated. Following are the things you can do to contribute to this project.
1. **Report a bug** <br>
If you think you have encountered a bug, and I should know about it, feel free to report it [here]() and I will take care of it.
2. **Request a feature** <br>
You can also request for a feature [here](), and if it will viable, it will be picked for development.
3. **Create a pull request** <br>
It can't get better than this, your pull request will be appreciated by the community. You can get started by picking up any open issues from [here]() and make a pull request.
> If you are new to open-source, make sure to check read more about it [here](https://www.digitalocean.com/community/tutorial_series/an-introduction-to-open-source) and learn more about creating a pull request [here](https://www.digitalocean.com/community/tutorials/how-to-create-a-pull-request-on-github).
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- LICENSE -->
## License
> Distributed under the MIT License. See `LICENSE.txt` for more information.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- CONTACT -->
## Contact
> Kudzai P Matizirofa - [linkedin.com/in/kudzai-prichard](https://linkedin.com/in/kudzai-prichard) - <kudzaiprichard@gmail.com>
Project Link: [https://github.com/kudzaiprichard/injury-on-duty-management](https://github.com/kudzaiprichard/injury-on-duty-management)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- ACKNOWLEDGMENTS -->
## Acknowledgments
list of resources I found helpful and would like to give credit to.
* [Choose an Open Source License](https://choosealicense.com)
* [MVC Framework - Introduction](https://www.tutorialspoint.com/mvc_framework/mvc_framework_introduction.htm)
* [PHP Documentation](https://www.php.net/docs.php)
* [GitHub Pages](https://pages.github.com)
* [MySql docs](https://dev.mysql.com/doc/)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
| A PHP system to manage on duty company injuries | bootstrap,css,html,javascript,mvc,mvc-architecture,mysql,object-oriented-programming,oop,php | 2023-03-19T22:36:11Z | 2023-10-14T22:10:18Z | null | 1 | 0 | 10 | 0 | 0 | 6 | null | NOASSERTION | PHP |
Soburjon19/To-Do-List | master | <h2 align="center">
<a href="https://soburjon-todo-list.netlify.app/" target="_blank">To-Do List</a>
</h2>
<div align="center">
<img alt="Image" src="./image/to-do-list.jpg" />
</div>
## 🛠 Installation and Setup Instructions
1. Installation: `npm i or npm install`
2. 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 the browser.
The page will reload if you make edits.
## Usage Instructions
Open the project folder and Navigate to `/src/components/`. <br/>
You will find all the components used and you can edit your information accordingly.
### Show your support
Give a ⭐ if you like this website!
<a href="https://www.buymeacoffee.com/soburjon19" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-violet.png" alt="Buy Me A Coffee" height= "60px" width= "217px" ></a>
| null | javascript,react,to-do-list,css,react-beautiful-dnd | 2023-03-16T03:57:44Z | 2023-03-26T06:34:17Z | null | 1 | 5 | 19 | 0 | 0 | 6 | null | null | JavaScript |
harshi0102/ConferencePage | main | <a name="readme-top"></a>
<!-- TABLE OF CONTENTS -->
# 📗 Table of Contents
- [📗 Table of Contents](#-table-of-contents)
- [📖 \[Conference Web Page -Capstone Project\] ](#-conference-web-page--capstone-project-)
- [Video Presentation ](#video-presentation-)
- [🛠 Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Key Features ](#key-features-)
- [🚀 Live Demo ](#-live-demo-)
- [💻 Getting Started ](#-getting-started-)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#deployment)
- [👥 Authors ](#-authors-)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [📝 License ](#-license-)
<!-- PROJECT DESCRIPTION -->
# 📖 [Conference Web Page -Capstone Project] <a name="about-project"></a>
**[Conference Web Page ]** is a conference web page built on HTML,CSS and Javascript.
I used semantic HTML tags in this project. -I used CSS selectors correctly. -I Used CSS box model. -I used Flexbox to place elements in the page. -I Demonstrated the ability to create UIs adaptable to different screen sizes using media queries. -I used GitHub Pages to deploy web pages. -I Applied JavaScript best practices and language style guides in this code. -I Used JavaScript to manipulate DOM elements. -I Used JavaScript events. -I used objects to store and access data.
[Live Demo](https://harshi0102.github.io/ConferencePage/)
<!--Video-->
## Video Presentation <a name="video-presentation"></a>
[Click Here for Video Presentation](https://www.loom.com/share/37fdc5ee0b2b4ab9994e54aa0f504f6a)
Desktop Version <a name="desktop-version"></a>
Mobile Version <a name="mobile-version"></a>
## 🛠 Built With <a name="built-with"></a>
### Tech Stack <a name="tech-stack"></a>
> - Front-end: HTML, CSS, JavaScript, Flexbox, Grid, Media Queries, Semantic HTML.
- Back-end: Not applicable as the project is a static website.
- Database: Not applicable as the project is a static website.
- Deployment: The website can be hosted on a web server or using a static site generator like Github Pages.
<details>
<summary>HTML</summary>
<ul>
<li><a href="https://www.w3schools.com/html/">HTML5</a></li>
</ul>
</details>
<details>
<summary>CSS</summary>
<ul>
<li><a href="https://www.w3schools.com/Css/">CSS3</a></li>
</ul>
</details>
<details>
<summary>Javascript</summary>
<ul>
<li><a href="https://javascript.info/">Javascript</a></li>
</ul>
</details>
<!-- Features -->
### Key Features <a name="key-features"></a>
> Describe between 1-3 key features of the application.
- **[Implemeted HTML,css and Javascript ]**
- **[Usage of Grid, media queries Semantic HTML]**
<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://harshi0102.github.io/ConferencePage/)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- GETTING STARTED -->
## 💻 Getting Started <a name="getting-started"></a>
> Create a local directory that you want to clone the repository.
- Open the command prompt in the created directory.
- On the terminal run this command git clone https://github.com/harshi0102/ConferencePage.git
- Go to the repository folder using command prompt cd.
- Install the dev dependencies for linters run npm install.
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
A web browser: You will need a modern web browser such as Google Chrome, Mozilla Firefox, or Safari to view and test your project.
- A code editor: You will need a code editor such as Visual Studio Code, Sublime Text, or Atom to write, edit, and manage your project's files.
- A local server: You will need a local server such as XAMPP or WAMP to run your project locally and test it on your own computer.
- Knowledge of HTML, CSS, and JavaScript: You will need to have a basic understanding of HTML, CSS, and JavaScript in order to build a web development project.
- Familiarity with Git and GitHub: If you are using Git and GitHub to manage your project's codebase, you will need to be familiar with how to use them.
<!--
Example command:
```sh
gem install rails
```
-->
### Setup
Clone this repository to your desired folder:
- Open the command prompt in the created directory.
- On the terminal run this command git clone https://github.com/harshi0102/ConferencePage.git
- Go to the repository folder using command prompt cd.
- Install the dev dependencies for linters run npm install.
### Install
No installation required
<!--
Example command:
```sh
cd my-project
gem install
```
--->
### Usage
To run the project, open index.html in any web browser.
<!--
Example command:
```sh
rails server
```
--->
### Run tests
To run tests, open index.html in any web browser.
<!--
Example command:
```sh
bin/rails test test/models/article_test.rb
```
--->
### Deployment
You can check the live version here:https://harshi0102.github.io/ConferencePage/
<!--
Example:
```sh
```
-->
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- AUTHORS -->
## 👥 Authors <a name="authors"></a>
👤 **Author1**
- GitHub: [harshi0102](https://github.com/harshi0102)
- Twitter: [@harshika0102me](https://twitter.com/harshika0102me)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/harshikagovind)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- FUTURE FEATURES -->
## 🔭 Future Features <a name="future-features"></a>
- Implement some UX improvements: add the "More" button on the home page, include transitions and/or animation
- Implement additional pages, like the tickets page and the schedule page. Make sure that you have a decent mobile design for them
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- CONTRIBUTING -->
## 🤝 Contributing <a name="contributing"></a>
Contributions, issues, and feature requests are welcome!
Feel free to check my issues page: https://github.com/harshi0102/ConferencePage/issues
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- SUPPORT -->
## ⭐️ Show your support <a name="support"></a>
>
If you like this project...Give a ⭐️ if you like this project!
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- ACKNOWLEDGEMENTS -->
## 🙏 Acknowledgments <a name="acknowledgements"></a>
[Cindy Shin](https://www.behance.net/gallery/29845175/CC-Global-Summit-2015) for the Amazing Design Template.
[Fontawsome](https://fontawesome.com/) Special thanks to fontawsome for the icons assets.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- FAQ (optional) -->
<!-- LICENSE -->
## 📝 License <a name="license"></a>
This project is [MIT](https://github.com/harshi0102/ConferencePage/blob/main/LICENSE) licensed.
<p align="right">(<a href="#readme-top">back to top</a>)</p> | [Conference Web Page ] is a conference web page that shows the information about Conferences built on HTML,CSS and Javascript. | css,css3,html,html5,javascript | 2023-03-20T09:32:48Z | 2023-05-13T12:51:47Z | null | 1 | 1 | 21 | 1 | 0 | 5 | null | MIT | CSS |
magicdev122/react-native | master | my first react native project
| null | android,ios,javascript,react,react-native | 2023-03-12T08:52:36Z | 2023-03-12T08:59:58Z | null | 1 | 0 | 2 | 0 | 0 | 5 | null | MIT | JavaScript |
consci210/Candy-Crush-Game- | Branch1 | # 🍭 Candy Crush Game 🎮
[LIVE-DEMO](https://candy-crush-react21.netlify.app/)
Indulge in the sweet and addictive world of candy crushing with my ReactJS implementation of the popular game.This game has helped me to hone my skills in using advanced JavaScript higher-order methods and elevated my ReactJS proficiency. With vibrant colors, seamless user experience, and challenging levels, my Candy Crush game is the perfect treat for casual and avid gamers alike. Satisfy your sweet tooth and sharpen your coding skills with my candy-crushing adventure! 🍬🍫🍭
## Technologies Used
- ReactJS
- JavaScript
- HTML
- CSS
## How to Play
- Clone or download the repository
- Run npm install to install the dependencies
- Run npm start to start the game
- Match three or more candies of the same color to score points and progress through the levels 🍭🍬💯
- Beware of the chocolate blockers and time constraints ⏰🍫
## Acknowledgments
Special thanks to Ania Kubow (@kubowania) for providing the tutorial that helped me create this game. Check out her channel for more amazing coding tutorials! 🙌
| 🍭🎮 Indulge in the sweet and addictive world of candy crushing with my ReactJS implementation of the popular game | candy-crush,games,react,reactgame,reactjs,webgame,first-timers,game,javascript | 2023-03-16T13:04:37Z | 2023-04-05T10:49:01Z | null | 2 | 1 | 29 | 0 | 1 | 5 | null | null | JavaScript |
GeekyHacks/My-Personal-Portfolio | main | # My-Personal-Portfolio
<a name="readme-top"></a>
<div align="center">
<img src="assests/images/Personal-portfolio-with-play.gif" alt="Personal portfolio video">
<br>
<a href="https://www.loom.com/share/cd64aa69dc6a4eccbdb72ddcaad2930e?sid=4119501f-11fe-4048-a05e-4e344525febe">Watch full video </a>
</div>
<br>
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ](#faq)
- [📝 License](#license)
# 📖 Personal Portfolio! <a name="about-project"></a>
**My Personal Portfolio!**
This is my second project with Microverse using Github professional flow and it's a porfolio website that is built in html & css, it includes my resume, basic information about me and my career, and projects I have worked on.
## 🛠 Built With <a name="built-with">HTML, CSS</a>
### Key Features <a name="key-features">
</a>
- Mobile First Styling
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 🚀 Live Demo <a name="live-demo"></a>
- [Live Demo Link](https://geekyhacks.github.io/My-Personal-Portfolio/)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 💻 Getting Started <a name="getting-started"></a>
To get a local copy up and running, follow these steps:
- Open your Terminal in your VSCode.
- Navigate to the desired directory[folder] to which you want to clone the repository to
- [Copy & Paste] git clone you find in the code button https://github.com/GeekyHacks/Personal-Portfolio-Microverse.git
### Prerequisites
In order to run this project you need:
- General Understanding of HTML & CSS
- basic Knowledge of Git Commands
- basic Knowledge of the Terminal Commands
### Setup
Clone this repository to your desired folder:
- git clone https://github.com/GeekyHacks/Personal-Portfolio-Microverse.git
Example commands:
```sh
cd my-folder
git clone https://github.com/GeekyHacks/Personal-Portfolio-Microverse.git
```
--->
### Install
Must-Install-Project-with-the-Following-Programmes:
- Prettier Extention in VScode
- Git
- Node.js
- npm install
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 👥 Authors <a name="authors"></a>
👤 **GeekyHacks**
- GitHub: [Geekyhacks](https://github.com/GeekyHacks)
- Twitter: [Geekydart](https://twitter.com/GeekyDart)
- LinkedIn: [Abdullah Nasser](https://www.linkedin.com/in/abdullah-nasser-711625268/)
## 🔭 Future Features <a name="future-features"></a>
- Adding Contact Form Page
- Customizing it for Desktop Screen
- Adding Email Newsletter Form
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 🤝 Contributing <a name="contributing"></a>
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/GeekyHacks/My-Personal-Portfolio/issues).
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## ⭐️ Show your support <a name="support"></a>
If you like this project please don't hesitate to support me with your valued contribution and don't forget to star the repo to reach more
people.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 🙏 Acknowledgments <a name="acknowledgements"></a>
I would like to thank...
- Microverse Review Team
- My Coding Partners
- Microverse Community in Slack
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## ❓ FAQ <a name="faq"></a>
Can I clone this project ?\*\*
- Of course you can as long as you fork it and star it
Can I contribute to this project?\*\*
- definitely you can
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 📝 License <a name="license"></a>
This project is [MIT](https://github.com/GeekyHacks/Personal-Portfolio-Microverse/blob/c94c940b573e85b888d2d3da699284214552018b/MIT.md) licensed.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
| This is my portfolio that I will be modifying and updating overtime, it includes some projects I did in my modest journey as full-stack developer | css,css3,javascript,portfolio,portfolio-website,html,personal-website | 2023-03-25T23:06:01Z | 2023-07-27T19:31:59Z | null | 5 | 22 | 211 | 3 | 0 | 5 | null | MIT | CSS |
ilyassatlassi/Maths-magician | dev | <a name="readme-top"></a>
<div align="center">
<h3><b>Module 3: Math Magician</b></h3>
</div>
<!-- TABLE OF CONTENTS -->
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ](#faq)
- [📝 License](#license)
<!-- PROJECT DESCRIPTION -->
# 📖 Math Magician <a name="about-project"></a>
Math Magician is project from Microverse module 3, it is a Webapp built using ReactJS.
## 🛠 Built With <a name="built-with"></a>
HTML, CSS, NodeJS v18, ReactJS
### Tech Stack <a name="tech-stack"></a>
<details>
<summary>Structure</summary>
<ul>
<li><a href="https://html.com/">HTML</a></li>
</ul>
</details>
<details>
<summary>Style</summary>
<ul>
<li><a href="https://www.w3schools.com/css/">CSS</a></li>
</ul>
</details>
<details>
<summary>Front-end framwork</summary>
<ul>
<li><a href="https://webpack.js.org/">ReactJS</a></li>
</ul>
</details>
<details>
<summary>Linters</summary>
<ul>
<li><a href="https://webhint.io/">Webhint</a></li>
<li><a href="https://stylelint.io/">Stylelint</a></li>
<li><a href="https://eslint.org/">ESLint</a></li>
</ul>
</details>
<!-- Features -->
### Key Features <a name="key-features"></a>
- Virtual DOM.
- JSX.
- Components.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- LIVE DEMO -->
## 🚀 Live Demo <a name="live-demo"></a>
- [Live Demo](https://math-magician-ilyass.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:
Open terminal on the same folder of the project and run:
```sh
npm install
```
### Setup
Clone this repository to your desired folder:
```sh
cd my-folder
git https://github.com/ilyassatlassi/Maths-magician.git
```
### Install
Install this project with:
```sh
cd Math-magician
npm install
```
### Usage
Run in development mode (Port 3000)
```
npm run start
```
### Build for production
```
npm run build
```
### Run tests
- ### Linter Tests
To run tests, run the following command:
To check for html errors run:
```sh
npx hint .
```
To check for css errors run:
```sh
npx stylelint "**/*.{css,scss}"
```
To check for js errors run:
```sh
npx eslint "**/*.{js,jsx}"
```
<!-- AUTHORS -->
## 👥 Authors <a name="authors"></a>
👤 Author1
- GitHub: [@ilyassatlass](https://github.com/ilyassatlass)
- Twitter: [@ilyass_atlassi](https://twitter.com/ilyass_atlassi)
- LinkedIn: [Ilyass Atlassi](https://www.linkedin.com/in/ilyassatlassi/)
<!-- FUTURE FEATURES -->
## 🔭 Future Features <a name="future-features"></a>
- Add Components.
- Add Events.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- CONTRIBUTING -->
## 🤝 Contributing <a name="contributing"></a>
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/ilyassatlassi/Maths-magician/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 send your feedback to encourage me to do more.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- ACKNOWLEDGEMENTS -->
## 🙏 Acknowledgments <a name="acknowledgements"></a>
I would like to thank Microverse for offering me this opportunity to learn, and practice my skills.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- FAQ (optional) -->
## ❓ FAQ <a name="faq"></a>
-Why use linters?
- The use of linters helps to diagnose and fix technical issues, also linters can help teams achieve a more readable and consistent style, through the enforcement of its rules.
-Why use ReactsJS?
- React has reusable Components.
- React uses Virtual DOM.
- React has a large ecosystem.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- LICENSE -->
## 📝 License <a name="license"></a>
This project is [MIT](./LICENCE.md) licensed.
(Check the LICENSE file)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
| A calculator application created with React. Users can perform basic operations such as addition, subtraction, multiplication, and division, as well as more advanced operations like modulo. | css,javascript,reactjs | 2023-03-20T16:18:07Z | 2023-04-02T15:35:39Z | null | 2 | 7 | 34 | 0 | 0 | 5 | null | MIT | JavaScript |
devvsakib/orderfood | main | null | Order Food from home and eat delicious burger pizza | javascript,mern-stack,mongodb,reactjs,authentication,firebase,firebase-auth | 2023-03-18T15:46:28Z | 2023-03-18T18:14:49Z | null | 1 | 0 | 5 | 0 | 0 | 5 | null | null | JavaScript |
sparkz-technology/simongame | main | # Simon Game
This is a web app that simulates the classic memory game Simon. The app shows a sequence of colors that the user has to repeat by clicking on the corresponding buttons. The sequence gets longer and faster as the game progresses. The game ends when the user makes a mistake.
## Technologies
- HTML
- CSS
- JavaScript
- jQuery
## Usage
To run the app, open the `index.html` file in your browser. You can press any key to start the game. You will see a level number and a color flashing on the screen. You have to click on the same color button as shown. Then, another color will be added to the sequence and you have to repeat it. The game will keep adding colors until you make a mistake. You can press any key to restart the game.
[🚀Click Here](https://sparkz-technology.github.io/simongame/)
> Author: github.com/sparkz-technology
| This is a web app that simulates the classic memory game Simon. | css3,html5,javascript | 2023-03-21T02:31:21Z | 2023-07-11T14:35:05Z | null | 1 | 0 | 7 | 0 | 0 | 5 | null | null | JavaScript |
ekremgunes/Blog-WebUI | master | <h3>Example views</h3>
<hr>
<img src="readmeFiles/Ekran görüntüsü 2023-04-03 101228.png"/>
<hr>
<img src="readmeFiles/Ekran görüntüsü 2023-04-03 101205.png"/>
<hr>
<img src="readmeFiles/Ekran görüntüsü 2023-04-03 101432.png"/>
<div>
<img src="readmeFiles/mobile-index.png"/>
<img src="readmeFiles/mobile-single.png"/>
</div>
<hr>
<div>
<img width="45%" src="readmeFiles/commentreply.png "/>
<img width="45%" src="readmeFiles/comments.png "/>
</div>
<hr>
<img src="readmeFiles/single.png "/>
<hr>
<img src="readmeFiles/Ekran görüntüsü 2023-04-03 101402.png"/>
<video src="readmeFiles/login_signup.mp4">
<h5>License</h5>
<a href="LICENSE.md">MIT</a>
| You can use this template; Designed with responsive,html,css,js,bootstrap | ajax,blogtemplate,html-css-javascript,template,javascript,jquery,bootstrap,css3,fetch-api,html5 | 2023-03-22T15:02:55Z | 2023-07-04T17:35:43Z | null | 1 | 1 | 44 | 0 | 0 | 5 | null | Apache-2.0 | CSS |
MukulKolpe/MedMate | main | # MedMate🏥
## Introduction📚
MedMate is a Web3 solution to manage medical records, consult with professionals, and book appointments with medical experts with different expertise all in one place
## Tools & Technologies Used 🎯
<li>ReactJS</li>
<li>Chakra UI</li>
<li>Solidity</li>
<li>ethersjs</li>
<li>react-router-dom</li>
<li>Scroll's Alpha Testnet</li>
<li>Polybase</li>
## List of all Smart Contracts Depolyed on Scroll:-
```
Doctor.sol:- 0x0Df39c36E8e9b462F2672498054E129416a7093D
```
```
CreateDoctor.sol:- 0x09d0907751601eb789078Fe14f184A53490811f0
```
## List of all Smart Contracts deployend on Optimism Goerli
```
Doctor.sol - 0x9452C28fC02370a15a279f325C84EC14a8278dA3
```
| MedMate is a Web3 solution to manage medical records, consult with professionals, and book appointments with medical experts with different expertise all in one place | react-router,reactjs,vite,scroll-alpha,ethereum,ethersjs,javascript,solidity,polybase,chakra-ui | 2023-03-24T01:23:24Z | 2023-03-26T16:28:15Z | null | 4 | 21 | 52 | 0 | 0 | 5 | null | null | JavaScript |
apocas/wireguarode | main | # Wireguarode
* Wireguarode allows to easily manage a Wireguard installation with ACLs and 2FA (TOTP) peer authentication.
* It works with a main JSON file as input/config, allowing to allocate peers to groups, manage ACLs, and enable 2FA TOTP authentication.
* Wireguarode can be used both as a library and a CLI tool.
* Leverages `iptables` to acomplish all this.
## Features
- Accepts JSON configuration file
- Group-based peer allocation
- Access Control Lists (ACL) management
- Two-Factor Authentication (2FA) with Time-based One-Time Password (TOTP)
- Library and CLI usage
## Installation
To install Wireguarode, run the following command:
```bash
npm install -g wireguarode
```
You need to have Wireguard already installed, `wireguarode` defaults to `/etc/wireguard/...` but it's possible to specify a different path.
## Usage
### As a CLI tool
To use Wireguarode as a CLI tool, simply provide the path to your JSON configuration file as an argument:
```bash
wireguarode --help
wireguarode group --help
wireguarode peer --help
```
#### Example use case
* Create two groups of peers one called "operator" that can only access a specific IP address and port and an unrestricted one called "god".
* Add a new peer that belongs to the operator group.
```bash
wireguarode group add operator
wireguarode group adddestination operator tcp://192.168.1.10:443
wireguarode group adddestination operator tcp://192.168.1.10:22
wireguarode group add god
wireguarode peer add --identifier john.doe2@rainbow --key XXXXXXX --address 10.15.12.4 --group operator
wireguarode reload
```
### 2FA
```bash
wireguarode peer secret john.doe1@rainbow
> Secret generated: otpauth://totp/wireguarode:john.doe1%40rainbow?secret=XXXXXXXXXXXX&period=30&digits=6&algorithm=SHA1&issuer=wireguarode
wireguarode reload
```
#### CLI Commands
Wireguarode supports several CLI commands for different operations:
- `save`: Save the configuration file to a specified optional path.
- `generate`: Generate Wireguard configuration files and save them to a specified path.
Group Commands:
- `add`: Add a new group.
- `remove`: Remove an existing group.
- `adddestination`: Add a destination (IP, port, and protocol) to an existing group.
- `removedestination`: Remove a destination (IP, port, and protocol) from an existing group.
Peer Commands:
- `activate`: Activate a peer using a TOTP code.
- `deactivate`: Deactivate a peer.
- `secret`: Activate 2FA for a peer.
- `expire`: Expire peers based on the maximum minutes since their last login (default: 24 hours).
- `add`: Add a new peer.
To use a command, pass it as an argument followed by the configuration file:
```bash
wireguarode <command> [arguments]
```
### As a library
To use Wireguarode as a library, first install it as a dependency in your project:
```bash
npm install wireguarode
```
Then, you can import and use it in your project:
```javascript
const wireguarode = require('wireguarode');
// Load your WireGuard configuration JSON
const config = require('./path/to/your/config.json');
// Instantiate Wireguarode
var wireguard = new Wireguard();
wireguard.loadConfig(config);
```
## Configuration
* Wireguarode uses a JSON file for its configuration.
* The following configuration will automatically generate the files that are in the `output_example` folder.
```json
{
"addresses": [
"192.168.1.1"
],
"enforce2fa": false,
"debug": true,
"path": "/etc/wireguard",
"private_key": "XXXXXXXXXX",
"listen_port": 12345,
"interfaces": [
"eth0",
"eth1"
],
"peers": [
{
"identifier": "john.doe1@rainbow",
"addresses": [
"192.168.20.1"
],
"public_key": "YYYYYYYYYY",
"group": "xpto"
},
{
"identifier": "john.doe2@rainbow",
"addresses": [
"192.168.20.3"
],
"public_key": "HHHHHHHHHHH",
"group": "admin"
}
],
"groups": [
{
"name": "admin",
"destinations": [
"tcp://192.168.1.1:80",
"tcp://192.168.1.1:443"
]
},
{
"name": "admin2",
"destinations": [
"tcp://192.168.1.10:443",
"tcp://192.168.1.2:22",
"tcp://192.168.1.4:22"
]
},
{
"name": "xpto",
"destinations": [
"tcp://192.168.1.2:22"
]
}
]
}
``` | Wireguard with ACLs and TOTP 2FA | acls,iptables,nodejs,wireguard,javascript,vpn,security | 2023-03-20T19:14:04Z | 2023-03-28T01:25:50Z | 2023-03-28T01:25:50Z | 1 | 0 | 47 | 0 | 0 | 5 | null | Apache-2.0 | JavaScript |
CodingWithEnjoy/Weather-Application-HTML-CSS-JS | main | <h2 align="center">آب و هوا | Weather App 🤩🚀</h2>
###
<h4 align="center">دمو | Demo 😁<br><br>https://codingwithenjoy.github.io/Weather-Application-HTML-CSS-JS</h4>
###
<p align="left"></p>
###
<p align="left"></p>
###
<div align="center">
<img height="350" src="https://user-images.githubusercontent.com/113675029/227153481-8dc4374a-548e-4d9a-91f5-7ef997aab6db.png" />
</div>
###
<p align="left"></p>
###
<div align="center">
<img height="350" src="https://user-images.githubusercontent.com/113675029/227153559-0936c542-a892-4904-be45-95c1c384197b.png" />
</div>
###
<p align="left"></p>
###
<p align="left"></p>
###
<p align="left"></p>
###
<div align="center">
<a href="https://www.instagram.com/codingwithenjoy/" target="_blank">
<img src="https://raw.githubusercontent.com/maurodesouza/profile-readme-generator/master/src/assets/icons/social/instagram/default.svg" width="52" height="40" alt="instagram logo" />
</a>
<a href="https://www.youtube.com/@codingwithenjoy" target="_blank">
<img src="https://raw.githubusercontent.com/maurodesouza/profile-readme-generator/master/src/assets/icons/social/youtube/default.svg" width="52" height="40" alt="youtube logo" />
</a>
<a href="mailto:codingwithenjoy@gmail.com" target="_blank">
<img src="https://raw.githubusercontent.com/maurodesouza/profile-readme-generator/master/src/assets/icons/social/gmail/default.svg" width="52" height="40" alt="gmail logo" />
</a>
<a href="https://twitter.com/codingwithenjoy" target="_blank">
<img src="https://raw.githubusercontent.com/maurodesouza/profile-readme-generator/master/src/assets/icons/social/twitter/default.svg" width="52" height="40" alt="twitter logo" />
</a>
</div>
###
<p align="left"></p>
###
<h4 align="center">توسعه داده شده توسط برنامه نویسی با لذت</h4>
###
| آب و هوا | Weather App 🤩🚀 | api,css,fetch,fetch-api,html,javascript,js,json,openweathermap,openweathermap-api | 2023-03-23T08:51:44Z | 2023-03-24T13:43:54Z | null | 1 | 0 | 6 | 0 | 0 | 5 | null | Apache-2.0 | CSS |
vaibhzz101/vaibhzz101.github.io | main | # vaibhzz101.github.io
Portfolio
| Portfolio | css,html,javascript | 2023-03-16T08:30:43Z | 2024-02-15T05:31:46Z | null | 1 | 0 | 70 | 0 | 0 | 5 | null | null | HTML |
Drabovich/quiz | master | null | Quiz | javascript,css,html | 2023-03-18T09:44:34Z | 2024-01-15T06:41:06Z | null | 1 | 0 | 3 | 0 | 0 | 5 | null | null | CSS |
sparkz-technology/drumkit | main | # Drum Kit
This is a simple drum kit application that allows you to play different drum sounds by pressing keyboard keys or clicking on buttons. It features sound playback, keyboard event handling, button event handling, and animation effects.
## Usage
To play the drum sounds, you can either press the corresponding keys on your keyboard or click on the buttons displayed on the screen. Each key/button corresponds to a specific drum sound. When a key is pressed or a button is clicked, the associated sound will be played.
## Keyboard Event Handling
The application listens for `keydown` events on the document. When a key is pressed, it triggers the `sound()` function to play the corresponding drum sound. Additionally, the `activeKey()` function is called to animate the pressed key/button.
## Button Event Handling
The application adds event listeners to each drum button on the page. When a button is clicked, it triggers the `sound()` function with the respective drum sound as an argument. Similarly, the `activeKey()` function is called to animate the clicked key/button.
## Drum Sounds
The drum sounds used in this application are provided in the `sounds/` folder. Each drum sound corresponds to a specific key/button and is played using the HTML5 `Audio` element.
## Animation Effects
When a key is pressed or a button is clicked, the associated key/button is animated briefly using the `pressed` class. This class is added to the respective element and then removed after a short delay, creating a visual feedback effect.
## Customization
To customize the drum kit, you can modify the following:
- Add or remove drum buttons in the HTML code.
- Replace the drum sounds in the `sounds/` folder with your own audio files.
- Modify the `sound()` function to add more drum sounds or change the existing ones.
- Adjust the animation effects by modifying the CSS styles in your own stylesheet.
Feel free to customize the drum kit according to your preferences and requirements.
[🚀Click Here](https://sparkz-technology.github.io/drumkit/)
> Author: github.com/sparkz-technology
| This is a simple drum kit application that allows you to play different drum sounds by pressing keyboard keys or clicking on buttons. | css3,html5,javascript | 2023-03-18T10:11:51Z | 2023-08-18T18:09:55Z | null | 1 | 0 | 15 | 0 | 0 | 5 | null | null | JavaScript |
create3000/sunrize | main | # [Sunrize](https://create3000.github.io/sunrize/) — A Multi-Platform X3D Editor
[](https://www.npmjs.com/package/sunrize)
[](https://npmtrends.com/sunrize)
[](https://deepscan.io/dashboard#view=project&tid=23540&pid=26817&bid=855450)
## Introduction
Sunrize is based on [X_ITE](https://create3000.github.io/x_ite/) and is a basic editor for X3D files. The scene can be edited in an Outline Editor and there is a Script Editor where Script nodes and ComposedShader nodes can be edited.
## Quick Links
* [Website](https://create3000.github.io/sunrize/)
* [Documentation](https://create3000.github.io/sunrize/documentation/)
## Usage
First you need to install both Node.js and npm on your system. To accomplish this, you can use a [Node installer](https://nodejs.org/en/download/) (Windows), or use [Homebrew](https://brew.sh) to install node (macos), or use your Linux package manager.
Then you can run Sunrize without installing it using npm's **npx** command:
```console
$ npx sunrize@latest [files]
```
>**Note:** The first time, it may take a while for Sunrize to start.
## License
Sunrize is free software: you can redistribute it and/or modify it under the terms of the [GNU General Public License version 3](LICENSE.md) only, as published by the Free Software Foundation.
| Sunrize — A Multi-Platform X3D Editor | editor,vrml,webgl,wrl,x3d,3d,electron,javascript,json,node | 2023-03-22T23:12:00Z | 2024-05-21T14:35:34Z | null | 1 | 0 | 2,168 | 2 | 0 | 5 | null | NOASSERTION | JavaScript |
chaseottofy/Portfolio | main | # [ottofy.dev](https://ottofy.dev)
> **Warning**
> Regarding the form: Refer to the [Form](#contact-form) section for information on how to setup the contact form, your build.
> Regarding the image optimization script: Requires setup, refer to the [Images](#images) section before running any CLI commands.
---
Special thank you to [@webdiscus](https://github.com/webdiscus) founder of [html-bundler-webpack-plugin](https://github.com/webdiscus/html-bundler-webpack-plugin) for help configuring the plugin.
---
**Table of Contents**
<!-- - [Notes](#notes) -->
- [Cloning](#cloning)
- [Features](#features)
- [Form](#contact-form)
- [Apps Script Setup](#apps-script-setup)
- [Images](#images)
- [How I handle Project Images](#how-i-handle-project-images)
- [CLI Commands](#cli-commands)
- [Resources](#resources)
## Cloning
Clone the repository and install dependencies
```bash
git clone
cd portfolio
npm install
```
Create a .env file in the root of the project, it can be empty or if you want to use the contact form, follow the steps in [Apps Script Setup](#apps-script-setup) and add the `SHEET_ID` to the .env file.
```bash
touch .env
```
---
**If you decide to not use the contact form**, follow the steps below to remove it from the project:
1. Remove the following files: `/src/components/form` & `/src/styles/sections/contactForm.css`
2. Remove the following lines from `/src/index.js`
```javascript
import initForm from './components/form/form';
initForm();
```
3. Remove the following Tag from `/src/index.html`
```html
<article class="contact-form--container"></article>
```
---
## Features
- Zero 3rd party code/dependencies, all assets are local.
- 100% Vanilla JS & Vanilla CSS
- Includes linting for both JS and CSS
- Handlebars
- If you are unfamiliar with handlebars, don't worry, I've only implemented the most basic feature and it's all self explanatory. It's just an easy way to create reusable html templates, and more importantly, break up long html files. All configuration is done in the webpack config within the html-bundler-webpack-plugin. Just define the entry `index.hbs` and the directory where the templates `partials` are located. The plugin is a dev dependency and does not affect the build.
- Prioritizes DOM updates vs re-renders, very aggressive memory management.
- Majority of content is defined in JSON, and then loaded into templates. Zero additional nodes are created on load to avoid layout shifts.
- UX focused design, 100% from scratch
- Useful custom vanilla hooks: closeOnEsc, throttle, copyToClipboard, etc.
- Custom vanilla components: tabs, modals, toast, tooltips, image preview, etc.
- Two themes (light and dark): Both verified to be AAA contrast compliant.
- Responsive on all devices: Mobile first design
- Utilizes a very simple form integration with google sheets using Apps Script.
- Free to use, no external requests, no server needed.
- Images/SVGS
- All images/svgs are properly sized to their display size.
- All icons are svgs.
- Lazy loaded when in or near the viewport.
- Custom CLI script to compress, scale to specific size or aspect ratio, and create both large and small outputs in bulk.
- see [Images](#images)
- Performance:
- Perfect score on all major audits (Lighthouse, page speed insights, gtmetrix)
- Passes all accessibility audits (WAVE, Lighthouse, nu html checker)
- Accessible: perfect score on several audits (WAVE, Lighthouse, page speed insights, NU HTML checker)
- Custom components
- Tab system that works as a gallery.
- Easy to integrate Tooltip system.
- Image preview.
- Configurable Toasts.
- Skeletons/Loaders.
- Hooks
- Close on escape
- Copy to clipboard
- Handle state
- Throttle
- Webpack
- js, css, & html minification
- js split
- hash naming
- babel
---
## Contact Form
The Form is integrated with google sheets using Apps Script - the process is very simple and free to use.
> Apps Script Setup (Google Sheets)
1. Create a new google sheet
2. Locate `Apps Script` in the `Extensions` menu and open it
3. Add a new file and name it `Code.gs` (or whatever you want)
4. Copy the full url of your google sheet e.g. `https://docs.google.com/spreadsheets/d/.../edit#gid=0`
5. Paste the following code into the file:
```javascript
// replace the URL with your own google sheet URL
const sheets = SpreadsheetApp.openByUrl("https://docs.google.com/spreadsheets/d/.../edit#gid=0");
const sheet = sheets.getSheetByName("Sheet1");
function doPost(e) {
let data = e.parameter;
// appendRow will recieve the formData : {messageName, contactMethod, messageContactVal, messageVal} in my case
sheet.appendRow([data.messageName, data.contactMethod, data.messageContactVal, data.messageVal]);
return ContentService.createTextOutput("Success");
}
```
6. Click Deploy -> New Deployment
7. Select `Web App` as the type
8. Set 'Who has access' to 'Anyone'
9. Click Deploy
10. Copy the Deployment ID
11. Create a .env and set `SHEET_ID` to the Deployment ID
12. Setup the fetch, or use the one provided in the project.
```javascript
fetch(`https://script.google.com/macros/s/${process.env.SHEET_ID}/exec`, {
method: 'POST',
body: new FormData(form),
})
```
---
## Images
> Project Images
- I have turned overwrites off by default just in case someone accidentally sets the output directory to the wrong folder.
- I wrote this to fit my very specific needs but after finding myself using it over and over again, I decided to include it in the project.
- I included a bunch of CLI commands but I recommend just setting the directories manually and to test everything in a test project before running it on your actual project.
In short, I use the script to do the following:
First, I keep all project images within the same directory on the same level.
- Large image names end in '1' and small images end in '2'. (you can customize this in the script)
- The script compresses each image, and formats all images to the same width and height. It then uses a predefined multiplier to create a small version of the images ending in '2'. There are also options to ensure that an aspect ratio is maintained for small and images, in my case, I use 4/3 for small images and 16/9 for large images.
- It utilizes the sharp library for all image processing, and in my opinion, there is no better library or tool for compression and easy manipulation (I wish they had a contrast filter though).
- Everything else is sketchy, I don't really ever mess around with node, so hopefully this works for you. I wouldn't include it if I ever had problems with it but I'm not sure if different operating systems will cause issues (I'm on windows).
### CLI Commands
| Command | Description | Example |
| --------------------- | -------------------------------------------------------------------------------------------- | --------------------------------------------- |
| `setparse` | Run the actual optimization (make sure to set up first either manually or with CLI commands) | `npm run setparse` |
| `setparse:help` | Get a list of all commands | `npm run setparse:help` |
| `setparse:base` | Set the base directory | `npm run setparse:base base/directory` |
| `setparse:sub` | Set the sub directory | `npm run setparse:sub folderWithinBase` |
| `setparse:out` | Set the output directory | `npm run setparse:out outputFolderWithinBase` |
| `setparse:wh` | Set the width and height of the large image | `npm run setparse:wh 1600 900` |
| `setparse:multiplier` | Set the multiplier for the large image | `npm run setparse:multiplier 0.1` |
| `setparse:format` | Set the format of the large image | `npm run setparse:format jpg` |
| `setparse:ar` | Set the aspect ratio of the small image | `npm run setparse:ar 4/3` |
| `setparse:current` | Get the current config | `npm run setparse:current` |
| `setparse:quality` | Set the quality of the large image | `npm run setparse:quality 1-99` |
> **Warning**
> It is recommended to manually optimize images before running the script.
> The script will not work if any of the directories are not set properly.
> The image optimization script is not perfect, it is very personalized to my needs, I use it to set all images to the same aspect ratio and size, and to create a small and large version of each image in different aspect ratios within the same folder.
---
## Resources
- [placeholder images](https://dummyimage.com/1600x900/000/000&text=.)
- [textures](https://www.transparenttextures.com/)
- [textures-two](https://www.toptal.com/designers/subtlepatterns/)
- [vercel-icons](https://vercel.com/design/icons)
- [react-icons](https://react-icons.github.io/react-icons/search)
- [Neue-Montreal-Font](https://pangrampangram.com/products/neue-montreal)
- [Basement-Expanded-Font](https://grotesque.basement.studio/)
| Personal portfolio to showcase Front-end skills/projects and means to contact. | javascript-portfolio,portfolio,portfolio-website,css,front-end,front-end-portfolio,javascript,personal-website,portfolio-template,ux | 2023-03-25T17:07:33Z | 2023-11-12T23:27:58Z | null | 1 | 1 | 179 | 0 | 1 | 5 | null | MIT | JavaScript |
magicdev122/magicdev122 | main | ### Dear Everyone 👋
Hi, I am a software engineer who is specialized in web and blockchain space development.
I have helped a few startups' development and those project over the last 5 years, including Hedera, Highwing, and Ascendle. I brought them my web dev skills and values, thus led those growth to success.
I am full time available now, and ready for a new challenge.
Since I've graduated the university, I’ve joined several companies and dev teams to build web and mobile apps.
Nowadays I passionate about blockchain technologies so that I'm mainly focusing on the Defi development stack.
Looking forward to hearing from you.
Regards.
<br/>
<br/>
<img align="right" alt="GIF" src="https://camo.githubusercontent.com/fa73289736064aba480d0708da37d7aa183a8c3e2bcc2f58c54285a3bbbeecc1/68747470733a2f2f7777772e61616c7068612e6e65742f77702d636f6e74656e742f75706c6f6164732f323032302f31322f66756c6c2d737461636b2d646576656c6f706d656e742e676966" width="400" height="270" />
<br/>
<br/>
<br/>
- 🌱 I’m currently learning blockchain technologies<br/>
- 🤔 I’m looking to help with buliding web sites and apps<br/>
- 💼I'm enthusiast in **Creative Front-End Building**<br/>
- 💬 Ask me about MERN stack and Angular
<br/>
<br/>
<br/>
<br/>
### Languages and Tools:
<code><img height="40" src="https://raw.githubusercontent.com/github/explore/80688e429a7d4ef2fca1e82350fe8e3517d3494d/topics/javascript/javascript.png"></code>
<code><img height="40" src="https://raw.githubusercontent.com/github/explore/80688e429a7d4ef2fca1e82350fe8e3517d3494d/topics/react/react.png"></code>
<code><img height="40" src="https://raw.githubusercontent.com/github/explore/80688e429a7d4ef2fca1e82350fe8e3517d3494d/topics/redux/redux.png"></code>
<code><img height="40" src="https://raw.githubusercontent.com/github/explore/80688e429a7d4ef2fca1e82350fe8e3517d3494d/topics/wordpress/wordpress.png"></code>
<code><img height="40" src="https://raw.githubusercontent.com/github/explore/80688e429a7d4ef2fca1e82350fe8e3517d3494d/topics/laravel/laravel.png"></code>
<code><img height="40" src="https://raw.githubusercontent.com/github/explore/80688e429a7d4ef2fca1e82350fe8e3517d3494d/topics/php/php.png"></code>
<code><img height="40" src="https://raw.githubusercontent.com/github/explore/80688e429a7d4ef2fca1e82350fe8e3517d3494d/topics/nodejs/nodejs.png"></code>
<code><img height="40" src="https://raw.githubusercontent.com/github/explore/80688e429a7d4ef2fca1e82350fe8e3517d3494d/topics/express/express.png"></code>
<code><img height="40" src="https://raw.githubusercontent.com/github/explore/80688e429a7d4ef2fca1e82350fe8e3517d3494d/topics/mongodb/mongodb.png"></code>
<code><img height="40" src="https://raw.githubusercontent.com/github/explore/80688e429a7d4ef2fca1e82350fe8e3517d3494d/topics/mysql/mysql.png"></code>
<code><img height="40" src="https://raw.githubusercontent.com/github/explore/80688e429a7d4ef2fca1e82350fe8e3517d3494d/topics/firebase/firebase.png"></code>
<code><img height="40" src="https://raw.githubusercontent.com/github/explore/80688e429a7d4ef2fca1e82350fe8e3517d3494d/topics/git/git.png"></code>
#### Web Development
#### Blockchain Development
#### Other
| Blockchain starter | blockcahin,ethereum,javascript,nodejs,smart-contracts | 2023-03-12T04:36:45Z | 2023-04-26T03:43:35Z | null | 1 | 1 | 25 | 0 | 0 | 5 | null | null | null |
n-ce/Awesome-Minimal-JavaScript-Frameworks | main | ### Here's a curated list of awesome light weight & modern JS frameworks that can be loaded through a CDN.
## [HTMX](https://htmx.org/)
- [](https://github.com/bigskysoftware/htmx)
- [](https://github.com/bigskysoftware/htmx/releases)
- CDN : https://unpkg.com/browse/htmx.org/dist/
- Access AJAX, CSS Transitions, WebSockets and Server Sent Events directly in HTML, using attributes.
## [Alpine](https://alpinejs.dev/)
- [](https://github.com/alpinejs/alpine)
- [](https://github.com/alpinejs/alpine/releases)
- CDN : https://cdn.jsdelivr.net/npm/alpinejs/dist/cdn.min.js
- A rugged, minimal framework for composing JavaScript behavior in your markup.
## [Van](https://vanjs.org)
- [](https://github.com/vanjs-org/van)
- [](https://github.com/vanjs-org/van/releases)
- CDN : https://cdn.jsdelivr.net/gh/vanjs-org/van/public/van-latest.min.js
- Ultra-lightweight, zero-dependency, and unopinionated Reactive UI framework, feels like building React apps, without JSX.
## [Preact](https://preactjs.com/)
- [](https://github.com/preactjs/preact)
- [](https://github.com/preactjs/preact/releases)
- CDN : https://unpkg.com/preact/dist/preact.js
- Fast 3kB(not anymore) alternative to React with the same modern API.
## [Inferno](https://infernojs.org/)
- [](https://github.com/infernojs/inferno)
- [](https://github.com/infernojs/inferno/releases)
- CDN : https://cdn.jsdelivr.net/npm/inferno/dist/inferno.min.js
- An extremely fast, React-like JavaScript library for building modern user interfaces.
<br>
<hr>
#### [Mithril](https://github.com/MithrilJS/mithril.js) was removed from the list due to no visible development in a year  even though a major release was announced 2 years ago
| A curated list of awesome Lightweight JavaScript Frameworks (CDN loadable) | awesome-list,client-side-rendering,javascript-framework,lightweight-javascript-framework,awesome,javascript | 2023-03-24T06:58:01Z | 2024-02-04T04:45:53Z | null | 1 | 1 | 17 | 0 | 0 | 5 | null | null | null |
mvaibhav131/Calculator-ReactTs | main | # React-ts-Calculators:-
[to click here to see my project](https://vaibhav-react-ts-calculator.netlify.app/)
## start the project creating the React App.
### `npm run 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 run 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.
If you want to remove build dependency then run following commands
### `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)
| The simple calculator app is made by using react, Typescript, tailwindcss. | react,calculator,calculator-application,docker,javascript,netlify,src,tailwindcss,typescript | 2023-03-18T11:24:34Z | 2024-05-22T11:57:06Z | null | 1 | 1 | 71 | 0 | 1 | 5 | null | null | TypeScript |
kalbek/Awesome-Books | main | <a name="readme-top"></a>
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#triangular_flag_on_post-deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ (OPTIONAL)](#faq)
- [📝 License](#license)
<!-- PROJECT DESCRIPTION -->
# 📖 Awesome Books 2023 <a name="about-project"></a>
**Awesome Books** is a JavaScript project at microverse
## 🛠 Built With <a name="built-with"> HTML CSS & Java Script</a>
### Tech Stack <a name="tech-stack"></a>
> HTML CSS & Java Script
<details>
<summary>Client</summary>
<ul>
<li><a href="https://developer.mozilla.org/en-US/docs/Web/HTML">HTML</a></li>
<li><a href="https://developer.mozilla.org/en-US/docs/Web/CSS">CSS</a></li>
</ul>
</details>
### Key Features <a name="key-features"></a>
- **Adds book title to books lists and displays on browser**
- **Adds book author to books lists and displays on browser**
- **Removes a book when remove button is clicked**
- **Stores data on web browser**
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 💻 Getting Started <a name="getting-started"></a>
Try to have these in your local machine
- Git and GitHub
- VS Code or any code editor
### Prerequisites
In order to run this project you need
- A web browser
- Code editor
### Setup
Clone this repository to your desired folder:
git clone https://github.com/kalbek/Awesome-Books.git
For stylelint error run:sudo npx stylelint "*/.{css,scss}" --fix
refer to [this-link](https://github.com/microverseinc/linters-config/tree/master/javascript) to resolve lint errors.
### Install
Install this project using the cloned repo or download and use the files to your local machine.
### Usage
To run the project open the index.html file in your web browser
### Run tests
No test are available
### Deployment
You can deploy this project through Github Pages
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- AUTHORS -->
## 👥 Authors <a name="authors"></a>
👤 **Kaleb Bekele**
- GitHub: [@githubhandle](https://github.com/kalbek)
- Twitter: [@twitterhandle](https://twitter.com/KNuramo)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/kaleb-nuramo/)
- Website: https://kalbek.github.io/Portfolio/
👤 **Ekiugbo Tega Blessing**
- GitHub: [@githubhandle](https://github.com/Otegaa)
- Slack: [@slackhandle](https://microverse-students.slack.com/archives/D04VDN1F70Q)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 🔭 Future Features <a name="future-features"></a>
- [ ] **Changes will be made as comming project requirement.**
<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>
## ⭐️ Show your support <a name="support"></a>
If you like this project give a star to this repositiory.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 🙏 Acknowledgments <a name="acknowledgements"></a>
- I would like to acknowledge my codding partner who made a huge effort on this project.
- I would also like to thank Microverse for the guidance they made all the way up to this point.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## ❓ FAQ <a name="faq"></a>
- **Is it allowed to copy the contents of this project and use it for personal use?**
- Yes, this project is free for copying and reusing in any way you like.
## 📝 License <a name="license"></a>
This project is [MIT](./MIT.md) licensed.
<p align="right">(<a href="#readme-top">back to top</a>)</p> | Awesome Books is a project under Microverse’s JavaScript module. Key features include: adding books and authors, displaying books along with authors in a recent order, and storing book and author details on local storage. | css,html,javascript,jest,linters,webpack5 | 2023-03-20T11:34:16Z | 2023-03-22T12:55:52Z | null | 2 | 3 | 61 | 0 | 0 | 5 | null | null | JavaScript |
No-Country/s7-02-m-javareact | main | ### S7-02-m-JavaReact
# Juntas Web
### Introducción
<p> Juntas es una aplicación web que permite conectar a mujeres que buscan compartir
viajes en vehículos propios con aquellas que desean viajar a destinos similares.</p>
<p> El objetivo principal de “Juntas” se centra en mejorar la seguridad entre las mujeres que viajan y a su vez generar comunidad entre ellas. Al compartir un mismo trayecto por varias horas, las viajeras establecen relaciones sociales, buenas conversaciones y disfrutan de un viaje divertido.
Adicionalmente, al reunir varias personas en un mismo vehículo, se reduce la emisión de carbono que éstos provocan cuando hay excesiva circulación. Es una manera de contribuir positivamente con el impacto ambiental.</p>
<p> La distinción de esta plataforma es la posibilidad que ofrece para determinar de manera automática el precio estimado de un viaje, asegurando un precio más justo y estable. De esta forma, se distribuye el gasto de combustible y peajes de manera equitativa: las conductoras recuperan parte de sus gastos y las pasajeras obtienen un precio razonable por el traslado.</p>
## Equipo S7-02-M
### UX/UI
* [Andrea Abdala](https://www.linkedin.com/in/andruabdala)
### Tester QA
* [Alejandra Ortiz](https://github.com/AlejandraOrtiz2403)
### Frontend
* [Ignacio García](https://github.com/iegarcia)
* [Isaac Urdaneta](https://github.com/IducSoft)
* [Marcos Fernández](https://github.com/marcosfer243)
### Backend
* [Lucas Gonzales](https://github.com/lucas2205)
* [Cristian Granero](https://github.com/cristiangranero90)
### Analisis funcional - Project Managment
* [Cristian Granero](https://github.com/cristiangranero90)
### Team Leader
* [Micaela Andrés](https://www.linkedin.com/in/micaelaandres)
## Tecnologías y Herramientas
1. <a href="https://reactjs.org/" target="_blank"><img style="margin: 10px" src="https://profilinator.rishav.dev/skills-assets/react-original-wordmark.svg" alt="React" height="30" /></a><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="30" /></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="25" /></a><a href="https://www.tailwindcss.com/" target="_blank"><img style="margin: 10px" src="https://profilinator.rishav.dev/skills-assets/tailwindcss.svg" alt="Tailwind CSS" height="30" /></a>
2. <a href="https://www.java.com/" target="_blank"><img style="margin: 10px" src="https://profilinator.rishav.dev/skills-assets/java-original-wordmark.svg" alt="Java" height="30" /></a><a href="https://docs.spring.io/spring-framework/docs/3.0.x/reference/expressions.html#:~:text=The%20Spring%20Expression%20Language%20(SpEL,and%20basic%20string%20templating%20functionality." target="_blank"><img style="margin: 10px" src="https://profilinator.rishav.dev/skills-assets/springio-icon.svg" alt="Spring" height="30" /></a><a href="https://www.mysql.com/" target="_blank"><img style="margin: 10px" src="https://profilinator.rishav.dev/skills-assets/mysql-original-wordmark.svg" alt="MySQL" height="30" /></a>
3. <a href="https://www.figma.com/" target="_blank"><img style="margin: 10px" src="https://profilinator.rishav.dev/skills-assets/figma-icon.svg" alt="Figma" height="30" /></a><a href="https://www.adobe.com/in/products/illustrator.html" target="_blank"><img style="margin: 10px" src="https://profilinator.rishav.dev/skills-assets/adobe_illustrator-icon.svg" alt="Illustrator" height="30" /></a>
4. ***Trello - Notion - Draw.io - Vercel - Railway***
## Documentación
* [Docuemento de requerimientos funcionales - FRD](https://docs.google.com/document/d/1F-gqtVG6_88kVm2KrrytbO5hxrH9D5ESIZVyvpmiFUc/edit?usp=share_link)
* [Diagrama de entidad relación - UML](https://drive.google.com/file/d/1wt1HSWKEa9j9G7XC-0H-s-WYctCr33mK/view?usp=share_link)
* [Diagrama de estados - Registration State - UML](https://drive.google.com/file/d/1MyyYtWAUOsLy-7nxccIyHY6na44OwU7s/view?usp=share_link)
* [Términos y condiciones - Disclaimer](https://docs.google.com/document/d/1qGQF_LXcAIeb5QWvhYHfwQk3XN0QYjifS9MfSv58etQ/edit?usp=share_link)
## Despliegue
* Web Page: [Juntas-Web](https://juntaas.vercel.app/#/home)
* Server-side application: [Juntas-Swagger](https://juntas-web-server-production.up.railway.app/swagger-ui/)
* Figma: [Juntas-Design](https://www.figma.com/file/rBGHlllstnUdobdZPAlRPM/Juntas?node-id=1-9&t=IqoprU29TbjjQYPE-0)
## Galería
<img src="https://github.com/No-Country/s7-02-m-javareact/blob/main/readme_resources/juntas_home.png" alt="Home Page" width="1000"/>
<img src="https://github.com/No-Country/s7-02-m-javareact/blob/main/readme_resources/juntas_how-it-works.png" alt="How it works" width="1000"/>
<img src="https://github.com/No-Country/s7-02-m-javareact/blob/main/readme_resources/juntas_login.png" alt="Login/Register Page" width="1000"/>
<img src="https://github.com/No-Country/s7-02-m-javareact/blob/main/readme_resources/juntas_chooser.png" alt="Chooser Page" width="1000"/>
<img src="https://github.com/No-Country/s7-02-m-javareact/blob/main/readme_resources/juntas_traveler.png" alt="Traveler Page" width="1000"/>
<img src="https://github.com/No-Country/s7-02-m-javareact/blob/main/readme_resources/juntas_driver.png" alt="Driver Page" width="1000"/>
<img src="https://github.com/No-Country/s7-02-m-javareact/blob/main/readme_resources/juntas_profile.png" alt="Profile Page" width="1000"/>
<img src="https://github.com/No-Country/s7-02-m-javareact/blob/main/readme_resources/juntas_qualifications.png" alt="Qualifications Page" width="1000"/>
<img src="https://github.com/No-Country/s7-02-m-javareact/blob/main/readme_resources/juntas_journeys.png" alt="Journeys Page" width="1000"/>
| Juntas web application - Carpooling | css,docs,figma,html5,illustrator,java,javascript,mysql,notion,railway-deployment | 2023-03-25T14:24:34Z | 2023-04-24T02:44:45Z | null | 11 | 29 | 166 | 0 | 2 | 5 | null | null | JavaScript |
piral-samples/piral-cloud-vanilla-demo | main | [](https://piral.io)
# [Piral Cloud Sample](https://piral.cloud) · [](https://github.com/smapiot/piral/blob/main/LICENSE) [](https://gitter.im/piral-io/community)
> Sample project to illustrate a micro frontend discovery with vanilla (no framework) micro frontends.
:zap: Use the Piral Feed Service for generic micro frontend discovery.
Feel free to play around with the code using StackBlitz.
[](https://stackblitz.com/github/piral-samples/piral-cloud-vanilla-demo)
You can also visit this demo at [cloud-vanilla.samples.piral.cloud/](https://cloud-vanilla.samples.piral.cloud/).
## License
Piral and this sample code is released using the MIT license. For more information see the [license file](./LICENSE).
| Demo for the Piral Cloud micro frontend discovery service using no framework. | discovery,example,javascript,microfrontends,sample,service,vanilla | 2023-03-15T16:02:31Z | 2023-06-27T09:50:49Z | null | 1 | 0 | 2 | 0 | 0 | 5 | null | null | JavaScript |
gisachris/Portfolio-Site | main | <!-- TABLE OF CONTENTS -->
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)
<!-- PROJECT DESCRIPTION -->
# 📖 My portfolio <a name="about-project"></a>
**My portolio** is a web application to showcase my projects, experience and Professional Information all in one package. Intuitive design, functionality and great user experience are the core fundamentals with this react application.
## 🛠 Built With <a name="built-with"></a>
### Tech Stack <a name="tech-stack"></a>
<details>
<summary>React</summary>
<ul>
<li><a href="https://www.reactdev.org/">React</a></li>
</ul>
</details>
<!-- Features -->
### Key Features <a name="key-features"></a>
- **Display My experience**
- **Display My past projects**
- **Provide modes of communication a person can use to reach me.**
- **Descibe my professional personality**
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 🚀 Live Demo <a name="live-demo"></a>
[Checkout the live site here!](https://gisadev.onrender.com)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- GETTING STARTED -->
## 💻 Getting Started <a name="getting-started"></a>
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
```sh
Nodejs
```
### Setup
Clone this repository to your desired folder:
```sh
git clone https://github.com/gisachris/Portfolio-Site.git
cd Portfolio-Site
```
### Install
Install this project with:
```sh
cd Portfolio-Site
npm install
```
### Usage
To run the project, execute the following command:
```sh
npm run dev
```
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- AUTHORS -->
## 👥 Authors <a name="authors"></a>
👤 **Gisa Chris**
- GitHub: [@gisachris](https://github.com/gisachris)
- LinkedIn: [LinkedIn](https://linkedin.com/in/gisa-chris/)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- FUTURE FEATURES -->
## 🔭 Future Features <a name="future-features"></a>
- [ ] **Animations and better user Experience**
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- CONTRIBUTING -->
## 🤝 Contributing <a name="contributing"></a>
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/gisachris/budget_builder/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 consider leaving a star in the repo.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- ACKNOWLEDGEMENTS -->
## 🙏 Acknowledgments <a name="acknowledgements"></a>
Original design idea by [ Kartik Bansal on Figma.](<https://www.figma.com/file/uDYE2tjJNrNTDTBm4QaG4f/Personal-portfolio-Website-landing-page-UX-UI-kit-(Design-By-Kartik-Bansal)-(Community)?type=design&node-id=91-11&mode=design&t=VqOBASZmsKNPn8P6-0>)
Application icons by <a target="_blank" href="https://icons8.com">Icons8</a>
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- LICENSE -->
## 📝 License <a name="license"></a>
This project is [MIT](./MIT.md) licensed.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
| This is my portfolio website that displays the wide variety of programs and languages I have used through out my career as well as contact information on how to reach out for any inquires | css,html,javascript,portfolio | 2023-03-23T06:58:15Z | 2023-11-16T04:48:27Z | null | 3 | 30 | 238 | 0 | 0 | 5 | null | null | SCSS |
adityayaduvanshi/Spotify-Clone | master | # Project Lyrics
Develop an elegant React.js Music Application.
Check out the complete project requirements [here](https://docs.google.com/document/d/13PeFwRlPEhMw_HPyrIrInvQuKaVWnpNmcv-y3NA208s/edit?usp=sharing)
# Contributing
When contributing to this repository, please first discuss the change you wish to make via issue.
Please note we have a [code of conduct](CODE_OF_CONDUCT.md), please follow it in all your interactions with the project.
## System Requirements
To get started with development, you need to install few tools
1. git
`git` version 2.13.1 or higher. Download [git](https://git-scm.com/downloads) if you don't have it already.
To check your version of git, run:
```shell
git --version
```
2. node
`node` version 16.15.1 or higher. Download [node](https://nodejs.org/en/download/) if you don't have it already.
To check your version of node, run:
```shell
node --version
```
3. npm
`npm` version 5.6.1 or higher. You will have it after you install node.
To check your version of npm, run:
```shell
npm --version
```
## Setup
To set up a development environment, please follow these steps:
1. Clone the repo
```shell
git clone https://github.com/JavaScript-Mastery-PRO/project1_team4_repository.git
```
2. Change directory to the project directory
```shell
cd project1_team4_repository
```
3. Install the dependencies
```shell
npm install
```
If you get an error, please check the console for more information.
If you don't get an error, you are ready to start development.
4. Run the app
```shell
npm run dev
```
Project will be running in the browser.
Open [http://localhost:3000](http://localhost:3000) to view it in your browser.
## Issues
You've found a bug in the source code, a mistake in the documentation or maybe you'd like a new feature? You can help us by [submitting an issue on GitHub](https://github.com/orgs/JavaScript-Mastery-PRO/projects/8). Before you create an issue, make sure to search the issue archive -- your issue may have already been addressed!
Please try to create bug reports that are:
- _Reproducible._ Include steps to reproduce the problem.
- _Specific._ Include as much detail as possible: which version, what environment, etc.
- _Unique._ Do not duplicate existing opened issues.
- _Scoped to a Single Bug._ One bug per report.
## Pull Request
There are 2 main work flows when dealing with pull requests:
* Pull Request from a [forked repository](https://help.github.com/articles/fork-a-repo)
* Pull Request from a branch within a repository
Here we are going to focus on 2. Creating a Topical Branch:
1. First, we will need to create a branch from the latest commit on master. Make sure your repository is up to date first using
```bash
git pull origin main
```
*Note:* `git pull` does a `git fetch` followed by a `git merge` to update the local repo with the remote repo. For a more detailed explanation, see [this stackoverflow post](http://stackoverflow.com/questions/292357/whats-the-difference-between-git-pull-and-git-fetch).
2. To create a branch, use `git checkout -b <new-branch-name> [<base-branch-name>]`, where `base-branch-name` is optional and defaults to `main`.
Use a standard convention for branch names. For example, `<your-name>-dev`. It will be easier to track your pull requests if you use this convention.
I'm going to create a new branch called `jsm-dev` from the `main` branch and push it to github.
```bash
git checkout -b jsm-dev main
git push origin jsm-dev
```
3. To create a pull request, you must have changes committed to your new branch.
4. Go to [Pull Requests](https://github.com/JavaScript-Mastery-PRO/project1_team4_repository/pulls) and click on the `New Pull Request` button.
5. Select the `main` branch as the `base` branch and the `jsm-dev` branch as the `compare` branch.
6. Follow the template and fill in the proper information for the pull request.
7. Click on the `Submit` button.
8. You have successfully created a pull request. Now wait for mentor approval. Once approved, you can merge the pull request.
#
| null | javascript,react,spotify-clone | 2023-03-24T13:03:37Z | 2023-03-24T13:04:28Z | null | 1 | 0 | 1 | 0 | 0 | 5 | null | null | JavaScript |
baqar-abbas/Leaderboard-project | development | # Leaderboard-project
<a name="readme-top"></a>
<div align="center">
<br/>
<h3><b>Microverse README Template</b></h3>
</div>
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#triangular_flag_on_post-deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)
# 📖 Leaderboard-Project <a name="about-project"></a>
**Leaderboard-Project** is a simple project which can add and remove scores on the website using Leaderboard API.
## 🛠 Built With <a name="built-with"></a>
HTML CSS JavaScript and Webpack
### Tech Stack <a name="tech-stack"></a>
### Key Features <a name="key-features"></a>
- **[html manipulated with JavaScript and usage of Leaderboard API ]**
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 🚀 Live Demo <a name="live-demo"> </a>
> https://baqar-abbas.github.io/Leaderboard-project/dist
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 💻 Getting Started <a name="getting-started"></a>
To get a local copy up and running, follow these steps.
### Prerequisites
Web Browser, Code Editor.
### Setup
Clone this repository to your desired folder:
Example commands:
```sh
cd my-folder
git clone https://github.com/baqar-abbas/Leaderboard-Project
```
### Install
VS CODE, Dev Dependencies (Linters), npm Package Manager
### Usage
Add score update score into the leaderboard and display on the UI.
### Run tests
Add and update score and check whether it is being displayed properly on the UI.
### Deployment
This Project will be deployed after final approval.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 👥 Author <a name="authors"></a>
👤 **Baqar Abbas**
- GitHub: [@Baqar](https://github.com/baqar-abbas)
- Twitter: [@BaqarAbbas9](https://twitter.com/BaqarAbbas9)
- LinkedIn: [Baqar Abbas](https://www.linkedin.com/in/baqarlinkedin/)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 🔭 Future Features <a name="future-features"></a>
- [ ] **[Functionality of adding scores usimg the Leaderboard API will be implemented]**
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 🤝 Contributing <a name="contributing"></a>
Contributions, issues, and feature requests are welcome!
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## ⭐️ Show your support <a name="support"></a>
If you like this project please consider leaving a review.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 🙏 Acknowledgments <a name="acknowledgements"></a>
I would like to thank my coding partner [@Tracy& Samson] for their contributions for this project with me.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 📝 License <a name="license"></a>
This project is [MIT](./LICENSE.md) licensed.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<a name="readme-top"></a>
| This is a Simple Project to demonstrate and learn usage of Leaderboard API to put name and scores of players using ASYNC and AWAIT | api,css3,html5,javascript,webpack | 2023-03-14T13:34:14Z | 2023-04-18T11:35:46Z | null | 1 | 4 | 16 | 0 | 0 | 5 | null | MIT | JavaScript |
CodePapa360/Forkify-Recipe-App | main | <h1 align="center">Forkify App</h1>
<p align="center">
<img src="./src/img/favicon.png" alt="Logo" width="15%" height="auto">
</p>
<p align="center">
<img src="https://img.shields.io/badge/version-2.0.0-blue.svg?cacheSeconds=2592000" />
<a href="https://forkify-alamin.netlify.app/" target="_blank">
<img alt="Demo" src="https://img.shields.io/badge/demo-online-green.svg" />
</a>
<a href="https://github.com/CodePapa360/Forkify-Recipe-App#readme" target="_blank">
<img alt="Documentation" src="https://img.shields.io/badge/documentation-yes-brightgreen.svg" />
</a>
<a href="https://github.com/CodePapa360/Forkify-Recipe-App/graphs/commit-activity" target="_blank">
<img alt="Maintenance" src="https://img.shields.io/badge/maintained-yes-green.svg" />
</a>
<a href="https://github.com/CodePapa360/Forkify-Recipe-App/blob/master/LICENSE" target="_blank">
<img alt="License: MIT" src="https://img.shields.io/badge/License-MIT-yellow.svg" />
</a>
<a href="https://twitter.com/CodePapa360" target="_blank">
<img alt="Twitter: CodePapa360" src="https://img.shields.io/twitter/follow/CodePapa360.svg?style=social" />
</a>
</p>
<h2 align="center">
Check out the <a href="https://forkify-alamin.netlify.app/" target="_blank">live Forkify App here</a>.
</h2>
<p align="left">
Forkify is a recipe search and saving app, built with HTML5, CSS3, and JavaScript. It features an intuitive user interface and dynamic serving size adjustment. The app uses advanced JavaScript concepts like asynchronous programming, ES6 modules, and object-oriented programming. Forkify was created by Jonas Smechmann in his Udemy course and this app was built as part of a personal project to learn JavaScript.
</p>
## Features
- Search for recipes: Find recipes using keywords or ingredients.
- View recipe details: See ingredients, cooking instructions, and serving size.
- Bookmark recipes: Save your favorite recipes for later.
- Add recipes: Create and share your own recipes.
- Pagination: Easily navigate search results.
- Responsive Design
## Built with
- JavaScript
- CSS3
- HTML5
- Parcel
- NPM
<p align="center">
<img alt="Forkify App" src="./src/img/forkify-alamin-screenshot.png" width="100%" />
</p>
## Flowchart
<p align="center">
<img alt="Flowchart" src="./forkify-flowchart-part-3.png" width="100%" />
</p>
## Recipe Loading Architecture
<p align="center">
<img alt="Recipe Loading Architecture" src="./forkify-architecture-recipe-loading.png" width="100%" />
</p>
## Installation
- Clone this repo:
```sh
git clone https://github.com/CodePapa360/Forkify-Recipe-App.git
```
- Install dependencies:
```sh
npm install
```
- Run the app:
```sh
npm start
```
## Author
<b>👤 Alamin</b>
- LinkedIn - [@CodePapa360](https://www.linkedin.com/in/codepapa360)
- Twitter - [@CodePapa360](https://www.twitter.com/CodePapa360)
- Frontend Mentor - [@CodePapa360](https://www.frontendmentor.io/profile/CodePapa360)
- Github: [@CodePapa360](https://github.com/codepapa360)
Feel free to contact me with any questions or feedback!
## Credits
This app was created as part of [Jonas Smechmann](https://twitter.com/jonasschmedtman)'s Udemy course [The Complete JavaScript Course 2023: From Zero to Expert!](https://www.udemy.com/course/the-complete-javascript-course/).
Special thanks to Jonas for his excellent teaching and guidance throughout the course.
## Show your support
Give a ⭐️ if you liked this project!
## License
This project is [MIT](https://github.com/codepapa360/Forkify-Recipe-App/blob/master/LICENSE) licensed.
| Built with JavaScript and API. Made it responsive and added some new features to make it even more user-friendly. | api,asynchronous-programming,cooking,es6-modules,forkify,forkify-api,forking-projects,front-end,healthy-eating,javascript | 2023-03-14T11:10:53Z | 2023-04-06T11:19:08Z | null | 1 | 10 | 49 | 0 | 1 | 5 | null | MIT | JavaScript |
Mutai-Gilbert/Tv-amaze | development | # Tv-amaze
Capstone: API-based Webapp
# Tv-amaze project.
The JavaScript capstone project is about building web application based on an external API. We selected an API that provides data about Movies and then built the webapp around it.
## Project description video link:
[video link](https://youtu.be/FgK-wuXRoEE)
## Project web demo link.
## Built With
- Html.
- Css.
- JS.
- Webpark.
- jest test
Website link:
https://mutai-gilbert.github.io/TVamaze-API-based-webapp/dist/
# Getting starting
To get a local copy up and running follow these simple example steps:
## Prerequisites
Vscode.
must have git installed.
### Setup
If you installed git you can clone the code to your machine, or download a ZIP of all the files directly.
[Download the ZIP from this location], or run the following [git](https://git-scm.com/downloads) command to clone the files to your machine:
git clone https://github.com/Mutai-Gilbert/TVamaze-API-based-webapp
- Once the files are on your machine, open the _todo-list_ folder in [Visual Studio Code](https://code.visualstudio.com/), and follow the steps in Installation & Set Up
## 🛠 Installation & Set Up
1. Install Node Modules
npm install
2. Start the development server
npm run start
3. Open [http://localhost:8080](http://localhost:8080) to view it in the browser.
4. Run automated functionality test
To check for functionality with automated test run npm test
## 🚀 Building and Running for Production
1. Generate a full static production build
npm run build
## Author 1
👤 **Gilbert Mutai**
- GitHub: [@githubhandle](https://github.com/Mutai-Gilbert)
- Twitter: [@twitterhandle](https://twitter.com/@nerdmutai)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/mutai-gilbert-2a5a42137/)
## Authors
👤 **Ntwali Roland**
- GitHub: [@Roland-Ntwali](https://github.com/Roland-Ntwali)
- LinkedIn: [Roland Ntwali](https://www.linkedin.com/in/roland-ntwali-11b16617b/)
# 🤝 Contributing
Contributions, issues, and feature requests are welcome! Feel free to check the [issues page]Fork the Project Create your Feature Branch (git checkout -b 'branchname') Commit your Changes (git commit -m 'Add some branchname') Push to the Branch (git push origin branchname) Open a Pull Request Feel free to check the
## Deployment
Push changes to a branch. Wait for the build to pass on our CI server. Tell Hubot to deploy it. Verify that the changes work and fix any problems that come up. Merge the branch into master.
## Show your support
Give a ⭐️ if you like this project!
## Acknowledgments
MICROVERSE and My Team.
This project is MIT licensed.
| Tv-amaze is based on an external API. We selected an API that provides data about Movies and then built the webapp around it. | css,javascript,reactjs | 2023-03-13T13:20:06Z | 2024-01-17T12:43:58Z | null | 2 | 13 | 48 | 0 | 0 | 5 | null | MIT | JavaScript |
Prashant142/Mern-Dashboard | main | # MERN Dashboard
## An informative dashboard with multiple functionalities
## Features
### Login Page
Proper functional email and password authentication login form.
### Signup page
Register yourself and the passwords will save in hashed form to your database.
### Dashboard section
Dynamic charts that can be change as per the data.
### Permission & Role Management page
Tabel that retrieves the data from your database. And with a well functional search option in the table.
## Technologies Used
- MongoDB
- Express.js
- React.js
- Node.js
- Tailwind CSS
- JavaScript
- Chart.js
## How to Run the Application
1. Clone the repository to your local machine
2. Navigate to the project directory in your terminal
3. Run `npm install` to install the necessary dependencies
4. Start both the server by navigating to each directory "Clinet" and "Server"
4. Run `npm start` to start the application in front-end and back-end separately.
5. Open a web browser and go to http://localhost:3000/ to view the application.
## Author
Prashant Dhiman
| A dashboard using MERN stack | chartjs,expressjs,javascript,mongodb,mongoose,node-js,nodejs,react-chartjs-2,reactjs,tailwindcss | 2023-03-19T23:07:27Z | 2023-03-19T23:38:43Z | null | 1 | 0 | 2 | 0 | 1 | 5 | null | null | JavaScript |
IkboljonMe/leetcode | main | # MY [LEETCODE](https://leetcode.com/ikboljonme/) SOLUTIONS
This repo contains my solutions to various LeetCode problems, along with explanations and test cases in JavaScript and Python.
## Problem Solutions
For each problem, you can find a JavaScript file containing my solution and a link to an explanation of the code. I have tried to write clear and concise code that is easy to understand, and I have provided explanations to help you understand my thought process and approach to the problem.
# JavaScript:
## Jest Testcases
To ensure the correctness of my solutions in Javascript, I have included Jest test cases for each problem. These tests cover various edge cases and input scenarios to help verify that my solution is working correctly.
## Usage
Before running the tests, make sure to you are in leetcode/JavaScript path. You can do this with following command:
```
cd JavaScript
```
Then download all the required packages by running **npm install** command in the terminal.
```
npm install
```
To run all the Jest test cases, simply run **npm test** in the terminal. This will execute all the tests in the repository.
```
npm test
```
If you want to run tests for a specific problem, you can specify the file path of the test using the --PATH option. For example, to run tests for a problem located in the problems/foo.js file, **run npm test -- problems/foo.test.js**.
```
npm test -- problems/foo.test.js
```
## Links
- [Javascript](https://github.com/IkboljonMe/leetcode/tree/main/JavaScript)
- [30_day_Marathon](https://github.com/IkboljonMe/leetcode/tree/main/JavaScript/30days_marathon)
# Python:
## Pytest Testcases
To ensure the correctness of my solutions in Python, I have included `pytest` test cases for each problem in Python. These tests cover various edge cases to help verify that my solution is working correctly.
## Usage
Before running the tests, make sure to in directory `leetcode/Python`. You can do thi by following command:
```
cd Python
```
Then download all the required packages by running the following command in the terminal:
```
pip install -r requirements.txt
```
This will install all the required packages listed in the `requirements.txt` file.
To run all the `pytest` test cases, simply run the following command in the terminal. This will execute all the tests in the repository.
```
pytest
```
If you want to run tests for a specific problem, you can specify the file path of the test using the `-k` option followed by the file name. For example, to run tests for a problem located in the `problems/foo.py` file, run the following command:
```
pytest -k "foo"
```
This will run all the tests that match the string "foo" in the file name.
Note that you should be in the root directory of your project where the `pytest.ini` and `requirements.txt` files are located before running these commands.
## Links
- [Python](https://github.com/IkboljonMe/leetcode/tree/main/Python)
- [20_day_Marathon](https://github.com/IkboljonMe/leetcode/tree/main/Python/20days_marathon)
## License
This project is licensed under the terms of the MIT license. See the [LICENSE](https://github.com/IkboljonMe/leetcode/blob/main/LICENSE.txt) file for details.
## Conclusion
I hope that these solutions and explanations will be helpful to you in your own algorithmic problem-solving journey. Please feel free to leave any feedback or suggestions for improvement.
| This repo contains my solutions to LeetCode problems in JavaScript and Python, with explanations and test cases to ensure correctness. The goal is to show my algorithmic problem-solving skills to others and help to new beginners). | jest-tests,leetcode-solutions,problem-solving,javascript,python,pytest,python3,testcases | 2023-03-21T09:33:07Z | 2023-05-08T13:14:55Z | null | 1 | 0 | 75 | 0 | 3 | 5 | null | MIT | Python |
Pquar/PROJETOS-COM-HTML_CSS_JAVASCRIPT | master | # Links para Navegar entre os projetos
:warning: [Tags HTML](https://github.com/Pquar/PROJETOS-COM-HTML_CSS_JAVASCRIPT/tree/master/APRENDENDO%20html/exercicio%202%20(Tags))
:memo: [Estilo](https://github.com/Pquar/PROJETOS-COM-HTML_CSS_JAVASCRIPT/tree/master/APRENDENDO%20CSS)
:rocket: [Introdução a Javascript](https://github.com/Pquar/PROJETOS-COM-HTML_CSS_JAVASCRIPT/tree/master/APRENDENDO%20JS)
Este repositório foi criado para armazenar projetos voltados ao ensino, foi feito principalmente para inciantes e voltado a ensinar programação com HTML, CSS e Javascript.
[Conteúdo Extra](https://github.com/karlhorky/learn-to-program)
O conteúdo tem como premissa aprender de forma simples e direta, com exemplos e projetos práticos.
| Este repositório visa criar conteúdos Didáticos para ensinar sobre HTML, CSS e JavaScript, para pessoas que estão iniciando na programação. | css,html,javascript,css3,html5 | 2023-03-18T01:15:14Z | 2023-08-09T22:29:09Z | null | 1 | 0 | 23 | 0 | 0 | 5 | null | null | JavaScript |
SkyeUwU/CunnyBot | master | # CunnyBot
CunnyBot is a cute and funny bot that sends an image from your favorite image board (booru) to your Discord webhook every hour :3
## Installation
1. Run `npm install` to install all the required modules. The required modules will be pulled automatically from the `package.json`.
2. Create a `.env` file in the root path of the project.
3. Insert the following text, replacing the values with your own:
```python
WEBHOOK_URL=your-webhook-url-here
```
4. Create two text files, `allowed_tags.txt` and `disallowed_tags.txt`, and insert your tags separated by spaces, new lines, or both. For example:
```
# Example allowed tags:
gawr_gura murasaki_shion laplus_darknesss
uruha_rushia blue_archive hoshino_(blue_archive)
arona_(blue_archive) arisu_(blue_archive) iroha_(blue_archive)
# Example disallowed tags:
guro vore scat gore pee
```
5. Create a file named `configs.js` and paste the text bellow. (Optional: edit the variables inside it with the ones you like):
```javascript
module.exports = {
disallowedRatings: "explicit questionable", // The rating you want to exclude. "General" rating is used by Gelbooru to define the SFW posts, but other boorus might use the "safe" rating instead.
site: "gelbooru", // The website you want to send pictures from.
allowedTagsFile: "allowed_tags.txt", // The file containing the tags you want to include in the search. The code will pick a random tag instead of using all the tags at once.
disallowedTagsFile: "disallowed_tags.txt", // The file containing the tags you want to exclude from all the searches.
logToFile: "logs.csv", // The file you want to log every post that was sent. Use "logToFile: false" if you don't want to log it.
deleteLogsOlderThan: 7, // Days
preventDuplicates: true, // If enabled the code will reject any posts that already had been sent and will try sending another post (notice: the logging must be enabled for this feature to work)
outputType: "sampleUrl", // the output that will get sent to Discord. You can use fileUrl or sampleUrl (if it does't exist or is NULL, "fileUrl" will be used instead)
sendAtStart: false, // If you want to send the post when the script starts and then every hour at minute zero (true) or only every hour at minute zero (false).
};
```
6. Run `node index.js` to execute the script.
## Output
Here's an example of what the output might look like: <br>
You're free to modify the script to customize the output, such as adding embeds, modifying the schedule, and more.
## Collaboration
### How can I collaborate?
Simply make a pull request, and I will review it. I would be more than happy to have someone improve my code, as it pretty much sucks.
### What happens after I make the pull request?
I will regularly review pull requests, and if I find that your version is suitable, it will become part of the next update.
## License
This project is licensed under the terms of the [MIT License](https://github.com/SkyeUwU/CunnyBot/blob/master/LICENSE), which allows you to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the conditions specified in the license.
| CunnyBot is a cute and funny bot that sends an image from your favorite image board (booru) to your Discord webhook every hour :3 | anime,cunny,javascript,loli,nodejs,booru,discord,discordjs,gelbooru,webhook | 2023-03-12T05:23:44Z | 2024-04-27T17:35:43Z | null | 2 | 1 | 80 | 0 | 0 | 5 | null | MIT | JavaScript |
MuhdHanish/Evoca-Fashion | main | # EvocaFashion.store
EvocaFashion.store is a web application built with Node.js, MongoDB, Handlebars, CSS, and Bootstrap. It is an e-commerce platform where users can browse and purchase fashion products.
## Features
- User authentication: Users can create accounts, log in, and log out.
- Product browsing: Users can browse through a collection of fashion products.
- Product details: Users can view detailed information about each product.
- Shopping cart: Users can add products to their shopping cart and proceed to checkout.
- Order management: Users can view and manage their orders.
- Admin functionality: Admin users have access to additional features like product management, order management, and user management.
## Technologies Used
- Node.js: A JavaScript runtime that allows running JavaScript on the server-side.
- MongoDB: A NoSQL database used for storing and retrieving data.
- Handlebars: A templating engine used for generating dynamic HTML templates.
- CSS: Cascading Style Sheets for styling the application.
- Bootstrap: A popular CSS framework for building responsive and mobile-first websites.
## Getting Started
### Prerequisites
- Node.js and npm should be installed on your machine.
- MongoDB should be installed and running.
### Installation
1. Clone the repository:
2. Change into the project directory:
3. Install the dependencies:
4. Configure the environment variables:
- Create a `.env` file in the root directory of the project.
- Set the following environment variables in the `.env` file:
- `MONGODB_URI`: The connection URI for your MongoDB database.
- `SESSION_SECRET`: A secret key used for session management.
- `PORT`: The port number on which the application will run (optional, default is 3000).
5. Start the application:
-> npm start
6. Open your web browser and visit `http://localhost:3000` (or the specified port) to access the application.
## Contributing
If you'd like to contribute to EvocaFashion.store, you can follow these steps:
1. Fork the repository on GitHub.
2. Create a new branch for your feature or bug fix.
3. Make the necessary changes in your branch.
4. Commit your changes and push them to your forked repository.
5. Submit a pull request describing your changes.
## License
This project is licensed under the [MIT License](LICENSE).
## Contact
For any inquiries or feedback, you can reach me at muhammedhanish11@gmail.com.
| EvocaFashion.store is a web application built with Node.js, MongoDB, Handlebars, CSS, and Bootstrap. It is an e-commerce platform where users can browse and purchase fashion products. | nodejs,expressjs,handlebars-js,mongodb,ajax,bootstrap5,e-commerce,ecommerce,forgot-password,html | 2023-03-21T13:52:44Z | 2023-09-22T09:52:43Z | null | 1 | 0 | 66 | 0 | 0 | 5 | null | null | Handlebars |
A-Herzog/QueueCalc | master | # Warteschlangenrechner / Queue calculator
Queue calculator is a web service for calculating the characteristics of different queueing models.
## Usage
To use queue calculator just go to
**[a-herzog.github.io/QueueCalc](https://a-herzog.github.io/QueueCalc)**
You can also download queue calculator as an offline usable Windows application:
**[QueueCalc.exe](https://github.com/A-Herzog/QueueCalc/releases/latest/download/QueueCalc.exe)**
## License
Warteschlangenrechner / Queue calculator is licensed under the [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0).
This product bundles some components licensed under different open source licenses, see:
- [**Bootstrap**](https://getbootstrap.com/): [MIT license](https://opensource.org/license/mit/)
- [**Bootstrap icons**](https://icons.getbootstrap.com): [MIT license](https://opensource.org/license/mit/)
- [**Chart.js**](https://www.chartjs.org): [MIT license](https://opensource.org/license/mit/)
For building a desktop app from the Javascript code [**Neutralinojs**](https://neutralino.js.org/) under the
[MIT license](https://opensource.org/license/mit/) is used.
## Contact
[Alexander Herzog](https://github.com/A-Herzog) | Queue calculator is a web service for calculating the characteristics of different queueing models. | javascript,queueing,queueing-theory,webapp | 2023-03-17T23:03:44Z | 2024-05-12T22:16:05Z | 2024-01-12T09:35:28Z | 1 | 0 | 32 | 0 | 0 | 5 | null | Apache-2.0 | NSIS |
rozhkoy/best-tic-tac-toe | develop | # The Best Tic-tac-toe with multiplayer
The "Best Tic-tac-toe" project is an interactive web game that combines three exciting game modes for a diverse gaming experience.
1. **Online Mode:** Play Tic-Tac-Toe in real-time with opponents from around the world. Create or join games, interact with other players, and test your skills in battles over the internet.
2. **Bot Mode:** The artificial intelligence, based on the miniMax algorithm, provides an intelligent and challenging opponent for single-player mode. The bot adapts to the player's style and offers high-level difficulty strategies.
3. **Two-Player Mode:** Allows playing Tic-Tac-Toe with a friend or family member. Optimized for interactive interaction between two players, creating a competitive and engaging gaming space.
## Installation and local launch
1. Clone this repo: `git clone https://github.com/rozhkoy/best-tic-tac-toe.git`
2. Run `npm ci` in the client root folder
3. Fill all the fields in `.env` using your firebase data and etc.
4. Run `npm run dev` in the client root folder
5. Run `npm ci` in the server root folder
6. Fill all the fields in `.env` using your firebase data and etc.
7. Run `npm run dev` in the server root folder
### .env tamplates
#### .env template for client
```
VITE_API_KEY=
VITE_AUTH_DOMAIN=
VITE_PROJECT_ID=
VITE_STORAGE_BUCKET=
VITE_MESSAGING_SENDER_ID=
VITE_APP_ID=
VITE_MEASUREMENT_ID=
VITE_BASE_URL=
VITE_WS_URL=
```
#### .env template for server
```
PORT=8888
DB_NAME=
DB_USER=
DB_PASSWORD=
DB_HOST=
DB_PORT=
TYPE=
PROJECT_ID=
PRIVATE_KEY_ID=
PRIVATE_KEY=
CLIENT_EMAIL=
CLIENT_ID=
AUTH_URI=
TOKEN_URI=
AUTH_PROVIDER_X509_CERT_URL=
CLIENT_X509_CERT_URL=
UNIVERSE_DOMAIN=
CORS_URL=
```
## [](https://github.com/rozhkoy/best-tic-tac-toe/blob/develop/LICENSE)License
MIT — use for any purpose. Would be great if you could leave a note about the original developers. Thanks!
| Online best tic-tac-toe with Multiplayer | express,javascript,nodejs,react,reactquery,typescript | 2023-03-12T18:57:32Z | 2024-05-21T12:27:11Z | null | 2 | 67 | 232 | 1 | 0 | 5 | null | MIT | HTML |
is-a-dev/cli | main | # is-a.dev CLI
Register your own is-a.dev subdomain from your command line!
## Getting Started
Using the is-a.dev CLI is easy!
All you need to do is run the following command:
```bash
npm install @is-a-dev/cli -g
```
...and that's it!
## Using Commands
All of the CLI commands start with `is-a-dev`.
To show the help menu, in your terminal run this command:
```bash
is-a-dev help
```
### Debugging
If you are having issues using the CLI, follow these simple steps:
1. Run the debug command
```bash
is-a-dev debug
```
2. Open an issue
Open an issue stating your issue and provide the output from the debug command as well.
| Register your own is-a.dev subdomain from your command line! | cli,command-line,is-a-dev,javascript,js,nodejs,package,terminal | 2023-03-18T23:50:34Z | 2024-02-10T00:45:35Z | 2024-01-07T22:53:22Z | 6 | 19 | 40 | 0 | 1 | 5 | null | MIT | JavaScript |
gXLg/nullcord | main | # nullcord
<div>
<table align=left>
<tr><td><img src="https://github.com/gXLg/nullcord/assets/65429873/fb229323-62fa-4ffd-bbbc-56f473d3c1b2" width=380 alt="nullcord logo"></td></tr>
</table>
<table>
<tr height=50><td width=407 align=center>
<a href="https://www.npmjs.com/package/nullcord" title="NPM"><img src="https://img.shields.io/npm/v/nullcord?logo=npm&logoColor=%2300BA7F&labelColor=black&color=white"></a>
<a href="https://www.npmjs.com/package/nullcord" title="Downloads"><img src="https://img.shields.io/npm/dm/nullcord?labelColor=black&color=white"></a>
<a href="https://gxlg.dev/donate" title="Donate"><img src="https://img.shields.io/badge/Donate-black?logo=paypal&logoColor=%2300BA7F"></a>
</td></tr>
<tr height=158><td>Lightweight Javascript library for Discord API, developed by <code>/dev/null</code>.</td></tr>
</table>
<br clear=left>
</div>
# Installation
```sh
npm install nullcord
```
nullcord has only two dependencies:
* `gxlg-utils` - a small library with diffent JSON and Promise utilities
* `ws` - a library for the websocket connection
# Documentation
To use the library you can check out the [<kbd>Documentation</kbd>](docs).
To see examples check out the [<kbd>Examples</kbd>](examples) folder.
# Contribution
List of contributors (special thanks):
| User | Contributions |
|--|:--:|
| <a title="/dev/null" href="https://github.com/gXLg"><img src="https://wsrv.nl/?url=avatars.githubusercontent.com/u/65429873&h=64&mask=circle"> | Creator and owner |
| <a title="flp5" href="https://github.com/flp5"><img src="https://wsrv.nl/?url=avatars.githubusercontent.com/u/156463271&h=64&mask=circle"></a> | Advices about utils and logging |
When contributing, please first open an issue and contact me.
Sometimes I may have uncommited changes in my local repo,
which could break a pull request.
I will add you to the list of contributors once the pull request
is merged or I implemented your changes.
# Related Projects
* My project [<kbd>coc-bot</kbd>](https://github.com/gXLg/coc-bot) uses an
up-to-date version of nullcord, the testing of nullcord have been
done mainly through this repo
* Also check out [<kbd>gxlg-utils</kbd>](https://github.com/gXLg/gxlg-utils)
which is used in this lib
* First sketches of nullcord are available in my old
[<kbd>hackaton attempt</kbd>](https://github.com/gXLg/documantic-hackaton)
# For Fun
Some interesting facts all around nullcord:
* The name should always be written in lowercase
* The name obviously comes from my nickname `/dev/null` and `Discord`
* This lib was completely developed on my phone
("mobile developer" just got a new meaning, huh?)
* The internet at my house was/is so bad, that it created a perfect
environment for debugging connectivity related issues
* I developed this while listening to breakcore and drinking
69 liters of coffee a night (I am broke and have an addiction now, please help)
* This library got 2 of my testing bots banned, but it's safe
to use now, I swear!
* If there would have been an award for the worst structured documentation
of rate limits, Discord would surely receive it. I am so happy, I am through
with this, it was a nightmare!
* The logo has been made in Paint in under 5 minutes :D
| Lightweight library for Discord API | discord,javascript,library | 2023-03-20T15:38:47Z | 2024-04-11T12:17:25Z | null | 1 | 0 | 301 | 0 | 0 | 5 | null | MIT | JavaScript |
magicdev122/react-ts | master | # React+TypeScript Cheatsheets
Cheatsheets for experienced React developers getting started with TypeScript
---
<a href="https://github.com/typescript-cheatsheets/react/issues/81">
<img
height="90"
width="90"
alt="react + ts logo"
src="https://user-images.githubusercontent.com/84442212/194379444-02e5ec69-5e6c-4100-bd7a-c31d628af29c.png"
align="left"
/>
</a>
[**Web docs**](https://react-typescript-cheatsheet.netlify.app/docs/basic/setup) |
[**Español**](https://github.com/typescript-cheatsheets/react-typescript-cheatsheet-es) |
[**Português**](https://github.com/typescript-cheatsheets/react-pt) |
[Contribute!](https://github.com/typescript-cheatsheets/react/blob/main/CONTRIBUTING.md) |
[Ask!](https://github.com/typescript-cheatsheets/react/issues/new/choose)
:wave: This repo is maintained by [@swyx](https://twitter.com/swyx), [@eps1lon](https://twitter.com/sebsilbermann) and [@filiptammergard](https://twitter.com/tammergard). We're so happy you want to try out TypeScript with React! If you see anything wrong or missing, please [file an issue](https://github.com/typescript-cheatsheets/react/issues/new/choose)! :+1:
---
[](/CONTRIBUTORS.md) | [](https://discord.gg/wTGS5z9) | [](http://twitter.com/home?status=Awesome%20%40Reactjs%20%2B%20%40TypeScript%20cheatsheet%20by%20%40ferdaber%2C%20%40sebsilbermann%2C%20%40swyx%20%26%20others!%20https%3A%2F%2Fgithub.com%2Ftypescript-cheatsheets%2Freact)
## All React + TypeScript Cheatsheets
- [The Basic Cheatsheet](https://react-typescript-cheatsheet.netlify.app/docs/basic/setup) is focused on helping React devs just start using TS in React **apps**
- Focus on opinionated best practices, copy+pastable examples.
- Explains some basic TS types usage and setup along the way.
- Answers the most Frequently Asked Questions.
- Does not cover generic type logic in detail. Instead we prefer to teach simple troubleshooting techniques for newbies.
- The goal is to get effective with TS without learning _too much_ TS.
- [The Advanced Cheatsheet](https://react-typescript-cheatsheet.netlify.app/docs/advanced) helps show and explain advanced usage of generic types for people writing reusable type utilities/functions/render prop/higher order components and TS+React **libraries**.
- It also has miscellaneous tips and tricks for pro users.
- Advice for contributing to DefinitelyTyped.
- The goal is to take _full advantage_ of TypeScript.
- [The Migrating Cheatsheet](https://react-typescript-cheatsheet.netlify.app/docs/migration) helps collate advice for incrementally migrating large codebases from JS or Flow, **from people who have done it**.
- We do not try to convince people to switch, only to help people who have already decided.
- ⚠️This is a new cheatsheet, all assistance is welcome.
- [The HOC Cheatsheet](https://react-typescript-cheatsheet.netlify.app/docs/hoc)) specifically teaches people to write HOCs with examples.
- Familiarity with [Generics](https://www.typescriptlang.org/docs/handbook/2/generics.html) is necessary.
- ⚠️This is the newest cheatsheet, all assistance is welcome.
---
| null | javascript,react,reactjs,typescript | 2023-03-12T09:17:23Z | 2023-03-12T09:19:45Z | null | 1 | 0 | 2 | 0 | 0 | 5 | null | MIT | JavaScript |
mrcbq/portfolio-mobile-first | main | <a name="readme-top"></a>
<!-- TABLE OF CONTENTS -->
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#triangular_flag_on_post-deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributors](#contributors)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ (OPTIONAL)](#faq)
- [📝 License](#license)
<!-- PROJECT DESCRIPTION -->
# 📖 Portfolio Mobile First <a name="Portfolio Mobile first version"></a>
> This is the first mobile version of my portfolio
**Portfolio Mobile First** There is the first exercise for create a portfolio web page app, using mobile firts modern techniques.
## 🛠 Built With <a name="built-with"></a>
### Tech Stack <a name="tech-stack"></a>
<details>
<summary>Client
<ul>
<li>HTML</li>
<li>css</li>
<li>JavaScript</li>
</ul>
</summary>
</details>
<!-- Features -->
### Key Features <a name="key-features"></a>
> Describe between 1-3 key features of the application.
- **Portfolio web version Using only html and css**
- **Mobile first, Responsive Desing**
- **Using gh actions as a linter and hint as a local linter**
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- live demo -->
### 🚀 Live Demo <a name="live-demo"></a>
> **Please visit my application in following link.**
- <p align="left"><a href="https://mrcbq.github.io/portfolio-mobile-first/">https://mrcbq.github.io/portfolio-mobile-first/</a></p>
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- GETTING STARTED -->
## 💻 Getting Started <a name="getting-started"></a>
To get a local copy up and running, follow these steps.
clone and use this template
### Prerequisites
In order to run this project you need:
A browser, and that's it.
Please clone this repo, and forked it.
Open index.html on your browser.
### Setup
Clone this repository:
git clone https://github.com/mrcbq/portfolio-mobile-first.git to your desired folder and change the readme file for your fits.
### Install
Open Index.HTML on your favorite browser
No requires libraries extra.
### Usage
To run the project, execute the following command:
Open the index.html on your favorite browser.
### Run tests
This project has no test configured yet, no worries it an only a basic html and css project...
### Deployment
You can deploy this project using:
Git Hub Pages: use this instructions: https://livecode247.com/deploying-a-static-html-and-css-site-using-github-pages
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- AUTHORS -->
## 👥 Authors <a name="authors"></a>
👤 **Marco Baquero**
- GitHub: [@mrcbq](https://github.com/mrcbq)
- Twitter: [@mrcbq](https://twitter.com/mrcbq)
- LinkedIn: [LinkedIn](https://linkedin.com/in/mrcbq)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- CONTRIBUTING -->
## 🤝 Contributors <a name="contributing"></a>
Contributions, issues, and feature requests are welcome!
👤 **Joaquin Calle Aranzolo**
- GitHub: [Joaquin123455](https://github.com/Joaquin123455)
- Twitter: [@CalleJoaquinn](https://twitter.com/CalleJoaquinn)
- LinkedIn: [Joaquin Calle Aranzolo](https://www.linkedin.com/in/joaquin-calle-aranzolo-695bba260/)
👤 **Alvaro Iporre**
- GitHub: [@alvaroiporre](https://github.com/alvaroiporre)
- Twitter: [@alvaro.iporre](https://twitter.com/twitterhandle)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/alvaro-iporre-martiez-501533124/)
> 👤 **Gardimy Charles**
- GitHub: [@Gardimy](https://github.com/Gardimy)
- Twitter: [@gardyelontiga45](https://twitter.com/gardyelontiga45)
- LinkedIn: [Gardimy charles](https://www.linkedin.com/in/gardimy-charles)
Feel free to check the [issues page](../../issues/).
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- FUTURE FEATURES -->
## 🔭 Future Features <a name="future-features"></a>
- [ ] **[implement popups]**
- [ ] **[use another linter]**
- [ ] **[implemented express or nest.js]**
<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 consider give me a like.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- ACKNOWLEDGEMENTS -->
## 🙏 Acknowledgments <a name="acknowledgements"></a>
I would like to thank to microverse
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- FAQ (optional) -->
## ❓ FAQ (OPTIONAL) <a name="faq"></a>
Q: How to use the responsive design for the mobiel version?
A: Think mobile first.
- **[How use the readme file]**
- [Please copy the content and paste in your favorite editor, save as readme.md ]
<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>
# portfolio-mobile-first
| Portfolio web page, it's a showcase of my main projects with my contact info. Built with JS Vanilla, HTML and CSS. | css,html,javascript | 2023-03-24T17:00:46Z | 2023-06-30T00:25:10Z | null | 4 | 9 | 91 | 3 | 1 | 5 | null | MIT | CSS |
microvese-projects/blockchain-summit | main | <a name="readme-top"></a>
<div align="center">
<h3><b>Blockchain Summit</b></h3>
</div>
<!-- TABLE OF CONTENTS -->
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- - [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [👥 Author](#author)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)
<!-- PROJECT DESCRIPTION -->
# 📖 Blockchain Summit <a name="about-project"></a>
**Blockchain Summit** is a project that was created as a Module 1 capstone project from Microverse.
## 🛠 Built With <a name="built-with"></a>
### Tech Stack <a name="tech-stack"></a>
This project was created in HTML, CSS and Javascript with a mobile-first development approach.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- Key Features -->
### Key Features <a name="key-features"></a>
The project incorporates the following features:
- **[Home]**
This section marks the landing page to the website. It provides introductory information to the visitor.
- **[About]**
This section provides additional information about the summit including past summit events among other information.
- **[Navbar]**
This section provides buttons for navigating around the website. There is a different view for the mobile and desktop based browsers.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- LIVE DEMO -->
## 🚀 Live Demo <a name="live-demo"></a>
> Link to my deployed project.
- [Live Demo Link](https://microvese-projects.github.io/blockchain-summit/)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- Video Walkthrough -->
## Video Walkthrough <a name="outline-video"></a>
> Click on the [link](https://www.loom.com/share/8cb3549317c64b95addd3a2d5e9994f5) to watch an outline video of my project.
[Outline Video](https://www.loom.com/share/8cb3549317c64b95addd3a2d5e9994f5)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- GETTING STARTED -->
## 💻 Getting Started <a name="getting-started"></a>
To get a local copy up and running, follow these steps.
### Prerequisites <a name="prerequisites" ></>
In order to set up a local copy of this repository, you need to have git installed:
[Install Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) <a name="install"></a>
### Setup <a name="setup"></a>
Clone this repository to your desired folder:
Example commands:
```sh
mkdir my-folder
cd my-folder
git@github.com:microvese-projects/blockchain-summit.git
```
-
### Usage <a name="usage"></a>
To run the project:
Open the index.html file in your local browser to interact.
### Usage <a name="run-tests"></a>
Tests can be performed using the lighthouse extension on google chrome to get a report of the page's performance.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- AUTHORS -->
## 👥 Author <a name="author"></a>
👤 **Benson Njuguna**
- GitHub: [@bennyjoez](https://github.com/bennyjoez)
- Twitter: [@bennyjoezz](https://twitter.com/bennyjoezz)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- FUTURE FEATURES -->
## 🔭 Future Features <a name="future-features"></a>
I plan to add the following features:
- [ ] **[Program_page]**
- [ ] **[Sign_up]**
- [ ] **[Sponsors_page]**
- [ ] **[News_page]**
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- CONTRIBUTING -->
## 🤝 Contributing <a name="contributing"></a>
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/microvese-projects/blockchain-summit/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, you can show your support by giving this project's repository a star on github.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- ACKNOWLEDGEMENTS -->
## 🙏 Acknowledgments <a name="acknowledgements"></a>
I would like to thank Microverse for the outstanding collection of information they have provided that enabled me to create the project.
I would also like to thank <strong>*Cindy Shin*</strong> who is the author of the original design that I emulated while creating the project.
<!-- LICENSE -->
## 📝 License <a name="license"></a>
This project is [MIT](https://github.com/microvese-projects/blockchain-summit/blob/1c707165cc8d1afdd068aea824def7f2abee83d3/LICENSE) licensed.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
| This is a website created for a Blockchain Summit. It features the homepage, the about page and the program page. Build in HTML, CSS and JavaScript. | css,html,javascript | 2023-03-13T08:18:29Z | 2023-03-16T14:34:12Z | null | 1 | 1 | 57 | 0 | 0 | 5 | null | MIT | CSS |
kalbek/Hack-Summit | main | <a name="readme-top"></a>
# 📖 HackSummit 2023 <a name="about-project"></a>
### **HackSummit 2023** is a website developed for the 2023 Global Hack Summit Conference.
<br/>
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [🛠 Walkthough](#walkthough)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#triangular_flag_on_post-deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ (OPTIONAL)](#faq)
- [📝 License](#license)
<!-- PROJECT DESCRIPTION -->
## 🛠 Built With
<details>
<ul>
<li><a href="https://developer.mozilla.org/en-US/docs/Web/HTML">HTML</a></li>
<li><a href="https://developer.mozilla.org/en-US/docs/Web/CSS">CSS</a></li>
<li><a href="https://developer.mozilla.org/en-US/docs/Web/CSS">JAVASCRIPT</a></li>
</ul>
</details>
<!-- Checkout the [video](https://www.loom.com/share/fadb70b392754ee8ab23da8b3fff2f26) for the walkthough of this project. -->
## 👁 Walkthough <a name="walkthough"> </a>
- Video Walkthrough: coming soon.
### Tech Stack <a name="tech-stack"></a>
<ul>
<li><a href="https://developer.mozilla.org/en-US/docs/Web/HTML">HTML</a></li>
<li><a href="https://developer.mozilla.org/en-US/docs/Web/CSS">CSS</a></li>
<li><a href="https://developer.mozilla.org/en-US/docs/Web/CSS">JAVASCRIPT</a></li>
</ul>
<!--# 👁 Walkthough HakcSummit 2023 <a name="about-project"></a>
- Video to walkthrough of this project can be found [here]("https://www.loom.com/share/fadb70b392754ee8ab23da8b3fff2f26")> HTML CSS & Java Script
<details>
<ul>
<li><a href="https://developer.mozilla.org/en-US/docs/Web/HTML">HTML</a></li>
<li><a href="https://developer.mozilla.org/en-US/docs/Web/CSS">CSS</a></li>
</ul>
</details> -->
### Key Features <a name="key-features"></a>
- **Presents the Home page for HackSummit 2023**
- **Presents the About page for HackSummit 2023**
- **Displays Speakers List with more and less button functionality**
- **The site is responsive.**
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- LIVE DEMO -->
## 🚀 Live Demo <a name="live-demo"></a>
> Link to live demo of this project can be found here:
- [Live Demo Link](https://kalbek.github.io/Capstone-1-Hack-Summit/)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- GETTING STARTED -->
## 💻 Getting Started <a name="getting-started"></a>
Try to have these in your local machine
- Git and GitHub
- VS Code or any code editor
### Prerequisites
In order to run this project you need
- A web browser
- Code editor
### Setup
Clone this repository to your desired folder:
git clone https://github.com/kalbek/Hack-Summit.git
For stylelint error run:sudo npx stylelint "*/.{css,scss}" --fix
refer to [this-link](https://github.com/microverseinc/linters-config/tree/master/javascript) to resolve lint errors.
### Install
Install this project using the cloned repo or download and use the files to your local machine.
### Usage
To run the project open the index.html file in your web browser
### Run tests
No test are available
### Deployment
You can deploy this project through Github Pages
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- AUTHORS -->
## 👥 Authors <a name="authors"></a>
👤 **Kaleb Bekele**
- GitHub: [@githubhandle](https://github.com/kalbek)
- Twitter: [@twitterhandle](https://twitter.com/KNuramo)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/kaleb-nuramo/)
- Website: https://kalbek.github.io/Portfolio/
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- FUTURE FEATURES -->
## 🔭 Future Features <a name="future-features"></a>
- [ ] **More Content will be personalized**
- [ ] **Other pages will be created and linked to the home page**
<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>
## ⭐️ Show your support <a name="support"></a>
If you like this project give a star to this repository.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 🙏 Acknowledgments <a name="acknowledgements"></a>
A huge shout out to [Cindy Shin](https://www.behance.net/gallery/29845175/CC-Global-Summit-2015) who created the original design from which this project is inspired.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## ❓ FAQ <a name="faq"></a>
- **Is it allowed to copy the contents of this project and use it for personal use?**
- Yes, this project is free for copying and reusing in any way you like.
- How often will the future features be implemented?
- New features will be implemented depending on the request of stakeholders.
## 📝 License <a name="license"></a>
This project is [MIT](./MIT.md) licensed.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
| Hack Summit is a website developed as a capstone project for HTML and CSS module at Microverse. It is created with HTML, CSS, and JavaScript with proper linter configurations. | babel,css,html,javascript,linters | 2023-03-18T12:07:33Z | 2023-06-26T13:08:09Z | null | 1 | 1 | 39 | 1 | 0 | 5 | null | null | CSS |
kateFrontend/js-drag-n-drop | main | # Drag N Drop
## 🦉 Main information
Simple project that give you a basic understanding of how drag and drop functionality works.
The project goal:
- create a few boxes ans one div instde one of these boxes that includes a background image coming from Unsplash random image
- give a diferent CSS classes for js functionality
- set up it in HTML, style it with CSS and add the functionality with JavaScript
## 🦊 Useful links
### HTMLElement: dragstart event
```
https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/dragstart_event
```
### HTMLElement: dragend event
```
https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/dragend_event
```
### HTMLElement: dragenter event
```
https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/dragenter_event
```
### HTMLElement: dragover event
```
https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/dragover_event
```
### HTMLElement: dragleave event
```
https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/dragleave_event
```
### HTMLElement: drag event
```
https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/drag_event
```
### HTMLElement: drop event
```
https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/drop_event
```
## ⚡ Built With
[HTML5](https://www.w3schools.com/html/) / [CSS3](https://www.w3schools.com/css/) / [JavaScript](https://www.w3schools.com/js/) | Drag & Drop functionality | css,drag-and-drop,html,html-css-javascript,javascript,vanilla-js | 2023-03-17T00:09:46Z | 2023-03-28T14:36:01Z | null | 1 | 0 | 7 | 0 | 0 | 5 | null | null | JavaScript |
MiguelGuthridge/JSC-Compiler | main | # JSC Compiler
A 🔥 BLAZINGLY FAST 🔥, but ❄️ refreshingly simple ❄️ JavaScript to JavaScript
compiler.
## Why?
As JavaScript has become more popular and powerful, its ecosystem has
become increasingly convoluted. Developers have built many tools such as Babel
and TypeScript to help them manage the complexity and streamline their
workflows. However, although these tools bring many sophisticated features,
they can be burdensome and frustrating to use due to their complexity.
For years, developers have been looking for a simpler alternative, and it has
finally arrived: the **JSC Compiler**. Say goodbye to frustration and
complexity and say hello to the future of JavaScript development!
## How?
The **JSC Compiler** simplifies JavaScript compilation by not including
rarely-used features such as:
* Syntax transformation
* Performance optimisation
* Polyfills
* Type safety
* Size optimisation
* Code obfuscation
## Usage
Install the **JSC Compiler** using the command `npm install -D jsc-compiler`.
You can then run it using
`npx jsc <input file/directory> <output file/directory>`.
## Contributing
I'd love to have your help developing this awesome project! Feel free to open
up issues and pull requests to address any issues you may find in the code!
Note that JSC uses Babel to ensure that the Jest tests run correctly.
| A 🔥 BLAZINGLY FAST 🔥, but ❄️ refreshingly simple ❄️ JavaScript to JavaScript compiler | babel,compiler,javascript | 2023-03-20T10:17:57Z | 2023-05-26T15:01:13Z | null | 1 | 5 | 21 | 1 | 0 | 5 | null | MIT | JavaScript |
AbdusSattar-70/Javascript-Capstone | dev | <a name="readme-top"></a>
<div align="center">
<h3><b>Javascript-Capstone </b>.
</h5>
</div>
<div align="center">
<h3><b>screenshot</b></h3>
<img src="src/asset/Screenshot1.png" alt="screenshoot" width="500" height="auto"/>
<img src="src/asset/Screenshot2.png" alt="screenshoot" width="500" height="auto"/>
</div>
<!-- TABLE OF CONTENTS -->
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo and presentation video](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#triangular_flag_on_post-deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)
<!-- PROJECT DESCRIPTION -->
## 📖 Javascript-Capstone <a name="about-project"></a>
**Javascript-Capstone** is a project for learning Gitflows, GitHub workflows, and usage of API and SPA</b>
<h5> It has two main parts Homepage and Comments modal. Thanks ❤️ to my coding partner <b> Kevin Toro </b> for contributing to creating such an amazing-looking UI<b> In this project, we have used JS, HTML, CSS, webpack, and API for making a demo restaurant. It will allow users to make comments and likes and It will save on the Involvement API. In addition, we also followed the AAA pattern for testing suggested functions.
## 🛠 Built With <a name="built-with"></a>
## Tech Stack <a name="tech-stack"></a>
<details>
<summary>Client</summary>
<b>This project only works client side right now.</b>
<ul>
<li>HTML</li>
<li>CSS</li>
<li>JS</li>
<li>webpack</li>
</ul>
</details>
<details>
<summary>Server</summary>
<ul>
<li><a href=#>Local Server - Hosted on Github</a></li>
</ul>
</details>
<details>
<summary>Database</summary>
<ul>
<li><a href=#>API's used</a></li>
</ul>
</details>
<!-- Features -->
# 💻 Key Features <a name="key-features"></a>
## Home page:
- When the page loads, the webapp retrieves data from:
- The selected API and shows the list of items on screen.
- The Involvement API to show the item likes.
- The page should make only 2 requests:
- One to the base API.
- One to the Involvement API.
- When the user clicks on the Like button of an item, the interaction is recorded in the Involvement API and the screen is updated.
- Home page header and navigation similar to the given mockup.
- Home page footer similar to the given mockup.
## Comments popup:
- When the popup loads, the webapp retrieves data from:
- The selected API and shows details about the selected item.
- The Involvement API to show the item comments.
- When the user clicks on the "Comment" button, the data is recorded in the Involvement API and the screen is updated.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- LIVE DEMO -->
## 🚀 Live Demo and Project presentation video<a name="live-demo"></a>
- [Live Demo Link](https://abdussattar-70.github.io/Javascript-Capstone/dist)
- [Project presentation video](https://drive.google.com/file/d/1kaYJMSJTVw_1eVmV7t0yXi16nr7BfXx0/view?usp=sharing)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- GETTING STARTED -->
## 💻 Getting Started <a name="getting-started"></a>
To get a local copy up and running, follow these steps.
## Prerequisites <a name="prerequisites"></a>
- In order to run this project you need:
### It would be best if you had some familiarity with `HTML`, `CSS`, and `JS`.
- A Computer (MAC or PC)
- code editor (VSCode,Atom etc...)
- A browser (Chrome,Mozilla,Safari etc...)
- Version Control System (Git and Github)
# Setup <a name="setup"></a>
Clone this repository to your desired folder:
```bash
git clone https://github.com/AbdusSattar-70/Javascript-Capstone.git
cd Javascript-Capstone
```
# Install <a name="install"></a>
Install this project with:
```bash
npm install
```
# Run tests and check errors <a name="run-tests"></a>
To run tests and check errors, run the following command:
- To Test:-
```bash
npm test
```
- To check Styelint error:-
```bash
npx stylelint "\*_/_.{css,scss}"
```
- To check Eslint error:-
```bash
npx exlint .
```
- To check webhint error:-
```bash
npx hint .
```
# Deployment <a name="triangular_flag_on_post-deployment"></a>
You can deploy this project using:
```bash
npm run build
```
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- AUTHORS -->
## 👥 Authors <a name="authors"></a>
## 👤 Abdus Sattar
- GitHub: [AbdusSattar-70](https://github.com/AbdusSattar-70)
- Twitter: [Abdus Sattar](https://twitter.com/Abdus_Sattar70)
- LinkedIn: [Abdus Sattar](https://www.linkedin.com/in/abdus-sattar-a41a26215/)
## 👤 Kevin Toro
- GitHub: [@torobucii](https://github.com/torobucii)
- Twitter: [@torobucii](https://twitter.com/@torobucii)
- LinkedIn: [Kevin Toro](https://linkedin.com/in/KevinToro)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- FUTURE FEATURES -->
## 🔭 Future Features <a name="future-features"></a>
- [ ] **Web Responsiveness for all users**
- [ ] **Add web accessibility**
- [ ] **Add gradient background that will change randomly**
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- CONTRIBUTING -->
## 🤝 Contributing <a name="contributing"></a>
Everybody is welcome to suggest, changes,Contributions, issues, and feature request in this project.
In order to do it, fork this repository, create a new branch and open a Pull Request from your branch.
Feel free to check the [issues page](../../issues/).
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- SUPPORT -->
## ⭐️ Show your support <a name="support"></a>
If you like this project, Please give me ⭐️ and you can use it following [MIT](./LICENSE) license.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- ACKNOWLEDGEMENTS -->
## 🙏 Acknowledgments <a name="acknowledgements"></a>
Thanks ❤️ to my coding partner <b> @torobucci</b> for contributing to creating the project.
I would like to thank and appreciate who contributes this project.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- LICENSE -->
## 📝 License <a name="license"></a>
This project is under [MIT](./LICENSE) licensed.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
| Javascript-Capstone is a project for learning Gitflows, GitHub workflows, and usage of API and SPA It has two main parts Homepage and Comments modal. Thanks ❤️ to my coding partner Kevin Toro for contributing to creating such an amazing-looking UI In this project, we have used JS, HTML, CSS, webpack, and API for making a demo restaurant. It will a | css3,html5,javascript,webpack | 2023-03-20T13:33:05Z | 2023-03-23T09:12:37Z | null | 2 | 13 | 48 | 1 | 0 | 5 | null | MIT | JavaScript |
Amazinggracee/capstone-project | main |
<h3 id = "readme-top"><b>Capstone Project </b></h3>
<!-- TABLE OF CONTENTS -->
# 📗 Table of Contents
- [📖 Title](#Team Event)
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [🚀 Live Demo from loom](#Live-Loom-demo)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Credit](#Credit)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ](#faq)
- [📝 License](#license)
<!-- PROJECT DESCRIPTION -->
# 📖 [Capstone Project] <a name="about-project">https://github.com/Amazinggracee/capstone-project</a>
# Team Event
This Capstone Project is based on an online website for a conference with a slogan "Reduce, Reuse and Recycle".
You will learn how you can create enterprise value, empower greater worker productivity, and make the world a better place through advanced technology.
## Built With
- Html
- Css
- JavaScript
### Key Features <a name="key-features">
- **[key_feature_1]** Capstone Project: built with CSS, Html and JavaScript.
- **[key_feature_2]** Capstone Project: Mobile Version.
- **[key_feature_3]** Capstone Project: The Home me page.
- **[key_feature_4]** Capstone Project: desktop version.
- **[key_feature_5]** Capstone Project: About me page for both mobile and desktop version.
### Home page
[screenshot for desktop version](./img/desktop-screen-shot.png)
[screenshot for mobile version](./img/mobile-screen-shot.png)
## Live Demo
[Live Demo Link](https://amazinggracee.github.io/capstone-project/)
## Live Loom demo
[Live Demo from loom ](https://www.loom.com/share/9630c5d25918478697aea7fa71fc0706)
## Getting Started
To run this project clone it with `git clone git@github.com:Amazinggracee/capstone-project.git`
then run from a browser
To get a local copy.
### Prerequisites
In order to run this project you need:
1. A computer with a code writer, I recommend Visual Studio Code.
2. A pre-knowledge of HTML,CSS and JavaScript.
### Install
Install linters to handle some common Errors, You can have description about [Linters here](https://github.com/microverseinc/linters-config)
👤 **Amarachi Dimkpa**
- GitHub: [@amazinggacee](https://github.com/Amazinggracee)
- Twitter: [@amazinggaceu](https://twitter.com/amazinggraceu)
- LinkedIn: [Amarachi Dimkpa](https://linkedin.com/in/amarachi-dimkpa-070643183)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- FUTURE FEATURES -->
## 🔭 Future Features <a name="future-features"></a>
- [ ] **[new_feature_1]** Add more behaviour via Javascript.
- [ ] **[new_feature_2]** Capstone Project: details popup window.
- [ ] **[new_feature_3]** Capstone Project: validate contact form.
- [ ] **[new_feature_4]** Capstone Project: preserve data in the browser.
- [ ] **[new_feature_5]** Every other pages will be added example news page.
## Credit
[@Cindy Shin](https://www.behance.net/adagio07) Thanks for this amazing design
## 🤝 Contributing
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/Amazinggracee/capstone-project/issues).
## Show your support
Give a ⭐️ if you like this project!
## Acknowledgments
- I am grateful to everyone whose code was used
- Inspiration
- etc
## 📝 License
This project is [MIT](./MIT.md) licensed.
| This Capstone Project is based on an online website for a conference with a slogan "Reduce, Reuse and Recycle". You will learn how you can create enterprise value, empower greater worker productivity, and make the world a better place through advanced technology. Built With - Html - CSS - JavaScript | css,css3,html,html5,javascript | 2023-03-12T13:02:21Z | 2023-03-16T12:02:57Z | null | 1 | 4 | 29 | 0 | 0 | 4 | null | MIT | HTML |
MarwanDev/Awesome-Books | master | # Awesome Books Project
HTML, CSS and JavaScript Awesome Books Project
<a name="readme-top"></a>
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🎥 Video Explanation](#video-explanation)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
-- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ](#faq)
- [📝 License](#license)
# 📖 [Awesome_Books] <a name="Awesome Books"></a>
**[Awesome_Books]** is a simple website that displays a list of books and allows you to add and remove books from that list. By building this application, you will learn how to manage data using JavaScript. Thanks to that, your website will be more interactive. You will also use a medium-fidelity wireframe to build the UI.
## 🛠 Built With <a name="built-with"></a>
### Tech Stack <a name="tech-stack"></a>
<summary>Javascript runtime environment</summary>
<ul>
<li><a href="https://nodejs.org/en/">Node JS</a></li>
</ul>
<summary>Version control</summary>
<ul>
<li><a href="github.com">Git Hub</a></li>
</ul>
</details>
### Key Features <a name="key-features"></a>
- **[Medium-fidelity Wireframes]**
- **[Desktop Version]**
- **[Dynamic Design]**
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 🎥 Video Explanation <a name="video-explanation"></a>
Coming soon!
## 🚀 Live Demo <a name="live-demo"></a>
Coming Soon!
## 💻 Getting Started <a name="getting-started"></a>
Creating your first "Awesome Books" project
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
-A Git hub account
-Git bash
-Node JS
-Visual Studio Code as your code editor
### Setup
Clone this repository to your desired folder:
```sh
cd my-folder
git clone[(https://github.com/MarwanDev/Awesome-Books.git)]
```
### Set Up Linters
## Define Linters
A linter is a tool to help you improve your code. You can learn more about Linters here: (source: (<https://www.testim.io/blog/what-is-a-linter-heres-a-definition-and-quick-start-guide/>)).
Advantages of Linting:
1. Fewer errors in production- The use of linters helps to diagnose and fix technical issues such as code smells. As a result, fewer defects make their way to production.
2. Achieving a more readable and consistent style, through the enforcement of its rules.
3. Having more secure and performant code.
4. Having an objective and measurable assessment of code quality.
5. Having fewer discussions about code style and aesthetic choices during code reviews.
## Install Linters
You can find linters for most of the programming languages, e.g. Rubocop for Ruby or ESLint for JavaScript.
Also, there are many ways you can integrate a linter in your workflow:
-text editor plugin
-GitHub Actions
-GitHub apps
## Set up Linters
**Note:** The npm package manager is going to create a node_modules directory to install all of your dependencies. You shouldn't commit that directory. To avoid that, you can create a .gitignore file and add node_modules to it:
# .gitignore
node_modules/
## ESLint
Run
```
npm install --save-dev eslint@7.x eslint-config-airbnb-base@14.x eslint-plugin-import@2.x babel-eslint@10.x
```
## Web Hint
This is a customizable linting tool that helps you improve your site's accessibility, speed, cross-browser compatibility, and more by checking your code for best practices and common errors.
**NOTE:** If you are using Windows, make sure you initialize npm to create `package.json` file.
```
npm init -y
```
1. Run
```
npm install --save-dev hint@7.x
```
*how to use npm: (https://docs.npmjs.com/downloading-and-installing-node-js-and-npm).*
2. Copy [.hintrc](.hintrc) to the root directory of your project.
3. **Do not make any changes in config files - they represent style guidelines that you share with your team - which is a group of all Microverse students.**
- If you think that change is necessary - open a [Pull Request in this repository](../README.md#contributing) and let your code reviewer know about it.
4. Run
```
npx hint .
```
[Copy contents of .eslintrc.json to the root directory of your project](https://github.com/microverseinc/linters-config/blob/master/html-css-js/.eslintrc.json)
5. Fix validation errors.
### [Stylelint](https://stylelint.io/)
A mighty, modern linter that helps you avoid errors and enforce conventions in your styles.
1. Run
npm install --save-dev stylelint@13.x stylelint-scss@3.x stylelint-config-standard@21.x stylelint-csstree-validator@1.x
not sure how to use npm? Read this.
2. Copy .stylelintrc.json to the root directory of your project.
3. **Do not make any changes in config files - they represent style guidelines that you share with your team - which is a group of all Microverse students.**
If you think that change is necessary - open a Pull Request in this repository and let your code reviewer know about it.
4. Run npx stylelint "**/*.{css,scss}" on the root of your directory of your project.
5. Fix linter errors.
6. **IMPORTANT NOTE:** feel free to research auto-correct options for Stylelint if you get a flood of errors but keep in mind that correcting style errors manually will help you to make a habit of writing a clean code!
### Making Your HTML Using Medium-fidelity wireframes
-Make sure to use a design that is similar to the Medium-fidelity wireframes to present your website
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 👥 Authors <a name="authors"></a>
👤 **Joy Phoebe**
- GitHub: (https://github.com/joyapisi)
- Twitter: (https://twitter.com/joyapisi)
- LinkedIn: (https://http://www.linkedin.com/in/joy-phoebe-00b80a13a)
👤 **Marwan Abdelsattar**
- GitHub: (https://github.com/MarwanDev)
- Twitter: (https://twitter.com/MarwanEg)
- LinkedIn: (https://www.linkedin.com/in/marwan-abdelsattar-665a59105/)
## 🤝 Contributing <a name="contributing"></a>
## 🔭 Future Features <a name="future-features"></a>
# **[Feature-1]**
- Add more styling (aesthetics)
# **[Feature-2]**
- Add mobile version
<p align="right">(<a href="#readme-top">back to top</a>)</p>
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/joyapisi/ThePortfolio/issues).
## ⭐️ Show your support <a name="support"></a>
If you like this project, kindly leave a comment below and share it with someone who enjoys coding! Coding is all about continuous learning and allowing yourself to be a beginner. Keep going!
## 🙏 Acknowledgments <a name="Microverse Inc."></a>
I'm thankful to Microverse for providing a study platform which guided me through this project and to my coding partners at Microverse for the collaborative effort.
## ❓ FAQ <a name="faq"></a>
- **[Question_1]**
What is a medium-fidelity wireframe?
- Medium-fidelity wireframes present how your website's elements should be arranged, but they skip detailed information about aesthetics (e.g., colors, images). They can assist with communicating to teams how aesthetic features can support essential functionalities. Please read <a href="https://mentormate.com/blog/low-fidelity-wireframes-vs-high-fidelity-wireframes/" >Low Fidelity Wireframes vs High Fidelity Wireframes </a> to fully understand the difference between low-, medium-, and high-fidelity wireframes.
- **[Question_2]**
Where can I download node JS for installation?
- Node Js can be downloaded here- <ul>
<li><a href="https://nodejs.org/en/download/"> Node JS </a></li>
</ul>
## 📝 License <a name="license"></a>
This project is [MIT](https://github.com/MarwanDev/Awesome-Books/blob/js-classes/LICENSE) licensed.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
| A book collection webpage that is used for adding and removing books in a list. Built using HTML, CSS and JavaScript | css,html,javascript | 2023-03-20T07:41:01Z | 2023-03-27T14:09:08Z | null | 2 | 5 | 51 | 0 | 0 | 4 | null | MIT | JavaScript |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.