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 |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
UmangDalvadi/JavaScript | master | null | null | html5,javascript,javascript-game,javascript-library | 2023-03-05T17:51:22Z | 2023-12-22T16:05:21Z | null | 1 | 0 | 27 | 0 | 0 | 2 | null | null | JavaScript |
soheee-bae/Gatsby-Image-Blog-Starter | main | ## :eyes: Demo
https://gatsby-image-blog-starter.netlify.app/
<br />
Light Mode :
<div>
<img src="./assets/readMe/lightMode_1.png" width="250" />
<img src="./assets/readMe/lightMode_3.png" width="250" />
<img src="./assets/readMe/lightMode_4.png" width="250" />
</div>
<br />
Dark Mode :
<div>
<img src="./assets/readMe/darkMode_2.png" width="250"/>
<img src="./assets/readMe/darkMode_1.png" width="250" />
<img src="./assets/readMe/darkMode_3.png" width="250" />
</div>
<br/>
## :fire: Quick Start
### 1. Create a Gatsby site
Use the Gatsby CLI ([install instructions](https://www.gatsbyjs.com/docs/tutorial/part-0/#gatsby-cli)) to create a new site, specifying the gatsby-clean-blog starter.
```
npx gatsby new gatsby-image-blog-starter https://github.com/soheee-bae/Gatsby-Image-Blog-Starter
```
> if you are not using `npx`, following [Gatsby Getting Started](https://www.gatsbyjs.com/docs/quick-start/)
```
npm install -g gatsby-cli
gatsby new gatsby-image-blog-starter https://github.com/soheee-bae/Gatsby-Image-Blog-Starter
```
### 2. Start developing
Navigate into your new site's directory and start it up.
```
cd gatsby-image-blog-starter/
gatsby develop
```
### 3. Open the source code and start editing!
Your site is now running at `http://localhost:8000`!
Note: You'll also see a second link: `http://localhost:8000/___graphql`. This is a tool you can use to experiment with querying your data. Learn more about using this tool in the [Gatsby Tutorial](https://www.gatsbyjs.com/docs/tutorial/part-4/#use-graphiql-to-explore-the-data-layer-and-write-graphql-queries).
### 4. Add your content
You can write contents to blog in `/content` directory.
As you add a new directory, it will be listed as new category in the navbar!
### 5. Fix meta data
You can fix meta data in `/gatsby-metaconfig.js` file.
## :yellow_heart: Customize
### :computer: Gatsby config
```
root
├── gatsby-config.js
├── gatsby-metaconfig.js
└── gatsby-node.js
```
### :file_folder: Folder structure
```
src
├── components // components with styling
├── constants // collections of string global variables
├── layout // layout for home and post
├── pages // 404 page, about page, home page
├── hooks
├── styles
├── utils
└── templates
└── blog-post.js // blog template
```
### :art: Style
You can customize color, font, breakpoints and height / width of layout in `src/styles` directory.
```
src/styles
├── _breakpoints.scss
├── _colors.scss
├── _mixins.scss
├── _size.scss
└── _typography.scss
```
### :mag: Tip (Things you can customize!)
- Profile image : replace file in `src/components/bio/index.js`.
- Pagination : set sibling count (of the current page) and page size (number of posts per page) in `src/constants/page.js`.
- Resize layout : You can resize layout (e.g. `height of footer`) in `src/styles/_size.scss`.
- Change color : All colors that have been used in this blog are in `src/styles/_color.scss`. You can simply change hex code color from `src/styles/_color.scss`!
- Post thumbnail : You can display or hide (`title, subtitle, date, content`) by setting the option from `src/constants/contentItem.js`!
| ✏️ Gatsby starter for personal blog II | javascript,react,css,graphql,html,gatsby | 2023-03-05T23:08:53Z | 2024-03-10T18:59:31Z | null | 2 | 0 | 150 | 0 | 0 | 2 | null | 0BSD | JavaScript |
karinapatel02/MarketPlace-Laravel | main | # MarketPlace-laravel
This is a full stack laravel web application that enables users to communicate through a blog and conduct online buying and selling of products.
Created 4 role-based profiles (Student, Business Owner, School Admin, and Super Admin) with specific access control.
## Install Laravel here
https://laravel.com/docs/4.2
## Download php here
### For Mac OS
php: https://www.ergonis.com/products/tips/install-php-on-macos.php
### For Windows
php: https://windows.php.net/download/
### If database hosted on cloud.
Needs to give access to host(eg. wireless% or whatever)
To Run application in local:
Install composer globally
cd filename
composer install
npm install
composer require php-open-source-saver/jwt-auth
php artisan jwt:secret
This will update our .env file with a jwt secret.
npm run dev
php artisan serve
remember to check ports
#### You need to add your database credentials as well as Mail credentials, and hosted link for the blog.
#### If you get 500 | Server Error you can try this
composer install
mv .env.example .env
php artisan cache:clear
composer dump-autoload
php artisan key:generate
##### Other Contributors to the project
rachanamaria, Divya6696
| Market Place laravel application where you can buy and sell products just like OLX | react,reactjs,cloud-database,css,javascript,jwt-auth,jwt-authentication,laravel,laravel-framework,multiple-dashboard | 2023-03-05T07:06:02Z | 2023-03-07T20:48:39Z | null | 1 | 0 | 14 | 0 | 2 | 2 | null | MIT | JavaScript |
see7e/programming-studies | obsidian | ---
title: Studies - Root
tags: studies, programação
use: Documentation
languages: NULL
dependences: NULL
banner: "![[proggramming_banner.jpg]]"
banner_y: 0.5
banner_lock: true
---
> [!INFO]
> The links are built for the obsidian branch, i was working in main but now i'll split correctly and after that update all the inter document links over the main branch
---
> This is a list of interesting documents gathered during development studies
# The Big Picture 🌌
This repo is divided in two branches, [main](https://github.com/see7e/programming-studies) has common links and [obsidian](https://github.com/see7e/programming-studies/tree/obsidian) links follow a Zettelkasten adapted model along with Obsidian to map the network of documents. If you want to set up in you computer, [click here](obisidian_init.md).
<details>
<summary>If you want to know the history, click here.</summary>
<p>
I've started using Obsidian and found very userfull to see how my brain works, and all its connections. Sometime after stumbled with the Zettelkasten method, it fits right into the philosophy of the program.</p>
<p>
But the problem is that all my information was divided in a big folder structure, so I took my time and started thinking about how to conciliate both methods, PARA and Zettel.
</p>
<p>
The links, the special <code>[[]]</code> Obsidian type and the common <code>[](./path/to/file)</code>. The first one don't work in GitHub, and the second one if is a web url Obsidian won't link the way we expect. So what I will do/did is put altogether in one folder, and set <code>.gitignore</code> for exclude the independent sub-folders which are individual repositories, and with that Git won't create a mess during the commits and pushes.
</p>
</details>
</br>
# Process 🧩
As any (very) systematic person and with a great chance of my mind to escape the focus state, that is to me a very challenging task, I need a flow to guide me through the process of learning.
```mermaid
flowchart TD
A(Topic \n Question \n fa:fa-question) -->|Inputs| B
B[Catch] --> C{Screening \n fa:fa-filter}
C -->|blurting \n method| D[Synthesize]
C -->|meshing \n information| D[Synthesize]
D --> E[Store]
E -->|Review| D
E -.->|Expand| A
```
When a question or topic of interest shows up, they're added in a list, during the *Catch* process. This is just a big queue of elements that will be analysed (*Screening*) later. When this time commes a element (or group of elements), will be selected, to be studied this can be divided into two groups depending on the available time to be spent:
- Using the Blurting method: The element will be studied, and a draft will be created in a sketchbook using only the recalled information.
- Using the directly information of the gathered articles creating a mesh of information, and a draft will be created.
With the draft created, the information will be translated to a document located in this vault, and the information will be stored in a way that can be easily retrieved. Here the process can run in a loop, until the document has a good quality, there's a possibility of the document receive a `#toreview` tag, and the review process will be triggered later.
Other possibility is the *Expand* process, where the previous steps may revialed and unlisted topic, and the process will start again.
## [List of Documents](DIRECTORY.md) 📜
> [!QUOTE]
> If I have seen further, it is by standing on the shoulders of giants.
> *Isaac Newton*
## [A Fresh start](./Docs/fresh_start.md) 🛣️
Sometimes in the rush to resolve the problems that we face, the learn only to fill the gap that is presented by the obstacle. So I'll try to visit the core/basic concepts of CS, using some guidelines.
## Progress 🏗️
This graph reflects the themes that I'm studying, and the progress of each one. The tree divisions will follow the three different contexts (work and personal).
> [!NOTE]
> The priorities are changing quickly, and in the moment i cannot follow the original plan, so i'll just put a list of the topics that i'm studying.
> - Backend (webserver, database, authentication)
> - Django [work]
> - Go [personal]
> - Homelab (networking, security, services) [personal]
> - Teorical topics (Fresh start roadmap) [personal] *is currently paused*
> Here's the [archive](./src/progress_archive.md) of Gannt charts.
## First time with Markdown? 📑
> Enter [here](first-time.md)
## Some useful links [🔗](links.md)
## Readings 📚
- Modern Operating Systems - Andrew S. Tanenbaum, Herbert Bos
- Statistical Learning - Trevor Hastie, Robert Tibshirani
- Design Patterns: Elements of Reusable Object-Oriented Software - Erich Gamma, Richard Helm, Ralph Johnson, John Vlissides
- Compilers - Alfred V. Aho, Monica S. Lam, Ravi Sethi, Jeffrey D. Ullman
- Clean Code - Robert C. Martin
- Refactoring - Martin Fowler, Kent Beck, John Brant, William Opdyke, Don Roberts
- Pragmatic Programmer - From Journeyman to Master - Andrew Hunt, David Thomas
- Make it stick - The Science of Successful Learning - Peter Brown, Henry L. Roediger III, Mark A. McDaniel
- Computer Networking - Andrew S. Tanenbaum, David J. Wetherall
--- | List of interesting documents gathered during development studies | backend,c,frontend,learning,study,study-notes,programing-studies,python,css,html | 2023-02-25T12:57:26Z | 2024-03-26T08:11:53Z | null | 1 | 0 | 54 | 0 | 1 | 2 | null | MIT | Python |
stdlib-js/random-strided-invgamma | main | <!--
@license Apache-2.0
Copyright (c) 2023 The Stdlib Authors.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<details>
<summary>
About stdlib...
</summary>
<p>We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.</p>
<p>The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.</p>
<p>When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.</p>
<p>To join us in bringing numerical computing to the web, get started by checking us out on <a href="https://github.com/stdlib-js/stdlib">GitHub</a>, and please consider <a href="https://opencollective.com/stdlib">financially supporting stdlib</a>. We greatly appreciate your continued support!</p>
</details>
# Inverse Gamma Random Numbers
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] <!-- [![dependencies][dependencies-image]][dependencies-url] -->
> Fill a strided array with pseudorandom numbers drawn from an [inverse gamma][@stdlib/random/base/invgamma] distribution.
<section class="installation">
## Installation
```bash
npm install @stdlib/random-strided-invgamma
```
Alternatively,
- To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]).
- If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).
- For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]).
The [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships.
To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.
</section>
<section class="usage">
## Usage
```javascript
var invgamma = require( '@stdlib/random-strided-invgamma' );
```
#### invgamma( N, alpha, sa, beta, sb, out, so\[, options] )
Fills a strided array with pseudorandom numbers drawn from an [inverse gamma][@stdlib/random/base/invgamma] distribution.
```javascript
var Float64Array = require( '@stdlib/array-float64' );
// Create an array:
var out = new Float64Array( 10 );
// Fill the array with pseudorandom numbers:
invgamma( out.length, [ 2.0 ], 0, [ 5.0 ], 0, out, 1 );
```
The function has the following parameters:
- **N**: number of indexed elements.
- **alpha**: shape parameter.
- **sa**: index increment for `alpha`.
- **beta**: scale parameter.
- **sb**: index increment for `beta`.
- **out**: output array.
- **so**: index increment for `out`.
The `N` and stride parameters determine which strided array elements are accessed at runtime. For example, to access every other value in `out`,
```javascript
var out = [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ];
invgamma( 3, [ 2.0 ], 0, [ 5.0 ], 0, out, 2 );
```
Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views.
<!-- eslint-disable stdlib/capitalized-comments -->
```javascript
var Float64Array = require( '@stdlib/array-float64' );
// Initial arrays...
var alpha0 = new Float64Array( [ 0.0, 0.0, 0.0, 2.0, 2.0, 2.0 ] );
var beta0 = new Float64Array( [ 5.0, 5.0, 5.0, 5.0, 5.0, 5.0 ] );
// Create offset views...
var alpha1 = new Float64Array( alpha0.buffer, alpha0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
var beta1 = new Float64Array( beta0.buffer, beta0.BYTES_PER_ELEMENT*3 ); // start at 4th element
// Create an output array:
var out = new Float64Array( 3 );
// Fill the output array:
invgamma( out.length, alpha1, -2, beta1, 1, out, 1 );
```
The function accepts the following `options`:
- **prng**: pseudorandom number generator for generating uniformly distributed pseudorandom numbers on the interval `[0,1)`. If provided, the function **ignores** both the `state` and `seed` options. In order to seed the underlying pseudorandom number generator, one must seed the provided `prng` (assuming the provided `prng` is seedable).
- **seed**: pseudorandom number generator seed.
- **state**: a [`Uint32Array`][@stdlib/array/uint32] containing pseudorandom number generator state. If provided, the function ignores the `seed` option.
- **copy**: `boolean` indicating whether to copy a provided pseudorandom number generator state. Setting this option to `false` allows sharing state between two or more pseudorandom number generators. Setting this option to `true` ensures that an underlying generator has exclusive control over its internal state. Default: `true`.
To use a custom PRNG as the underlying source of uniformly distributed pseudorandom numbers, set the `prng` option.
```javascript
var Float64Array = require( '@stdlib/array-float64' );
var minstd = require( '@stdlib/random-base-minstd' );
var opts = {
'prng': minstd.normalized
};
var out = new Float64Array( 10 );
invgamma( out.length, [ 2.0 ], 0, [ 5.0 ], 0, out, 1, opts );
```
To seed the underlying pseudorandom number generator, set the `seed` option.
```javascript
var Float64Array = require( '@stdlib/array-float64' );
var opts = {
'seed': 12345
};
var out = new Float64Array( 10 );
invgamma( out.length, [ 2.0 ], 0, [ 5.0 ], 0, out, 1, opts );
```
#### invgamma.ndarray( N, alpha, sa, oa, beta, sb, ob, out, so, oo\[, options] )
Fills a strided array with pseudorandom numbers drawn from a [inverse gamma][@stdlib/random/base/invgamma] distribution using alternative indexing semantics.
```javascript
var Float64Array = require( '@stdlib/array-float64' );
// Create an array:
var out = new Float64Array( 10 );
// Fill the array with pseudorandom numbers:
invgamma.ndarray( out.length, [ 2.0 ], 0, 0, [ 5.0 ], 0, 0, out, 1, 0 );
```
The function has the following additional parameters:
- **oa**: starting index for `alpha`.
- **ob**: starting index for `beta`.
- **oo**: starting index for `out`.
While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying `buffer`, the offset parameters support indexing semantics based on starting indices. For example, to access every other value in `out` starting from the second value,
```javascript
var out = [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ];
invgamma.ndarray( 3, [ 2.0 ], 0, 0, [ 5.0 ], 0, 0, out, 2, 1 );
```
The function accepts the same `options` as documented above for `invgamma()`.
</section>
<!-- /.usage -->
<section class="notes">
## Notes
- If `N <= 0`, both functions leave the output array unchanged.
- Both functions support array-like objects having getter and setter accessors for array element access.
</section>
<!-- /.notes -->
<section class="examples">
## Examples
<!-- eslint no-undef: "error" -->
```javascript
var zeros = require( '@stdlib/array-zeros' );
var zeroTo = require( '@stdlib/array-base-zero-to' );
var logEach = require( '@stdlib/console-log-each' );
var invgamma = require( '@stdlib/random-strided-invgamma' );
// Specify a PRNG seed:
var opts = {
'seed': 1234
};
// Create an array:
var x1 = zeros( 10, 'float64' );
// Create a list of indices:
var idx = zeroTo( x1.length );
// Fill the array with pseudorandom numbers:
invgamma( x1.length, [ 2.0 ], 0, [ 5.0 ], 0, x1, 1, opts );
// Create a second array:
var x2 = zeros( 10, 'generic' );
// Fill the array with the same pseudorandom numbers:
invgamma( x2.length, [ 2.0 ], 0, [ 5.0 ], 0, x2, 1, opts );
// Print the array contents:
logEach( 'x1[%d] = %.2f; x2[%d] = %.2f', idx, x1, idx, x2 );
```
</section>
<!-- /.examples -->
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
<section class="related">
* * *
## See Also
- <span class="package-name">[`@stdlib/random-base/invgamma`][@stdlib/random/base/invgamma]</span><span class="delimiter">: </span><span class="description">inverse gamma distributed pseudorandom numbers.</span>
- <span class="package-name">[`@stdlib/random-array/invgamma`][@stdlib/random/array/invgamma]</span><span class="delimiter">: </span><span class="description">create an array containing pseudorandom numbers drawn from an inverse gamma distribution.</span>
</section>
<!-- /.related -->
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
<section class="main-repo" >
* * *
## Notice
This package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.
For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib].
#### Community
[![Chat][chat-image]][chat-url]
---
## License
See [LICENSE][stdlib-license].
## Copyright
Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors].
</section>
<!-- /.stdlib -->
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
<section class="links">
[npm-image]: http://img.shields.io/npm/v/@stdlib/random-strided-invgamma.svg
[npm-url]: https://npmjs.org/package/@stdlib/random-strided-invgamma
[test-image]: https://github.com/stdlib-js/random-strided-invgamma/actions/workflows/test.yml/badge.svg?branch=main
[test-url]: https://github.com/stdlib-js/random-strided-invgamma/actions/workflows/test.yml?query=branch:main
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/random-strided-invgamma/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/random-strided-invgamma?branch=main
<!--
[dependencies-image]: https://img.shields.io/david/stdlib-js/random-strided-invgamma.svg
[dependencies-url]: https://david-dm.org/stdlib-js/random-strided-invgamma/main
-->
[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
[stdlib]: https://github.com/stdlib-js/stdlib
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
[umd]: https://github.com/umdjs/umd
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
[deno-url]: https://github.com/stdlib-js/random-strided-invgamma/tree/deno
[deno-readme]: https://github.com/stdlib-js/random-strided-invgamma/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/random-strided-invgamma/tree/umd
[umd-readme]: https://github.com/stdlib-js/random-strided-invgamma/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/random-strided-invgamma/tree/esm
[esm-readme]: https://github.com/stdlib-js/random-strided-invgamma/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/random-strided-invgamma/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/random-strided-invgamma/main/LICENSE
[mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray
[@stdlib/random/base/invgamma]: https://github.com/stdlib-js/random-base-invgamma
[@stdlib/array/uint32]: https://github.com/stdlib-js/array-uint32
<!-- <related-links> -->
[@stdlib/random/array/invgamma]: https://github.com/stdlib-js/random-array-invgamma
<!-- </related-links> -->
</section>
<!-- /.links -->
| Fill a strided array with pseudorandom numbers drawn from an inverse gamma distribution. | continuous,generator,invgamma,javascript,math,mathematics,node,node-js,nodejs,prng | 2023-02-27T19:56:28Z | 2024-04-12T01:42:55Z | null | 5 | 0 | 14 | 0 | 0 | 2 | null | Apache-2.0 | JavaScript |
allohamora/config-manager | master | # Config-Manager
[](https://www.npmjs.com/package/@allohamora/config-manager)
This package contains managers and utils for creating configs in a type-safe and stylish way.
## Requirements
```json
{
"node": ">=18.14.0",
"npm": ">=9.3.1"
}
```
## Install
```bash
npm i @allohamora/config-manager
```
## Usage
```typescript
import { ConfigManager, EnvManager } from '@allohamora/config-manager';
const env = new EnvManager();
const config = new ConfigManager({
getConfig: () => ({
auth: {
email: env.pick('AUTH_EMAIL').default('example@example.com').value(), // string
password: env.get('AUTH_PASSWORD'), // string | undefined,
},
}),
});
config.getOrThrow('auth'); // { email: string, password?: string }
config.get('auth.email'); // string
config.get('auth.password'); // string | undefined
config.getOrThrow('auth.password'); // string or the validation error
```
| config manager | config,env,javascript,nodejs,typescript,config-manager | 2023-03-07T17:23:27Z | 2023-09-12T19:34:01Z | 2023-09-12T19:34:04Z | 1 | 17 | 121 | 0 | 0 | 2 | null | MIT | TypeScript |
shanukajain/Type-Battel | main |
# TypeBattle.com
TypeBattle is a multiplayer online browser-based typing game. In TypeBattle, players complete typing tests of various texts as fast as possible, competing against themselves or with other users online
## Features
- Authentication
- Authorization
- Responsive
- Cross platform
## Tech Stack
**Client:** HTML, CSS, JavaScript
**Server:** Node.js, Express.js, Socket.io
**Database:** MongoDB, Redis
## Run Locally
Clone the project
```bash
git clone https://github.com/faraz412/acceptable-straw-3421
```
Go to the project directory
```bash
cd acceptable-straw-3421
```
Install dependencies
```bash
npm install
```
Start the server
```bash
node index.js
```
## Environment Variables
To run this project, you will need to add the following environment variables to your .env file
`key`
`mongourl`
`PORT`
## API Reference
#### Welcome
```http
GET /api
```
#### User Register
```http
POST /api/user/register
```
#### User Login
```http
POST /api/user/login
```
#### Admin Register
```http
POST /api/admin/register
```
#### Admin Login
```http
POST /api/admin/login
```
#### All Content
```http
GET /api/content/
```
#### Add Content
```http
POST /api/content/addcontent
```
#### Update Content
```http
PATCH /api/content/update/:id
```
#### Delete Content
```http
DELETE /api/content/delete/:id
```
## Screenshots
## Demo
https://type-battle.onrender.com/
## Authors
- [@DanteHaxor](https://github.com/DanteHaxor)
- [@Abhinav068](https://github.com/Abhinav068)
- [@shanukajain](https://github.com/shanukajain)
- [@faraz412](https://github.com/faraz412)
- [@sarveshgupta1997](https://github.com/sarveshgupta1997)
| Type Battle is a multiplayer online browser-based typing game. In TypeBattle, players complete typing tests of various texts as fast as possible, competing against themselves or with other users online | css,expressjs,html,javascript,mongodb,nodejs,nodemailer,websocket | 2023-02-26T06:19:26Z | 2023-03-06T12:18:33Z | null | 4 | 1 | 118 | 0 | 1 | 2 | null | null | JavaScript |
lucaso-silva/weather-app--CTD | main | # Weather-app--CTD
<p align="center"> See in the <a href="https://lucaso-silva.github.io/weather-app--CTD/"> link </a></p>
## Overview
Weather app developed looking for improving my skills in JavaScript programming using asynchronous functions.
The page is integrated with the [OpenWeather API](https://openweathermap.org/api) which provides the weather information.
> Status: Concluded
- Deadline: 03.07.23 ✅
---
### Objectives
Users should be able to:
- View the optimal layout for the site depending on their device's screen size ✅
- Receive weather information about the searched city ✅
- Receive an error message when the input is submitted if:
- The input field is empty ✅
- The app doesn't find any information about the city informed ✅
## Built with
- Semantic HTML5 markup
- Mobile-first workflow
- CSS custom properties
- CSS-grid
- Flexbox
- JavaScript
## What I learned 💡
This project was really useful to provide and strengthen the necessary basis for how to get and use data provided by a third API.
Data about temperature and weather conditions were provided by [OpenWeather API](https://openweathermap.org/api), and the country's flag image was provided by [Country Flags API](https://flagsapi.com/).
Different from my previous project using API, this time, if the user put in an invalid city, what impossibility the request successful, a message related to error 404 will be shown.
I also set a "Searching" message to be shown while the request is processing.
```JavaScript
const showWeatherInfo = async (city) => {
const loadingMsg = document.querySelector(".searching-msg");
loadingMsg.classList.remove("hide");
title.classList.add("hide");
mainCard.classList.add("hide");
moreInfo.classList.add("hide");
errorMsg.classList.add("hide");
const data = await getWeatherInfo(city);
if (data.cod === "404") {
errorMsg.classList.remove("hide");
loadingMsg.classList.add("hide");
title.classList.add("hide");
mainCard.classList.add("hide");
moreInfo.classList.add("hide");
}
```
During the development of this page, I could work with CSS Grid Layout, and improve my knowledge about display grid properties: `grid-template-rows`, `grid-template-columns`, `grid-template-areas`, `grid-area`.
```CSS
.header-mobile--open {
display: grid;
grid-template-columns: auto auto;
grid-template-rows: auto auto;
grid-template-areas:
"logo search-icon"
"input input";
row-gap: .75em;
width: 100%;
box-sizing: border-box;
}
.logo-mobile--open {
grid-area: logo;
}
```
I learned to use the selector `::before`, and so deal with background properties without interfering with the properties of main elements.
```CSS
.title::before {
content: "";
position: absolute;
inset: 0;
background: var(--bg-color);
background-size: cover;
background-position: center;
border-radius: 10px;
z-index: -1;
opacity: .5;
}
```
### 🛠️ Continued development
<p>The next steps will be focused on coding refactoring.</p>
---
### Useful resources
- [CSS-Tricks Guides](https://css-tricks.com/guides/) - Useful guides to learn and consult about CSS custom properties.
- [Como aplicar opacidade em background-image sem afetar textos](https://dev.to/sucodelarangela/como-aplicar-opacidade-em-background-image-sem-afetar-textos-31fj) - This is an amazing and easy-understanding article that helped me to set background image opacity correctly without interfering with other elements' properties.
| Weather app developed integrated with a weather API | api,grid-layout,javascript,weather,mobile-first | 2023-03-01T19:43:21Z | 2023-03-08T19:03:54Z | null | 1 | 0 | 20 | 0 | 0 | 2 | null | null | CSS |
MiZTERARM/Misc | main | null | null | css,html,javascript | 2023-03-01T08:38:04Z | 2023-03-01T08:39:05Z | null | 1 | 0 | 1 | 0 | 0 | 2 | null | null | CSS |
MiZTERARM/Games | main | null | null | css,html,javascript,game | 2023-03-01T08:08:12Z | 2023-03-01T08:27:11Z | null | 1 | 0 | 3 | 0 | 0 | 2 | null | null | JavaScript |
4lbatr0s/express-boilerplate | master | Express Boilerplate is a customizable and easy-to-use starter kit for building Node.js web applications with the Express.js framework. It comes pre-configured with essential tools and packages, such as CORS, helmet, and Winston, to help you build robust and secure applications. It also includes a folder structure with pre-defined directories for controllers, middleware, models, and more, to help you organize your codebase and improve maintainability.
## Getting Started
To get started with Express Boilerplate, simply clone the repository and install the dependencies:
```
git clone https://github.com/yourusername/express-boilerplate.git
cd express-boilerplate
npm install
```
You can then start the development server using:
```
npm start
```
This will start the server and restart it automatically whenever you make changes to the code.
## Folder Structure
The folder structure of the project is designed to keep your code organized and maintainable. Here's a brief overview of each folder:
- `api-routes`: Contains the API routes of your application.
- `config`: Contains configuration files for your application.
- `controllers`: Contains the controllers of your application.
- `errors`: Contains custom error classes for your application.
- `loaders`: Contains the code for loading the application.
- `logs`: Contains the log files of your application.
- `middleware`: Contains the middleware functions for your application.
- `models`: Contains the database models of your application.
- `scripts`: Contains any scripts that you need to run for your application.
- `uploads`: Contains uploaded files.
- `services`: Contains the business logic of your application.
- `validations`: Contains the validation schemas for your application.
## Environment Variables
The application uses the `dotenv` package to load environment variables from a `.env` file. An example `.env` file is included in the `envexample.txt` file. You should create your own `.env` file and update the values as per your requirements.
## Contributing
Contributions are always welcome! If you have any suggestions or issues, please feel free to create an issue or pull request.
## License
This project is licensed under the MIT License. See the LICENSE file for details. | A simple boilerplate for express.js web applications. | boilerplate,boilerplate-application,boilerplate-template,express,express-js,expressjs,javascript,nodejs,nodejs-api,nodejs-server | 2023-03-01T14:06:44Z | 2023-03-01T18:21:40Z | null | 1 | 1 | 9 | 0 | 0 | 2 | null | MIT | JavaScript |
fatihbalsoy/commandcraft | main | 
CommandCraft was a popular mod that unlocked the full potential of Minecraft Pocket Edition on Android and iOS by allowing players to control their worlds through commands. For example, `/time` would set the time of the day and `/give` would give the player a specified item. Most of the commands were mere replicas of the PC counterpart of the game. The mod also included extra commands like `/disguise`, which let players disguise into animals and monsters to troll their friends. The development of the mod was discontinued on August 2016, exactly 2 years after its inception, since Mojang / Microsoft finally implemented commands into the game and the modded client, BlockLauncher, never caught up with the latest versions of the game.
## Installation
BlockLauncher (formerly known as MCPELauncher) is an application made for Android devices which allows you to install Minecraft mods. CommandCraft depends on the APIs exposed by this launcher. The mod is no longer possible to run on the latest versions of the game. You'll need an old copy of Minecraft that is compatible with the latest version of BlockLauncher on Github.
~~BlockLauncher [Download for Free](https://play.google.com/store/apps/details?id=net.zhuoweizhang.mcpelauncher)~~
~~BlockLauncher Pro [Pay for more features](https://play.google.com/store/apps/details?id=net.zhuoweizhang.mcpelauncher.pro)~~
BlockLauncher [Source code on Github](https://github.com/zhuowei/MCPELauncher)
1. Open BlockLauncher and tap the wrench on the top of the screen and select “Manage ModPE Scripts”.
3. Select “Import”.
4. Select "Web Address"
5. Paste the following [link](https://raw.githubusercontent.com/fatihbalsoy/commandcraft-mod/master/CmdCraft.js) and you're done.
## Commands ##
To start using the mod, simply enter any of the following commands into the chat. You can always list these commands in-game by typing `/help`.
- /about – displays a short message about the mod
- /biome – tells you which biome you are in
- /block [data/destroy] – destroys or shows the information about the block you are pointing at
- /clear – clears the inventory
- /coords – shows your current in-game coordinates
- /d {entity} - disguise/morph into a mob
- /disguise {entity} - disguise/morph into a mob
- /distance {x} {y} {z} - tells you the distance to a specified coordinate in meters (blocks)
- /dropitem {x} {y} {z} {item} {amount} [damage] – drops an item at the specified coordinates
- /effect {effect} [seconds] [amplifier] [hideParticles] - gain a potion effect
- /entity - display entity data
- /explode {x} {y} {z} {radius} – creates an explosion at the coordinates of your choice
- /explore here {radius}
- /fly [on | off] – turn fly on/off
- /fov {number} – sets your field of view
- /gamemode [0 | 1 | 2] – switch between survival, creative, and adventure mode
- /gamespeed {ticks} – decrease or increase game speed (slow motion or super fast)
- /give {item} {amount} [damage] – give yourself something nice
- /heal – instant healing
- /health [set | add] {hearts} – set your health to a specific amount or add hearts to your current health
- /help [page] – list commands offered by the mod
- /ignite {seconds} – put yourself on fire in x seconds
- /ip – check ip, only available on local servers
- /item [data | remove] – removes or shows information about the item you are currently holding
- /kill – sets your health to 0 (ie. death)
- /me {about you} – broadcast what you are doing to the server
- /name – see what your name is
- /playsound {sound} {volume} {pitch} – plays a sound of your liking
- /print {message} – show a message in the chat
- /spawnpoint – sets your spawnpoint to your current location
- /say {message} – lets you say something in the chat with your name as the one who said it
- /stop – leave the game
- /summon {id} {x} {y} {z} [skin] – summon a mob
- /time [set | add] {ticks} – set the time of the day: day, midday, night, midnight
- /title {title} - display a large text on the screen
- /tp {x} {y} {z} – teleports you to the coordinates you choose
- /update - check for updates
- /version – shows current version of the game and the mod
- /weather [clear | rain | storm | lightning] - change the weather
- /world – shows the current world name
- /xp [add | set] {number} - add or set the number of experience levels you have
## License
CommandCraft is available under the AGPL license. See the LICENSE file for more info.
## Disclaimers
Minecraft is a trademark of Mojang AB and Microsoft Corporation. The author of this mod is not affiliated with or endorsed by Mojang or Microsoft.
The CommandCraft mod for Minecraft Pocket Edition is provided as-is and without warranty of any kind. The author of this mod is not responsible for any damages, data loss, or other issues that may occur as a result of using this mod. This includes but is not limited to bugs, glitches, crashes, or any other unexpected behavior that may affect your Minecraft world. The user assumes full responsibility for any risks associated with the use of this mod, including any consequences (ie. bans) that may arise from using the mod's commands in servers. Please use at your own risk.
| Discontinued Minecraft PE mod that implements commands into the game. | blocklauncher,commands,javascript,mcpe,minecraft,minecraft-mod,mod,modpe | 2023-03-06T16:26:03Z | 2023-03-16T16:35:07Z | null | 1 | 0 | 3 | 0 | 0 | 2 | null | AGPL-3.0 | JavaScript |
jonycmtt/rotate-images-gellary | main | <div align="center">
<br />
<br />
<h2 align="center">Rotate Images Gellary</h2>
<a href=""><strong>➥ Live Demo</strong></a>
</div>
<br />
### Demo Screeshots
<!--  -->
## <img alt="gif" src="https://github.com/jonycmtt/jonycmtt/blob/main/wifi-gol.gif?raw=true" width="50" height="50" /> Connect with Me
[](https://facebook.com/jonycmt) [](https://instagram.com/jonycmt) [](https://linkedin.com/in/salman-rahaman) [](https://medium.com/@jonyislamcmt) [](https://youtube.com/@jonycmt)
| Rotate Images Gellary | css3,html,javascript | 2023-03-05T09:27:12Z | 2023-03-05T09:39:51Z | null | 1 | 0 | 5 | 0 | 0 | 2 | null | null | HTML |
patrykkawiak/Forest | main | null | Training website, created for sum my knowledge | css3,gulp,html5,javascript,sass,training-website,mobile-friendly | 2023-03-07T17:49:52Z | 2023-03-08T19:03:17Z | null | 2 | 0 | 2 | 0 | 1 | 2 | null | null | SCSS |
V1niciusR/Web-III | main | null | Aulas de programação: JS, Python... | banco-de-dados,estudos-javascript,javascript,python,cadastro | 2023-03-06T18:48:27Z | 2023-09-23T21:30:02Z | null | 1 | 0 | 76 | 0 | 0 | 2 | null | null | JavaScript |
FernandoBrino/maos_entrelacadas | main | # Mãos Entrelaçadas REST API
This is a RESTful API developed using [NestJS](https://nestjs.com), aiming help the NGO "Mãos Entrelaçadas";
## Description
The Mãos Entrelaçadas REST API is a final paper to Systems analysis and development course, aiming help the NGO "Mãos Entrelaçadas" collect funds, implements technology stronger and reach more people with this same technology. It utilizes the NestJS framework, a progressive Node.js framework for building efficient, reliable and scalable server-side applications.
## Resources
The API offers the following resources:
- **Auth**: Login with user.
- **Announcements**: Management of announcements such as creating, listing, updating and deleting.
- **Events**: Managemet of events such as creating, listing, updating, deleting and sign an user to a specific event.
- **Genders**: Management of genders such as creating, listing and deleting.
- **User**: Management of users such as creating, listing, updating, deleting and get all events signed by the user.
## Installation
Follow the instructions below to set up and run the project on your local environment:
1. Clone this repository to your computer using the command:
```shell
git clone https://github.com/FernandoBrino/maos_entrelacadas.git
```
2. Access the project directory:
```shell
cd maos_entrelacadas
```
3. Install the project dependencies:
```shell
npm install
```
4. Run migrations:
```shell
npm run:migration
```
5. Start the development server:
```shell
npm start:dev
```
6. The server will be running locally at `http://localhost:3000`.
## Usage
After starting the server, you can use the API through Swagger, accessing `_baseURL/api`.
## Contribution
Contributions are welcome! If you find any issues, have suggestions, or want to add new features, feel free to open an issue or submit a pull request.
## License
This project is licensed under the ISC License.
---
Created by [Fernando Brino](https://github.com/FernandoBrino)
| An api developed to a "ONG" called "Mãos Entrelaçadas", to help them reach more people with their great work. | nestjs,class-transformer,class-validator,eslint,javascript,postgresql,typeorm,typescript | 2023-03-11T20:50:39Z | 2024-01-27T16:43:14Z | null | 4 | 0 | 132 | 0 | 1 | 2 | null | null | TypeScript |
viktoriussuwandi/Timestamp-Microservice | main | # Timestamp Microservice
#### Documentation can be found on : [https://github.com/viktoriussuwandi/Timestamp-Microservice](https://github.com/viktoriussuwandi/Timestamp-Microservice)
This is the result to complete the Timestamp Microservice project.
Instructions for building this project can be found at
[https://www.freecodecamp.org/learn/apis-and-microservices/apis-and-microservices-projects/timestamp-microservice](https://www.freecodecamp.org/learn/apis-and-microservices/apis-and-microservices-projects/timestamp-microservice)
### Some of additional features :
* Avoid non date format
* using Regex to check string date format
* using toUTCString() function for convertion
### Test Scenario :
- You should provide your own project, not the example URL.
- A request to` /api/:date?` with a valid date should return a JSON object with a `unix` key that is a `Unix timestamp` of the input date in milliseconds (as type Number)
- A request to `/api/:date?` with a valid date should return a JSON object with a `utc` key that is a string of the input date in the format: `Thu, 01 Jan 1970 00:00:00 GMT`
- A request to `/api/1451001600000` should return `{ unix: 1451001600000, utc: "Fri, 25 Dec 2015 00:00:00 GMT" }`
- Your project can handle dates that can be successfully parsed by `new Date(date_string)`
- If the input date string is invalid, the API returns an object having the structure `{ error : "Invalid Date" }`
- An empty date parameter should return the current time in a JSON object with a `unix` key
- An empty date parameter should return the current time in a JSON object with a `utc` key
### Test Result :
 | create Timestamp Microservice using node JS | freecodecamp-challenge,freecodecamp-project,javascript,microservices,nodejs,replit,solution-challenge | 2023-02-28T13:00:06Z | 2023-12-27T08:40:55Z | null | 1 | 0 | 21 | 0 | 3 | 2 | null | null | JavaScript |
valenfiumana/travelBee | main |
<div align="center" id="top">
<img src="https://travel-bee-images.s3.us-east-2.amazonaws.com/brand/travelBee-logo.PNG" width="900" alt="TravelBee Logo" />
</div>
<div align="center" id="top">
<img src="TravelBee.gif" width="900" alt="Profile Readme Generator" />
</div>
<div align="center">
<h1>Travel bee</h1>
<h3>The best booking website you will find!</h3>
</div>
<p align="center">
<a href="https://gitlab.ctd.academy/ctd/proyecto-integrador-1022/0222-ft-c1/grupo-08/-/pipelines" target="_blank">
<img src="https://img.shields.io/badge/build-passing-brightgreen" alt="Badge showing passed build"/>
</a>
<a href="https://gitlab.ctd.academy/ctd/proyecto-integrador-1022/0222-ft-c1/grupo-08" target="_blank">
<img src="https://img.shields.io/badge/last%20updated-today-brightgreen" alt="Badge showing when was updated"/>
</a>
<p align="center">
<a href="#dart-about">About</a>   |  
<a href="#link-demo">Demo</a>   |  
<a href="#rocket-tech-stach">Tech Stach</a>   |  
<a href="#fire-features">Features</a>   |  
<a href="#muscle-main-objectives">Objectives</a>   |  
<a href="#checkered_flag-requirements">Starting</a>   |  
<a href="#page_with_curl-documentation">Documentation</a>   |  
<a href="#busts_in_silhouette-authors">Authors</a>  
</p>
<br/>
## :dart: About ##
TravelBee is a **responsive booking website** where people can list or rent properties for short-term use. It can be anything from a cabin, an island, a boat or even a whole castle. Travelers can browse the site for the accommodation that’s best for them by applying a number of **filters** to narrow their searches. Filters include factors like available date, location and property type. After **creating an account and login in** the website, a place can be booked and the fun of going on vacation can begin.
We built this project as a part of our studies in Digital House for the Certified Tech Developer career. As we followed an **agile approach**, the process was divided into a series of sprints. Each sprint involved discovery, design, development, and testing - as well as a lot of teamwork.
Creating this project from scratch was a **challenging and wonderful experience** that changed us for the better. The learn-by-doing method allowed us to absorb and aquire not only technical but also soft skills.
:point_right: For more detailed information (in Spanish), checkout the project [Wiki](https://gitlab.ctd.academy/ctd/proyecto-integrador-1022/0222-ft-c1/grupo-08/-/wikis/About).
<br/>
<br/>
## :link: Demo
[Link a TravelBee](http://travel-bee.sytes.net)
<br/>
## :rocket: Tech Stach ##
<a href="https://reactjs.org">
<img width="50" title="ReactJs" alt="React Logo" src="https://ionicframework.com/docs/icons/logo-react-icon.png">
</a>    
<a href="https://www.java.com/">
<img width="50" title="Java" alt="Java Logo" src="https://p.kindpng.com/picc/s/198-1984828_java-icon-transparent-hd-png-download.png">
</a>    
<a href="https://www.javascript.com">
<img width="50" title="JavaScript" alt="Javascript Logo" src="https://upload.wikimedia.org/wikipedia/commons/thumb/9/99/Unofficial_JavaScript_logo_2.svg/1200px-Unofficial_JavaScript_logo_2.svg.png">
</a>    
<a href="https://spring.io/projects/spring-boot">
<img width="50" title="Spring Boot" alt="Spring Logo" src="https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcQegowPDKqrJzjjfqfoFznZnVrzdq9uNE6g71NrtBT6R5GBXHvmK4qtr9KF78wB4psgejg&usqp=CAU">
</a>    
<a href="https://aws.amazon.com/">
<img width="50" title="Amazon Web Services" alt="AWS Logo" src="https://ezerus.com.au/wp-content/uploads/2019/05/aws-logo-aws-new-logo-album-on-imgur-ideas.png">
</a>    
<a href="https://spring.io/projects/spring-security">
<img width="50" title="Spring Boot Security" alt="Spring Boot Security Logo" src="https://www.javacodegeeks.com/wp-content/uploads/2014/07/spring-security-project.png">
</a>    
<a href="https://www.mysql.com/">
<img width="50" title="MySQL" alt="MySQL Logo" src="https://www.pngkey.com/png/full/269-2693201_mysql-logo-circle-png.png">
</a>
<a href="https://developer.mozilla.org/en-US/docs/Web/CSS">
<img width="50" title="CSS" alt="CSS Logo" src="https://www.pngitem.com/pimgs/m/198-1985012_transparent-css3-logo-png-css-logo-transparent-background.png">
</a>    
<a href="https://developer.mozilla.org/en-US/docs/Web/HTML">
<img width="50" title="HTML" alt="HTML Logo" src="https://cdn-icons-png.flaticon.com/512/732/732212.png">
</a>    
<a href="https://www.selenium.dev/">
<img width="50" title="Selenium" alt="Selenium Logo" src="https://upload.wikimedia.org/wikipedia/commons/d/d5/Selenium_Logo.png">
</a>    
<a href="https://www.postman.com/">
<img width="50" title="Postman" alt="Postman Logo" src="https://cdn.worldvectorlogo.com/logos/postman.svg">
</a>    
###
<details>
<summary>See more</summary>
###
* [momentjs](https://momentjs.com/)
* [nuka-carousel](https://github.com/FormidableLabs/nuka-carousel)
* [date-fns)](https://date-fns.org/docs/Getting-Started/)
* [react-loading-skeleton](https://github.com/dvtng/react-loading-skeleton#readme)
* [sweetalert2](https://sweetalert2.github.io/)
* [react-lines-ellipsis](https://www.npmjs.com/package/react-lines-ellipsis)
* [jwt-decode](https://github.com/auth0/jwt-decode#readme)
* [react-day-picker](https://react-day-picker.js.org/)
</details>
<br/>
## :fire: Features
- Responsive website
- Search bar with filters
- Lightbox gallery
- Interactive calendar
- Creation of an account
- Login in & JWT
- Booking an accomodation
- Sending confirmation emails
- Publishing new products
- Editing publications
<br/>
## :muscle: Main Objectives
#### :heavy_check_mark: Backend
- Create a CRUD Rest API with Spring Boot and Hibernate
- Document the API with Swagger
- Model UML and connect Java code to a MySQL database
- Implement register and login through Spring Boot Security
- Securing booking endpoint through JWT and roles assignment
#### :heavy_check_mark: Frontend
- Create a responsive web layout with React, HTML and CSS
- Manage interactions and events
- Connect to an API and handle response states
#### :heavy_check_mark: Database
- Model a database that satisfies the project's funcionalities with a DER diagram
- Create and implement database
#### :heavy_check_mark: Infraestructure
- Implement an EC2 instance for the backend
- Implement an S3 Bucket for the frontend and all images
- Deploy the app on AWS
- Connect to provided database
- Build an effective CI/CD pipeline
#### :heavy_check_mark: Testing
- Notificate errors
- Write test cases, smoke and regression tests
- Automate tests with JavaScript and Selenium
- Test web services with Postman
<br/>
## :zap: Project Database Structure ##
<div>
<img src="https://travel-bee-images.s3.us-east-2.amazonaws.com/brand/tablaDatos.png" width="600" alt="Database" />
</div>
<br/>
## :white_check_mark: Requirements ##
Before starting :checkered_flag:, you need to have [Git](https://git-scm.com), [Node](https://nodejs.org/en/), [VSCode](https://code.visualstudio.com/download), [IntelliJ](https://www.jetbrains.com/idea/download/#section=windows) and [MySQL](https://www.mysql.com/downloads/) installed.
Note that this is only if you want to edit the project, if not you can use the TravelBee app directly from this [link](http://travel-bee.sytes.net/).
## :checkered_flag: Starting ##
```bash
# Clone this project
$ git clone git@gitlab.ctd.academy:ctd/proyecto-integrador-1022/0222-ft-c1/grupo-08.git
# Access
$ cd grupo-08/
# Initialize the project
1. Open the 'backend' folder in IntelliJ.
2. In the application.properties file, modify the user and password with your MySQL data.
3. Run the API.
4. Open MySQL and run [(this script)](url) to load data into database.
Important: the admin users must be added from Postman or directly into the database.
# Install dependencies
1. Open the 'frontend' folder in VSCode and open a new terminal:
$ npm install
2. Run the project
$ npm run dev
# The server will initialize in the port indicated in the terminal
```
## :video_game: Scripts
- `run dev`: starts the application at `localhost:3000`
<br/>
## :page_with_curl: Documentation
##### API Reference
[Swagger](http://ec2-18-118-16-134.us-east-2.compute.amazonaws.com:8080/travel-bee/swagger-ui/index.html)
##### Testing final report
[Documentation](https://drive.google.com/file/d/19_vU_PJmj8MKLlULSF24-Q5h1r4q2sTd/view?usp=sharing)
<br/>
## :busts_in_silhouette: Authors
- **Fiumana**, Valentina [@valenfiumana](https://www.github.com/valenfiumana)
- **Urriza**, Gisela [@Gigi-U](https://www.github.com/Gigi-U)
- **Marienhoff**, Iván [@ivanM](https://github.com/ivanhoff)
- **Del Litto**, Segundo [@segudellito](https://www.github.com/segudl01) -
<br/>
Made with :heart:
 
<a href="#top">Back to top</a>
| This is a full-stack web application for finding and booking accommodations. The application is built using Java and React and tested with Postman and Selenium. The backend is built with Java and uses Spring Boot, Spring Data, and Hibernate to provide RESTful APIs for the frontend. | java,git,javascript,mysql,pipeline,postman,reactjs,selenium,spring-boot,spring-security | 2023-03-02T02:49:16Z | 2023-03-02T03:43:01Z | null | 1 | 0 | 9 | 0 | 2 | 2 | null | null | Rich Text Format |
danielochuba/AWESOME-BOOKS_ES6 | main | <a name="readme-top"></a>
<div align="center">
<h3><b>Awesome Book README</b></h3>
</div>
<!-- TABLE OF CONTENTS -->
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [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 Book] <a name="about-project"></a>
> Describe your project in 1 or 2 sentences.
**[Awesome Book]** is a microverse Project which allows users to ADD books by inputing the Book title and the Book author, and REMOVE books at will.
## 🛠 Built With <a name="built-with"></a>
### Tech Stack <a name="tech-stack"></a>
> Describe the tech stack and include only the relevant sections that apply to your project.
<details>
<summary>Client</summary>
<ul>
<li><a href="https://html.com/">HTML</a></li>
</ul>
<ul>
<li><a href="https://jsdocs.com/">JavaScript</a></li>
</ul>
</details>
<!-- Features -->
### Key Features <a name="key-features"></a>
> Describe between 1-3 key features of the application.
- **[Add Boks to Library]**
- **[Delete Books]**
- **[Local Storage]**
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 🚀 Live Demo <a name="live-demo"></a>
> Add a link to your deployed project.
- [Live Demo Link](https://danielochuba.github.io/AWESOME-BOOKS_ES6/)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- GETTING STARTED -->
## 💻 Getting Started <a name="getting-started"></a>
> Describe how a new developer could make use of your project.
### Prerequisites
In order to run this project you need to:
- Install Git
- Install NPM
- Have working browser
- Good internet connection
- Install a code editor like Visual Studio Code
- Install Live Server plugging in Visual Studio Code
### Setup
Clone this repository to your desired folder:
- Choose a directory
- Open a Terminal
- write: git clone https://github.com/ClintonYounge/Awesome-Books
- get into to directory "portfolio_mobile_mainpage"
- write: npm install
### Install
Install this project with linters:
- On your branch create .github/workflows/linters.yml
- Do not make any changes in config files
- Create .gitignore/ and instert node_modules/
- On the terminal run npm install --save-dev hint@7.x
- Copy .hintrc to the root directory of your project.
- Run npx hint .
- Run npx eslint .
- Fix linter errors.
### Usage
To run the project, execute the following command:
- Open the project by launching the Live Server plugging in visual studio code
### Run tests
To run tests, run the following command:
<!--
Example command:
```sh
bin/rails test test/models/article_test.rb
```
--->
<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.
👤 **Daniel Ochuba**
- GitHub: [@danielochuba](https://github.com/danielochuba)
- Twitter: [@ochuba_daniel](https://twitter.com/ochuba_daniel)
- LinkedIn: [@daniel_ochuba](www.linkedin.com/in/daniel-ochuba-614572238)
<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.
- [ ] **[Button Styles]**
- [ ] **[Table Display]**
- [ ] **[More Pages]**
<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 you can give me a star
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- ACKNOWLEDGEMENTS -->
## 🙏 Acknowledgments <a name="acknowledgements">I would like to thank Microverse for this opportunity to learn and W3Schools for the information shared in their site.</a>
## 🙏 Acknowledgments <a name="acknowledgements"></a>
## 📝 License <a name="license"></a>
This project is [MIT](./MIT.md) licensed.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<p align="right">(<a href="#readme-top">back to top</a>)</p>
| This is a Booklist Library that allows you add and remove books, it uses the Local storage to keep records of previously saved books for anytime you visit the page. This app also displays Added book items in the List section of the page. Have fun ☺ | css,html5,javascript | 2023-02-27T23:08:46Z | 2023-03-07T14:20:17Z | null | 1 | 1 | 9 | 3 | 0 | 2 | null | null | JavaScript |
AnhNguyenlost13/chuyendoidonvi | main | Được làm bởi [@AnhNguyenlost13](https://github.com/AnhNguyenlost13) và [@profcoder69420](https://github.com/profcoder69420) và Nguyễn Nguyên Huy không có github :( <br>
<h2>tại sao?</h2>
<h2>cách sử dụng</h2>
## các đơn vị chuyển đổi được
- [x] Độ dài
- [x] Cân nặng
- [x] Dữ liệu
- [x] Điện
- [x] Thời gian
- [x] Nhiệt độ
- [x] Vận tốc
- [x] Năng lượng
## các chức năng khác
- [x] tính cạnh huyền/cạnh góc vuông của một tam giác vuông
- [x] tính sin cos tan cot
- [x] tạo ra số chữ số PI theo yêu cầu
| trình chuyển đổi đơn vị :) | javascript | 2023-02-28T06:01:18Z | 2023-05-10T06:45:12Z | null | 2 | 5 | 129 | 0 | 0 | 2 | null | null | HTML |
BlckTitan/Octa | main | https://octabuild.netlify.app/
# Octa Crypto App
Octa cryptoApp was built to give information on the market performance of the different cryptocurrencies as well related news articles. This app utilizes chartJS to give a visual representation of statistical data to help influence purchase decisions. This project demonstrate my ability to use react, redux and RTK Query consume Api data. It also demonstrates my ability to use material UI and other skills listed above.
Users should be able to:
- See the ranking of each coin
- See coin market performance
- See related news for all cryptocurrencies
- See different coin exchanges and the performance of each coin in these exchanges
### Screenshot
### Links
- Solution URL: [https://octabuild.netlify.app/]
- Live Site URL: [https://octabuild.netlify.app/]
## My process
### Built with
- Semantic HTML5 markup
- CSS custom properties
- Flexbox
- CSS Grid
- Scss
- Mobile-first workflow
- [React](https://reactjs.org/) - JS library
- [Material-UI](https://mui.com/material-ui) - For styles
- [Material-icons](https://mui.com/material-ui/material-icons/) - For icons
- [Redux](https://reactjs.org/) - JS library
- [RapidApi](https://rapidapi.com) - For coin information
Author
Website - Ugorji Victor E
Twitter - @ugorjivee
GitHub - @BlckTitan | Octa cryptoApp was built to give information on the market performance of the different cryptocurrencies as well related news articles. This app utilizes chartJS to give a visual representation of statistical data to help influence purchase decisions. | css-flexbox,css-grid,css3,html5,chartjs,javascript,material-icons,material-ui,rapidapi,reactjs | 2023-03-01T11:58:18Z | 2023-05-17T09:45:20Z | null | 1 | 0 | 71 | 0 | 0 | 2 | null | null | SCSS |
debadityasingh8972/NFT-marketplace-next-app | master | # Sample Hardhat Project
This project demonstrates a basic Hardhat use case. It comes with a sample contract, a test for that contract, and a script that deploys that contract.
Try running some of the following tasks:
```shell
npx hardhat help
npx hardhat test
REPORT_GAS=true npx hardhat test
npx hardhat node
npx hardhat run scripts/deploy.js
```
| NFT Marketplace Web page with support for total 14 different themes, using React.js. For Smart Contract design I used Solidity. | css3,javascript,nextjs,reac,react,solidity | 2023-03-06T14:18:43Z | 2023-03-06T14:21:59Z | null | 1 | 0 | 1 | 0 | 0 | 2 | null | null | JavaScript |
santhoshparthiban2002/Time-Capsule | master | # **Time-Capsule**
<p class="center">
<img src="img/readme.png" alt="time capsule">
</p>
| Time Capsule is a web application allows users to create a personalized time capsule by adding personal information, messages, and media, and set a delivery date. The capsule will be locked until the delivery date arrives. Once the delivery date arrives, the user will receive a unique username and password to open the time capsule. | bootstrap5,css,django,html5,javascript,mail,postman,python,schdeduler,sqlite-database | 2023-03-03T13:35:34Z | 2023-04-18T02:26:41Z | null | 1 | 0 | 17 | 0 | 1 | 2 | null | null | JavaScript |
asifaminisonline/vet-clinic | dev | <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)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [👥 Authors](#authors)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
<!-- PROJECT DESCRIPTION -->
# 📖 [Vet Clinic] <a name="about-project"></a>
> Vet clinic is an educational Database project where I'll use a relational database to create the data structure for a vet clinic.
## 🛠 Built With <a name="built-with"></a>
### Tech Stack <a name="tech-stack"></a>
> Following technologies have been used in this project.
<details>
<summary>Database</summary>
<ul>
<li><a href="https://www.postgresql.org/">Postgres</a></li>
</ul>
</details>
<!-- Features -->
### Key Features <a name="key-features"></a>
> This is a Vet clinic educational project where I'll use a relational database to create the data structure for a vet clinic..
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- LIVE DEMO -->
## 🚀 Live Demo <a name="live-demo"></a>
still under production
- [Live Demo Link]
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- GETTING STARTED -->
## 💻 Getting Started <a name="getting-started"></a>
> This is how a new developer could make use this project.
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
- [ ] A PC or Mac.
- [ ] An active internet connection.
- [ ] Some knowledge of git and github.
### Setup
Clone this repository by using the command line : git clone https://github.com/asifaminisonline/vet-clinic.git
### Usage
- [ ] First you need to download this repo or clone this repo.
- [ ] Open this project in your local machine.
- [ ] Open Terminal in your machine.
- [ ] run npm install in your terninal to install necessary required dependencies for this project.
- [ ] Copy index.html file path and paste it in your browser url.
- [ ] now the project will be running.
<!-- AUTHORS -->
## 👥 Authors <a name="authors"></a>
> Mention all of the collaborators of this project.
👤 **asifaminisonline **
- GitHub: [@asifaminisonline ](https://github.com/asifaminisonline)
- Twitter: [@Asif Amin](https://twitter.com/AminAmi53306702)
- LinkedIn: [@Asif Amin](https://www.linkedin.com/in/asifaminisonline/)
👤 **Aman Worku **
- GitHub: [@Aman_on_GitHub](https://github.com/AmanWorku)
- Twitter: [@Aman_on_Twitter](https://twitter.com/Amexworku)
- LinkedIn: [@Aman_on_LinkedIn](https://www.linkedin.com/in/aman-worku-tsegaw/)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- FUTURE FEATURES -->
## 🔭 Future Features <a name="future-features"></a>
- **[More queries and schema files would be added.]**
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- CONTRIBUTING -->
## 🤝 Contributing <a name="contributing"></a>
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- SUPPORT -->
## ⭐️ Show your support <a name="support"></a>
If you're committed to making the world a better place, please support our project.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- ACKNOWLEDGEMENTS -->
## 🙏 Acknowledgments <a name="acknowledgements"></a>
- I would like to give credit to the following people who have inspired my codebase:
- [] The Whole Microverse Team - thank you so much for this great learning platform.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- LICENSE -->
## :memo: License <a name="license"></a>
This project is [MIT](https://github.com/asifaminisonline/vet-clinic/blob/animal-table/LICENSE) licensed.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
| This project is a movie app. In this project you can see the details of recent action movies, you can like the movie and you can add comments to a movie. This application calls an API to fetch data which is a movie Database API, created using pure Html5, Css3, ES6, and Webpack 5 | api-rest,css3,html5,javascript,webpack | 2023-03-01T08:52:04Z | 2023-03-09T08:06:08Z | null | 2 | 6 | 21 | 0 | 0 | 2 | null | MIT | PLpgSQL |
KhanZiaul/JS-news-portal-API | main | null | It is a news portal website with small and medium device responsiveness. You can see different categories news by " clicking " or " selecting " any category and also can see trending and today's pick news by clicking those buttons. To see more details of the current news click ( " -> " ) icon . | css-flex,css-grid,dasiyui,font-awesome,javascript,tailwindcss | 2023-03-01T09:30:10Z | 2023-03-02T10:56:45Z | null | 1 | 0 | 25 | 0 | 0 | 2 | null | null | JavaScript |
devancadman/MP1-Gobekli-Tepe-Website | main | # Göbekli Tepe
##### Code Institute / User-Centric Front-End Development
You can check the website here [Göbekli Tepe](https://devancadman.github.io/MP1-Gobekli-Tepe-Website/index.html)
The main website for Göbekli Tepe. This is my first project which has been designed to be responsive and accessible on a range of devices, making it easy to navigate for visitors. It allows visitors to find out all the information they may need about Göbekli Tepe.
___
## Table of Contents
- [**Introduction**](#Initial-Discusion)
- [Client Goals](#Client-goals)
- [User Goals](#First-Time-Visitor-Goals)
- [**Structure**](#Structure)
- [Common sections](#Common-sections)
- [Home page](#Home-page)
- [Gallery page](#Gallery-page)
- [Contact us Page](#Contact-us-Page)
- [**Future Implementations**](#Future-Implementations)
- [**Design**](#Design)
- [Colour Scheme](#ColourScheme)
- [Typography](#Typography)
- [Imagery](#Imagery)
- [Wireframes](#Wireframes)
- [**Technologies Used**](#technologies-used)
- [**Testing**](#testing)
- [**Deployment**](#deployment)
- [**Credits**](#credits)
## User Experience (UX)
### Introduction
Göbekli Tepe is a Neolithic sanctuary located in the Southeastern Anatolia Region of Turkey. It is considered to be one of the oldest and most important archaeological discoveries of the 21st century.
The website provides users with information about the site. It's targeted toward people who are looking for further information about the site.
Users can use the website the get information about it's history, discovery, symbolisms and tours or to get in touch for further information.
### Client Goals:
* To have an online presence.
* To display tour information on the site.
* To increase traffic to the physical site.
* Increase our social media presence via social media links.
### First Time Visitor Goals:
* I want to quickly and easily find out everything their is to know about the site.
* I want to easily find images of the site.
* I want to be able to access and download tour brochures for future use.
* I want to find out opening times and locations.
* I want to see the Sites Timeline.
### Returning and frequent Visitor Goals:
* As a returning or frequent visitor, I want to:
* Find out about more information (information is regularly updated).
* Look at new images.
* Contact for more information.
* See the Virtual Tour.
___
## Structure ##
#### The website is has five pages with a link to an external page (home page, about page, timeline page, gallery page, virtual tour (external) and contact page) which are all accessible from the navigation menu.
#### Common sections:
* Sticky Scroll Navigation bar consisting of the Göbekli Tepe logo on the left side linked to the home page and a navigation menu on the right side with links to Home page, about page, timeline page, gallery page, virtual tour (external) page and contact page. This is displayed when a user scrolls and sticks to the top of the page.
Initially their is a Custom Nav Button, which opens up a full page navigation screen, providing a responsive navigation for all devices.
All the links change colour on hover for good user experience.
| **Sticky Scroll NavBar** | **Custom Nav Button** |
| :----------------------------------------------------------: | :-------------------------------------------------------------------: |
|  |  |
| **Full Screen Navigation**
 |  |
* Hero section with an image of a popular Pillar from the site with contrasting colours to keep the text readable.
Each page displays the site Logo, with the page title below it, for easy user navigation. Except for the home page.
Below this, their is a call-to-action animated button to view more.
* **Animated View More Button**
* Footer is simple and easy to understand with social media links, menu links, contact links and a contact button. The links change colour from white to tan on hover for better user experience.
* In the Sub-footer it showcases the site's copyright information.
### Home Page
The home page consists of nine sections:
* Navigation button to easily access the navigation screen.
* Hero section with Göbekli Tepe's logo with a simple and clean design. And a call-to-action button to view more.
* A sticky Nav bar to easily and quickly access all the pages.
* Welcome section with brief intro and image of the site.
* Box Navigation for quick access to important page's.
* A Discovery section, detailing the site's discovery.
* Significance section, explaining the site's importance.
* An Architecture section, detailing the site's discovery.
* A Purpose section, with the site's possible purpose.
* FAQ section, showcasing the answers to common questions, assuages concerns, and overcomes objections.
* Footer section, consists of social media links, menu links, contact links and a contact button.
### About Page
The About page consists of Nine sections:
* Navigation button to easily access the navigation screen.
* Hero section with Göbekli Tepe's logo and page title with a simple and clean design. And a call-to-action button to view more.
* A sticky Nav bar to easily and quickly access all the pages.
* The Beginning section, explaining it's discovery, excavations, rediscovery & findings. With a Video for more info.
* The Most Impressive section, details the site enclosures.
* Pillars section, explains the pillars and illustrates their decoration
* 3D Model Video of Göbekli Tepe.
* Further-info section, provides info and links to books, videography & links for further information about Göbekli Tepe.
* Brochures section, lists link to Website & PDF Brochures for Tours.
* Footer section, consists of social media links, menu links, contact links and a contact button.
### Timeline Page
The Timeline page consists of three sections:
* Navigation button to easily access the navigation screen.
* Hero section with Göbekli Tepe's logo and page title with a simple and clean design. And a call-to-action button to view more.
* A sticky Nav bar to easily and quickly access all the pages.
* Timeline section, showing the site's timeline.
* Footer section, consists of social media links, menu links, contact links and a contact button.
### Gallery page
The Gallery page consists of three sections:
* Navigation button to easily access the navigation screen.
* Hero section with Göbekli Tepe's logo and page title with a simple and clean design. And a call-to-action button to view more.
* A sticky Nav bar to easily and quickly access all the pages.
* Gallery section, showing images of the site.
* Footer section, consists of social media links, menu links, contact links and a contact button.
### Virtual Tour Page
* This is an External Page, to a Virtual Tour of the Site.
### Contact us Page
The contact us page consists of four sections:
* Navigation button to easily access the navigation screen.
* Hero section with Göbekli Tepe's logo and page title with a simple and clean design. And a call-to-action button to view more.
* A sticky Nav bar to easily and quickly access all the pages.
* Hero image with "Contact us" message.
* Contact information with email, phone number and address, and a contact form so the user can send an email with a message.
* Footer section, consists of social media links, menu links, contact links and a contact button.
___
## Future Implementations.
* Add a full detailed Visit Page.
* Use Javascript to close an FAQ if another is already open.
* Add FancyBox for images.
* Use Javascript to implement a thank you page redirect.
* Change Image formats to WebP.
___
## Design
### Colour Scheme
For the colours I based them off the colours of the stone used at Göbekli Tepe, a type of Tan. I then chose a suitable dark complimentary colour - Dark Navy.
This then gave me two options of how I could implement these colours on the site. In the end I went with Option 2 as this felt more modern and looked better.
| **Colour Option 1** | **Colour Option 2** |
| :----------------------------------------------------------: | :-------------------------------------------------------------------: |
|  |  |
[ *all colors are set at `:root` level in CSS* ]
- `#161C21` (*Navy*)
- `#d6b68e` (*Tan*)
### Typography
I have tried to use old antique style font's, due to it being an ancient site. I found the Dalek font from doctor who, which really gave the logo an old style look to it. I then chose Inknut Antiqua as this is a more modern font for readability with an old style twist to keep in in keeping with the site.
My preference for fallback font is Arial & Serif.
The Dalek font is a custom font, which I got from dafont.
Inknut Antiqua is a google font.
* [Dalek](https://www.dafont.com/dalek.font) is used for the logo, headers and Welcome messages on the page.
* [Inknut Antiqua ](https://fonts.google.com/specimen/Inknut+Antiqua) is used for the most of the body text on the page.
| **Dalek Font** | **Inknut Antiqua Font** |
| :----------------------------------------------------------: | :-------------------------------------------------------------------: |
|  |  |
### Imagery
I have used different sources for images and to create the logo and favicon, all free to use or with owners consent.
Please see [Credits](#credits) section for more info.
### Symbols
Symbols were created using Illustrator and are based on the symbols found within Göbekli Tepe on its various pillars and other areas where symbols have been depicted in reliefs.
| **Icon 1** | **Icon 2** | **Icon 3** | **Icon 4** |
| :---------------------------: | :---------------------------: | :---------------------------: | :---------------------------: |
|  |  |  |  |
I used these on both the Gallery & Timeline pages.
#### Logo
When creating the logo I wanted to create a logo that would be easily associated with Göbekli Tepe. I used the Dalek font for this. I then used one of it's pillars to replace the "T" character from the text. I based the symbol off "Pillar 18" and re-created it within Illustrator.
I also used this symbol to create the site favicon.
| **Logo** | **Favicon** |
| :----------------------------------------------------------: | :-------------------------------------------------------------------: |
|  |  |
* To create the logo and Favicon I have used Adobe Illustrator:
[Adobe Illustrator](https://www.adobe.com/uk/products/illustrator.html) 
* For the hero image please see reference in credits, I then edited it within Photoshop:
[Adobe Photoshop](https://www.adobe.com/uk/products/photoshop.html) 
* For the Nav Button and View More button the symbols were created within Illustrator
| **Nav Button** | **View More Button** |
| :----------------------------------------------------------: | :-------------------------------------------------------------------: |
|  |  |
### Wireframes
I have usedAdobe XD software to create my wireframes, for desktop and mobile.
The finished product came very close to the initial concepts.
| Desktop Home | Desktop Timeline |
| --------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|  |  |
| Mobile Home | Mobile Timeline |
| --------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|  | 
* [Desktop home page wireframe](/documentation/wireframes-mockups/desktop/home.png)
* [Desktop about page wireframe](/documentation/wireframes-mockups/desktop/about.png)
* [Desktop timeline page wireframe](/documentation/wireframes-mockups/desktop/timeline.png)
* [Desktop gallery page wireframe](/documentation/wireframes-mockups/desktop/gallery.png)
* [Desktop contact page wireframe](/documentation/wireframes-mockups/desktop/contact.png)
* [Mobile home page wireframe](/documentation/wireframes-mockups/mobile/HOME.png)
* [Mobile about page wireframe](/documentation/wireframes-mockups/mobile/ABOUT.png)
* [Mobile timeline page wireframe](/documentation/wireframes-mockups/mobile/TIMELINE.png)
* [Mobile gallery page wireframe](/documentation/wireframes-mockups/mobile/GALLERY.png)
* [Mobile contact page wireframe](/documentation/wireframes-mockups/mobile/CONTACT.png)
___
## Technologies Used
*  [HTML5](https://developer.mozilla.org/en-US/docs/Glossary/HTML5) - building, structuring and presenting project
*  [CSS3](https://developer.mozilla.org/en-US/docs/Web/CSS) - website styling
*  [JavaScript](https://developer.mozilla.org/en-US/docs/Web/JavaScript) - building, structuring and presenting project
*  [Adobe Illustrator](https://www.adobe.com/uk/products/illustrator.html) - To create site icons.
*  [Adobe Photoshop](https://www.adobe.com/uk/products/photoshop.html) - To edit photos.
*  [Adobe XD](https://www.adobe.com/products/xd/learn/get-started/what-is-adobe-xd-used-for.html) - To create Wireframes.
*  [VScode](https://code.visualstudio.com) - code editing
*  [GIT](https://git-scm.com/), [GitHub](https://github.com/) - tracking, storing, hosting project
*  [GitHub Desktop](https://desktop.github.com/) - for local development
*  [Google Fonts:](https://fonts.google.com/) - Google fonts were used to import the 'Inknut Antiqua' font into the style.css file which is used on all pages throughout the project.
* [Coolors](https://coolors.co/) - Coolors was used for choosing the website's colours palette.
* [Tiny PNG](https://tinypng.com/) - To compress images.
*  [Shields.io](https://shields.io/) - To add badges to the README
*  [Chrome DevTools](https://developer.chrome.com/docs/devtools) - - To troubleshoot and test features, solve issues with responsiveness and styling.
* [Am I Responsive?](http://ami.responsivedesign.is/) & [Responsinator](http://www.responsinator.com/) - To show the website image on a range of devices.
* [Embed Responsively](https://embedresponsively.com/ ) - To ensure videos are responsive.
* [BrowserStack](https://www.browserstack.com/guide/browser-compatibility-for-variable-fonts) - To check site responsiveness on live devices.
* [Polypane Browser](https://polypane.app/) - Responsive & Accessibility Testing and more!
* [ghostCSS](http://wernull.com/2013/04/debug-ghost-css-elements-causing-unwanted-scrolling/) - To check for layout issues.
* [Can I Use](https://caniuse.com/#home) - to check for CSS Browser comparability issues.
* [Deadlinkchecker](https://www.deadlinkchecker.com/) - To check site for Dead Links.
___
## Testing
See [TESTING.md](https://github.com/devancadman/MP1-Gobekli-Tepe-Website/blob/main/documentation/Testing.md) for an overview of website testing and debugging.
#### TEST MATRIX
I also created a [testing matrix](https://github.com/devancadman/MP1-Gobekli-Tepe-Website/blob/main/documentation/ucfd-user-testing.pdf) in Excel, but saved as `.pdf` to visualize here on GitHub. It outlines the various tests I made to ensure the site renders consistently across different platforms, and that each functionality behaves as intended.
___
## Deployment
The Live link is [Göbekli Tepe's](https://devancadman.github.io/MP1-Gobekli-Tepe-Website/index.html)
#### To deploy the project:
1. In the [GitHub repository](https://github.com/), navigate to the *Settings* tab.
2. Once in Settings, navigate to the *Pages* tab on the left hand side.
3. In the *Build and deployment* section under *Branch*, select the **master** branch and click *Save*.
4. Once the master branch has been selected, the page will be automatically refreshed and a display indicates the successful deployment and the link to the address.
#### To run the website on a local machine:
1. Go to the [MP1 Gobekli Tepe Website repo](https://github.com/devancadman/MP1-Gobekli-Tepe-Website)
2. Click on the green *Code* button and *Download ZIP*
3. Extract the ZIP file on your local machine
4. Run the *index.html* file in a browser
#### To clone the repo:
1. Go to the [MP1 Gobekli Tepe Website repo](https://github.com/devancadman/MP1-Gobekli-Tepe-Website)
2. Click the *Code* button to the right of the screen and copy the *HTTPs* link there
3. Open a GitBash terminal and navigate to the directory where you want to locate the clone
4. Type `git clone` and paste the copied *HTTPs* link, press the *Enter* key to begin the clone process
___
## Credits
### Code
All my code was written based on what I have learned from [CodeInstitute Full Stack Developer Course](https://codeinstitute.net/ie/full-stack-software-development-diploma/) and [W3schools](https://www.w3schools.com/) and other online resources.
* CSS Reset was added to the site from [Josh's Custom CSS Reset](https://www.joshwcomeau.com/css/custom-css-reset/).
* CSS [Grid](https://css-tricks.com/snippets/css/complete-guide-grid/) & [Flex](https://css-tricks.com/snippets/css/a-guide-to-flexbox/) was based on what I have learned from [CSS-Tricks](https://css-tricks.com/).
* Nav Burger/Bento Menu button was implemented and based on this [codepen](https://codepen.io/camille-cebu/pen/MWrGZWR)
### Image References/Attributes:
* Main header Image - Göbekli Tepe - The Stone Age Sanctuaries. New results of ongoing excavations with a special focus on sculptures and high reliefs - Scientific Figure on ResearchGate. Available from: https://www.researchgate.net/figure/Goebekli-Tepe-2006-pillar-18-in-enclosure-D-foto-Berthold-Steinhilber_fig3_270030960 [accessed 23 Feb, 2023]
* T-shaped Pillars - Human Palaeoecology in Southwest Asia During the Early Pre-Pottery Neolithic (c. 9700-8500 cal BC): the Plant Story - Scientific Figure on ResearchGate. Available from: https://www.researchgate.net/figure/T-shaped-pillars-from-Enclosure-D-at-Goebekli-Tepe-images-courtesy-of-the-late-Klaus_fig9_322508486 [accessed 23 Feb, 2023]
* Plan of Gobeliki tepe showing pillar loactions:
New Possible Astronomic Alignments at the Megalithic Site of Göbekli Tepe, Turkey - Scientific Figure on ResearchGate. Available from: https://www.researchgate.net/figure/Plan-of-Goebekli-Tepe-Enclosures-A-B-C-and-D-are-in-the-context-with-enclosure-E-shown_fig1_276320115 [accessed 26 Feb, 2023]
* Location Map - <a href="https://commons.wikimedia.org/wiki/File:Smithsonian_map_g%C3%B6bekli_tepe.jpg">US gov</a>, Public domain, via Wikimedia Commons
* Göbekli-Tepe_Construction_Illustration - Addendum 2: Megafauna Extinction Events Update to the Thunderbolt Extinction Model; the Surprising truth of the Younger Dryas Event that Changes Everything - Scientific Figure on ResearchGate. Available from: https://www.researchgate.net/figure/Double-lobe-legs-and-plasma-sheath-around-solar-center-Enclosure-D_fig2_354010454 [accessed 23 Feb, 2023]
* Tourists image - Photo by Yasemin Durmus: https://www.pexels.com/photo/roof-over-the-gobekli-tepe-turkey-15193961/
* Building D replica - <a href="https://commons.wikimedia.org/wiki/File:%C5%9Eanl%C4%B1urfa_M%C3%BCzesi_G%C3%B6beklitepe_D_Tap%C4%B1na%C4%9F%C4%B1.jpg">Cobija</a>, <a href="https://creativecommons.org/licenses/by-sa/4.0">CC BY-SA 4.0</a>, via Wikimedia Commons
* Plan of excavations 2012 - The role of cult and feasting in the emergence of Neolithic communities. New evidence from Göbekli Tepe, south-eastern Turkey - Scientific Figure on ResearchGate. Available from: https://www.researchgate.net/figure/Plan-of-excavations-and-geophysical-surveys-at-Goebekli-Tepe-graphics-T-Goetzelt-c-DAI_fig3_235799794 [accessed 23 Feb, 2023]
* Aerial View - <a href="https://commons.wikimedia.org/wiki/File:The_archaeological_site_of_G%C3%B6bekli_Tepe_-_main_excavation_area.png">German Archaeological Institute, photo E. Kücük.</a>, <a href="https://creativecommons.org/licenses/by/2.5">CC BY 2.5</a>, via Wikimedia Commons
* Panorama - <a href="https://commons.wikimedia.org/wiki/File:Gobeklitepe_Panorama.jpg">Spica-Vega Photo Arts (Banu Nazikcan)</a>, <a href="https://creativecommons.org/licenses/by-sa/4.0">CC BY-SA 4.0</a>, via Wikimedia Commons
* Animals Pillar_small - <a href="https://commons.wikimedia.org/wiki/File:Reliefs_of_animals,_G%C3%B6bekli_Tepe_Layer_III,_circa_9000_BCE.jpg">Klaus-Peter Simon</a>, <a href="https://creativecommons.org/licenses/by-sa/3.0">CC BY-SA 3.0</a>, via Wikimedia Commons
* wolf pillar - <a href="https://commons.wikimedia.org/wiki/File:G%C3%B6bekli_Tepe_Pillar.JPG">Zhengan</a>, <a href="https://creativecommons.org/licenses/by-sa/4.0">CC BY-SA 4.0</a>, via Wikimedia Commons
* Vulture/bag pillar - <a href="https://commons.wikimedia.org/wiki/File:Vulture_Stone,_Gobekli_Tepe,_Sanliurfa,_South-east_Anatolia,_Turkey.jpg">Sue Fleckney</a>, <a href="https://creativecommons.org/licenses/by-sa/2.0">CC BY-SA 2.0</a>, via Wikimedia Commons
* vultures head stone pillar - <a href="https://commons.wikimedia.org/wiki/File:G%C3%B6bekli2012-3.jpg">Klaus-Peter Simon</a>, <a href="https://creativecommons.org/licenses/by-sa/3.0">CC BY-SA 3.0</a>, via Wikimedia Commons
* Pillar 43 - A “Curious and Sometimes a Trifle Macabre Artistry” - Scientific Figure on ResearchGate. Available from: https://www.researchgate.net/figure/Stone-pillar-from-Goebekli-Tepe-Turkey-source-Deutsches-Archaeologisches-Institut-A_fig2_259708559 [accessed 23 Feb, 2023]
* Pillar 31 - Architecture and imagery in the early neolithic of South-West Asia: Framing rituals, stabilising meanings - Scientific Figure on ResearchGate. Available from: https://www.researchgate.net/figure/Pillar-31-one-of-the-central-pair-of-pillars-in-Enclosure-D-Goebekli-Tepe-with-one-of_fig3_325767557 [accessed 23 Feb, 2023]
* Pillar 51 - Recent Research 2013/14: Insights into a new Enclosure at Göbekli Tepe - Scientific Figure on ResearchGate. Available from: https://www.researchgate.net/figure/Pillar-51-central-pillar-of-Enclosure-H-depicting-a-large-felid-Photo-Nico-Becker-DAI_fig3_265612641 [accessed 23 Feb, 2023]
* Urfa Statue - Göbekli Tepe - The Stone Age Sanctuaries. New results of ongoing excavations with a special focus on sculptures and high reliefs - Scientific Figure on ResearchGate. Available from: https://www.researchgate.net/figure/The-Urfa-statue-foto-Irmgard-Wagner-DAI_fig6_270030960 [accessed 23 Feb, 2023]
* The site futuristic shelter - A Haunted Landscape and Its Drained Souls: The Last Rush to Heritage and Archaeology in Turkey - Scientific Figure on ResearchGate. Available from: https://www.researchgate.net/figure/The-site-of-Goebeklitepe-with-its-futuristic-shelter-that-allegedly-cost-65-million_fig2_349975124 [accessed 23 Feb, 2023]
* Pillar 27 Lion - Symbols of Power - Symbols of Crisis? A Psycho-Social Approach to Early Neolithic Symbol Systems - Scientific Figure on ResearchGate. Available from: https://www.researchgate.net/figure/Relief-of-a-lion-or-panther-in-a-crouching-position-on-pillar-P27-Goebekli-Tepe_fig3_260248860 [accessed 23 Feb, 2023]
* Viper Pillar - PETERS J., DRIESCH VON DEN A. and HELMER D. 2005 - The Upper Euphrates-Tigris Basin: Cradle of agro-pastoralism ?, in VIGNE J.D., PETERS J. and HELMER D. (eds) New methods and the first steps of mammal domestication . Proceedings of the 9th International Council of Archeozoology. (Durham, 23rd-28th August 2002). Oxford: Oxbow Books : 96-123. - Scientific Figure on ResearchGate. Available from: https://www.researchgate.net/figure/Goebekli-Tepe-T-shaped-stone-pillar-with-representations-of-snakes-probably-viper_fig2_263331501 [accessed 23 Feb, 2023]
### A personal thank you to:
* My Cohort Facilitator - [Iris Smok](https://github.com/Iris-Smok) for her help & support.
* My Mentor for continuous helpful feedback.
* Tutor support at Code Institute for their support.
* My course collegues for helping me with any questions I had.
| Milestone Project 1 for Code Institutes Level 5 Diploma in Web Application Development | css,html,javascript,responsive-web-design | 2023-02-28T20:43:05Z | 2023-05-18T04:02:49Z | null | 1 | 0 | 184 | 0 | 1 | 2 | null | null | HTML |
MashaMoreva/students | main | # Панель управления студентами
#### Функционал:
Веб-приложение позволяет выполнять различные операции над списком студентов. В нем реализованы следующие возможности:
* отображение таблицы со списком студентов с возможностью фильтрации и сортировки
* добавление новых студентов с помощью формы
* валидация данных студента в соответствии с правилами (все поля обязательны для заполнения после применения к значению метода trim(); дата рождения находится в диапазоне от 01.01.1900 до текущей даты; год начала обучения находится в диапазоне от 2000-го до текущего года)
* отображение сообщений об ошибках для некорректного ввода.
* расчет и отображение возраста студента на основе даты рождения
* данные о студентах хранятся в локальном хранилище браузера (localStorage) и сохраняются между сеансами работы с приложением
#### Стек технологий:
* JavaScript - использован для логики и взаимодействия с DOM
* Bootstrap - использован для стилизации пользовательского интерфейса
* HTML - разметка страницы
#### Инструкции по установке:
* cкачайте репозиторий с приложением или склонируйте его с помощью команды: `git clone`
* oткройте файл index.html в любом современном веб-браузере
#### Использование:
* чтобы добавить нового студента, заполните соответствующие поля ввода в форме и нажмите кнопку "Добавить"
* после успешного добавления студента, все поля будут очищены, и информация о студенте будет отображаться в таблице
* используйте фильтры для поиска студентов по определенным критериям:
- введите текст в поле "Ф. И. О." для поиска студента по подстроке в фамилии, имени или отчестве
- введите текст в поле "Факультет" для поиска студента по подстроке в названии факультета
- введите конкретный год начала обучения в поле "Год начала обучения" для поиска студентов с указанным годом начала обучения
- введите конкретный год окончания обучения в поле "Год окончания обучения" для поиска студентов с указанным годом окончания обучения
#### Ссылка на проект
* [посмотреть на GitHub Pages](https://mashamoreva.github.io/students/)
| 🎓 Проект: "Панель управления студентами" | bootstrap5,javascript | 2023-03-01T10:15:19Z | 2023-12-13T16:57:06Z | null | 1 | 0 | 14 | 0 | 0 | 2 | null | null | JavaScript |
arlee17/nodejs-crud-api | main | # Cookbook recipes APIs
## Introduction
This is a collection of three APIs developed with Node.js.
The user can create, read, update and delete cookbook recipes.
The projects are divided into their respective directories and can be used separately.
If you want to use them at the same time you have to change the port 3000 to one of them to avoid conflicts.
## Installation
To install the APIs, you must have Node.js installed on your system. Then, follow these steps:
- Clone this repository to your local machine.
- Navigate to the project_directory/src/vX in your terminal.
- Run `npm install` to install the project dependencies.
- Run `npm run dev` to start the API in development mode.
> Note: These are the general steps, each version may require further adjustments.
## Endpoints
The APIs provides the following endpoints:
| Method | Endpoint | Description |
| ------ | ------ | ------ |
| GET | /recipes| Returns all recipes.
| GET | /recipes/:id | Returns the recipe with the specified ID.
| POST | /recipes | Creates a new recipe.
| PUT |/recipes/:id | Updates the recipe with the specified ID.
| DELETE | /recipes/:id | Deletes the recipe with the specified ID.
## Data Storage
- V1 (version 1) uses a JSON file as the database for data storage.
- V2 (version 2) uses a mySQL database for data storage.
- V3 (version 3) uses a MongoDB database for data storage.
## Testing
Each project has its own unit tests.
## Documentation
Each API has its own documentation.
> Note: I recommend using these APIs only for test or personal projects.
| This is a collection of three APIs developed with Node.js. | api,javascript,nodejs,crud,backend | 2023-03-04T16:13:21Z | 2024-01-30T21:20:52Z | null | 1 | 0 | 19 | 0 | 0 | 2 | null | MIT | JavaScript |
W-HanYu/FE-JS-TS | master | <img src="assets/first-page.png" width="100%">
### 目录
- [你不知道的JS](vuepress/docs/you-dont-know-js/rollup-1.md)
- [作用域和闭包](vuepress/docs/you-dont-know-js/rollup-1.md)
- [第一章 作用域是什么](vuepress/docs/you-dont-know-js/rollup-1.md)
- [第二章 词法作用域](vuepress/docs/you-dont-know-js/rollup-2.md)
- [第三章 函数与块作用域](vuepress/docs/you-dont-know-js/rollup-3.md)
- [基础回顾：typescript 入门教程](docs/tutorial.md)
- [一、typescript 是什么?](docs/tutorial.md#一typescript-是什么)
- [1.1 TypeScript 与 JavaScript 的区别](docs/tutorial.md#11-typescript-与-javascript-区别)
- [1.2 获取 TypeScript](docs/tutorial.md#12-获取-typescript)
- [1.3 典型 TypeScript 工作流程](docs/tutorial.md#13-典型-typescript-编译流程)
- [1.4 Typescript 初次体验](docs/tutorial.md#14-typescript-初体验)
- [二、typescript 基础类型](docs/tutorial.md#二typescript-基础类型)
- [2.1 Boolean 类型](docs/tutorial.md#21-boolean-类型)
- [2.2 Number 类型](docs/tutorial.md#22-number-类型)
- [2.3 String 类型](docs/tutorial.md#23-string-类型)
- [2.4 Symbol 类型](docs/tutorial.md#24-symbol-类型)
- [2.5 Array 类型](docs/tutorial.md#25-array-类型)
- [2.6 Enum 类型](docs/tutorial.md#26-enum-类型)
- [2.6.1 数字枚举](docs/tutorial.md#261数字枚举)
- [2.6.2 字符串枚举](docs/tutorial.md#262字符串枚举)
- [2.6.3 常量枚举](docs/tutorial.md#263常量枚举)
- [2.6.4 异构枚举](docs/tutorial.md#264异构枚举)
- [2.7 Any 类型](docs/tutorial.md)
- [2.8 Unknown 类型](docs/tutorial.md)
- [2.9 Tuple 类型](docs/tutorial.md)
- [2.10 Void 类型](docs/tutorial.md)
- [2.11 Null 和 undefined 类型](docs/tutorial.md)
- [2.12 object、Object 和{} 类型](docs/tutorial.md)
- [2.12.1 object 类型](docs/tutorial.md)
- [2.12.2 Object 类型](docs/tutorial.md)
- [2.12.3 {}类型](docs/tutorial.md)
- [2.13 Never 类型](docs/tutorial.md)
-
- [三、typescript 断言](docs/tutorial.md#三typescript-断言)
- [3.1 类型断言](docs/tutorial.md#31-类型断言)
- [3.1.1.“尖括号” 语法](docs/tutorial.md#311尖括号-语法)
- [3.1.2.as 语法](docs/tutorial.md#312as-语法)
- [3.2 非空断言](docs/tutorial.md#32-非空断言)
- [ 3.2.1.忽略 undefined 和 null 类型](docs/tutorial.md#321忽略-undefined-和-null-类型)
- [3.2.2.调用函数时忽略 undefined 类型](docs/tutorial.md#322调用函数时忽略-undefined-类型)
- [3.3 确定赋值断言](docs/tutorial.md#33-确定赋值断言)
- [四、类型守卫](docs/tutorial.md#四类型守卫)
- [4.1 in 关键字](docs/tutorial.md#41-in-关键字)
- [4.2 typeof 关键字](docs/tutorial.md#42-typeof-关键字)
- [4.3 instanceof 关键字](docs/tutorial.md#43-instanceof-关键字)
- [4.4 自定义类型保护的类型谓词](docs/tutorial.md#44-自定义类型保护的类型谓词)
- [五、联合类型和类型别名](docs/tutorial.md#五联合类型和类型别名)
- [5.1 联合类型](docs/tutorial.md#51-联合类型)
- [5.2 可辨识联合](docs/tutorial.md#52-可辨识联合)
- [5.2.1.可辨识](docs/tutorial.md#521-可辨识)
- [5.2.2.联合类型](docs/tutorial.md#522-联合类型)
- [5.2.3.类型守卫](docs/tutorial.md#523类型守卫)
- [5.3 类型别名](docs/tutorial.md#53-类型别名)
- [六、交叉类型](docs/tutorial.md#六交叉类型)
- [6.1 同名基础类型属性的合并](docs/tutorial.md#61-同名基础类型属性的合并)
- [6.2 同名非基础类型属性的合并](docs/tutorial.md#62-同名非基础类型属性的合并)
- [七、typescript 函数](docs/tutorial.md#七typescript-函数)
- [7.1 TypeScript 函数与 JavaScript 函数的区别](docs/tutorial.md#71-typescript-函数和-javascript-函数区别)
- [7.2 箭头函数](docs/tutorial.md#72-尖头函数)
- [7.2.1.常见语法](docs/tutorial.md#721-常见于法)
- [7.2.2.使用示例](docs/tutorial.md#722-使用示例)
- [7.3 参数类型和返回类型](docs/tutorial.md#73-参数类型和返回类型)
- [7.4 函数类型](docs/tutorial.md#74-函数类型)
- [7.5 可选参数及默认参数](docs/tutorial.md#75-可选参数及默认参数)
- [7.6 剩余参数](docs/tutorial.md#76-剩余参数)
- [7.7 函数重载](docs/tutorial.md#77-函数重载)
- [八、typescript 数组](docs/tutorial.md#八typescript-数组)
- [8.1 数组解构](docs/tutorial.md#81-数组解构)
- [8.2 数组展开运算符](docs/tutorial.md#82-数组展开运算符)
- [8.3 数组遍历](docs/tutorial.md#83-数组遍历)
- [九、typescript 对象](docs/tutorial.md#九typescript-对象)
- [9.1 对象解构](docs/tutorial.md#91-对象解构)
- [9.2 对象展开运算符](docs/tutorial.md#92-对象展开运算符)
- [十、typescript 接口](docs/tutorial.md#十typescript-接口)
- [10.1 对象的形状](docs/tutorial.md#101-对象的形状)
- [10.2 可选 | 只读属性](docs/tutorial.md#102-可选--只读属性)
- [10.3 任意属性](docs/tutorial.md#103-任意属性)
- [10.4 接口与类型别名的区别](docs/tutorial.md#104-接口与类型别名的区别)
- [10.4.1.Objects/Functions](docs/tutorial.md#1041objectsfunctions)
- [10.4.2.Other Types](docs/tutorial.md#1042other-types)
- [10.4.3.Extend](docs/tutorial.md#1043extend)
- [10.4.4.Implements](docs/tutorial.md#1044implements)
- [10.4.5.Declaration merging](docs/tutorial.md#1045declaration-merging)
- [十一、typescript 类](docs/tutorial.md#十一typescript-类)
- [11.1 类的属性与方法](docs/tutorial.md#111-类的属性与方法)
- [11.2 ECMAScript 私有字段](docs/tutorial.md#112-ecmascript-私有字段)
- [11.3 访问器](docs/tutorial.md#113-访问器)
- [11.4 类的继承](docs/tutorial.md#114-类的继承)
- [11.5 抽象类](docs/tutorial.md#115-抽象类)
- [11.6 类方法重载](docs/tutorial.md#116-类方法重载)
- [十二、typescript 泛型](docs/tutorial.md#十二typescript-泛型)
- [12.1 泛型语法](docs/tutorial.md#121-泛型语法)
- [12.2 泛型接口](docs/tutorial.md#122-泛型接口)
- [12.3 泛型类](docs/tutorial.md#123-泛型类)
- [12.4 泛型工具类型](docs/tutorial.md#124-泛型工具类型)
- [12.4.1.typeof](docs/tutorial.md#1241typeof)
- [12.4.2.keyof](docs/tutorial.md#1242keyof)
- [12.4.3.in](docs/tutorial.md#1243in)
- [12.4.4.infer](docs/tutorial.md#1244infer)
- [12.4.5.extends](docs/tutorial.md#1245extends)
- [12.4.6.Partial](docs/tutorial.md#1246partial)
- [十三、装饰器](docs/tutorial.md#十三装饰器)
- [13.1 装饰器是什么](docs/tutorial.md#131-装饰器是什么)
- [13.2 装饰器的分类](docs/tutorial.md#132-装饰器的分类)
- [13.3 类装饰器](docs/tutorial.md#133-类装饰器)
- [13.4 属性装饰器](docs/tutorial.md#134-属性装饰器)
- [13.5 方法装饰器](docs/tutorial.md#135-方法装饰器)
- [13.6 参数装饰器](docs/tutorial.md#136-参数装饰器)
- [十四、typescript4.0 特性](docs/tutorial.md#十四typescript40-特性)
- [14.1 构造函数的类属性推断](docs/tutorial.md#141-构造函数的类属性推断)
- [14.2 标记的元组元素](docs/tutorial.md#142-标记的元组元素)
- [十五、编译上下文](docs/tutorial.md#十五编译上下文)
- [15.1 tsconfig.json 的作用](docs/tutorial.md#151-tsconfigjson-的作用)
- [15.2 tsconfig.json 重要字段](docs/tutorial.md#152-tsconfigjson-重要字段)
- [15.3 compilerOptions 选项](docs/tutorial.md)
- [十六、typescript 开发辅助函数](docs/tutorial.md#十六typescript-开发辅助函数)
- [16.1 TypeScript Playground](docs/tutorial.md#161-typescript-playground)
- [16.2 TypeScript UML Playground](docs/tutorial.md#162-typescript-uml-playground)
- [16.3 JSON TO TS](docs/tutorial.md#163-json-to-ts)
- [16.4 Schemats](docs/tutorial.md)
- [16.5 TypeScript AST Viewer](docs/tutorial.md#164-schemats)
- [16.6 TypeDoc](docs/tutorial.md#165-typescript-ast-viewer)
- [16.7 TypeScript ESLint](docs/tutorial.md#167-typescript-eslint)
- [十七、参考工具](docs/tutorial.md#十七参考工具)
- [第一章:Type Manipulation 类型操作](./docs/1.Type%20Manipulation.md)
- [1.1 范型](./docs/1.Type%20Manipulation.md#11-范型)
- [1.2keyof](./docs/1.Type%20Manipulation.md#12-keyof-类型操作符)
- [1.3typeof](./docs/1.Type%20Manipulation.md#13-typeof-操作符)
- [1.4 条件类型](./docs/1.Type%20Manipulation.md#14-条件类型)
- [1.5 映射类型 Mapped-Type](./docs/1.Type%20Manipulation.md#15-映射类型-MappedType)
- [1.6 模版文字类型](./docs/TemplateLiteralType.md)
- [第二章:Utility Type](./docs/Utility-Type.md)
- [2.1 Partial <Type>](./docs/Utility-Type.md#21-Partial-type)
- [2.2 Required<Type>](./docs/Utility-Type.md#22-Requiredtype)
- [2.3 Readonly<Type>](./docs/Utility-Type.md#23-Readonlytype)
- [2.4 Record<Type>](./docs/Utility-Type.md#24-Recordtype)
- [2.5 Exclude<UnionType, ExcludedMembers>](./docs/Utility-Type.md#25-ExcludeUnionType-ExcludedMembers)
- [2.6 Extrac<Type,Union>](./docs/Utility-Type.md#26-ExtracTypeUnion)
- [2.7 Pick<Type,Keys>](./docs/Utility-Type.md#27-PickTypeKeys)
- [2.8 Omit<Type,Keys>](./docs/Utility-Type.md#28-OmitTypeKeys)
- [2.9 NonNullable<Type>](./docs/Utility-Type.md#29-NonNullableType)
- [2.10 Parameters<Type>](./docs/Utility-Type.md#210-Parameterstype)
- [2.11 ReturnType<Type>](./docs/Utility-Type.md#211-ReturnTypetype)
- [2.12 Uppercase<StringType>](./docs/Utility-Type.md#212-UppercaseStringType)
- [2.13 Lowercase<StringType>](./docs/Utility-Type.md#213-LowercaseStringType)
- [2.14 Capitalize<StringType>](./docs/Utility-Type.md#214-CapitalizeStringType)
- [2.15 Uncapitalize<StringType>](./docs/Utility-Type.md#215-UncapitalizeStringType)
- [第三章:装饰器 Decorators](./docs/Decorators.md)
- [3.1 装饰者模式介绍](docs/Decorators.md#31-装饰者模式)
- [3.2 Typescript 装饰器](docs/Decorators.md#32-Typescript-装饰器)
- [3.3 装饰器的使用](docs/Decorators.md#33-装饰器的使用)
- [3.4 装饰器工厂](docs/Decorators.md#34-装饰器工厂)
- [3.5 类装饰器](docs/Decorators.md#35-类装饰器)
- [3.6 方法装饰器](docs/Decorators.md#36-方法装饰器)
- [3.7 属性装饰器](docs/Decorators.md#37-属性装饰器)
- [3.8 其他装饰器的写法](docs/Decorators.md#38-其他装饰器的写法)
- [3.9 装饰器运行时代码分析](docs/Decorators.md#39-装饰器运行时代码分析)
- [第四章:TS 中奇怪的符号](./docs/StrangeSymbols.md)
- [4.1 !非空断言操作符](docs/StrangeSymbols.md#41-非空断言操作符)
- [4.2 ?. 运算符](docs/StrangeSymbols.md#42--运算符)
- [4.3 ?? 空值合并运算符](docs/StrangeSymbols.md#43--空值合并运算符)
- [4.4 ?：可选属性](docs/StrangeSymbols.md#44-可选属性)
- [4.5 & 可选属性](docs/StrangeSymbols.md#45--运算符)
- [4.6 ｜ 分隔符](docs/StrangeSymbols.md#46--分隔符)
- [4.7 \_ 数字分隔符](docs/StrangeSymbols.md#47--数字分割符)
- [4.8 <Type> 语法](docs/StrangeSymbols.md#48-lttypegt-语法)
- [4.9 @XXX 装饰器](docs/StrangeSymbols.md#49-xxx-装饰器)
- [4.10 #XXX 私有字段](docs/StrangeSymbols.md#410xxx-私有字段)
- [第五章:泛型 Generics](docs/Generics.md)
- [5.1 泛型是什么？](docs/Generics.md#51-泛型是什么)
- [5.2 泛型接口？](docs/Generics.md#52-泛型接口)
- [5.3 泛型类？](docs/Generics.md#53-泛型类)
- [5.4 泛型约束](docs/Generics.md#54-泛型约束)
- [5.4.1 确保属性存在](docs/Generics.md#541-确保属性存在)
- [5.4.2 检查对象上的键是否存在](docs/Generics.md#542-检查对象上的键是否存在)
- [5.5 泛型参数默认类型](docs/Generics.md#55-泛型参数默认类型)
- [5.6 泛型条件类型](docs/Generics.md#56-泛型条件类型)
- [5.7 泛型工具类型](docs/Generics.md#57-泛型工具类型)
- [5.7.1 partial](docs/Generics.md#571-partial)
- [5.7.2 record](docs/Generics.md#572-record)
- [5.7.3 pick](docs/Generics.md#573-pick)
- [5.7.4 exclude](docs/Generics.md#574-exclude)
- [5.7.5 returntype](docs/Generics.md#575-returntype)
- [5.8 使用泛型创建对象](docs/Generics.md#58-使用泛型创建对象)
- [5.8.1 构造签名](docs/Generics.md#581-构造签名)
- [5.8.2 构造函数类型](docs/Generics.md#582-构造函数类型)
- [5.8.3 构造函数类型的应用](docs/Generics.md#583-构造函数类型的应用)
- [5.8.4 使用泛型创建对象](docs/Generics.md#584-使用泛型创建对象)
- [5.9 参考资源](docs/Generics.md#59-参考资源)
### 欢迎大家 PR 贡献 TS 代码，点个 Star 持续更新中...
| 🔥🔥🔥随着前端技术越来越成熟，JS/TS已成为各大厂开发的必备使用语言，本站从易到难深入理解JS/TS，同时提供TS做题功能，让你边学边实践，快速掌握🔥🔥🔥 | javascript,javascript-library,typescript,typescript-library | 2023-03-02T13:23:31Z | 2024-01-25T08:13:41Z | null | 1 | 5 | 121 | 16 | 0 | 2 | null | null | TypeScript |
creativoma/mariano-alvarez-portfolio-v1.0 | main | # Astro Landing Page
Este es mi portfolio v1 personal, diseñado y desarrollado con [Astro.build](https://astro.build) y [Tailwind CSS](https://tailwindcss.com). Astro.build me permitió crear una experiencia de usuario fluida y optimizada, mientras que Tailwind CSS me proporcionó un conjunto de herramientas para estilizar rápidamente mi sitio web. El resultado es una página web moderna y elegante que refleja mi trabajo y habilidades. ¡Gracias por visitar!
## Screenshots
## Lighthouse scores
| Performance | Accessibility | Best Practices | SEO | PWAs |
| :---------: | :-----------: | :------------: | :--: | :--: |
| 100% | 100% | 100% | 100% | S/D |
## Comandos
| Command | Action |
| :--------------------- | :------------------------------------------------ |
| `npm install` | Install dependencies |
| `npm run dev` | Start local dev server at `localhost:3000` |
| `npm run build` | Build your production site to `./dist/` |
| `npm run preview` | Preview your build locally, before deploying |
| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
| `npm run astro --help` | Get help using the Astro CLI |
| `npm run format` | Format code with [Prettier](https://prettier.io/) |
| `npm run clean` | Remove `node_modules` and build output |
## Creditos
- Template creado por [mhyfritz](https://github.com/mhyfritz/astro-landing-page).
- Otros elementos y datos fueron tomados de [Astro](https://astro.build) y [Tailwind CSS](https://tailwindcss.com).
| Este es mi portfolio v1 personal, diseñado y desarrollado con Astro.build y Tailwind CSS. Astro.build me permitió crear una experiencia de usuario fluida y optimizada, mientras que Tailwind CSS me proporcionó un conjunto de herramientas para estilizar rápidamente mi sitio web. | astro,astrobuild,javascript,performance,portfolio,tailwindcss,vercel | 2023-03-06T19:48:06Z | 2023-10-17T08:46:02Z | null | 1 | 0 | 36 | 2 | 0 | 2 | null | MIT | Astro |
roypromax/Samajhdaar.com | main | # Block-22 Unit-3 Construct Week Project
Website to clone -----> https://www.bewakoof.com/
Team Lead - Shakti Singh,
Member 1 - Rishabh Roy,
Member 2 - Kulsoom Rasheed,
Member 3 - Aman Singh,
Member 4 - Pratiyush Sharma
| Samajhdaar is a clone of bewakoof.com which is a new age clothing and apparel e-commerce website. | css3,e-commerce,html5,javascript | 2023-03-07T19:27:31Z | 2023-01-23T06:43:21Z | null | 5 | 0 | 67 | 0 | 0 | 2 | null | null | HTML |
python-nerd-3/crystal-coves | main | # crystal-coves
**#2 MINING-GAME ON GITHUB** *definetly not out of 5*
github aggressively wants me to add a readme help i am being held hostage to add this and make it relevant;;;
ABOVE IS JOKE!
CURRENT ORES: ThisNumbahIsOutdated
| rex sqrt(-2.43) | css,game,html,html-css-javascript,html-css-js,html-js-css,html5-canvas,html5-game,javascript,js | 2023-03-05T19:19:33Z | 2023-05-15T23:09:14Z | null | 1 | 0 | 64 | 1 | 1 | 2 | null | null | JavaScript |
lack21/Manage-Website | main | # Manage-Website
Tool Used:
• HTMl
• SCSS
• JavaScript
Link : https://lack21.github.io/Manage-Website/
| Website Project | html,javascript,scss | 2023-03-03T21:51:36Z | 2023-05-16T14:21:14Z | null | 1 | 0 | 4 | 0 | 0 | 2 | null | null | HTML |
ndrean/gruland | main | # Gruland
Accessible via: <https://gruland.surge.sh>
A backend to serve the statistics on AWS package from NPM is deployed on fly.io (`curl https://gruland.fly.dev/api/packages?p="@grucloud"`)
```bash
> fly deploy
```
## JSON files (Elixir)
1/ To build the examples,
- fork the repo <https://github.com/aws-samples/serverless-patterns>.
- open an IEx session and run `Builder.run`. It will read all the directories and extract the "example-pattern.json" files, and concat into a new file for the front to render it.
In a terminal run:
```bash
mix deps.get
iex -S mix
```
This open an IEx session. Then run:
```elixir
iex> Builder.run
```
This creates a file "serverlessland-examples.json"
2/ The NPM packages are served by a deployed app. You can `curl https://gruland.fly.dev/api/packages?p="mypackage"` or use the front-end `https://gruland.surge.sh` to get them.
The file "aws-npm-packages.json" is created if you set `true`. This can only be done in the terminal locally where you can also set "starting" and "ending" query period.
```elixir
$ iex -S mix
iex> Npm.find(true, "@aws-sdk/client", "2022-01-01", "2023-01-01")
```
3/ Sources:
The official list of AWS NPM packages is: <https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/index.html>
The NPM api can be found at: <https://api-docs.npms.io/> and a "search" endpint <https://api.npms.io/v2/search> (paginated per 25).
4/ Results for AWS JS packages in 2022:
Total downloads in 2022 per package:
<img width="702" alt="Screenshot 2023-03-11 at 01 42 08" src="https://user-images.githubusercontent.com/6793008/224469567-eca61d3d-448c-4689-ac94-7acdf4f9a8ac.png">
Detail of downloads per package in 2022:
<img width="422" alt="Screenshot 2023-03-11 at 01 44 37" src="https://user-images.githubusercontent.com/6793008/224469675-a996a21a-d885-4eb8-a67b-9756ce733c45.png">
The code of AWS NPM packages can be run in a Livebook.
[](https://livebook.dev/run?url=https://github.com/ndrean/gruland/blob/main/livebook.livemd)
## Front
Vite generate Preact + Universal-Router + Zustand
Package.json:
```json
"dependencies": {
"history": "^5.3.0",
"preact": "^10.11.3",
"universal-router": "^9.1.0",
"zustand": "^4.3.6"
},
```
Erase "React" in the "node_modules".
Visible at: <https://gruland.surge.sh>
| NPM AWS package && serverlessland example-patterns | javascript,universal-router,zustand,elixir,aws | 2023-03-03T23:11:25Z | 2023-08-04T14:25:10Z | null | 1 | 2 | 110 | 0 | 0 | 2 | null | null | Elixir |
pitch2/Portfolio | base | # Portfolio pour mes projets scolaires, présenter mon travail...
---
#### Projet fermé et moche mdr
---
| null | css,french,html,javascript,photography,php,portolio | 2023-02-25T18:19:23Z | 2023-10-02T11:38:51Z | null | 1 | 0 | 8 | 0 | 0 | 2 | null | null | HTML |
osmn-byhn/TodoApp | master | null | My first MEVN Project | javascript,project-completed | 2023-02-26T16:46:45Z | 2023-03-01T18:21:42Z | null | 1 | 0 | 12 | 0 | 0 | 2 | null | null | Vue |
Wesley1227/Winter | master | A terceira entrega consiste no avanço no trabalho que foi feito desde a primeria entrega.
Conta ADMIN:
Admin (email/user: amin // Senha: 1227)
Alterações Back-end:
*Pasta Base de dados* - Nela contém a base de dados em formato SQL.
*Pasta Admin* - Nela contém páginas admin adicionadas que só quem é admin tem acesso, como por exemplo, adicionar categorias, marcas, etc, ao site.
O admin, é úncio, ele tem acesso e consegue como por exemplo remover e eitar anúncios, e isso está disponível apenas para quem criou o anúncio.
*Pasta Login* - Nela contém páginas para o funcionamento o login e registro do usuário.
*Pasta uploads* - Nela contém itens adicionadas a base de dados, como por exemplo imagens de anúncios, foto de perfil, etc.
Por não ter uma base de dados remota para ficheirops, optei por essa fuincionaliade no momento, na base de dados é inserida o nome o ficheiro e o mesmo é guardado na pasta, assim apenas precisa fazer a busca pelo nome.
*Pasta Include_once* - Nela contém ficheiros .php pastas, pasta expecifica para guardar código que depois será chamado com Include_once, assim nao precisar encher ficheiros com o mesmo código, basta criar uma vez e chamar quantas vezes eu quiser, como por exemplo o footer do site, basta inserir "<?php include_once '../Include_once/footer.php'; ?>". Assim ficando mais organizao e leve.
Entre váaarias alterações, como pesquisa, anuncios, perfil, dados, criar anuncio, etc...
Diego esteve aqui
Alterações Front-end:
Página index.php - Nela agora contém Destaques que faz a busca dos ultimos 15 anúncios adicionados e obrigatóriamente tem que possuir imagem.
Possui tambem, deslumbre do que será feito em projhetos futuros, que serão:
-"Winter produtos" parte que ja esta quase pronta e já está disponivel, onde podes vender e comprar proutos, novos e usados.
-"Winter empregos" onde poderá porcurar e adicionar vagas de empregos.
-"Winter entreterimento" onde poderá porcurar e adicionar coisas de entretenimento como videos e músicas e pessoas poddem ir lá e comprar, como por exemplo, vender musica instrumental, assim quem comprar terá total direto ao prouto e será disponiblizado um certificado a compra. Ou então ver intro de um vídeo, assim quem comprar terá direito a ele poder edita-lo como quiser.
-"Winter programação" onde poderá porcurar e adicionar projetos de programação, como por exemplo, "App de gestãop e stock", ou contrar alguém fazer fazer algo que envolva programação como por exemplo: "Preciso de um site que gere a minha loja de cosméticos".
-"Winter fórum" onde poderás entrar em grupos e conversar com pessoas com mesmo interesse que o seu, como por exemplo: "Fórum programação PT" esse forum pode ser utilizado para as pessoas conversarem sobre programação, ajudarem uns aos outros, etc.
| PAP Winter | css,html,javascript,php | 2023-02-26T20:27:43Z | 2023-04-01T14:29:02Z | null | 1 | 0 | 11 | 1 | 0 | 2 | null | null | PHP |
Yehonatal/Calculator-app | master | # Frontend Mentor - Calculator app
[](https://app.netlify.com/sites/calculator-from-fem/deploys)
## Welcome! 👋
Thanks for checking out this front-end coding challenge.
### The challenge
Users should be able to:
- View the optimal layout for the site depending on their device's screen size
- See hover states for all interactive elements on the page
### Built with
- Semantic HTML5 markup
- CSS custom properties
- Flexbox
- Mobile-first workflow
### What I learned
Basic Html/Css/Js :)
### Useful resources
- Just used YouTube
## Author
- Website - [Yonatan Afewerk Teshome](#)
- Frontend Mentor - [@R4nn3r](https://www.frontendmentor.io/profile/R4nn3r)
- Github - [@R4nn3r](https://github.com/R4nn3r)
| Calculator app with multiple themes | css3,html,javascript,scss | 2023-02-27T07:13:28Z | 2023-03-08T09:33:18Z | null | 1 | 4 | 24 | 0 | 0 | 2 | null | null | SCSS |
JoySarkarBD/Redux-Assignments-LWS | master | null | null | css3,html5,javascript,react,react-redux,redux,redux-template,redux-thunk,redux-toolkit,tailwindcss | 2023-03-10T07:12:39Z | 2023-05-01T05:45:00Z | null | 2 | 0 | 7 | 0 | 0 | 2 | null | null | CSS |
younusaliakash/vanilla-js-sortable-drag-and-drop-list | master | ## Sortable List
Display a scrambled list that can be sorted with drag and drop
## Project Specifications
- Create an ordered list (Top 10 richest people)
- Scramble list items randomly
- Allow user to drag and drop an item to a different position
- Button to check if items are in correct order
- Show green for correct order and red for wrong order
<img src="./draggable-list-item.gif" alt="draggable-list-item">
``` Younus Ali Akash ```
| Display a scrambled list that can be sorted with drag and drop | css,dom-manipulation,drag-and-drop,html,javascript | 2023-02-25T08:29:16Z | 2023-04-05T18:11:00Z | null | 1 | 0 | 2 | 0 | 0 | 2 | null | null | JavaScript |
TacticalReader/Restaurant-template-website | main | # Responsive Food Website
## Project Description
The project is a responsive food website designed to showcase a variety of dishes, allow users to explore the menu, read customer reviews, and place orders. It features different sections, including a home section with a swiper slider highlighting special dishes, a dishes section displaying popular food items, an about section providing information about the restaurant, a menu section showcasing today's specialties, a customer review section with testimonials, and an order section for users to place orders quickly and easily. Additionally, there's a footer section with links to different locations, quick navigation links, contact information, and social media links.
### Purpose
The purpose of the website is to create an engaging online presence for a food establishment, allowing users to discover the menu, learn more about the restaurant, read reviews from other customers, and conveniently place food orders. The responsive design ensures that the website is accessible and visually appealing across various devices, providing a seamless user experience.
## Installation Instructions
### Prerequisites
- Make sure you have a code editor installed, such as Visual Studio Code, Sublime Text, or Atom.
- You need a web browser to view the project locally.
- Ensure you have Git installed on your machine to clone the repository.
### Installation Steps
1. **Clone the Repository:**
Open your terminal or command prompt and run the following command to clone the repository:
```bash
git clone https://github.com/{username}/{repository}.git
```
Replace `{username}` and `{repository}` with the actual GitHub username and repository name.
2. **Navigate to Project Directory:**
Change into the project directory using the `cd` command:
```bash
cd {repository}
```
Replace `{repository}` with the name of the cloned repository.
3. **Open in Code Editor:**
Open the project in your preferred code editor. For example, using Visual Studio Code:
```bash
code .
```
4. **Run Locally:**
Open the `index.html` file in your web browser. You can do this by right-clicking on the file and selecting "Open with" your preferred browser.
5. **Explore the Website:**
Explore the different sections of the website locally in your browser. Interact with the navigation, review the pages, and ensure everything looks as expected.
**Note:** If the project relies on any server-side components or APIs, you may need to set up a local server environment. However, based on the provided code, it seems to be a static website, so no server-side setup should be necessary.
## Usage
Users interact with this project through a web browser. Here's a brief overview of how they can navigate and use the different sections of the website:
(I). **Navigation:**
- The website has a navigation bar at the top with links to different sections. Users can click on these links to navigate to the corresponding sections.
- The navigation links include "home," "dishes," "about," "menu," "review," and "order."
(ii). **Home Section:**
- The home section showcases a slider with special dishes. Each slide includes the name of the dish, a brief description, and an "order now" button.
- Users can click on the "order now" button to potentially initiate an order process.
(iii). **Dishes Section:**
- In the dishes section, there are several boxes displaying popular dishes. Each box includes an image of the dish, icons for actions like "heart" and "eye,"
the name of the dish, star ratings, price, and an "add to cart" button.
- Users can click on the "add to cart" button to add a dish to their cart.
(iv). **About Section:**
- The about section provides information about the business, including an image, a headline, and a detailed description.
- Icons representing free delivery, easy payments, and 24/7 service are displayed.
- Users can click on the "learn more" button to get more information.
(v). **Menu Section:**
- The menu section displays today's specialties with images, ratings, a brief description, an "add to cart" button, and the price.
- Users can click on the "add to cart" button to add a menu item to their cart.
(vi). **Review Section:**
- The review section features a slider with customer reviews. Each slide includes a quote, the name of the customer, an image, and star ratings.
- Users can navigate through the reviews using the slider.
(vii). **Order Section:**
- The order section allows users to place an order. Users can fill in details such as their name, phone number, order details, quantity, date, time, address, and a message.
- After filling in the details, users can click the "order now" button.
(viii). **Footer Section:**
- The footer includes links to different locations, quick links, contact information, and social media links.
(ix. **Loader:**
- A loader with an animated GIF is displayed, indicating that the website is loading.
**Note:** The actual functionality may vary, and the project may require additional backend logic for features like order processing, which is not evident from the provided HTML and CSS.
## Contributing
Absolutely! We welcome contributions from the developer community to enhance and improve the project. Here are the guidelines for contributing:
**1. Fork the Repository:**
- Fork the project repository to your GitHub account.
**2. Clone the Repository:**
- Clone the forked repository to your local machine:
```bash
git clone https://github.com/your-username/project-name.git
```
**3. Create a Branch:**
- Create a new branch for your contribution:
```bash
git checkout -b feature/your-feature
```
**4. Make Changes:**
- Implement your feature or fix a bug. Ensure your changes follow the coding style and best practices of the project.
**5. Test Locally:**
- Test your changes locally to ensure they work as expected.
**6. Commit Changes:**
- Commit your changes with a clear and descriptive commit message:
```bash
git commit -m "Add feature: your feature description"
```
**7. Push Changes:**
- Push your changes to your forked repository:
```bash
git push origin feature/your-feature
```
**8. Create Pull Request:**
- Create a pull request from your branch to the main project repository.
- Provide a detailed description of your changes and the purpose behind them.
**9. Review:**
- Participate in the code review process. Address any feedback provided by maintainers.
**10. Merge:**
- Once approved, your changes will be merged into the main branch.
**Note:**
- Ensure your branch is always up-to-date with the main branch before creating a pull request.
- If you're fixing a bug, please create an issue describing the bug and how to reproduce it before creating a pull request.
Thank you for contributing to our project!
## License
Our project is released under the [MIT License](https://opensource.org/licenses/MIT). Feel free to check the [LICENSE](#) file for more details.
## Acknowledgements
Certainly! We'd like to express our gratitude to the following individuals, projects, and resources that have contributed to or inspired this project:
1. **Swiper:**
- We acknowledge the Swiper project for providing the responsive slider component used in our project. [Swiper GitHub](https://github.com/nolimits4web/swiper)
2. **Font Awesome:**
- Special thanks to Font Awesome for the iconic and scalable vector icons. [Font Awesome](https://fontawesome.com/)
3. **Open Source Community:**
- Our project is built on the collective knowledge and efforts of the open-source community. We appreciate the countless developers who share their expertise and code.
4. **Online Resources:**
- Various online tutorials, documentation, and forums have been valuable in shaping this project. We acknowledge the broader online community for its wealth of information.
5. **Inspiration:**
- The design and concept of this project have been inspired by various websites, UI/UX designs, and food-related platforms.
Thank you to everyone who has played a role in the creation and evolution of this project! Your contributions are truly appreciated.
## Scrollspy Functionality
This project incorporates a scrollspy feature to enhance the user experience. The scrollspy functionality is implemented using JavaScript to dynamically highlight the active navigation item based on the user's scroll position within the page.
### How it Works
1. **Navigation Links Highlighting:**
- As you scroll through different sections of the website, the corresponding navigation links in the header are dynamically highlighted to indicate the active section.
2. **Smooth Scrolling:**
- Clicking on navigation links smoothly scrolls to the respective section on the page, providing a seamless navigation experience.
### Implementation Details
- **JavaScript:**
- The scrollspy functionality is implemented using JavaScript, detecting the scroll position and updating the active state of navigation links accordingly.
- **HTML Structure:**
- The HTML structure is designed to include section IDs corresponding to the navigation links.
- **CSS Styling:**
- CSS styles are applied to highlight the active state of the navigation links.
### Example Code Snippet
```javascript
// Add an event listener for scroll events
window.addEventListener('scroll', function () {
// Your scrollspy logic goes here to update active state
// Example: Update active state based on scroll position
});
```
## Contact Information
If you have any questions or would like to collaborate, you can reach out to us through the following contact information:
- **Email:** srivastavatanmay561@gmail.com
- **Alternative Email:** yashsrivastava561@gmail.com
- **Phone:** +91 6394729329,
- **Address:** Uttar Pradesh, Bahraich, 271801
Feel free to connect with us, and we'll get back to you as soon as possible!
---
| "Explore a responsive food website with a modern design. Discover mouth-watering dishes, read customer reviews, and place orders effortlessly. Powered by HTML, CSS, and JavaScript. 🍔🌐 #WebDesign #Uidesign" | css3,customer-review,food-website,html5,javascript,responsive-design,restaurant,scrollspy,swiper-slider,website-template | 2023-03-02T15:00:19Z | 2023-12-29T20:20:36Z | null | 1 | 0 | 31 | 1 | 0 | 2 | null | MIT | HTML |
Huntken26/wipe-chicago | main | # Wipe Chicago LLC
## Description
This React app was built as a freelance project for a local commericial cleaning business. This application was created using Chakra-ui, emotion/react, undraw.co, email-js, and github pages. Initially, we wanted to have a full stack but it was decided to startoff with the frontend and as the brand builds and more employees/contracts are made- then we will add on the backend portion. Future development will include a employee/client login, appointment setting tools, client reviews component and square payment APIs.
## TABLE OF CONTENTS:
[installation](#installation) <br/>
[screenshots](#screenshots)<br/>
[credits](#credits)<br/>
[contributing](#contributing)<br/>
[license](#license)<br/>
[badges](#badges)<br/>
[tests](#tests)<br/>
[questions](#questions)<br/>
## DEMO:
## Live:
https://huntken26.github.io/wipe-chicago
## INSTALLATION:
To run this application locally, you'll need to have Node.js installed on your machine. Then, follow these steps:
Clone the repository to your local machine using git clone.
Install the dependencies by running npm install in both the root directory
Start the application by running npm run dev in the root directory. The application should open in your default browser at http://localhost:3000.
## Screenshots
 <br/>
 <br/>
 <br/>
 <br/>
## Credits
React - JavaScript library used to build the frontend user interface.<br/>
Node.js - JavaScript runtime environment used to run the backend API.<br/>
create-react-app - Tool used to create the initial React project structure.<br/>
Chakra UI - UI component library used to style the application.<br/>
Email-js - Service used to take in user input and forwarding to the owner's email address.<br/>
Canva- Graphic design website used to create the branding, logo and color scheme of the business.<br/>
Github-Pages - Used for deployment.<br/>
## Contributing
Contributions to this project are welcome. If you find a bug or have an idea for a new feature, feel free to open an issue or shoot me an email.
## License
This project is licensed under the MIT License - see the LICENSE file for details.
## TESTS:
N/A
## Badges
Add badges from somewhere like: [shields.io](https://shields.io/)
<img src="https://img.shields.io/badge/Visual_Studio_Code-0078D4?style=for-the-badge&logo=visual%20studio%20code&logoColor=white" />
<img src="https://img.shields.io/badge/Node.js-339933?style=for-the-badge&logo=nodedotjs&logoColor=white" />
<img src="https://img.shields.io/badge/json-5E5C5C?style=for-the-badge&logo=json&logoColor=white" />
<img src="https://img.shields.io/badge/JavaScript-323330?style=for-the-badge&logo=javascript&logoColor=F7DF1E" />
## QUESTIONS:
You can contact via email- huntken26@gmail.com<br/>
Also checkout my linkedin- http://www.linkedin.com/in/kenny-hunter-fullstack<br/>
You can contact the company at- wipechicago@gmail.com <br/>
| React application for a local commercial cleaning company. | cleaningservice,freelance-work,frontend,javascript,reactjs | 2023-02-27T22:21:20Z | 2023-03-08T02:17:50Z | null | 1 | 0 | 12 | 0 | 1 | 2 | null | MIT | JavaScript |
MikixIT/pokefilter-db | main | # pokefilter-db
Pokémon filter web application! we will have the possibility to filter pokèmon by name and type of pokèmon, all developed using Javascript and using the API (https://pokeapi.co/)
# TRY IT HERE -> https://mikixit.github.io/pokefilter-db/
| Pokémon filter web application! we will have the possibility to filter pokèmon by name and type of pokèmon, all developed using Javascript and using the API (https://pokeapi.co/) | filter,javascript,pokemon | 2023-03-07T12:32:40Z | 2023-09-19T16:37:13Z | null | 1 | 0 | 70 | 0 | 0 | 2 | null | null | CSS |
melsayedshoaib/Quiz_App | main | # Quiz_App
This is a simple quiz app using OOP JavaScript
| This is a simple quiz app using OOP JavaScript | api,bootstrap5,css3,html5,javascript,jquery,oop,quiz,quiz-game,quizapp | 2023-03-03T03:21:09Z | 2023-03-03T03:27:55Z | null | 1 | 0 | 3 | 0 | 1 | 2 | null | null | HTML |
eraydmrcoglu/reactjs-food-ordering | master | # 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)
| Food Ordering App Created with React JS | css,food-delivery,food-delivery-app,food-ordering,javascript,react,react-redux,react-router,react-router-dom,react-slick-carousel | 2023-02-28T14:58:59Z | 2023-02-28T15:52:30Z | null | 1 | 0 | 6 | 0 | 3 | 2 | null | null | JavaScript |
MarkusDavis/NextJS-Ecommerce | main | # Next.js E-Commerce Website
The Next.js E-Commerce Website is a sleek and secure full-stack application built with React, Next.js, and Firebase. Users can browse, search, and purchase products with a responsive interface and user accounts for saving shipping information and tracking orders. This modern and elegant application is a great example of what can be achieved with Next.js for building e-commerce websites.
## Technologies Used
- React
- Next.js
- Firebase
- Other libraries
## Features
- Browsing, searching, and purchasing products
- Responsive user interface
- User accounts for saving shipping information and tracking orders
- Secure Firebase authentication and Firestore database
## Getting Started
1. Clone the repository
2. Install dependencies with `npm install`
3. Create a Firebase project and add the keys to `.env.local`
4. Run the project with `npm run dev`
## Credits
## License
This project is licensed under the GPL License. See `LICENSE` for more information.
## Contact
[@MarkusDavisDev](https://twitter.com/MarkusDavisDev) - feel free to contact me!
| This project is a web application built with Next.js, React, Tailwind CSS, and Firebase. It provides a platform for e-commerce and features browsing, searching, and purchasing products, a responsive user interface, and user accounts for saving shipping information and tracking orders. The application also features secure Firebase authentication. | ecommerce,firebase,javascript,nextjs,reactjs,tailwindcss | 2023-03-09T00:53:52Z | 2023-03-09T01:00:23Z | null | 1 | 0 | 4 | 0 | 2 | 2 | null | GPL-3.0 | JavaScript |
benjamin-milhet/benjamin-milhet.github.io | main | # benjamin-milhet.github.io
[](https://github.com/benjamin-milhet/benjamin-milhet.github.io/actions/workflows/pages/pages-build-deployment)
| Personal website | css3,cv,html5,javascript | 2023-02-27T17:43:43Z | 2024-03-09T16:48:44Z | null | 1 | 0 | 52 | 0 | 0 | 2 | null | MIT | HTML |
paulio11/P4-Squigl-Twitter-Clone | main | # Squigl
[Link to live site](http://squigl.herokuapp.com/)
## Contents
1. [Introduction](#introduction)
2. [Project Planning](#project-planning)
1. [Github Project](#github-project)
2. [Database Schema](#database-schema)
3. [Epics and User Stories](#epics-and-user-stories)
4. [Timeboxing](#timeboxing)
3. [User Experience](#user-experience)
1. [Wireframes](#wireframes)
2. [Design Choices](#design-choices)
1. [Typography](#typography)
2. [Images](#images)
3. [Colour Scheme](#colour-scheme)
4. [Layout](#layout)
4. [Features](#features)
1. [Site Wide Features](#site-wide-features)
2. [Specific Pages](#specific-pages)
3. [Unimplemented Features](#unimplemented-features)
5. [Bugs and Fixes](#bugs-and-fixes)
6. [Technologies](#technologies)
1. [Main Languages Used](#main-languages-used)
2. [Frameworks](#frameworks)
3. [Libraries](#libraries)
4. [Software and Other](#software-and-other)
7. [Testing](#testing)
8. [Deployment](#deployment)
9. [Credits](#credits)
1. [Code](#code)
2. [Text](#text)
3. [Images](#images-1)
4. [Acknowledgements](#acknowledgements)
## Introduction
Squigl is a Twitter clone, a social network built using the Django framework. Deployed to Gitpod.
This is the fourth milestone project required to complete my Diploma in Full Stack Software Development at [Code Institute](https://codeinstitute.net/). I was required to build a Full-Stack site based on business logic used to control a centrally-owned dataset. With an authentication mechanism that provides role-based access to the site's data. This was achieved using HTML, CSS, JavaScript, Python and the Django framework paired with a relational database.
The name comes from the use of ~ in front of usernames, used here in a similar fashion to @username tags on Twitter. The tilde symbol is on the same keyboard key as # (on a UK keyboard) so it was a natural pairing for me. Its appearance as a squiggly line inspired the project’s name.
The idea behind Squigl was to create an alternative to Twitter. I started on this project during the beginning of the recent Elon Musk Twitter drama. Basing this project on a pre-existing website helped aid planning early on, establishing expected goals and requirements for end users.
Squigl allows users to post short posts on their customizable profile pages. Follow other users, like, and comment on posts. Send private messages to each other. Be notified when they are mentioned. See popular trending topics or search for users and posts by a phrase keyword.
[Back to top 🔺](#squigl)
## Project Planning
### GitHub Project
The GitHub project board feature was used to keep track of what I was working on and what still needed to be done. I created a user story for each feature and moved them when necessary throughout the development of the site.
### Database Schema
The models required for this project are:
- **Post** - for user posts.
- **Reply** - for replies to the posts.
- **Message** - for private messaging between users
- **CustomUser** - my custom user model which includes additional fields for a user to customize their profile.
#### CustomUser Model
| Name | Type | Details | Notes |
|--|--|--|--|
| id | Primary Key | unique |
| username | CharField | unique, max_length=20, validators=[alphanumeric] | Used by the user to login and for their url, therefor it has to be unique. Alphanumeric validator ensures that user tagging works as punctuation breaks the script. |
| email | EmailField | unique | Used when a user attempts to reset their password. |
| name | CharField | max_length=30 | Included a max length so it doesn't break the size of html elements. |
| avatar | ResizedImageField | blank=True, upload_to='avatars/', size=[150, 150], crop=['middle', 'center'], force_format='WEBP' | The user's avatar is displayed as a small square. Cropped and resized to keep the file size low and the aspect ratio correct. |
| profile_background | ResizedImageField | blank=True, upload_to='backgrounds/', size=[600, 200], crop=['middle', 'center'], force_format='WEBP' | Cropped and resized to keep the file size low and the aspect ratio correct. |
| about | CharField | max_length=200, blank=true | Text to display on a user's profile. |
| website | CharField | max_length=50, blank=true | A website link to display on a user's profile. |
| verified | BooleanField | default=False | Text to display on a user's profile. |
| following | ManyToManyField | to self (CustomUser), blank=true | A list of followed users. |
| strikes | IntegerField | default=0 | Number of strikes gained, for moderation. |
#### Post Model
| Name | Type | Details | Notes |
|--|--|--|--|
| id | Primary Key | unique |
| user | Foreign Key | to CustomUser | The author of the post. |
| date | DateTimeField | auto_now_add=True | Date of post, automatically added on creation. |
| post | TextField | max_length=400 | Text content of the post. |
| image | ResizedImageField | blank=True, upload_to='post-images/', size=[600, None], force_format='WEBP' | Optional image for post. Cropped to a width of 600px and converted to WEBP. |
| link | CharField | max_length=50, blank=True | Optional website link. |
| likes | ManyToManyField | to CustomUser, blank=True | A list of users that liked the post. |
| repost_post | ForeignKey | to self (Post), blank=True | If this post is a repost this is the original post. |
| reported | ManyToManyField | to CustomUser, blank=True | A list of user that have reported the post (for moderation). |
| read | ManyToManyField | to CustomUser, blank=True | A list of users that have marked the post read (for mentions). |
#### Reply Model
| Name | Type | Details | Notes |
|--|--|--|--|
| id | Primary Key | unique |
| user | Foreign Key | to CustomUser | The author of the reply. |
| post | Foreign Key | to Post | The parent post of the reply. |
| date | DateTimeField | auto_now_add=True | Date of reply, automatically added on creation. |
| reply | TextField | max_length=400 | Text content of the reply. |
| hidden | BooleanField | default=False | The author of the parent post can hide inappropriate replies. |
| reported | ManyToManyField | to CustomUser, blank=True | A list of user that have reported the reply (for moderation).|
| read | ManyToManyField | to CustomUser, blank=True | A list of users that have marked the reply read (for mentions). |
#### Message Model
| Name | Type | Details | Notes |
|--|--|--|--|
| id | Primary Key | unique |
| sender | Foreign Key| to CustomUser | The user sending the message. |
| recipient | Foreign Key | to CustomUser | The user receiving the message. |
| date | DateTimeField | auto_now_add=True | Date of message, automatically added on creation. |
| message | TextField | max_length=400 | Text content of the message. |
| sender_del | BooleanField | default=False | True if the sender has deleted the message. |
| recipient_del | BooleanField | default=False | True if the recipient has deleted the message. |
| read | BooleanField | default=False | A user can mark a message as read, to remove it from unread messages. |
| reported | BooleanField | default=False | A user can report a message (for moderation). |
### Epics and User Stories
There will be three types of users visiting Squigl. A **new** or **logged out user**, a **registered user**, and **moderators**. User stories were logged as issues on GitHub to track them throughout the project - [Project Issues](https://github.com/paulio11/P4-Squigl-Twitter-Clone/issues?q=is:issue%20is:closed%20sort:created-asc). They were subject to manual testing at the end of the project to determine if I was successful with my objectives.
#### Epic - New or Logged Out Users
| User Story | Achieved? |
|--|--|
|As a new user I can **sign up** so that I can have my own account and use the full feature set of the website|✓|
|As a logged out user I can **sign in** so that I can return to my account|✓|
|As a logged out user I can **search squigl** so that I can find users, posts and replies that I am looking for|✓|
#### Epic - A registered user can view a feed of posts from followed users
| User Story | Achieved? |
|--|--|
|As a user I can **view my feed** so that I can see my own posts and posts of users I follow|✓|
|As a user I can **follow or unfollow other users** so that their posts appear in my feed|✓|
#### Epic - A registered user can customize their profile
| User Story | Achieved? |
|--|--|
|As a user I can **upload an avatar** so that it can represent me as a user|✓|
|As a user I can **add a link to my profile** so that I can share something important to me or another website relevant to my account|✓|
|As a user I can **add a short description to my profile** so that other users can find out more about me|✓|
|As a user I can **add an image as a background to my profile** so that I can further customize my profile|✓|
#### Epic - A registered user can create new posts and manage their posts
| User Story | Achieved? |
|--|--|
|As a user I can **create a new post** so that I can share something with my followers|✓|
|As a user I can **add an image to my post** so that I can share an image with my followers|✓|
|As a user I can **add a link to a website to my post** so that I can share a website with my followers|✓|
|As a user I can **like my own or someone else's post** so that I can show my support|✓|
|As a user I can **delete my own posts** so that I can remove them from my profile if necessary|✓|
|As a user I can **edit my posts** so that I can change them if necessary|✓|
#### Epic - A registered user can reply to posts and manage their replies
| User Story | Achieved? |
|--|--|
|As a user I can **add a reply to my own posts or someone else's** so that I can start or add to a conversation related to the post|✓|
|As a user I can **edit my replies** so that I can change what I said or fix a mistake|✓|
|As a user I can **delete my replies** so that I can remove them if I want|✓|
|As a user I can **hide a reply to my post** so that it can be hidden from other users if inappropriate or irrelevant|✓|
#### Epic - A registered user can privately message other registered users
| User Story | Achieved? |
|--|--|
|As a user I can **send a private message to another user** so that we can have a private conversation|✓|
|As a user I can **have a message inbox** so that I can read my private messages|✓|
|As a user I can **reply to my private messages** so that I can quickly respond to the sender and keep a conversation going|✓|
|As a user I can **delete a message** so that I keep my inbox clear and/or remove no longer useful messages|✓|
#### Epic - A registered user can report inappropriate content
| User Story | Achieved? |
|--|--|
|As a user I can **report a post** so that moderators are notified of inappropriate content|✓|
|As a user I can **report a reply** so that moderators are notified of inappropriate content|✓|
|As a user I can **report a message** so that moderators are notified of inappropriate content|✓|
#### Epic - A registered user can keep their account secure
| User Story | Achieved? |
|--|--|
|As a user I can **log out** so that my account remains secure and private when not in use|✓|
|As a user I can **delete my account** so that I can leave the website and remove all my content|✓|
|As a user I can **change my password** so that my account can remain secure|✓|
|As a user I can **reset my password** so that I can still log in if I have forgotten my password|✓|
#### Epic - A registered user be part of a conversation
| User Story | Achieved? |
|--|--|
|As a user I can **search squigl** so that I can find users, posts and replies that I am looking for|✓|
|As a user I can **repost another user's post** so that I can share it with my own followers|✓|
|As a user I can **create a hashtag in my posts and replies** so that I can be part of a larger conversation and contribute to trending topics|✓|
|As a user I can **tag other users in my posts, replies and messages** so that I can link directly to their profile|✓|
|As a user I can **see trending hashtags** so that I am aware of current popular topics of conversation|✓|
#### Epic - Moderation
| User Story | Achieved? |
|--|--|
|As a moderator I can **see reported items** so that I can act upon them|✓|
|As a moderator I can **delete or mark okay a reported item** so that it can either be deleted or removed from the reported items list where appropriate|✓|
|As a moderator I can **message users** so that we can talk to them with clearly labeled official messages|✓|
|As a moderator I can **see a list of users with strikes** so that troublesome users are clearly viewable and action can be take if necessary|✓|
|As a moderator I can **ban or unban a user** so that they can be banned or unbanned if necessary|✓|
### Timeboxing
Using MoSCoW prioritisation I categorised the features needed to meet the requirements of the user stories into the following categories:
#### Must Do
The final version of Squigl must be able to do the following:
- User signup
- User login
- Make new posts
- View posts
- Edit posts
- Delete posts
This would produce the **minimal viable product**.
#### Should Do
A more fully featured product would contain these features:
- Search
- Replying to posts
- Reading replies
- Editing replies
- Deleting replies
- Post liking
- Follow and unfollow users
- User settings
#### Could Do
And if there is extra time before then end these features could be included:
- User profile customisation
- User to user private messaging
- Notifications
An early version of Squigl would contain the following - every **must do** feature, from **should do**: post replying, user following, and from **could do:** user profile customisation (time permitting). Futher features can be added in later versions.
Fortunately due to the length of this project I was able to produce every feature.
[Back to top 🔺](#squigl)
## User Experience
### Wireframes
[Balsamiq for Desktop](https://balsamiq.com/wireframes/) was used ahead of development to plan the basic skeleton of all pages. You can download my wireframes file [here](https://github.com/paulio11/P4-Squigl-Twitter-Clone/blob/main/documentation/squigl-wireframes.bmpr).
<details>
<summary><strong>Feed page wireframe</strong></summary>
<img src="https://raw.githubusercontent.com/paulio11/P4-Squigl-Twitter-Clone/main/documentation/images/wf-feed.png">
</details>
<details>
<summary><strong>Post page wireframe</strong></summary>
<img src="https://raw.githubusercontent.com/paulio11/P4-Squigl-Twitter-Clone/main/documentation/images/wf-post.png">
</details>
<details>
<summary><strong>New post form wireframe</strong></summary>
<img src="https://raw.githubusercontent.com/paulio11/P4-Squigl-Twitter-Clone/main/documentation/images/wf-newpost.png">
</details>
<details>
<summary><strong>User page wireframe</strong></summary>
<img src="https://raw.githubusercontent.com/paulio11/P4-Squigl-Twitter-Clone/main/documentation/images/wf-user.png">
</details>
<details>
<summary><strong>Search page wireframe</strong></summary>
<img src="https://raw.githubusercontent.com/paulio11/P4-Squigl-Twitter-Clone/main/documentation/images/wf-search.png">
</details>
<details>
<summary><strong>Mobile wireframe</strong></summary>
<img src="https://raw.githubusercontent.com/paulio11/P4-Squigl-Twitter-Clone/main/documentation/images/wf-mobile.png">
</details>
### Design Choices
#### Typography
Fonts are imported from [Google Fonts](https://fonts.google.com/). The font used for the website logo and some usernames is [Fredoka One](https://fonts.google.com/specimen/Fredoka+One). To keep visual clutter to a minimum only two fonts are used. Fredoka One for elements that are important to the current page, and for the rest of the content the default bootstrap font is used. Simply increasing the font-weight creates enough contrast between titles and body text.
#### Images
The only images used on the website are those **added by users**. These include profile backgrounds, user avatars and images shared in posts. This keeps the focus where it should be - on the user generated content. A placeholder image is used in cases where a user has not yet uploaded an avatar.
#### Colour Scheme
Squigl uses a restrained colour-scheme. The design focuses mainly on off black text on a white background. The main content column is highlighted by a grey gradient background to draw user's eyes to the middle of the page. Colour mostly comes from the content added by users.
The colours used in the site logo represent two of the main pillars of squigl - users and trending topics. The letter "i" coloured goldenrod represents the users, as the "i" looks like a person and the colour is also used for the *verified tick* next to usernames. The indigo ~ is the same colour used for hashtags.
#### Layout
In desktop view the website is structured into three columns. The first being for navigation, the centre for the main content, and the right sidebar is for extra content. The centre column is the largest to highlight it's importance and draw the eye.
For smaller screens such as mobile the navigation shrinks and the right side bar hides - keeping focus on the centre column. The menu will include links to the Trending Hashtags and the Who To Follow pages when the right sidebar is hidden due to screen size.
<details>
<summary><strong>Desktop layout</strong></summary>
<img src="https://raw.githubusercontent.com/paulio11/P4-Squigl-Twitter-Clone/main/documentation/images/readme-desktop.png">
</details>
<details>
<summary><strong>Small desktop layout</strong></summary>
<img src="https://raw.githubusercontent.com/paulio11/P4-Squigl-Twitter-Clone/main/documentation/images/readme-desktop-small.png">
</details>
<details>
<summary><strong>Tablet layout</strong></summary>
<img src="https://raw.githubusercontent.com/paulio11/P4-Squigl-Twitter-Clone/main/documentation/images/readme-tablet.png">
</details>
<details>
<summary><strong>Mobile layout</strong></summary>
<img src="https://raw.githubusercontent.com/paulio11/P4-Squigl-Twitter-Clone/main/documentation/images/readme-mobile.png">
</details>
[Back to top 🔺](#squigl)
## Features
### Site-wide features
#### Header
- The header featured on every page is made of three parts. The site logo, a search box, and the logged in user's info.
- The logo returns a logged in user to their feed.
- Having search in the header encourages users to explore squigl.
- The user info links the user to their page and helps show that the user is signed in.
#### Navigation
- The user will navigate to all the main pages of the site using the menu in the left sidebar. Depending on the status of the current user this menu changes.
- A logged out or new user will see the options to login and sign up.
- A logged in user will see the full list of menu options.
- A moderator will see two further options, one for the Django admin and another for the moderation tools.
- Labels are removed from the menu at lower screen widths, on mobile this is then replaced with an expandable hamburger menu.
- If the logged in user has any unread mentions or messages the relevant menu link is highlighted and includes a count.
<details>
<summary><strong>Logged out navigation</strong></summary>
<img src="https://raw.githubusercontent.com/paulio11/P4-Squigl-Twitter-Clone/main/documentation/images/readme-loggedout-nav.png">
</details>
<details>
<summary><strong>Full desktop navigation</strong></summary>
<img src="https://raw.githubusercontent.com/paulio11/P4-Squigl-Twitter-Clone/main/documentation/images/readme-fullnav.png">
</details>
<details>
<summary><strong>Portrait tablet navigation</strong></summary>
<img src="https://raw.githubusercontent.com/paulio11/P4-Squigl-Twitter-Clone/main/documentation/images/readme-tablet-nav.png">
</details>
<details>
<summary><strong>Expanded mobile navigation</strong></summary>
<img src="https://raw.githubusercontent.com/paulio11/P4-Squigl-Twitter-Clone/main/documentation/images/readme-mobile-nav.png">
</details>
#### Scroll To Top Button
- A back to top button appears when scrolling below the header to further assist navigation.
- The JavaScript code that makes this work can be found in [this file](https://github.com/paulio11/P4-Squigl-Twitter-Clone/blob/main/static/js/script.js).
#### Centre Column
- The centre column houses the main content on every page, and is the only column to remain visible at every screen size.
#### Sidebar
- On the majority of pages the sidebar will show a list of recent trending hashtags and a random list of unfollowed users.
- On the post page the user will find the reply form here.
#### User Tagging
- User's can mention/tag other users in their posts, replies and messages by using ~ in front of their username.
- This functionality is made possible using JavaScript, the code that makes this work can be found in [templates/base.html](https://github.com/paulio11/P4-Squigl-Twitter-Clone/blob/main/templates/base.html).
- This code is included in the html file because it requires django template tags to function.
#### Hashtags
- Users can include hashtags in their posts and replies by using # in front of the desired keyword.
- This functionality is made possible using JavaScript, the code that makes this work can be found in [templates/base.html](https://github.com/paulio11/P4-Squigl-Twitter-Clone/blob/main/templates/base.html).
- This code is included in the html file because it requires django template tags to function.
**Example of a post with a tagged user and hashtags:**
#### Trending Hashtags
- JavaScript looks for a hidden `<div>` containing the last 100 posts that include `#` or in other words, a hashtag.
- The hashtag form inner html is extracted, the number of occurrences are counted, then sorted by value.
- Finally keys from this created JavaScript object are appended into the page html.
- The code that makes this work can be found in [this file](https://github.com/paulio11/P4-Squigl-Twitter-Clone/blob/main/static/js/script.js).
#### Modals
Modals are used where it's possible to make permanent irreversible changes. Giving the user a chance to reconsider.
- Deleting a post
- Deleting a reply
- Deleting a message
- Reporting a post
- Reporting a reply
- Reporting a message
- Moderator functions
- Account deletion
**Modal example:**
#### Django Messages
Django messages are implemented to provide the user with confirmation of their actions.
**Example message:**
### Specific pages
#### Error pages
- There are error pages for error [404](https://github.com/paulio11/P4-Squigl-Twitter-Clone/blob/main/templates/404.html), [500](https://github.com/paulio11/P4-Squigl-Twitter-Clone/blob/main/templates/500.html), and a [third one](https://github.com/paulio11/P4-Squigl-Twitter-Clone/blob/main/templates/error.html) for squigl specific error messages.
- A bootstrap alert is used to display the relevant error message.
- A button using JavaScript can send the user back one page if they want.
- Custom error messages are sent to the page from the relevant `views.py` file, often the else result of an if statement.
```
else:
e = 'You can not delete this post because you are not the author.'
return render(request, 'error.html', {'e': e})
```
**Error 404 example:**
#### Login and Sign up
- The default django login and sign up forms are used. Using [accounts/forms.py](https://github.com/paulio11/P4-Squigl-Twitter-Clone/blob/main/accounts/forms.py) I have added placeholder text to the html inputs to assist the user when signing up.
- In my CustomUser model I made email a requirement, this is so the user can reset their password, and this is reflected while signing up.
- The login page includes a link to password reset.
- Login is required for most of the functionality. A `@login_required` decorator is used where possible. In cases where this is not an alert will notify the user.
- A logged out user will be redirected to the login page if they attempt any of these actions:
- Change account settings such as password
- View, send, mark read, delete, report or reply to messages
- Any moderation only action
- View feed
- Make a new post
- Repost a post
- Report a post
- Follow or unfollow a suer
- View mentions
- Mark posts and replies as read
**New user sign up form**
#### Feed
- The home page for a logged in user.
- The feed displays a timeline of all the user's post and the posts of followed users.
- If there are no posts to display the user is encouraged to find users to follow.
- 20 posts are shown at a time, with pagination at the bottom so the user can navigate further into the timeline.
```
def feed(request):
following = request.user.following
posts = Post.objects.filter(
Q(user__in=following.all()) | Q(user=request.user))
paginator = Paginator(posts, 20)
page_number = request.GET.get('page')
page_obj = paginator.get_page(page_number)
return render(request, 'social/feed.html', {
'post_count': posts.count(),
'page_obj': page_obj,
})
```
**An example feed:**
#### Search
- All users can search squigl.
- The user input in the search form is used to filter through posts, replies, and users.
- Results can be filtered using the navigation below the page title.
- The number of results in each category are displayed.
- Replies shown in search results contain a link to the post they are a part of.
```
def search(request):
if request.method == 'POST':
query = request.POST['query'].strip().lower()
users = CustomUser.objects.filter(
Q(username__icontains=query) | Q(name__icontains=query)).order_by(
'username')
posts = Post.objects.filter(
post__icontains=query).order_by('-date')
replies = Reply.objects.filter(
reply__icontains=query).exclude(hidden=True).order_by('-date')
return render(request, 'social/search.html', {
'query': query,
'posts': posts,
'users': users,
'replies': replies,
})
else:
return render(request, 'social/search.html')
```
**Searching for users example:**
**Searching for posts example:**
#### User Page
- Every user that signs up has a profile page.
- This is where a user's posts will be shown regardless of if you follow them or not.
- Includes buttons to **Message** and **Follow/Unfollow** the user.
- If this is the logged in user's page then a **Edit Profile** button is shown instead.
- The user can choose to upload and display an avatar, a profile background image, a short description about themselves, change their profile name, and add a link to a website.
- User stats are also shown: Number of followers, number of users they are following, and number of posts.
- Like the Feed page, user posts are paginated.
```
def user(request, user):
queryset = CustomUser.objects
user = get_object_or_404(queryset, username=user)
posts = Post.objects.filter(user_id=user.id).order_by('-date')
following = False
paginator = Paginator(posts, 20)
page_number = request.GET.get('page')
page_obj = paginator.get_page(page_number)
if request.user.is_authenticated:
if request.user.following.filter(id=user.id):
following = True
return render(request, 'social/user.html', {
'user': user,
'page_obj': page_obj,
'post_count': posts.count(),
'following': following,
})
```
**User page example:**
#### New Post
- Placeholder text is included to guide a user when making a new post. You can see the code [here](https://github.com/paulio11/P4-Squigl-Twitter-Clone/blob/main/social/forms.py).
- A user has the option to include an image and/or a link to a website.
- Using the [django-reszied](https://pypi.org/project/django-resized/) package images are scaled to a width of 600px, this ensures images being shared with users of the website are not a large file size. This also has hosting benefits as well. Images are stored on [Cloudinary](https://cloudinary.com/).
- Once the form is submitted the user is redirected to the page for that post.
```
def new_post(request):
if request.method == 'POST':
form = PostForm(request.POST, request.FILES or None)
if form.is_valid():
post = form.save(commit=False)
post.user = request.user
post.save()
return redirect('post', post.id)
else:
return render(request, 'new/new-post.html', {'form': PostForm()})
```
**New post form:**
#### Post Page
- Each post has its own page, this can be accessed by clicking the post timestamp or permalink in the footer.
- On the post page a user can read and post their own replies.
- The date of the post is represented in a few ways.
- If the post is less than a minute old it shows as "Now".
- If the post is less than 24 hours old then "X hours ago" is shown.
- If the post is greater than 24 hours old then the published date will be shown.
- Each post shows a like count, reply count, repost count and a menu with further options. These are also shown wherever a post is displayed (feed, user page and search results).
- If the logged in user has replied and/or liked a post the relevant icons will be filled in.
- Clicking the repost icon or count will let the user repost the post by including it in a post of their own.
- A user can like a post without the need for a page reload thanks to Ajax. This code can be found [here](https://github.com/paulio11/P4-Squigl-Twitter-Clone/blob/main/templates/templates/post-template.html).
- Each post contains a drop down menu which includes the option to **Report** the post and a **Permalink**. If the logged in user is the author of the post, they will also see the **Edit/Delete** option.
- Each reply contains a button to **Report** the reply. If the logged in user is the author of the reply, they will also see the **Edit/Delete** option.
```
def post(request, post_id):
post = get_object_or_404(Post, id=post_id)
replies = Reply.objects.filter(post_id=post_id).order_by('-date')
if request.method == 'POST':
form = ReplyForm(data=request.POST)
if form.is_valid():
form.instance.user = request.user
form.instance.post = post
form.save()
return HttpResponseRedirect(request.path_info)
else:
return render(request, 'social/post.html', {
'post': post,
'replies': replies,
'form': ReplyForm(),
})
```
**An example of a post with replies:**
#### Mentions
- If a user is mentioned in a public post or reply they will be notified of this by an unread mention count in the menu.
- A user can view these posts and replies on their Mentions page.
- Posts and replies are excluded if the logged in user exists in their **read** `ManyToManyField`.
- Posts and replies can be marked as **Read** to clear the notification, and be excluded in the future.
```
def mentions(request):
posts = Post.objects.filter(post__icontains=request.user).exclude(
read=request.user).order_by('-date')
replies = Reply.objects.filter(reply__icontains=request.user).exclude(
hidden=True).exclude(read=request.user).order_by('-date')
return render(request, 'social/mentions.html', {
'posts': posts,
'replies': replies,
})
```
**An example of a user's mentions:**
#### Messages
- Two logged in users can privately message each other.
- A user can either be messaged using the **Message** button on their user page, or by replying to a message they have previously sent.
- As with mentions above, a user is notified of any unread messages with a count in the menu.
- A user can view unread, read and sent messages using the message page navigation.
- Each message has a drop down menu with the options **Mark Read**, **Reply**, **Report**, and **Delete**.
- If a sent message has been read by the recipient, the sender is notified.
- Messages from website moderators (django staff role) are labeled.
- A user can chose to delete a message. The message remains in the database until both the sender and recipient have both chosen to delete it.
```
def messages(request):
unread_messages = Message.objects.filter(
recipient=request.user).filter(read=False).order_by('-date')
messages = Message.objects.filter(
recipient=request.user).filter(read=True).exclude(
recipient_del=True).order_by('-date')
sent_messages = Message.objects.filter(
sender=request.user).exclude(sender_del=True).order_by('-date')
return render(request, 'dm/messages.html', {
'unread_messages': unread_messages,
'messages': messages,
'sent_messages': sent_messages})
```
**Example unread messages:**
**Example sent messages:**
#### Moderation
- Squigl moderators have access to the moderation page.
- Posts, replies and messages reported by users can be viewed here by moderators.
- A moderator can decide whether to ignore a report and mark the content as okay, or if necessary delete the content which will remove it and give the author a strike.
- Users with strikes can be viewed and messaged and banned or unbanned if necessary.
- All tables can be sorted by clicking on a column header. The code for this can be found [here](https://github.com/paulio11/P4-Squigl-Twitter-Clone/blob/main/static/js/script.js).
```
def moderation(request):
if request.user.is_staff:
reported_posts = Post.objects.annotate(
nreports=Count('reported')).filter(nreports__gt=0)
reported_replies = Reply.objects.annotate(
nreports=Count('reported')).filter(nreports__gt=0)
reported_messages = Message.objects.filter(reported=True)
users = CustomUser.objects.filter(strikes__gt=0).order_by('-strikes')
return render(
request,
'moderation/moderation.html', {
'reported_posts': reported_posts,
'reported_replies': reported_replies,
'reported_messages': reported_messages,
'users': users,
})
else:
e = 'Only Squigl moderators can view this page.'
return render(request, 'error.html', {'e': e})
```
**Example reported posts:**
**Example reported post modal:**
**Example naughty users list:**
### Unimplemented Features
If possible I would have liked to have implemented the following features:
- A dark mode theme.
- The ability to post other media such as videos including YouTube embeds.
- A server side trending hashtags list. The current implementation is built with JavaScript that runs client side.
- Improvements to the user pages, including a gallery of their shared images, and a list of their liked posts.
- Reposts would notify the author of the original post.
- Further styling. In my opinion this still looks too much like a Bootstrap website, even though there are almost 700 lines of CSS code!
- Inline private messaging. Replies to messages appearing as a conversation thread instead of individual separate messages.
- Some form of indication that a post or reply has been updated by the author.
- URLs shown as part of a post or on a user profile automatically converted into a working link without the need for a user to include "http://" etc.
[Back to top 🔺](#squigl)
## Bugs and Fixes
A lot of bug fixes relate to features that are no longer a part of this project so they are not documented. They are still visible via commits with the **Fix** preset. There are currently no known unfixed bugs.
|Bug|Cause|Fixed?|
|--|--|--|
|Sign page up not working|Incorrect url in view, using 'accounts' where the included default django view requires 'registration'|✓|
|Avatar in header displaying incorrectly|Wrong class applied to element|✓|
|Reply form not working|Missing `data=request.POST` parameter|✓|
|Incorrect display of 'Follower' and 'Followers' on user page|Incorrect comparison operator in django html tag|✓|
|Followers count not working|ManyToManyField in CustomUser model had a relation ship with the wrong model|✓|
|New reposts not linking to original post|`old_post` variable assignment outside of if statement|✓|
|EditProfile success url broken|Unnecessary `request.user` in kwargs|✓|
|Change password field missing on change password page|Hide password div javascript running on every page|✓|
|Hide reply not working|Missing `save()` reply function in view|✓|
|Reply indicator in post footer not working|Missing `request.user` from if statement|✓|
|User links and hashtags not working in reposts|Incorrect class on element|✓|
|HTML table sorting not functioning|Incorrect url value in javascript if statement|✓|
|Mentions notification in menu not functioning|Incorrect value in if statement|✓|
|CollectStatic failing|Missing `STATICFILES_STORAGE` variable in settings.py|✓|
|Suggested users showing when not logged in|Beginning of if statement on the wrong line|✓|
|Error page not shown when attempting to delete a message when not a moderator|Incorrect file path in render request|✓|
[Back to top 🔺](#squigl)
## Technologies
### Main Languages Used
- [Python](https://en.wikipedia.org/wiki/Python_(programming_language))
- [HTML5](https://en.wikipedia.org/wiki/HTML)
- The HTML is found in the [templates directory](https://github.com/paulio11/P4-Squigl-Twitter-Clone/tree/main/templates).
- [CSS3](https://en.wikipedia.org/wiki/CSS)
- You can see all my CSS [here](https://github.com/paulio11/P4-Squigl-Twitter-Clone/blob/main/static/css/style.css).
- [JavaScript](https://en.wikipedia.org/wiki/JavaScript)
- The majority of my JavaScript is [here](https://github.com/paulio11/P4-Squigl-Twitter-Clone/blob/main/static/js/script.js).
- Hashtag and user tagging functionality can be found [here](https://github.com/paulio11/P4-Squigl-Twitter-Clone/blob/main/templates/base.html).
### Frameworks
- [Bootstrap](https://getbootstrap.com/) - A frontend toolkit.
- [Django](https://www.djangoproject.com/) - A high-level Python web framework.
### Libraries
- [jQuery](https://jquery.com/) - A fast, small, and feature-rich JavaScript library. JQuery is linked in the `<head>` element instead of at the bottom of `<body>`, due to some of my inline JavaScript requiring JQuery.
- [crispy-bootstrap5](https://pypi.org/project/crispy-bootstrap5/) - A bootstrap5 template pack for django-crispy-forms. Includes [django-crispy-forms](https://pypi.org/project/django-crispy-forms/).
- [dj-database-url](https://pypi.org/project/dj-database-url/) - Enables the use of database URLS in Django.
- [django-cloudinary-storage](https://pypi.org/project/django-cloudinary-storage/) - A Django package that provides Cloudinary storages for both media and static files as well as management commands for removing unnecessary files.
- [django-resized](https://pypi.org/project/django-resized/) - Used to resize images uploaded by the user.
- [gunicorn](https://pypi.org/project/gunicorn/) - Gunicorn ‘Green Unicorn’ is a Python WSGI HTTP Server for UNIX.
- [oauthlib](https://pypi.org/project/oauthlib/) - A generic, spec-compliant, thorough implementation of the OAuth request-signing logic.
- [Pillow](https://pypi.org/project/Pillow/) - A Python Imaging Library that adds image processing capabilities to your Python interpreter.
- [psycopg2](https://pypi.org/project/psycopg2/) - Psycopg is the most popular PostgreSQL database adapter for the Python programming language.
- [PyJWT](https://pypi.org/project/PyJWT/) - JSON Web Token implementation in Python.
- [pytz](https://pypi.org/project/pytz/) - Allows accurate and cross platform timezone calculations using Python 2.4 or higher.
- [requests-oauthlib](https://pypi.org/project/requests-oauthlib/) - OAuthlib authentication support for Requests.
- [sqlparse](https://pypi.org/project/sqlparse/) - sqlparse is a non-validating SQL parser for Python.
- [Coverage](https://pypi.org/project/coverage/) - To check full for automated test coverage.
- [model-bakery](https://pypi.org/project/model-bakery/) - To create database objects for testing.
### Software and Other
- [ElephantSQL](https://www.elephantsql.com/) - Hosting of the PostgreSQL database used by squigl.
- [Balsamiq](https://balsamiq.com/) - For the creation of my wireframes during the planning stages.
- [GitHub](https://github.com/) - Repository hosting, commit history and project management with user stories.
- [Heroku](https://heroku.com/) - Squigl is deployed to Heroku.
- [Gitpod](https://www.gitpod.io/) - Used to write code and commit to GitHub.
- [Lighthouse](https://developer.chrome.com/docs/lighthouse/overview/) - For testing of site performance and used to check if the website meets accessibility guidelines.
- [Favicon.io](https://favicon.io/) - Creation of the favicon from an image.
- [Chrome Dev Tools](https://developer.chrome.com/docs/devtools/) - Used to debug and test website responsiveness.
- [Cloudinary](https://cloudinary.com/) - Hosting of images and other static files such as CSS and JS.
- [Font Awesome](https://fontawesome.com/) - Source of icons used in the menu and in posts/replies/messages.
- [Google Fonts](https://fonts.google.com/) - Fonts imported from Google Fonts, see Typography section above.
- [W3C Markup Validation Service](https://validator.w3.org/) - Used to validate HTML code.
- [Jigsaw CSS Validation Service](https://jigsaw.w3.org/css-validator/) - Used to validate CSS code.
- [JSHint JavaScript Code Quality Tool](https://jshint.com/) - Used to validate JavaScript code.
- [CI Python Linter](https://pep8ci.herokuapp.com/) - Used to validate my Python code.
- [Am I Responsive](https://ui.dev/amiresponsive) - Used to create the hero image at the top of this readme.
[Back to top 🔺](#squigl)
## Testing
Testing information can be found [here](https://github.com/paulio11/P4-Squigl-Twitter-Clone/blob/main/TESTING.md).
[Back to top 🔺](#squigl)
## Deployment
Deployment steps can be found [here](https://github.com/paulio11/P4-Squigl-Twitter-Clone/blob/main/DEPLOYMENT.md).
[Back to top 🔺](#squigl)
## Credits
### Code
- Code to make sure usernames are alphanumeric from [StackOverflow](https://stackoverflow.com/questions/17165147/how-can-i-make-a-django-form-field-contain-only-alphanumeric-characters).
- CSS for reply speech bubbles from [Codepen](https://codepen.io/rikschennink/pen/mjywQb).
- JavaScript to count occurrences of hashtags from [StackOverflow](https://stackoverflow.com/questions/14914046/counting-occurrences-of-a-word-in-a-string-javascript).
- Code to strip irrelevant time since information from post dates from [StackOverflow](https://stackoverflow.com/questions/6481788/format-of-timesince-filter).
- JavaScript to sort HTML tables from [StackOverflow](https://stackoverflow.com/questions/3160277/jquery-table-sort).
- Scroll to Top button code from [W3 Schools](https://www.w3schools.com/howto/howto_js_scroll_to_top.asp)
### Text
- Profile descriptions and posts from real life companies/individuals are taken from their respective Twitter profiles.
### Images
- Icons from [Font Awesome](https://fontawesome.com/).
- User avatars and profile backgrounds from real life companies/individuals are taken from their respective Twitter profiles.
### Acknowledgements
Thanks again to my mentor [Oluwaseun Owonikoko](https://github.com/seunkoko) and the [Code Institute](https://codeinstitute.net/) students from class June 2022 for their help, testing and suggestions throughout the project.
[Back to top 🔺](#squigl)
| A social network based on Twitter. | css,django,html,javascript,jquery,python,sql | 2023-03-07T18:42:30Z | 2024-04-10T14:56:14Z | null | 1 | 0 | 343 | 0 | 1 | 2 | null | null | Python |
Hive-Fundraiser/Front-End | main | # 🐝 Hive Fundraiser - Frontend 🐝
Welcome to the Hive Fundraiser frontend repository. Hive is an Iranian crowdfunding platform designed to help people raise funds for their personal or charitable causes. 🌟
### 🔧 Installation
A step by step series of examples that tell you how to get a development environment running.
```
docker compose up
```
## 🛠️ Built With
* [⚛️ React.js](link) - The web framework used
* [📡 Node.js](link) - Backend framework
* [🚀 Express.js](link) - Node.js framework used
* [🐍 Mongoose](link) - Object Modeling for Node.js
* [🔑 JWT](link) - Used for authentication
* [🎨 Figma](link) - Used for UI/UX design
## 📚 Curriculum
Below you can find all the subjects that we talked about in this tutorial:
- User authentication and authorization
- Create, edit, and delete campaigns
- Search and filter campaigns
- Donate to campaigns
- View campaign details and progress
- View user profile and campaign history
## 📐 UI/UX Design
The UI/UX design of Hive was created using Figma. You can view the design at [Figma Design](https://www.figma.com/file/59GZzb7DHjFcDfvLmhNzqa/Hive-UI%2FUX-Design?type=design&node-id=0%3A1&mode=design&t=qWUw9yUkp2IC6Tvv-1).
## 👥 Authors
* **Bardia Fardar** - *Software Engineer* - [Bardiafa](https://github.com/Bardiafa)
See also the list of [contributors](https://github.com/Hive-Fundraiser/Front-End/graphs/contributors) who participated in this project.
## 📄 License
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details
## 🙏 Acknowledgments
* Hat tip to anyone whose code was used
* Inspiration
* etc
| 🐝 Hive Project Front-End Repo | fundraising,help,hive,css,html,javascipt,javascript,platform,react,react-bootstrap | 2023-03-07T20:22:38Z | 2023-07-18T09:01:22Z | null | 3 | 1 | 199 | 0 | 0 | 2 | null | null | JavaScript |
saehaana/Heirloom | master | # Summary
This discord bot provides ease of access to data commonly utilized by Apex Legends users. If you want to check up on Apex in-game information **WITHOUT** launching the game, adding this bot to your server is a better alternative if you always leave your discord open. Otherwise you can stick to web searches or opening the game as that will fulfill the same purpose.
# Bot Invitation
Will be available for server invite on top.gg once enough features have been added.
# Command List
## User Commands
By default all user commands are prefixed with the `/` character.
e.g. To use the bot's map command, enter `/map`.
| Command | Options/Subcommands | Description |
|------------|------------------------|-------------------|
| craft | daily,weekly | Get daily and weekly crafting rotations from the replicator |
| create | role,title,team-size | Creates a matchmaking lobby. Click join or leave to queue or dequeue. When the queue is fulfilled or the role option is used players will receive notifications. |
| heirloom | setup,edit,count | Track your total Apex packs collected from past events |
| help | | Brings up documentation, support, and report sections |
| latest | patch,collection-event | Returns the latest patch notes and collection events as clickable links |
| map | ranked,unranked | View the current and next map along with their durations and start times |
| roll | max | Random number generator. Adding a number in the max option will set a roll range from 0 to max's value exclusively |
| status | | Checks online status of various Apex related services |
| store | | Get current in game shop bundles along with pricings. Displays both Apex Coins and Legend Tokens if available |
# API
This bot makes use of [Apex Legends Status](https://apexlegendsapi.com/#introduction), a public third party API.
As mentioned on their website, store data may not always be accurate/up to date as the project is still in beta.
| A lightweight Discord bot that provides quality of life services for Apex Legends players | nodejs,discord-bot,discord-js,javascript,shell,aws | 2023-03-04T00:25:53Z | 2024-03-30T00:34:35Z | null | 1 | 3 | 145 | 2 | 3 | 2 | null | MIT | JavaScript |
JeremyTallant/RetailSalesPredictor | main | # Fine-Grained Time Series Forecasting Prophet and Apache Spark
<img src="https://github.com/JeremyTallant/RetailSalesPredictor/blob/main/app/static/images/prophetimage.png" alt="Prophet">
This project aims to provide fine-grained time series forecasting using Prophet, a popular time series forecasting library developed by Facebook, and Apache Spark, a powerful distributed data processing framework. The forecasts will be displayed on a web page for easy access and interpretation.
## Table of Contents
- [Overview](#overview)
- [Installation](#installation)
- [Usage](#usage)
- [Data Preparation](#data-preparation)
- [Forecasting with Prophet](#forecasting-with-prophet)
- [Hyperparameter Tuning and Model Training on All Store-Item Combinations](#hyperparameter-tuning-and-model-training-on-all-store-item-combinations)
- [Results](#results)
- [Future Work](#future-work)
- [File Organization and Structure](#file-organization-and-structure)
## Overview
The primary goal of this project is to develop a scalable and efficient time series forecasting solution by leveraging the capabilities of the Prophet library and Apache Spark. The project will involve data preparation, model training, forecasting, and visualization. The web application will display the data, the model, and the forecast results on a single webpage for easy access and interpretation.
## Installation
To run this project, you'll need to install the necessary dependencies using pip. The required packages are listed in the requirements.txt file. You can install them by following these steps:
1. Clone the repository to your local machine:
```python
git clone https://github.com/JeremyTallant/RetailSalesPredictor.git
```
2. Navigate to the project directory:
```python
cd RetailSalesPredictor
```
3. Install the required dependencies from `requirements.txt`:
```python
pip install -r requirements.txt
```
3. Load the database schema from `model.sql` into the PostgreSQL database.
```python
pg_restore -U <username> -d <database_name> model.sql.dump
```
Here, `<username>` is the username of the PostgreSQL superuser, `<database_name>` is the name of the database you want to restore to, and `model.sql` is the name of the backup file you want to restore from.
## Usage
1. Ensure all the necessary libraries and dependencies are installed. You can refer to the `Installation` section in the README for guidance.
2. Navigate to the root directory of the project.
3. Run the app.py file using the command:
```python
python app.py
```
6. Open your web browser and navigate to http://127.0.0.1:5000 to view the home page of the web application.
<img width="1440" alt="Screenshot 2023-03-22 at 9 25 58 PM" src="https://user-images.githubusercontent.com/112406455/227085127-de2967de-45da-4c50-a973-7029053cffbc.png">
7. From the home page, you can navigate to the different pages to explore the data, model, and results of the project.
8. On the `Data` page, you can view the raw data and the visualizations of the time series data.
<img width="1440" alt="Screenshot 2023-03-22 at 9 26 15 PM" src="https://user-images.githubusercontent.com/112406455/227085406-7b6a6b92-4d80-477e-a426-0e36b0e0ea8b.png">
9. On the `Model` page, you can view the training and validation results of the Prophet model.
<img width="1439" alt="Screenshot 2023-03-25 at 8 01 34 PM" src="https://user-images.githubusercontent.com/112406455/227749625-e14fe379-2a8b-4855-9364-ff0e6c0a704a.png">
10. On the `Results` page, you can view both the predicted and actual values of the time series test data in a chart, along with a table that displays the evaluation metrics for the selected store and item combination.
<img width="1439" alt="Screenshot 2023-03-27 at 3 56 23 PM" src="https://user-images.githubusercontent.com/112406455/228065085-c2f0f592-b81e-49d5-a8bf-49b8c589e028.png">
11. To interact with the web application, you can use the navigation bar at the top of the page to move between the different pages.
12. If you want to stop the server, press `CTRL+C` in the terminal where the `app.py` script is running.
## Data Preparation
The data preparation phase is a critical step in any machine learning project. It involves cleaning and transforming the raw data into a format that can be used by the machine learning algorithms. In this project, the data preparation phase involves reading the raw data from a CSV file, changing the date column to datetime format, splitting the data into training and testing sets, and saving the processed data to separate CSV files.
To accomplish this, the Pandas library is used to read the CSV file and create a DataFrame. The date column is then converted to a datetime format using the `pd.to_datetime function`. The data is then split into training and testing sets using the `train_end_date` variable, which represents the end of the training data. The training and testing data are saved to separate CSV files in the `processed_data` folder.
By the end of this phase, the data is clean, formatted correctly, and ready for the machine learning phase.
## Forecasting with Prophet
This section describes the forecasting process using Prophet and Apache Spark. The code was implemented in Databricks, a cloud-based data engineering platform that provides an interactive workspace for data scientists, engineers, and analysts to collaborate on big data projects.
The forecasting process in this project utilizes Facebook Prophet, a time-series forecasting library. The data was first read into a Spark session and aggregated to the daily level. The data was then transformed to a Pandas DataFrame to use in Prophet.
The Prophet model was fitted to the historical data using the Prophet library's built-in functions. The Prophet model was then used to make future forecasts.
The metrics for evaluating the model were calculated using the mean absolute error (MAE), mean squared error (MSE), root mean squared error (RMSE), and mean absolute percentage error (MAPE). These metrics were calculated using the actual and predicted values of the historical data.
## Hyperparameter Tuning and Model Training on All Store-Item Combinations
To improve the accuracy of our forecasts, we performed hyperparameter tuning on the Prophet model using a grid search approach. We tested various combinations of parameters such as `changepoint_prior_scale`, `holidays_prior_scale`, `n_changepoints`, and `seasonality_mode` on a subset of the data. After analyzing the results, we selected the best set of parameters based on the Mean Absolute Percentage Error (MAPE) metric.
We then trained the Prophet model with the optimized set of parameters on all store and item combinations. The resulting models were stored in a dictionary with a tuple key of `(store, item)` for easy access.
We then used these models to make predictions on the test dataset for each store and item combination and computed evaluation metrics such as MAE, MSE, RMSE, and MAPE. The results are stored in a Pandas DataFrame called `metrics_df`.
Overall, this approach allowed us to improve the accuracy of our forecasts and make predictions for every store and item combination that was tested in the dataset.
## Results
The Facebook Prophet model was able to accurately predict the sales performance of Store 1, Item 1 based on historical data from January 1, 2013 to January 31, 2017. The model achieved a root mean squared error (RMSE) of 4.31, indicating that the predicted sales values were on average within +/- 4.31 units of the actual sales values. The model was able to capture the seasonal trends and overall sales performance of the item, with predicted sales values closely following the actual sales values. In addition to the RMSE, we also calculated several other metrics to evaluate the performance of the model:
* MAE (Mean Absolute Error): The MAE is 3.40, which means that on average, the model's predicted sales values were within +/- 3.40 units of the actual sales values.
* MSE (Mean Squared Error): The MSE is 18.60, which means that on average, the squared difference between the predicted and actual sales values was 18.60 units.
* MAPE (Mean Absolute Percentage Error): The MAPE is 20.37%, which means that on average, the model's predicted sales values were within +/- 20.37% of the actual sales values.
Overall, the model appears to have performed reasonably well for Store 1, Item 1, with RMSE, MAE, MSE, and MAPE values indicating that the predicted sales values were generally within a few units or percentage points of the actual sales values. To evaluate the scalability and practicality of our Facebook Prophet model, we deployed it on all store and item combinations and stored the results in a dataframe. This allowed us to easily access and analyze the predicted sales values for each combination using simple queries.
The results of the model were encouraging, with the predicted sales values closely following the actual sales values for most store and item combinations. The model was able to capture seasonal trends and overall sales performance, making it a useful tool for forecasting sales in retail stores.
With the ability to easily access and analyze the results for each store and item combination, our Facebook Prophet model has the potential to be a valuable tool for retailers looking to forecast sales performance and optimize their inventory management. Future work could include incorporating external factors such as weather or promotions into the model to further improve its accuracy and practicality.
## Future Work
Although our pre-trained Facebook Prophet model provides accurate sales forecasts for a range of store and item combinations, there is still room for further improvement and development. Here are a few potential areas for future work:
**Dynamic Updating**: Currently, our model is trained on historical sales data and is not updated in real-time. A possible improvement could be to build a mechanism to dynamically update the model as new sales data becomes available. This could help ensure that the forecasts remain accurate and up-to-date.
**Integration with Inventory Management Systems**: Our web application currently provides retailers with sales forecasts, but it does not include recommendations for inventory management. An interesting area for future work could be to integrate our forecasts with inventory management systems to provide retailers with real-time recommendations for optimal inventory levels.
**Expansion of Model Capabilities**: While our pre-trained model is effective at forecasting sales trends and handling missing data, there may be other factors that impact sales performance that are not currently accounted for in the model. Future work could involve expanding the model to include additional factors such as marketing campaigns, seasonal trends, or external events.
**User Interface Improvements**: While our web application provides a user-friendly interface for visualizing sales forecasts, there is always room for improvement in terms of usability and design. Future work could involve incorporating feedback from users and incorporating improvements to make the interface even more intuitive and user-friendly.
Overall, there are many exciting directions for future work on this project, and we look forward to continuing to improve and expand upon our current capabilities.
## File Organization and Structure
* `app/` contains the Flask web application, with static files (`css`, `js`, and `images`) and templates.
* `data/` contains the raw `store.csv` data and processed data, including the `processed_data/` folder with `test_data.csv` and `train_data.csv`.
* `database/` contains the `model.sql` file with the schema of the database used to store data for rendering in the Flask app.
* `notebooks/` contains Jupyter notebooks for data exploration, preprocessing, and model training.
* **Note** that there are two files for model training: `model_training.ipynb` and `model_training.dbc`. We used a regular Jupyter notebook for `model_training.ipynb` because we were using the free trial version of Databricks and were unable to save the results of the model into a PostgreSQL database using Databricks.
* `README.md` is the main file containing the documentation and instructions for the project.
* `requirements.txt` lists the required Python packages and their versions.
| This project focuses on leveraging the capabilities of Facebook's Prophet library and Apache Spark to deliver accurate and efficient fine-grained time series forecasting. The results are visualized and accessible through an interactive web interface, providing users with an intuitive way to interpret the forecasts and make data-driven decisions. | css,databricks,flask,html,javascript,plotly,postgresql,prophet,python,spark | 2023-03-11T15:46:21Z | 2023-03-28T05:27:39Z | null | 5 | 0 | 65 | 0 | 0 | 2 | null | null | Jupyter Notebook |
n2duc/evondev-react | main | # Getting Started Learning ReactJS with [Evondev](https://evon.dev/)
- I'm learning ReactJS. Let's develop together.\
Course [ReactJS Evondev](https://ktclick.com/invite/333702752127).\
Course [HTML CSS Master Evondev](https://ktclick.com/invite/391900256373).
## `npm start`
## Knowledge
- Prop
- Fragment
- Portal
- ErrorBoundary
## ReactHook
### [useState](https://react.dev/reference/react/useEffect)
### [useReducer](https://react.dev/reference/react/useReducer)
### [useEffect](https://react.dev/reference/react/useState)
### [useRef](https://react.dev/reference/react/useRef)
### [useCallback](https://react.dev/reference/react/useCallback)
### and Custom Hook
## React Hook Form - Form Validation
- [Yup](https://www.npmjs.com/package/yup)
- [Formik](https://formik.org/docs/overview)
- [react-hook-form](https://react-hook-form.com/)
## Style Sheets with React
- [Style components](https://styled-components.com/docs/basics)
- [SCSS](https://sass-lang.com/)
- [Tailwind-CSS](https://tailwindcss.com/docs/installation)
## Project / Pet-project
- Tic-Tac-Toe
- Photo Loading
- HackerNews
- Movie Search
- SignUpForm-[Yup, Formik] | Evondev's Basic to Advanced Reactjs Course | react,reactjs,javascript,react-hooks | 2023-03-09T02:56:35Z | 2023-06-17T16:26:06Z | null | 1 | 0 | 38 | 0 | 0 | 2 | null | null | JavaScript |
Arafa-Tech-Foundation/Courses | main | null | 🤓 Arafa Tech's coding courses for students. Empowering futures through education. | arafa-tech,javascript,python | 2023-02-26T03:10:58Z | 2023-05-23T23:22:40Z | null | 5 | 0 | 94 | 0 | 1 | 2 | null | MIT | null |
Huseyin-Cinar/web-apps | main | <div align="center">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://socialify.git.ci/Huseyin-Cinar/web-apps/image?description=1&font=Raleway&forks=1&issues=1&owner=0&pulls=1&pattern=Solid&stargazers=1&theme=Dark">
<img src="https://socialify.git.ci/Huseyin-Cinar/web-apps/image?description=1&font=Raleway&forks=1&issues=1&owner=0&pulls=1&pattern=Solid&stargazers=1&theme=Light">
</picture>
</div>
# web-apps
This repository includes apps where applications programmed on the internet by our software team are compiled. Made with ❤️ Open Source.
## [Click for detailed explanation](https://futuree.netlify.app/kodlama)
## [Author's Github](https://github.com/Huseyin-Cinar)
## [See more repo like this](https://github.com/Huseyin-Cinar?tab=repositories)
<br><br>
***Author's Media Accounts;***
- Instagram
- [@huseyinn.cinar](https://instagram.com/huseyinn.cinar)
- Twitter
- [@Hseyinn59612876](https://twitter.com/Hseyinn59612876)
- Facebook
- [@mrbeast](https://facebook.com/mrbeast6000)
- Discord
- [Black Death#3957](https://discord.com/users/782246367204605953)
- Discord Server
- [Join](https://futuree.netlify.app/dc)
- My Website
- [Click](https://futuree.netlify.app/en)
| This repository includes apps where applications programmed on the internet by our software team are compiled. Made with ❤️ Open Source. | css3,html5,javascript,madewithlove,open-source,webapp | 2023-02-28T07:34:02Z | 2023-07-03T17:56:28Z | null | 2 | 0 | 35 | 0 | 1 | 2 | null | MIT | CSS |
AvinashPatel15/Warm-Dirt-3394-Hackathon | main | # Welcome to Tech Memory Game <img src="https://raw.githubusercontent.com/MartinHeinz/MartinHeinz/master/wave.gif" width="30px">
---
**Introduction**
---
This is a Gaming Website which is created by a total of four members in a Hackathon in Masai in a total of 48 hours. It is a Memory-based game where users have to match the pairs of Tech Cards. Once the user is able to match all the tech cards then the time will be stored in Our Leaderboard. The leaderboard is independently dependent on the Total number of wins.
## Tech-stack used
```
Frontend: React JS, TypeScript, Chakra-UI
Backend : ExpressJS, NodeJS
Database: MongoDB
Frontend Deployment: Vercel
Backend Deployment: Cyclic
```
## Features
| Serial No | Feature |
| ----------------- | ------------------------------------------------------------------ |
| 1 | User signup and Login |
| 2 | Nodemailer to verify the real email address|
| 3 | Homepage, Gamepage, Leaderboard|
**Sample Page Images**
---
**1) Home Page**
---
<a href="https://ibb.co/pXrvSWs"><img width="960" alt="image" src="https://user-images.githubusercontent.com/107500115/222908157-8960fa11-95d4-4e2e-ad08-db8fe3c11128.png"></a>
**2) User Login Page**
---
<img width="947" alt="image" src="https://user-images.githubusercontent.com/107500115/222908214-cbb388ae-5e5c-4bda-ab3c-0d97881e1414.png">
**3) Game Page**
---
<img width="946" alt="image" src="https://user-images.githubusercontent.com/107500115/222908293-fe89659c-c1c7-4ccf-8441-eb2cbead2d4f.png">
**4)Leaderboard Page**
---
<img width="946" alt="image" src="https://user-images.githubusercontent.com/107500115/222908381-46d7e167-aed4-40a9-8e7b-894ab71bacfd.png">
| This is a Gaming Website which is created by total of four members in Hackathon in Masai in total of 48 hours. | chakra-ui,css3,html5,javascript,react-js,scss,typescript | 2023-03-02T11:17:26Z | 2023-09-15T14:26:42Z | null | 4 | 15 | 85 | 0 | 1 | 2 | null | null | TypeScript |
shotit/shotit-media | main | # Shotit-media
[](https://github.com/shotit/shotit-media/blob/main/LICENSE)
[](https://app.codecov.io/gh/shotit/shotit-media/branch/main)
[](https://github.com/shotit/shotit-media/actions)
[](https://github.com/shotit/shotit-media/releases/latest)
[](https://hub.docker.com/r/lesliewong007/shotit-media)
[](https://hub.docker.com/r/lesliewong007/shotit-media)
### Media broker for serving video preview for [shotit](https://github.com/shotit/shotit)
This server uses a "video scene cutter" which automatically detect timestamp boundaries of a shot, and then trim the shot out without leaking / exposing other frames that belongs to previous / next scenes.
#### Background of this project
When search result from shotit returns a TV & film, episode and a timecode, it can generate a video preview for the scene at that time code.
Query image:
Search result: `Shelter, episode 1, timecode: 00:00:51.83`
Video Preview at time `00:00:51.83`
| Fixed offset without shotit-media | Auto detect with shotit-media |
| :------------------------------------------------------: | :------------------------------------------------------: |
|  |  |
| 00:50.93 (-0.9) to 00:53.93 (+2.1) | 00:49.22 to 00:51.30 (dynamic) |
By using first / last frames from the fixed offset preview, user may be able to use that to search again and reveal previous/next scene of the original video. By repeating this process, users may eventually read the whole video until the rate limit/search quota used up.
With the video preview generated by auto detect method, searching any frame form the preview would only results the same video preview. This prevents leaking the previous/next scene.
### How does it work
To be completed
### Getting Started
```bash
> git clone https://github.com/shotit/shotit-media.git
>
> cd shotit-media
>
> # Copy .env.example to .env
> touch .env.example .env
>
> # Launch shotit-media server as well as its dependent services
> docker-compose up -d
```
Since some of the following endpoints are secured by the `TRACE_API_SECRET` environment variable, please put `x-trace-secret` in HTTP header when sending requests.
#### Verify status
```
GET http://127.0.0.1:3000/ -> OK
```
#### List files
```shell
# Need x-trace-secret header
GET http://127.0.0.1:3000/list/
```
#### Video URL
```shell
# Need x-trace-secret header
GET http://127.0.0.1:3000/file/tv_film_title/episode_number.mp4
```
For this URL endpoint, use HTTP Method PUT, DELETE to upload and delete files.
#### Video Preview URL
```
GET http://127.0.0.1:3000/video/tv_film_title/episode_number.mp4?t=87
```
You can use the `&size=` param to specify preview size (l: 640, m: 320, s: 160)
```
GET http://127.0.0.1:3000/video/tv_film_title/episode_number.mp4?t=87&size=l
```
You can use the `&mute` param to generate a muted video (like GIF)
```
GET http://127.0.0.1:3000/video/tv_film_title/episode_number.mp4?t=87&size=l&mute
```
#### Image Preview URL
```
GET http://127.0.0.1:3000/image/tv_film_title/episode_number.mp4?t=87
```
You can use the `&size=` param to specify preview size (l: 640, m: 320, s: 160)
```
GET http://127.0.0.1:3000/image/tv_film_title/episode_number.mp4?t=87&size=l
```
### Environment variables
```
VIDEO_PATH= # e.g. /mnt/data/imdb/
SERVER_PORT= # e.g. 3001
SERVER_ADDR= # e.g. 127.0.0.1 or 0.0.0.0
TRACE_MEDIA_SALT= # define any random string, or leave blank to disable secure token
TRACE_API_SECRET= # same as TRACE_API_SECRET in shotit-api's .env, or leave blank to disable auth(Not recommended)
AWS_BUCKET= # e.g. shotit-media
AWS_ENDPOINT_URL= # e.g. http://127.0.0.1:9000
AWS_REGION= # e.g. us-east-1
AWS_ACCESS_KEY= # e.g. minioadmin
AWS_SECRET_KEY= # e.g. minioadmin
```
### Local Development Guide
```shell
git clone https://github.com/shotit/shotit-media.git
cd shotit-media
yarn install
```
### Configuration
- Copy `.env.example` to `.env`
- Edit `.env` as appropriate for your setup, as is for the first time.
### Dependent Services
- minio
- etcd
Comment out the `media` service at `docker-compose.yml`, then:
```
docker-compose up -d
```
### Start Development
You can use pm2 to run shotit-media server in background in cluster mode.
Use below commands to start / restart / stop server.
```
yarn start
yarn stop
yarn reload
yarn restart
yarn delete
yarn logs
```
To change the number of nodejs instances, edit ecosystem.config.json
| Media broker for serving video preview for shotit | approximate-nearest-neighbor-search,distributed,image-search,javascript,nearest-neighbor-search,node,nodejs,search,search-engine,vector | 2023-02-26T17:02:58Z | 2023-08-02T19:40:37Z | 2023-08-02T19:40:37Z | 4 | 294 | 465 | 0 | 0 | 2 | null | Apache-2.0 | JavaScript |
sunilkumarroy450/elspectra | main | # El Spectra #
# Cats Clicker App #
<a href="https://astounding-taiyaki-f3e1ad.netlify.app/" >Deployed Link</a>
BASE_URL='https://puzzled-toad-kilt.cyclic.app/'
Unique Deploy URL: https://643fb4aa2f1c0400c97a1757--astounding-taiyaki-f3e1ad.netlify.app
| It is an assignments give by a company called El Spectra, It is a single page app for a better user experience, where I used react for fronted and node for backend | chakra-ui,cors,css,expressjs,html,javascript,mongodb,mongodb-atlas,mongoose,nodejs | 2023-03-03T15:54:13Z | 2023-04-19T09:33:13Z | null | 1 | 0 | 34 | 0 | 0 | 2 | null | null | JavaScript |
devlak2001/car-game | main | null | "Muscle Car Game": Drive, survive, and compete for high scores on an endless highway. Intuitive controls, dynamic visuals, and seamless gameplay across desktop and mobile. Launch your browser and hit the road! 🚗💨 | blender,game,game-development,javascript,threejs,web,vite,html,scss | 2023-03-11T17:42:31Z | 2023-03-12T18:36:59Z | null | 1 | 0 | 14 | 0 | 0 | 2 | null | null | JavaScript |
ArslanYM/DailyJournal | main | # DailyJournal
Minimalist Daily Journal Web App using EJS and node modules.
| Minimalist Daily Journal Web App using EJS and node modules. | daily-journal-application,ejs,ejs-express,ejs-templates,express,javascript,minimalist | 2023-03-01T15:54:17Z | 2023-03-08T16:08:23Z | null | 1 | 0 | 7 | 0 | 0 | 2 | null | null | JavaScript |
Temyturpe/Tech1m-group3-project | master | # Tech1m-group3-project (Tech1m Junior)
Final project for the tech1m frontend development bootcamp program. Tech1m junior is platform where children with passion for tech are taught. This platform gives children access to well selected and explained tech courses that makes lerning fun for them. The platform also allows the instructors to pass information and courses to students. It also allows the instructor to track the progress of the students and view all submitted assignments. This project is also mobile responsive.
# Contributors:
* [Temitope Okesanya](https://github.com/Temyturpe)
* [Nnaemeka Egba](https://github.com/egba001)
* [Ololade Akinrinsola](https://github.com/Lolaakinrinsola)
# About the project
Tools used to create this project:
* React Js (Javascrip framework) 
* Firebase (for form authetication) 
* Tailwindcss (Css Library) 
* Chart Js ( for bar-chart) 
* Formik ( for form)
* DayJs ( for calender)
* React Icons (for icons)
* React Router (for routing) 
* NPM 
This website includes 9 pages:
# page1: (welcome page)
This page is the welcome page and it asks users if they either want to log in as old users or sign up as new users either as students or instructors.
# Page2: (login / signup)
This page content is dependent on which ever button is clicked in the first page. If users choose signup the page show form for signing up, but if users click log in, the page displays a login form. When the user inputs a wrong password or email on the Login page, it displays an error of invalid password/username. The user can then go to the sign up page to create a new account or go to the forgot password page to reset their password. While on the Sign up page, if the user inputs an email that exists on the database, it displays a 'user already exists' error.
# Page3: (forgot password)
This page is for users that need to recover their passwords. after filling the form, a link is sent to the user's registered email for password recovery. An email that does not exist on the database would display an error of 'user does not exist'.
# Page4: (Home)
This page is the home where all general details are displayed.
# Page5: (Course)
This page displays all courses and their details.
# Page6: (students)
This page displays all the students and their details in a table.
# Page7: (payment)
This page displays all the payments made by the students and their details such as status of the payment.
# Page8: (quiz and assignments)
This page shows all the assignments and quiz that have been submitted by students for the instructor to assess
# Page9: (messages)
This page show messages sent to users.
# Live Demo
This project is hosted on vercel 
[Live Demo](https://tech1m-group3-project.vercel.app/)
# To clone this repository:
* copy the url: https://github.com/Temyturpe/Tech1m-group3-project.git and in your vscode or github desktop,
* open project in vscode and run: "npm install" to install all dependencies,
* then run "npm run start" to view on browser
| Final project for the tech1m frontend development bootcamp prgram | reactjs,tailwindcss,chartjs,dashboard,figmadesign,group-project,javascript | 2023-03-10T07:58:19Z | 2023-03-20T17:56:25Z | null | 3 | 19 | 82 | 0 | 1 | 2 | null | null | JavaScript |
Shubhamgulik/spotify-clone | main | ### View Live : https://spotify-clone-eb998.web.app/
### SPOTIFY LOGO
### Login with spotify button
###
# 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)
| null | firebase-auth,hooks,html-css-javascript,javascript,jsx-templates,reactsjs,redux,redux-toolkit,spotify-api,spotify-clone | 2023-03-11T10:56:59Z | 2023-03-11T11:46:05Z | null | 1 | 0 | 3 | 0 | 0 | 2 | null | null | JavaScript |
beginner-cryptonyx/Job-Descriptions | master | # **Job Description Generator**
This Website is designed for generating a job descripon based on __*skills*__ and __*exprience*__.
---
## Features:
> - Skill list input
>
> - Years of experiance feild
>
> - Output Button
>
> - Spinner Loader for API response time
>
> - API response screen
>
> - Reload Functionality
>
---
## Languages Used:
|Part of Site | Language |
|----|--------|
|Server | Python-Flask [^1] |
|API's | <mark>OpenAI-GPT3 API</mark> [^2] |
|Front-End | HTML<sup>5</sup> and CSS<sup>3</sup> |
|Server to User | Javascript |
---
[^1] : Secret Key will be needed
[^2] : API key is needed
| Generate a Job Description | api,chatgpt,css,fetch,flask,gpt-3,html,html-css-javascript,javascript,jobs | 2023-03-08T15:38:58Z | 2023-03-09T08:40:41Z | null | 1 | 0 | 10 | 0 | 0 | 2 | null | CC0-1.0 | CSS |
lack21/YOGO | main | # YOGO
Website Project
Tools Used:
• HTML
• SCSS
• JS
Design from this project I copied from this video https://www.youtube.com/watch?v=pIvrUBAqn_g
Link : https://lack21.github.io/YOGO/
| Website Project | html5,javascript,scss | 2023-02-28T14:13:41Z | 2023-02-28T14:23:55Z | null | 1 | 0 | 3 | 0 | 0 | 2 | null | null | CSS |
navodveduth/Factory-Management-System | master | # Project Name - Factory Management System ITP Project
# Batch - WD_B02_ITP_14
### Group Leader - IT21003028 - Minod Perera (IT21003028)
### Member 2 - IT21003332 - Devindu Samarasinghe (IT21003332)
### Member 3 - IT21004322 - Chanukya Serasinghe (IT21004322)
### Member 4 - IT21006166 - Shafa Bishirhafi (IT21006166)
### Member 5 - IT21110948 - Navod Weerawarna (IT21110948)
### Member 6 - IT21151392 - Janindu Dissanayake (IT21151392)
### Member 7 - IT20159030 - Sachini Lekamge (IT20159030)
### Member 8 - IT21128868 - Devinya Vidanage (IT21128868)
#### Brief Description of Project - This is a web based factory management system with the folllowing capabilities.
1. Employee management
2. Finanace managemnt
3. Sales management
4. Production management
5. Stock management
6. Supplier management
7. Machinery and maintenance management
8. Transport management
#### Technologies used - MongoDB, Express, React, Node JS
Note - The student's github account should be given in brackets e.g. (asiriRepos), this ideally should be your student id
| Web based factory management system for Lanka Mount Castle Pvt Ltd | javascript,jwt-authentication,mern,nodejs,reactjs,synfusion,tailwindcss,typescript,mongodb | 2023-03-01T14:26:02Z | 2022-12-27T03:34:54Z | null | 8 | 0 | 1,669 | 0 | 0 | 2 | null | null | JavaScript |
SaraKhamisMostafa/Calculator | main | # Calculator
| Online Calculator Website | css,html,javascript | 2023-03-09T21:45:35Z | 2023-03-09T22:11:49Z | null | 1 | 0 | 3 | 0 | 0 | 2 | null | null | HTML |
Satyam1013/BlijMart | main | null | It's an e-commerce website for electronics item. | bootstrap,css3,html5,javascript,php | 2023-03-08T11:23:03Z | 2023-03-11T13:15:29Z | null | 2 | 1 | 14 | 0 | 0 | 2 | null | null | HTML |
kodie/hashjump | main | null | A tiny, dependency-free JavaScript module for handling anchor links and scrolling elements into view. | anchor,easing,javascript,no-dependencies,no-jquery,scrolling,frontend,vanilla-javascript,vanilla-js | 2023-03-05T17:26:33Z | 2023-04-01T22:32:31Z | null | 1 | 0 | 11 | 1 | 0 | 2 | null | MIT | JavaScript |
rohiniee0028/tars-app | master | Deployed link : https://tars-app-xi.vercel.app/ | React.js Image Gallery web app with an Image Search feature using Unsplash Image API | chakra-ui,css,javascript,react-router,reactjs,usecontext-hook | 2023-02-27T13:42:31Z | 2023-02-27T17:53:53Z | null | 1 | 0 | 4 | 0 | 0 | 2 | null | null | JavaScript |
ganeshkbhat/numericalarrays | main | # numericalarrays
`ndarrays` offers `numerical arrays` which is a comprehensive mathematical functions, `random number generators`, `linear algebra routines`, `Fourier transforms`, and more like `NumPy`, `Scipy`, `Scikit-learn`, `Statistics`, `Six Sigma` Functions, `D3` Graphs for scientific graphs. The goal was to be as near as NumPy as possible, however, a combination of a few packages were being done to make this a comprehensive port for major Python Scientific packages.
The version 0.0.2 will start having the actual usable ndarrays which is a python numpy like module.
- rlib:
```
```
- regression:
```
```
- pickle:
```
```
- extenders:
```
```
- stats:
```
```
- streamStats:
```
```
- pyc:
Usage:
```
const { loadPyodide } = require("ndarrays").pyc;
async function main() {
let pyodide = await loadPyodide();
console.log(pyodide.runPython(`
import sys
sys.version
`));
};
main();
```
Following Packages have been used. A comprehensive package documentation will be done for the package.
- `atoll`: `^0.7.4`,
- `blasjs`: `^1.0.15`,
- Basic Linear Algebra SubPrograms (BLAS)
- `d3-regression`: `^1.3.10`,
- Linear, Exponential, Logarithmic, Quadratic, Polynomial, Power law, LOESS
- `datalib`: `^1.9.3`,
- `extenders`: `^0.0.2`,
- `jerzy`: `^0.2.1`,
- `lib-r-math.js`: `^2.0.0`,
- `mathjs`: `^11.8.2`,
- `mod-pickle`: `^0.0.3`,
- `natural`: `^6.5.0`,
- `pyodide`: `^0.23.3`,
- `scientist.js`: `^0.0.1`,
- Liner Algebra, Statistics
- `simple-statistics`: `^7.8.3`,
- `stream-statistics`: `^0.4.0`,
- `vega-statistics`: `^1.9.0`
| numericalarrays offers comprehensive mathematical functions, random number generators, linear algebra routines, Fourier transforms, and more like NumPy. The goal is to be as near as NumPy as possible | array,array-prototype,arrays,javascript,linear-algebra,matrix,numerical,numpy,python,scientific-computing | 2023-02-27T13:35:28Z | 2024-03-09T07:14:09Z | null | 1 | 2 | 26 | 0 | 0 | 2 | null | MIT | JavaScript |
Samuel-Ricardo/ExpertMax | main | # ExpertMax
<p align="center">
<a href="https://cursos.erickwendel.com.br/">
<img width="auto" src="./readme_files/image"/>
</a>
</p>
<h4 align="center" >🚀 🟩 Semana JS Expert - 2023 🟩 🚀</h4>
<h4 align="center">
Application developed during a JavaScript Event, the <a style="color: #8a4af3;" href="https://github.com/search?q=js+expert" target="_blank">JS Expert #07</a> promoted by <a style="color: #8a4af3;" href="https://cursos.erickwendel.com.br/" target="_blank">@ErickWendel</a>
</h4>
#
<p align="center">
|
<a style="color: #8a4af3;" href="#project">Overview</a> |
<a style="color: #8a4af3;" href="#techs">Technologies</a> |
<a style="color: #8a4af3;" href="#app">Project</a> |
<a style="color: #8a4af3;" href="#run-project">Run</a> |
<a style="color: #8a4af3;" href="#author">Author</a> |
</p>
#
<h1 align="center">
<a href="https://github.com/Samuel-Ricardo">
<img src="https://img.shields.io/static/v1?label=&message=Samuel%20Ricardo&color=black&style=for-the-badge&logo=GITHUB"/>
</a>
<a herf="https://www.instagram.com/samuel_ricardo.ex/">
<img src='https://img.shields.io/static/v1?label=&message=Samuel.ex&color=black&style=for-the-badge&logo=instagram'/>
</a>
<a herf='https://www.linkedin.com/in/samuel-ricardo/'>
<img src='https://img.shields.io/static/v1?label=&message=Samuel%20Ricardo&color=black&style=for-the-badge&logo=LinkedIn'/>
</a>
</h1>
<br>
<p id="project"/>
<h2> | :artificial_satellite: About: </h2>
<p align="justify">
Streaming platform with pure JS CSS HTML, with support for gesture navigation, receives data from the camera and, with user permission of course (privacy in 1st place), processes data with a Google AI that maps the points of your hands and recreates from them a 2d representation of your hand on the screen in real time
</p>
<p align="justify">
Also while identifying hand gestures and interpreting what they mean, translating to a code comman. It has a facial recognition to map the eyes and identify eye blinks, it automatically identifies the blink and translates it into a command in code
</p>
<p align="justify">
All this happening in real time 60 times per second (60 fps), made with performance to run on any potato that dares to show video, compatible with Google, Firefox, Opera GX and other browsers
</p>
- Site: <a target="_blank" style="color: #8a4af3;" href="https://samuel-ricardo.github.io/ExpertMax/">ExpertMax - Home Page</a>
> <a href="https://samuel-ricardo.github.io/ExpertMax/"> <img src="./readme_files/image-2.png"> </a>
<br>
- This Site is hosted on <a style="color: #8a4af3;" href='https://pages.github.com/'> Github Pages </a>
- Current Version: <b> 1.0.0 </b>
#
<h2 id="techs">
:building_construction: | Technologies and Concepts Studied:
</h2>
> <a href='https://www.tensorflow.org/?hl=pt-br'> <img width='40px' src='https://cdn.jsdelivr.net/gh/devicons/devicon/icons/tensorflow/tensorflow-original.svg'> </a>
- JavaScript
- HTML
- CSS
- Tensorflow
- Webworkers
- Browser-Sync
- MVC
- Desing Patterns
- Camera Handling
- Canvas
- Perfomance
> Among Others...
#
<h2 id="app">
💻 | Application:
</h2>
* Click on GIFs to open the full HD (1080p) video and see details
<p align="justify">
This application map 4 gestures with possibilities to expando for more, you can control the screen scroll and click in any place of screen without touch on mouse or screen or any place, just with gestures, you to can control the video player, pausing and resuming with just a blink.
</p>
<br>
> <a href="https://samuel-ricardo.github.io/ExpertMax/"> <img src="./readme_files/image"> </a>
<br>
### Firefox Demo
<p align="center">
<video width="90%" controls>
<source src="./readme_files/demo_firefox.mp4" type="video/mp4">
Your browser does not support the video tag.
</video>
<a target="_blank" href="./readme_files/demo_firefox.mp4">
<img width="80%" src="./readme_files/demo_firefox.gif"/>
</a>
</p>
<p align="justify">
Application running on Firefox browser, by the way, firefox browser dont have support to blink detection, but, the application look more fluid.
</p>
<br>
### Brave Demo
<p align="center">
<video width="90%" controls>
<source src="./readme_files/google_demo.mp4" type="video/mp4">
Your browser does not support the video tag.
</video>
<a target="_blank" href="./readme_files/google_demo.mp4">
<img width="80%" src="./readme_files/google_demo.gif"/>
</a>
<p>
<p align="justify">
Application running on Brave, google chromiun based browser.
</p>
<br>
### ✌ | Gestures
<br>
| - Scroll Up: [✋]
<br>
<p align="center">
<video width="90%" controls>
<source src="./readme_files/up-demo.mp4" type="video/mp4">
Your browser does not support the video tag.
</video>
<a target="_blank" href="./readme_files/up-demo.mp4">
<img src="./readme_files/up-demo.gif"/>
</a>
<p>
<p align="justify">
To Scroll Up you just need to open your hands in front of camera
</p>
<br>
| - Scroll Down: [✊]
<br>
<p align="center">
<video width="90%" controls>
<source src="./readme_files/down-demo.mp4" type="video/mp4">
Your browser does not support the video tag.
</video>
<a target="_blank" href="./readme_files/down-demo.mp4">
<img src="./readme_files/down-demo.gif"/>
</a>
<p>
<p align="justify">
to scroll down you just need to close your hands
</p>
<br>
| - Mouse Click - [🤏]
<br>
<p align="center">
<video width="90%" controls>
<source src="./readme_files/click_demo.mp4" type="video/mp4">
Your browser does not support the video tag.
</video>
<a target="_blank" href="./readme_files/click_demo.mp4">
<img src="./readme_files/click_demo.gif"/>
</a>
<p>
<p align="justify">
To hover you just need to hover your hands through the elements, to click, you just need to make the pinch gesture, i put a dlay of 1 second else it was clicking to many times by second
</p>
<br>
| Pause / Resume video - [😉]
<br>
<p align="center">
<video width="90%" controls>
<source src="./readme_files/blink_demo.mp4" type="video/mp4">
Your browser does not support the video tag.
</video>
<a target="_blank" href="./readme_files/blink_demo.mp4">
<img width="60%" src="./readme_files/blink_demo.gif"/>
</a>
<p>
<p align="justify">
To pause and resume video, you need to active the facial recognition on button above the video and wait a second to start, when it ready will display a blink counter and you can blink to pause and resume video, stay close to camera for better experience
</p>
#
- This Site is hosted on <a style="color: #8a4af3;" href='https://samuel-ricardo.github.io/ExpertMax/'> Github Pages </a>
- Current Version: <b> 1.0.0 </b>
#
<h2 id="run-project">
👨💻 | How to use
</h2>
### Open your Git Terminal and clone this repository
```git
$ git clone "git@github.com:Samuel-Ricardo/ExpertMax.git"
```
### Make Pull
```git
$ git pull "git@github.com:Samuel-Ricardo/ExpertMax.git"
```
You need to have `NodeJS` on your machine and a package manager (`npm`, `yarn`, or other...) to interpret the code and install the dependecies.
> <a target="_blank" href="https://nodejs.org/en/"> <img width="48px" src="https://cdn.jsdelivr.net/gh/devicons/devicon/icons/nodejs/nodejs-original.svg" /> </a>
```bash
# To install all the dependencies
$ yarn
$ npm install
$ npm ci
# To run the project
$ yarn run start
$ npm run start
```
#
<h2 id="author">
:octocat: | Author:
</h2>
> <a target="_blank" href="https://www.linkedin.com/in/samuel-ricardo/"> <img width="350px" src="https://github.com/Samuel-Ricardo/bolao-da-copa/blob/main/readme_files/IMG_20220904_220148_188.jpg?raw=true"/> <br> <p> <b> - Samuel Ricardo</b> </p></a>
<h1>
<a herf='https://github.com/Samuel-Ricardo'>
<img src='https://img.shields.io/static/v1?label=&message=Samuel%20Ricardo&color=black&style=for-the-badge&logo=GITHUB'>
</a>
<a herf='https://www.instagram.com/samuel_ricardo.ex/'>
<img src='https://img.shields.io/static/v1?label=&message=Samuel.ex&color=black&style=for-the-badge&logo=instagram'>
</a>
<a herf='https://twitter.com/SamuelR84144340'>
<img src='https://img.shields.io/static/v1?label=&message=Samuel%20Ricardo&color=black&style=for-the-badge&logo=twitter'>
</a>
<a herf='https://www.linkedin.com/in/samuel-ricardo/'>
<img src='https://img.shields.io/static/v1?label=&message=Samuel%20Ricardo&color=black&style=for-the-badge&logo=LinkedIn'>
</a>
</h1>
| Movie streaming with gesture navigation support | css,html,javascript,tensorflow,workers | 2023-02-28T19:02:28Z | 2023-03-24T13:29:04Z | null | 1 | 0 | 133 | 0 | 0 | 2 | null | null | JavaScript |
oleksaYevtush/Movie_search_React | main | # Getting Started with Create React App
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
## Available Scripts
In the project directory, you can run:
### `npm start`
Runs the app in the development mode.\
Open [http://localhost:3000](http://localhost:3000) to view it in your browser.
The page will reload when you make changes.\
You may also see any lint errors in the console.
### `npm test`
Launches the test runner in the interactive watch mode.\
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
### `npm run build`
Builds the app for production to the `build` folder.\
It correctly bundles React in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.\
Your app is ready to be deployed!
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
### `npm run eject`
**Note: this is a one-way operation. Once you `eject`, you can't go back!**
If you aren't satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own.
You don't have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it.
## Learn More
You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
To learn React, check out the [React documentation](https://reactjs.org/).
### Code Splitting
This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting)
### Analyzing the Bundle Size
This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size)
### Making a Progressive Web App
This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app)
### Advanced Configuration
This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration)
### Deployment
This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment)
### `npm run build` fails to minify
This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify)
| ✨Movie catalog app with filters by categories✨ | hooks-api-react,javascript,movies-api,npm,reactjs | 2023-02-28T13:44:42Z | 2023-02-28T13:51:21Z | null | 1 | 0 | 1 | 0 | 0 | 2 | null | null | JavaScript |
laststonedjs/arctic_foxes_react_native | master | # 🦊 Arctic Foxes 🦊 React Native, Expo-Go
<hr/>
- To start the application, it is necessary to start the command: <br/>
`npm start` from the root directory (dir_name: 'arctic_foxes_rn') and Metro will generate a QR code for scanning (Expo-Go App - we can download it from the play store).
> > If by any chance it doesn't compile on the first try, just click 'R' in the terminal or scan the qr code again
<hr/>
Go deeper and get to know my pets from the far north of the planet, this application also offers you the possibility of inserting,
deleting and changing existing foxes from the list. Without a backend, I use data object from a local <i>dummyData.js</i> file.
<br/> <hr/>
- <h2>Goals and Achievements during the construction of the project</h2>
Through this task and challenge, the biggest challenge for me was sending data between components and calling them through various dynamic forms, cards and lists. Thoroughly reading the react-native documentation, I learned a lot more about FlatList (many of its props), native navigation and, among other things, the search functionality that I implemented on the 'Home' page. As for the 'Details' page, you can find larger pictures, more descriptions with text, as well as our editing section.
- For fonts used this great Inter typeface open source font family!
[ https://rsms.me/inter/ ]
- Note
When scanning the QR code with the <i>Expo-Go</i> application, your mobile phone must be on the same Wi-Fi network as the PC.
Enjoy and give me a star if you like it! 🔥🔥
<h3>Screenshots</h3>
<p>
<figcaption>Home Screen</figcaption>
<img src="https://user-images.githubusercontent.com/58791451/229930593-48ca0144-08e6-4d6d-867f-5c0456146df7.jpg" width="80%" height="70%" />
</p>
<p>
<figcaption>Fox Cards</figcaption>
<img src="https://user-images.githubusercontent.com/58791451/229930609-0e76a001-ca56-4fab-9765-2c6d592fbc30.jpg" width="80%" height="70%" />
</p>
<p>
<figcaption>Fox Details Screen</figcaption>
<img src="https://user-images.githubusercontent.com/58791451/229930624-a2645fc1-49e2-4eb5-98fd-35293bdd2056.jpg" width="80%" height="70%" />
</p>
<p>
<figcaption>From here it is possible to edit the existing Fox</figcaption>
<img src="https://user-images.githubusercontent.com/58791451/229930636-f092170a-28c8-40dd-b970-dc71181abef1.jpg" width="80%" height="70%" />
</p>
<p>
<figcaption>"Edit" Modal</figcaption>
<img src="https://user-images.githubusercontent.com/58791451/229930646-e29298a2-63c3-43a6-b379-cbfbd6b86fc2.jpg" width="80%" height="70%" />
</p>
<p>
<figcaption>"Add" Modal</figcaption>
<img src="https://user-images.githubusercontent.com/58791451/229930657-fc68b0d0-f631-40fa-9af1-eeeb03ca510d.jpg" width="80%" height="70%" />
</p>
<p>
<figcaption>Example of added fox to the list</figcaption>
<img src="https://user-images.githubusercontent.com/58791451/229930667-4a591e51-ab2d-41e8-8cf0-43b28569deeb.jpg" width="80%" height="70%" />
</p>
| React native and Expo CLI application for displaying, adding, editing and updating cute arctic foxes and their detailed display and description. | expo-cli,expo-go,react-native,crud-application,expo-image-picker,javascript,image-picker,react-native-modal | 2023-03-02T16:54:14Z | 2023-04-05T13:59:16Z | null | 2 | 0 | 66 | 0 | 0 | 2 | null | null | JavaScript |
theresetuyi/To-do-List | main | # To-do-List
<a name="readme-top"></a>
<div align="center">
<h3><b> To Do list: interactive list</b></h3>
</div>
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#triangular_flag_on_post-deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)
<!-- PROJECT DESCRIPTION -->
# 📖 To Do list: interactive list<a name="about-project"></a>
**interactive list** In this project, you will add some functionality to your application to make it interactive. The user will also be able to mark task completion by selecting the corresponding checkbox (or undo it by unchecking the checkbox). The updated tasks list will be stored in local storage.
## 🛠 Built With <a name="built-with"></a>
### Tech Stack <a name="tech-stack"></a>
> Describe the tech stack and include only the relevant sections that apply to your project.
<details>
<summary>Client</summary>
<ul>
<li><a href="https://www.w3schools.com/html/default.asp">Html</a></li>
<li><a href="https://www.w3schools.com/css/default.asp">CSS</a></li>
<li><a href="https://www.w3schools.com/javascript/default.asp">JavaScript</a></li>
<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules">DOM</a>
</li>
</ul>
</details>
<!-- Features -->
### Key Features <a name="key-features"></a>
- **[Add items]**
- **[Display items]**
- **[Remove items]**
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 🚀 Live Demo <a name="live-demo"></a>
**Open the live-demo of the project**
[Project Link][https://theresetuyi.github.io/To-do-List/]
<!-- GETTING STARTED -->
## 💻 Getting Started <a name="getting-started"></a>
## Getting Started
To get a local copy of this exercice, Please follow these simple example steps.
1. Clone this repository or download the Zip folder:
**``https://github.com/theresetuyi/To-do-List.git``**
2. Navigate to the location of the folder in your machine:
**``C:\Users\PATH\project\To-do-List>``**
3. Press Enter to navigate to your local clone.
4. Open terminal and run this command npm install
5. after finishing step 5, run this command npm start to run the project
6. for testing components, you can run: npm run test.
## 👥 Authors <a name="authors"></a>
👤 **theresetuyi**
- GitHub: [@githubhandle](https://github.com/theresetuyi)
- Twitter: [@twitterhandle](https://twitter.com/THERESETUYISAB2)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/therese-theddy-tuyisabe-249820203/)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- FUTURE FEATURES -->
list-structure
## 🔭 Future Features <a name="future-features"></a>
[ ] **[To do list]**
- [ ] **[Add modules]**
- [ ] **[Use webpack to bundle JavaScript]**
- [ ] **[ ES6 modules]**
- [ ] **[Add contact page]**
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## Show your support
Give a ⭐️ if you like this project!
## 🤝 Contributing
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/theresetuyi/To-do-List/issues)
## Acknowledgments
This project has been created in reference to the template created by
## 📝 License
This project is [License](MIT.md) licensed.
| "To-do list" is a tool that helps to organize your day. to do and allows you to mark them as complete. it was build as simple website that allows for doing that, and it was build by using using ES6 and Webpack. | css,javascript | 2023-03-02T13:12:14Z | 2023-03-04T19:01:33Z | null | 1 | 3 | 30 | 1 | 0 | 2 | null | null | JavaScript |
macagua/intro_to_owl_javascript_odoo | main | null | Introduction To Owl and JavaScript with Odoo V15 from Oocademy | javascript,odoo15,owl,widget,odoo,odoo-addons | 2023-02-27T19:46:06Z | 2023-03-02T04:21:02Z | null | 1 | 0 | 9 | 1 | 0 | 2 | null | AGPL-3.0 | HTML |
Arpish00/payment-gateway-with-merchant-payment-wallet-and-hd-address-wallet | master | # Payment Gateway with Merchant Payment Wallet and HD Address Wallet
[](https://opensource.org/licenses/MIT)
A payment gateway solution built on the Ethereum platform that enables users to accept payments on a blockchain network. It allows the merchant to accept ether as payment and can be easily leveraged to accept an ERC20 token as payment as well for enterprise applications not implementing cryptocurrencies.
## Technologies Used
- Merchant site and gateway: JavaScript, React, MetaMask, Web3, Node.js, Bulma CSS
- HD wallet: Node.js, Express.js, HTTPS API, BIP39, ethutil, ethtx
- Payment wallet: Ganache, Web3, React, Node.js, BIP39, HTTP API, Bulma CSS
## Key Features
- Defining blockchain payment ecosystem
- Generating dynamic merchant addresses using HD wallets
- An e-commerce website and payment gateway
- An API for generating dynamic payment addresses
- The merchant HD wallet
- Running the payment ecosystem and Ethereum blockchain
## Tags
- Ethereum
- Payment Gateway
- Blockchain
- Merchant Wallet
- HD Wallet
- Web3
- React
- JavaScript
- Node.js
- MetaMask
- Ganache
- API
- BIP39
- HTTPS
- CSS
- MIT License
| A payment gateway solution built on the Ethereum platform that enables users to accept payments on a blockchain network. It allows the merchant to accept ether as payment and can be easily leveraged to accept an ERC20 token as payment as well for enterprise applications not implementing cryptocurrencies. | api,cryptography,ethereum,ganache,hdwallet,https,javascript,merchant-payments,metamask,nodejs | 2023-03-03T15:24:40Z | 2023-03-12T01:15:26Z | null | 1 | 0 | 5 | 0 | 1 | 2 | null | null | JavaScript |
dpvasani/Calculator | main | # Calculator Website
Welcome to the Calculator Website! This website allows users to perform basic arithmetic calculations with three toggle modes: standard.
## Image
## Features
- Basic Arithmetic Operations: Perform addition, subtraction, multiplication, and division.
- Standard Mode: Switch to the standard mode for general arithmetic calculations.
## Usage
1. Choose the toggle mode (standard, scientific, or programmer) based on your calculation needs.
2. Input the numbers and select the desired operation using the provided buttons.
3. The calculator will display the result on the screen.
4. Use the clear button to reset the input and start a new calculation.
## Technologies Used
- HTML
- CSS
- JavaScript
## License
### All Right Reserved
| Welcome to the Calculator Website! This website allows users to perform basic arithmetic calculations with three toggle modes: standard. | css,html,html-css-javascript,javascript | 2023-03-11T05:01:15Z | 2023-06-17T13:46:58Z | null | 1 | 0 | 4 | 0 | 0 | 2 | null | null | JavaScript |
asRizvi888/Expo-Reminder | main | # Reminder App
## Table of Contents
- [About](#about)
- [Getting Started](#getting_started)
- [Features](#features)
## About
it's a simple reminder app made with React-Native and Expo.
## Getting Started
- Install dependencies: `yarn install` (or `npm install`).
- Run on both Android & iOS: `expo start` (or `npm start`).
- Run on Android: `yarn android` (or `npm run android`).
- Run on iOS: `yarn ios` (or `npm run ios`).
### Preview
<img src = "Images/Preview_Image_1.png" width="200"/><img src ="Images/Preview_Image_2.png" width="200"/>
## Features
- Notification Support
- Local Storage
- Dark theme and light theme
- Reminders
- Minimal design
- and much more..
## Testing
- it has been Tested on Android 10.0
- it uses expo SDK 40
- if you find any bugs, please raise an issue
## License
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details
## Thank You
| A minimal Reminder App | ios,reminder-app,android,apk,context-api,dark-mode,eas-build,expo-cli,javascript,local-storage | 2023-03-10T04:25:25Z | 2023-03-10T04:40:20Z | 2023-03-10T04:40:20Z | 1 | 0 | 4 | 0 | 0 | 2 | null | MIT | JavaScript |
AAWA-byt/scientists-quartet | main | # scientists-quartet
This project is an online multiplayer quartet game for the browser.
It includes a backend server and a front end.
The backend is a Node.js server and the front end is a React.js application.
The communication between server and client takes place with the help of Socket.io.
⚠ I take no responsibility for the data used in the various categories. If you find any errors, please create an issue and point them out. ⚠
## :rocket: Game concept
In this version of the quartet, the player with the highest number or value on the card wins. If a player takes a turn and names a value, the player with the highest value wins. This player collects all the cards and adds them to his pile and it is his turn.
If two cards have the same value, a draw is made. In this case, both cards are placed in the middle and the player who was last to act chooses a value from his next card. The player with the higher value then collects all the cards from the centre. The game ends when one player has all the cards and is thus considered the winner of the game.
## :sparkles: Features
- ✅ Quartet game
- ✅ Live Chat
- ✅ User list & user count
- ✅ User limit
- ✅ Responsive design
- ☑️ Log Games (MySQL)
- ☑️ Multiple games (game rooms with keys)
- ☑️ login system (stats, ...)
## :wrench: How to install
### :package: Requirements
- [Node.js](https://nodejs.org/en/download)
- [npm](https://docs.npmjs.com/cli/)
- [Git](https://git-scm.com/downloads)
- [pm2](https://pm2.keymetrics.io/)
- [Docker](https://docs.docker.com/)
### :page_facing_up: Procedure
- Clone the source code with the following command:
```
git clone https://github.com/AAWA-byt/scientists-quartet.git
```
- Edit the config file ```./server/config.json``` as you need it (here you define the address with which the backend server is allowed to communicate)
- In the ```./client``` folder you run the following commands:
```
# Install all required packages
npm i
# Build project to serve it to a static server
npm run build
```
- Now deploy the files from the ```build``` folder to a static server
- After deploying the files, you go back to the ```./server``` folder and run the following commands:
```
# Install all required packages
npm i
# Start backend server for testing
npm start
```
- For running the backend server in the background execute the following command after installing the packages:
```
pm2 index.js
```
### 🐘 Docker Compose
It is also possible to run the backend server in a Docker container. Here you can use the following commands:
```
# pull the repo from github
git clone https://github.com/AAWA-byt/physiker-quartet.git
# start docker
cd ./server
docker-compose up -d
```
Proceed as described above with the files for the web server and the config files.
# :construction: Contribute
### Pull Request
You are always welcome to create a [pull request](https://github.com/AAWA-byt/scientists-quartet/pulls). I will look at it as soon as possible.
### Bug Reports / Feature Requests
If you want to report a bug or request a new feature, feel free to open a new [issue](https://github.com/AAWA-byt/physiker-quartet/issues).
# :memo: License
Copyright 2023 Aaron Wagner
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
See the [LICENSE.md](https://github.com/AAWA-byt/scientists-quartet/blob/main/LICENSE.md) file for details.
# :construction_worker: Author
- [AAWA-byt](www.github.com/AAWA-byt) - Aaron Wagner
| An awesome self-hosted online quartet game. | javascript,quartet,scientists,socket-io,games | 2023-02-28T09:09:49Z | 2024-04-04T15:42:56Z | 2023-05-08T21:08:08Z | 1 | 15 | 202 | 8 | 0 | 2 | null | Apache-2.0 | JavaScript |
peles-taras/TVShows_Website | main | ## <h1 align="center" style="font-color: red;">Welcome to [whatepisode.online](https://whatepisode.online/home)! </h1>
<h1 align="center">About this project</h1>
As a fan of TV shows myself, I understand the excitement and challenge of keeping up with multiple series. This website was born out of the desire to make tracking TV show progress a seamless experience. Whether you're juggling numerous shows simultaneously or just looking for a convenient way to manage your viewing, this platform is designed with you in mind.
<br></br>
Tracking TV show progress can be a daunting task, and I've been there too. I believe in the power of technology to simplify our lives, and that's why I created this platform. My aim is to provide TV enthusiasts with a user-friendly tool that not only helps you keep track of episodes and seasons but also enhances your overall viewing experience.
## <h1 align="center">Technologies used:</h1>
Back-end: MySQL, Spring Web, Spring Data, Spring Security, Mailjet, Themoviedb api, Lombok, Maven, Docker, Slf4j, JUnit, Mockito
<br></br>
Front-end: Spring MVC, Thymeleaf, HTML, CSS, JS
## <h1 align="center">Project structure</h1>
<p align="center">
<img src="https://github.com/peles-taras/TVShows_Website/assets/92885035/7eb668d2-b754-41ac-b4fe-b0c5b673bfc7" alt="Structure">
</p>
## <h1 align="center">Database structure</h1>
<p align="center">
<img src="https://github.com/peles-taras/TVShows_Website/assets/92885035/e673b544-4685-4e6c-9116-1d2070912e43" alt="db">
</p>
## <h1 align="center">Accessable at [whatepisode.online](https://whatepisode.online/home)</h1>
## <h1 align="center">Features</h1>
Effortlessly monitor the advancement of each season, evaluate shows, seamlessly integrate a show into your curated library with a personalized status, stay updated with relevant TV show news, contribute insightful comments, take control of your profile, and unlock a myriad of additional features! Try it out at [whatepisode.online](https://whatepisode.online/home)
## <h1 align="center">Connect <img src="https://github.com/peles-taras/peles-taras/assets/92885035/524e4e12-adf9-4ea2-8133-cc61ca2b4db6" alt="Shop Icon" style="height: 20px; width: 20px; vertical-align: middle; margin-right: 5px;"></h1>
Feel free to reach out to me on the following platforms:
- <img src="https://github.com/peles-taras/peles-taras/assets/92885035/b4e764ad-7152-41d2-877e-09219ba31688" alt="Shop Icon" style="height: 15px; width: 15px; margin-right: 5px;"> Telegram: [@noampersone](https://t.me/noampersone)
- <img src="https://github.com/peles-taras/peles-taras/assets/92885035/94e4720e-803b-473c-a4c0-e0bcda67f7da" alt="Shop Icon" style="height: 15px; width: 15px; margin-right: 5px;"> LinkedIn: [Peles Taras](https://www.linkedin.com/in/taras-peles)
| A dynamic web application developed using Spring, designed to elevate user's television viewing experience. Accessable at https://whatepisode.online | css,desktop-app,docker,html,java,javascript,junit,mockito,mvc,mysql | 2023-02-26T12:35:06Z | 2024-04-01T18:27:02Z | null | 1 | 0 | 80 | 0 | 0 | 2 | null | null | Java |
matteorigat/matteorigat.github.io | main | **My personal site**
[matteorigat.github.io](https://matteorigat.github.io)
| My personal site -> https://matteorigat.github.io | css,html,javascript | 2023-03-03T16:05:40Z | 2024-03-23T16:49:22Z | null | 1 | 1 | 43 | 0 | 0 | 2 | null | GPL-3.0 | HTML |
TheKostVK/react2023_backend | main | <div align="center">
<p>Проект ReactJS Backend</p>
<p>ide: WebStorm -v 2022.3</p>
<p>Выполненные задания находятся в ветке <span style="color: cyan">Releases</span></p>
<p>Выполнили: <a href="https://github.com/TheKostVK">TheKostVK</a> и <a href="https://github.com/b1abb">b1abb</a></p>
</div>
<p align="center">Ссылки на проекты GitHub</p>
<table align="center">
<tr>
<th align="center"><a href="https://github.com/TheKostVK/react2023_frontend">Frontend</a></th>
<th align="center"><a href="https://github.com/TheKostVK/react2023_backend">Backend</a></th>
</tr>
</table>
<p align="center">Таблица используемых модулей</p>
<table align="center">
<tr>
<th style="color: blueviolet; font-size: large">Frontend</th>
<th style="color: blueviolet; font-size: large">Backend</th>
</tr>
<tr>
<td><p style="color: brown">ReactJS v18</p></td>
<td><p style="color: brown">NodeJS/ES6</p></td>
</tr>
<tr>
<td>
<p style="font-size: large; color: black">Redux Toolkit</p>
<p style="color: brown">(глобальный стейт менеджер)</p>
</td>
<td>
<p style="font-size: large; color: black">Express + Validator</p>
<p style="color: brown">(веб-сервер/валидация запросов)</p>
</td>
</tr>
<tr>
<td>
<p style="font-size: large; color: black">React Hook Form</p>
<p style="color: brown">(работа с формами)</p>
</td>
<td>
<p style="font-size: large; color: black">MongoDB/Mongoose</p>
<p style="color: brown">(работа с базой данных)</p>
</td>
</tr>
<tr>
<td>
<p style="font-size: large; color: black">Redux Router v6</p>
<p style="color: brown">(навигация/роутинг)</p>
</td>
<td>
<p style="font-size: large; color: black">JSON Web Token</p>
<p style="color: brown">(аутентификация/авторизация)</p>
</td>
</tr>
<tr>
<td>
<p style="font-size: large; color: black">React Markdown/Simple Editor</p>
<p style="color: brown">(редактор статей)</p>
</td>
<td>
<p style="font-size: large; color: black">Multer</p>
<p style="color: brown">(загрузка файлов/изображений)</p>
</td>
</tr>
<tr>
<td>
<p style="font-size: large; color: black">Axios</p>
<p style="color: brown">(отправка запросов на сервер)</p>
</td>
<td>
<p style="font-size: large; color: black">BCrypt</p>
<p style="color: brown">(шифрование пароля)</p>
</td>
</tr>
</table>
| react project backend | javascript,react,reactjs | 2023-02-25T11:35:25Z | 2023-05-08T10:33:37Z | 2023-03-24T08:18:33Z | 2 | 21 | 156 | 0 | 1 | 2 | null | null | JavaScript |
TalipOrdu/Value-added_Tax_Calculator | main | # Value-added_Tax_Calculator
I made a Value-added tax calculator using with html, bootstrap, javascript.
## [DEMO LINK](https://valueaddedtaxcalculator.netlify.app/)
| I made a Value-added tax calculator using with html, bootstrap and javascript. | bootstrap,javascript,vat-calculator | 2023-02-25T22:14:26Z | 2023-03-03T22:21:55Z | null | 1 | 0 | 20 | 0 | 0 | 2 | null | null | HTML |
emTr0/ai-avatar-generator | starter | # Stable Diffusion AI Avatar Generator Project
Based on a [buildspace](https://buildspace.so/) project where I learned about Stable Diffusion to create a web app where users can generate avatars with my likeness.
Web app available at [ai-avatar-generator-production.up.railway.app](https://ai-avatar-generator-production.up.railway.app/).
Try something like "emTr0 as Thor in Avengers"! Want more control over how the AI generates avatars? Check out this awesome guide on [becoming a prompt engineer](https://buildspace.so/p/build-ai-avatars/lessons/become-a-prompt-engineer).
There may be a slight delay in the avatar's generation depending on how many requests the services are getting, and when my model was last used.
| Based on a buildspace project where I learned about Stable Diffusion to create a web app where users can generate avatars with my likeness. | ai,ai-avatars,artificial-intelligence,avatar,avatar-generator,buildspace,buildspace-projects,dreambooth,javascript,nextjs | 2023-02-26T06:54:23Z | 2023-02-27T06:19:10Z | null | 2 | 0 | 11 | 0 | 1 | 2 | null | null | CSS |
jonycmtt/30-days-Projects | main | # 30 Days 30 Projects (Running)
| 30 Days 30 Projects (Running) | css3,html5,javascript | 2023-03-03T16:55:23Z | 2023-03-14T08:22:10Z | null | 2 | 0 | 4 | 0 | 0 | 2 | null | null | HTML |
DarkWool/cv-creator-app | main | # CV Creator App - [view live](https://darkwool.github.io/cv-creator-app/)
This is my very first app created using _**React**_, alongside _**react-pdf**_ and _**emoji-mart**_, it was difficult at first but after a few commits I started to see that is awesome to use it and I think that this was a good project to start practicing with it.
The best part is that I learned how to manage class and functional components (Started with class ones and later I refactored) but not only that, I decided that I could learn about hooks too!
## Features
1. Fill your CV using your personal data, education, work experience, skills, languages and interests.
1. Download your CV as a **PDF** file!
1. Use emojis to express yourself on the "interests" section.
## Specifications
1. Create a new project using npx create-react-app cv-project. If you need a reminder on how it works, check out the previous lessons. Don’t forget to setup a GitHub repository for your project, to push your progress.
1. Remove the boilerplate code created by create-react-app.
1. You should use class components for this project. You’re going to find a lot of code written using class components and this practical experience will help you understand it when encountered. You’ll also revisit this project in a later lesson to replace the class components with functional ones.
1. Think about how to structure your application into components. Your application should include:
1. A section to add general information like name, email, phone number.
1. A section to add your educational experience (school name, title of study, date of study)
1. A section to add practical experience (company name, position title, main tasks of your jobs, date from and until when you worked for that company)
1. Be sure to include an edit and submit button for each section or for the whole CV, your preference. The submit button should submit your form and display the value of your input fields in HTML elements. The edit button should add back (display) the input fields, with the previously displayed information as values. In those input fields, you should be able to edit and resubmit the content. You’re going to make heavy use of state and props, so make sure you understood those concepts.
1. Create a components folder in your src directory and add your components.
1. Include a styles folder in your src directory for your CSS files. You’ll need to import these in the component files to use them.
Check the assignment's page [here.](https://www.theodinproject.com/lessons/node-path-javascript-cv-application)
| React app made for The Odin Project! | create-react-app,css,cv-creator,html5,javascript,react,reactjs,create-cv-react,react-cv-creator | 2023-03-05T04:15:25Z | 2023-04-04T04:23:40Z | null | 1 | 0 | 55 | 0 | 0 | 2 | null | null | JavaScript |
LucianoGarcia1/countries-search | main | # Getting Started with Create React App
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
## Available Scripts
In the project directory, you can run:
### `npm start`
Runs the app in the development mode.\
Open [http://localhost:3000](http://localhost:3000) to view it in your browser.
The page will reload when you make changes.\
You may also see any lint errors in the console.
### `npm test`
Launches the test runner in the interactive watch mode.\
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
### `npm run build`
Builds the app for production to the `build` folder.\
It correctly bundles React in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.\
Your app is ready to be deployed!
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
### `npm run eject`
**Note: this is a one-way operation. Once you `eject`, you can't go back!**
If you aren't satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own.
You don't have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it.
## Learn More
You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
To learn React, check out the [React documentation](https://reactjs.org/).
### Code Splitting
This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting)
### Analyzing the Bundle Size
This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size)
### Making a Progressive Web App
This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app)
### Advanced Configuration
This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration)
### Deployment
This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment)
### `npm run build` fails to minify
This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify)
| Find countries through this webapp, technologies used ReactJS and Axios | api,axios,axios-react,css,hooks,html,html5,javascript,js,react | 2023-02-27T13:08:06Z | 2023-02-28T01:07:10Z | null | 1 | 0 | 1 | 0 | 0 | 2 | null | null | SCSS |
lack21/Hover-Card | main | # Hover-Card
Tools Used:
• HTML
• SCSS
• JavaScript
Link : https://lack21.github.io/Hover-Card/
| Personal Project | html,javascript,scss | 2023-03-06T11:45:34Z | 2023-03-06T11:49:05Z | null | 1 | 0 | 2 | 0 | 0 | 2 | null | null | CSS |
alaminniyaz/Tech-Shop | main |
# Tech Shop 🪁
**Clean, Beautiful and Responsive Website for Tech & Gadget Shop 🚀**
## Sections 🎯
- **Home**
- **About**
- **Reviews**
- **Contact**
## Features 🎉
- **Multi Page 💎**
- **Easy to Use 💻**
- **Fully Responsive 🚀**
- **Free to Use ( OpenSource ) 🥳**
- **Super Fast and Optimized for SEO ⚡**
- **Great Audits Score 🎖️**
## Technologies used 🛠️
- **HTML**
- **CSS**
- **Javascript**
## Connect with me 🔗
[](https://ialamin.netlify.app)
[](https://twitter.com/alaminniyaz)
| Beautiful Clean and Responsive Website for Tech & Gadget Shop 🪁 | css,css3,html,html-css-javascript,html5,javascript,tech,tech-blog,technology | 2023-03-06T11:33:41Z | 2023-03-13T14:45:24Z | null | 1 | 0 | 7 | 0 | 0 | 2 | null | null | CSS |
aniyavolfman/health-app-project | dev | # SlimMom
## Briefly about the application:
Team project.
This is a web application built using React that allows users to track their daily food intake and monitor their calorie consumption. The app includes a nutrition database, which provides nutritional information for a wide range of food items. Additionally, it incorporates an authorization system to ensure secure access to user-specific data.
## Technology stack:
- React,
- Redux Toolkit,
- HTML,
- SASS,
- JavaScript,
- Adaptive/Responsive design,
- REST API,
- GIT (for version control).
## Installation
Clone the repository:
```bash
git clone https://github.com/aniyavolfman/health-app-project.git
```
Install the dependencies:
```bash
npm i
```
Start the application:
```bash
npm start
```
## Features
- **Food Diary:** Users can keep a record of the foods they consume throughout the day by adding entries to their food diary. Each entry includes the food item and quantity.
- **Nutrition Database:** The app offers a comprehensive nutrition database that provides information on various food items. Users can search for specific foods and retrieve their nutritional details, including calories, macronutrients, and micronutrients.
- **Authorization:** To ensure data privacy and security, the app implements an authorization system. Users can create an account, log in, and securely access their own food diary and personalized information.
- **Dashboard:** The dashboard provides users with an overview of their daily calorie intake, macronutrient distribution, and other relevant statistics. It helps users track their progress towards their health and fitness goals.
- **Search** Users can search for specific food items in the nutrition database by name or category.
- **Progress Tracking:** Users can view their historical food diary entries and track their progress over time.
## Usage
1. Create an account or log in to access the app's features.
2. Once logged in, you will be directed to the main dashboard.
3. Use the search bar to find specific food items in the nutrition database.
4. Add food items to your food diary by specifying the quantity.
5. View and manage your food diary entries in the diary section.
6. Monitor your daily calorie intake and nutrition distribution on the dashboard.
7. Log out when you're done using the app.
## Error Handling
If an error occurs during the work with contacts, the app will display a message using Notiflix to notify the user.
This allows users to quickly and easily understand what went wrong and take appropriate action. | Application for health | html5,javascript,react,redux-toolkit,sass,css3,adaptive,responsive | 2023-03-06T10:07:35Z | 2023-05-22T14:57:59Z | null | 9 | 102 | 251 | 0 | 0 | 2 | null | null | JavaScript |
akshaychavan010101/Zoomcar.com_clone | main | <!-- # fearful-doll-6867 -->
Zoomcar-clone-website
This was a collaborative project made by 5 members Executed in 5 days.
We did this project within 5 days in our unit-3 construct week.Flexi Wheels is a car rental company based in India that allows customers to rent cars on an hourly, daily, or weekly basis. It has expanded to several cities & states in India, as well as a few international locations. Flexi Wheels operates on a self-drive model, which means that customers can rent a car and drive it themselves, rather than hiring a driver. The company offers a variety of car models to choose from, and customers can book cars through the Flexi Wheels website or mobile app.
Dharanesh <br>
Salman <br>
Akshay <br>
Upendra <br>
Prashant <br>
Deploy Link - https://sweet-madeleine-db3b7d.netlify.app/
Tech Stack Used : -
Languages
HTML
CSS
JavaScript
Following are the Screenshots for the reference
Landing Page Landing Page
** Landing Page **
](https://user-images.githubusercontent.com/112868723/213928669-414af7e4-6db4-4c22-adb3-256987a4fe77.png)
** All Product Page **
** Payment Page**
# About Project
We did this project within 5 days in our unit-3 construct week.Flexi Wheels is a car rental company based in India that allows customers to rent cars on an hourly, daily, or weekly basis. The company was founded in 2012 and has since expanded to several cities in India, as well as a few international locations. Flexi Wheels operates on a self-drive model, which means that customers can rent a car and drive it themselves, rather than hiring a driver. The company offers a variety of car models to choose from, and customers can book cars through the Flexi Wheels website or mobile app.
| Flexi Wheels allows individuals to rent from a diverse pool of cars by the hour or by the day. | css,html,javascript | 2023-03-10T10:09:39Z | 2023-02-26T04:42:05Z | null | 4 | 0 | 90 | 0 | 0 | 2 | null | null | HTML |
OpenVoices/OpenVoices | main | # OpenVoices | This shall become a VoIP web application for Matrix | javascript,react,reactjs,typescript,voip | 2023-03-08T14:09:55Z | 2023-03-16T10:10:47Z | null | 2 | 2 | 21 | 2 | 1 | 2 | null | null | CSS |
daniel-oliv3/the_last_of_us-website-dev-two | main | null | Projeto desenvolvido com HTML CSS JavaScript | css,html,javascript | 2023-03-08T12:43:23Z | 2023-03-14T18:43:22Z | null | 1 | 0 | 8 | 0 | 0 | 2 | null | null | CSS |
assoft/tauri-nuxt3-earthquakes | main | # Afad ve Kandilli Rasathanesi Son Depremler Uygulaması (Win/MacOS)
- Stack
- Tauri (Rust)
- Nuxt 3 (Vue/Typescript)
- Unocss
## Özellikler
- Bildirimler depremlerin şiddetine göre özelleştirilebilir.
- Yenileme sıklığı özelleştirilebilir.
## Uygulama
- [Windows x64](https://github.com/assoft/tauri-nuxt3-earthquakes/releases/download/v0.0.8/Earthquakes.Tracker_0.0.1_x64_en-US.msi)
- [MacOS](https://github.com/assoft/tauri-nuxt3-earthquakes/releases/download/v0.0.8/Earthquakes.Tracker_0.0.1_x64.dmg)
- Linux Build [planlanıyor...]
<div align="center">
<img src="./screenshot.png" width="400px"</img>
</div>
# Development
## Setup
Make sure to install the dependencies:
```bash
# yarn
yarn install
# npm
npm install
# pnpm
pnpm install
```
## Development Server
Start the development server on http://localhost:3000
```bash
npm/yarn/pnpm tauri dev
```
## Production
Build the application for production:
```bash
npm/yarn/pnpm run tauri build
```
| Afad ve Kandilli Son Deprem Etkinlikleri (MacOS & Windows) | afad,deprem,kandilli,nuxt3,rust,tauri,vue,javascript,typescript | 2023-02-25T19:33:54Z | 2023-08-14T03:54:47Z | 2023-08-14T03:54:47Z | 1 | 0 | 22 | 0 | 0 | 2 | null | null | Vue |
thania2004/react-social | master | # 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)
| The react-social is a web-based application that allows users to create an account, log in, and interact with other users on the platform. The application provides users with the ability to create a profile, upload a profile picture, and add personal information. | css,css-flexbox,developer,html5,javascript,react | 2023-02-28T18:42:11Z | 2023-02-28T18:29:55Z | null | 1 | 0 | 1 | 0 | 0 | 2 | null | null | JavaScript |
shm04/rock-paper-scissors | main-branch | # 📗 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)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ (OPTIONAL)](#faq)
- [📝 License](#license)
# 📖 ROCK-PAPER-SCISSORS GAME <a name="about-project"></a>
**ROCK-PAPER-SCISSORS GAME** is an aplication where you can play classic game "rock-paper-scissors".
## 🛠 Built With <a name="built-with"></a>
### Tech Stack <a name="tech-stack"></a>
<ul>
<li><a href="https://developer.mozilla.org/es/docs/Web/HTML">HTML</a></li>
</ul>
<ul>
<li><a href="https://developer.mozilla.org/es/docs/Web/CSS">CSS</a></li>
</ul>
<ul>
<li><a href="https://developer.mozilla.org/es/docs/Web/JavaScript">JavaScript</a></li>
</ul>
### Key Features <a name="key-features"></a>
- **You can play against the computer**
- **You can see your current score**
- **You can restart scores count to play a new game**
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 🚀 Live Demo <a name="live-demo"></a>
- [Live Demo Link](https://shm04.github.io/rock-paper-scissors/)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 💻 Getting Started <a name="getting-started"></a>
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
Text Editor
### Setup
Clone this repository to your desired folder:
```
cd my-folder
git clone git@github.com:myaccount/rock-paper-scissors.git
```
### Install
Install this project with:
You don´t need to install this project
### Usage
To run the project, execute the following command:
```
code rock-paper-scissors
```
### Run tests
To run tests, run the following command:
No tests available
### Deployment
You can deploy this project using:
Browser (Chrome recommended)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 👥 Authors <a name="authors"></a>
Sebastián Hernández
👤 **Sebastián Hernández**
- GitHub: [@shm04](https://github.com/shm04)
- LinkedIn: [Sebastian Hernandez](https://www.linkedin.com/in/sebastian-hernandez-b42052259/)
## 🤝 Contributing <a name="contributing"></a>
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## ⭐️ Show your support <a name="support"></a>
If you like this project please rate it, let a comment or contribute to it.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 🙏 Acknowledgments <a name="acknowledgements"></a>
I would like to thank to Rafeh Qazi and https://www.cleverprogrammer.com/ to encourage me to do this project.
<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>
| This is a rock, paper, scissors game, where you can play againts the computer. Built with JavaScript. | css,game,javascript | 2023-03-01T21:43:34Z | 2023-03-06T20:53:14Z | null | 1 | 0 | 8 | 0 | 0 | 2 | null | MIT | JavaScript |
younusaliakash/vanilla-js-infinite-scroll-blog | master | null | Display blog posts from jsonplaceholder and add infinite scroll to fetch posts and also add filter box | css,html,infinite-scroll,javascript,jsonplaceholder-api | 2023-03-04T16:41:00Z | 2023-03-29T10:07:27Z | null | 1 | 0 | 2 | 0 | 0 | 2 | null | null | JavaScript |
RifatXia/CSE499-Project | main | null | Hospital Management System and Disease Prediction using Machine Learning | css,disease-detection,django,html,javascript,machine-learning,pandas,python,react-native,streamlit | 2023-03-07T15:34:23Z | 2023-11-27T16:01:48Z | null | 2 | 0 | 323 | 0 | 1 | 2 | null | null | HTML |
LakhderAmine99/EPL_WinningTeamPredictions | master | # About The EPL Winning Team Prediction Application
EPW WTP is a web application that predicts the winning team of the english premier league football games using supervised machine learning algorithms , the app is developped using flask framwork and scikit-learn package for machine learning , pickle package for saving the trained models , this is for the backend , for the client the app developped with javascript using fetch api to connect diffrent end points with the client.
## Run Flask App
Note : You need to install all the packages in the requirements.txt file to run the app.
Flask 1.1.2
numpy 1.19.5
pandas 1.2.4
scikit-learn 0.24.1
matplotlib 3.4.1
## Packages
Flask 1.1.2
numpy 1.19.5
pandas 1.2.4
scikit-learn 0.24.1
matplotlib 3.4.1
## Application Preview
The application home page
<p align="center">
<img src="https://github.com/LakhderAmine99/EPL_WinningTeamPredictions/blob/master/screens/Screenshot%202022-05-25%20002117.png" alt="Logo">
<br />
</p>
The models evaluation page
<p align="center">
<img src="https://github.com/LakhderAmine99/EPL_WinningTeamPredictions/blob/master/screens/Screenshot%202022-05-25%20002209.png" alt="Logo">
<br />
</p>
The prediction page
<p align="center">
<img src="https://github.com/LakhderAmine99/EPL_WinningTeamPredictions/blob/master/screens/Screenshot%202022-05-25%20002248.png" alt="Logo">
<br />
</p>
<br>
`@Authon` : [Lakhder Amine](#Author).
| A Flask Web Application that uses Machine Learning Techniques & Algorithms to Predict English Premier League Game Winning Team's. | data-science,decision-trees,flask,javascript,knn,machine-learning,plotly,python,random-forest,svm | 2023-03-03T22:11:55Z | 2023-03-05T19:40:26Z | null | 1 | 2 | 9 | 0 | 0 | 2 | null | null | Jupyter Notebook |
Okafor-Ifeanyi/Post-it_learnable | main | # Post-it by `Prog Bio`
## Prerequisites.
- npm installed
- IDE eg _vscode_
- CLI eg _postman_.
## How to start code
1. Clone or Download repositry
2. Setup .env file => `port`, `mongo_uri`, `jwt _secret`
2. run `npm install`
3. run `npm start`
> Post-it is ready for use
## Live Server `@render`
> [Render Live](https://post-it-q0g4.onrender.com)
## Postman Documentation
> [Postman Docs](https://documenter.getpostman.com/view/19026826/2s93JtRPcU)
## Model Diagram
> [Diagram sketch on dbdiagrams.io](https://dbdiagram.io/d/640748ba296d97641d861a12)
## Design Pattern
For this API `layered_structure` was abopted for the main purpose of creating
all the files in an order that could acomodate the rest easily. This structure was optimized
as `scalable` and the best for the project decided by the developer.
> Developer: "If I can get one path right, then the rest would be `cake`"
## **Soft Delete**
This feature was implemented by adding an extra attribute to the Postit model called `deleted`
**Posts**
```json
{
"post": "Soft delete feature",
"ownerID": "640a12d5f6020fee349f8219",
"deleted": false // default: false
}
```
the delete `http request` in the controller is set to `PATCH` => updates deleted attribute in the post to true.
**Posts**
```json
{
"post": "Soft delete feature",
"ownerID": "640a12d5f6020fee349f8219",
"deleted": true
}
```
All get `Post` request in the db have been set to get request by `id` and `delete == false`. To prevent a user from calling a
deleted request
- _await PostService.findOne({deleted: false})_
- _await PostService.findbyID({ post: info.post, deleted: false })_
Deleted posts are treated as unexisting to the users on Postit but all initial data on the system are still intact.
**Detected Loophole**
1. Deleted posts can still not be duplicated
2. Recreation of a deleted post will throw an error because posts are unique
3. Removal of post uniqueness to accomodate the last stated loophole will cause major redundancy with reason of eg that a client could click their create post button 5* due to a lagging device, slow intrnet... and have the same post created 5*, which would only cause such a client more pain
## **Validations**
**Joi Validation**
`Joi` validation was used as my `schema validator` to validate all `req.body` data sent sent by the user to match my model before being sent to controller.js for use.
**JWT**
`jwt token` for `login` authorization and specification too
> installed `jsonwebtoken`
## POSTMAN Features Adopted
### Environment
Used postman environment to keep url paths neat and simple
- _env name_ => `DEV: post-it`
- _variable_ => `USER` // {{USER}}
- _initial value_ => `localhost:3838/api/v1/user/`
### Set an Environment Variable
Automate authorizstion setting by setting your `jwt_token` to this an _env variable_
> ref: [Youtube Video - time @7:46:45](https://youtu.be/0sOvCWFmrtA)
## Error Handler
All route endpoints stored in `try/catch` to hold asyn and sync errors
API probed to remain active under all circumstance.
Ready for Deployment
## User AvatarUrl / Image Tag
A special feature was adopted in this api, giving a unique avatar to all users with information drafter
from their provided details, this feature was made possible using [`dicebear api`](https://www.dicebear.com/) to generate random avatars and return an `avatar url`. **Image Tag** was included in the user model to hold a `html` img tag for the avatar url.
> img_tag: **"<img src=\"${avatarUrl}\" alt=\"Avatar image for profile picture\" />"** | Post-it is a social media app that allows users make posts then interact through the comment session and ... | 1-week,api,javascript,nodejs,standardization-test,social-media-app | 2023-03-07T13:17:03Z | 2024-03-30T22:52:23Z | null | 1 | 34 | 84 | 0 | 0 | 2 | null | null | JavaScript |
FujaTyping/Yorwor64Slash10 | main | <p align="center"> <img src="https://github.com/FujaTyping/Yorwor64Slash10/blob/main/public/assets/GithubBanner.png?raw=true" alt="Yw" /> </p>
# 🏫 Yorwor64Slash10-Project
ยินดีต้อนรับสู่ Web App ของ ห้อง 3/10! โครงการโอเพ่นซอร์สนี้ออกแบบมาเพื่อมอบแพลตฟอร์มที่สะดวกและมีประสิทธิภาพสำหรับการจัดการกิจกรรมในชั้นเรียน งานมอบหมาย และข้อมูลของนักเรียน แอปนี้ได้รับการพัฒนาขึ้นเพื่อการใช้งานของครูและนักเรียนในระดับชั้น ม.3/10 เป็นหลัก
# ✨️ ฟีเจอร์
- **การจัดการงานที่มอบหมาย** : ครูสามารถสร้างงานที่มอบหมาย กำหนดวันครบกำหนด
- **ประกาศ** : ครูสามารถโพสต์ประกาศและอัปเดตที่สำคัญสำหรับชั้นเรียนเพื่อดู
- **ตารางเวลา** : ครูและนักเรียนสามารถดูและจัดการตารางเรียนและตารางเรียนได้
- **ดูคะแนน** : สามารถเช็คคะแนนของตัวเองในรายวิชานั้นๆๆได้
- **บันทุกกิจกรรม** : สามารถดูกิจกรรมที่เคยจัดที่ผ่านมา
# 🔮 เทคโนโลยีที่ใช้
- **Front-end** : HTML, CSS, JavaScript, bootstrap, PHP
- **Back-end** : Google app script
- **Database** : Google Sheet
- **Deploy** : [Firebase](https://firebase.google.com/)
- **API** : [Sheetdb](https://sheetdb.io/)
- **Notification** : [Push alert](https://pushalert.co/)
- **Version Control** : [Git](https://git-scm.com/)
# 📈 สถิติหน้าเว็ป
อ้างอิงจาก [Pagespeed Insights](https://pagespeed.web.dev/)
<p align="center"> <img width=700px src="https://raw.githubusercontent.com/FujaTyping/Yorwor64Slash10/fdcb0a66758fd9aefe2be877405b67f4b6cc1e2c/pagespeed%20insights.svg" alt="Yw" /> </p>
# ⚠️ โปรเจคนี้ไม่ได้พัฒนาอีกต่อไปแล้ว
> ณ วันที่ 21 มีนาคม 2567
> พวกเรายังคนเปิดเว็ปนี้ให้เพื่อนๆ ได้รำลึกถึงความทรงจำเก่าๆ
> - https://yorwor64slash10.web.app/
> - https://talent.siraphop.me/
# 📝 ใบอนุญาต
โครงการนี้ได้รับอนุญาตภายใต้ใบอนุญาต [GNU General Public License (GPL)](https://en.wikipedia.org/wiki/GNU_General_Public_License)
| ม.3/10 - ญ.ว. | bootstrap5,css3,html5,javascript,web-application,appscript | 2023-02-25T04:37:59Z | 2024-04-01T15:24:16Z | null | 1 | 6 | 209 | 0 | 0 | 2 | null | GPL-3.0 | HTML |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.