{"id":22246568,"url":"https://github.com/el634dev/waves","last_synced_at":"2025-03-25T11:24:42.806Z","repository":{"id":227147477,"uuid":"770600141","full_name":"el634dev/waves","owner":"el634dev","description":"Search and find what you need","archived":false,"fork":false,"pushed_at":"2025-01-21T23:29:16.000Z","size":1960,"stargazers_count":1,"open_issues_count":3,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-30T10:30:23.006Z","etag":null,"topics":["custom-engine","react-jsx","searchengine","tail","vite"],"latest_commit_sha":null,"homepage":"https://waves-beryl.vercel.app/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/el634dev.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-03-11T20:35:30.000Z","updated_at":"2024-11-20T18:15:11.000Z","dependencies_parsed_at":"2024-03-18T22:48:05.568Z","dependency_job_id":"b8393031-49d8-4a69-9279-d0c29cdcb70a","html_url":"https://github.com/el634dev/waves","commit_stats":null,"previous_names":["el634dev/waves"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/el634dev%2Fwaves","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/el634dev%2Fwaves/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/el634dev%2Fwaves/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/el634dev%2Fwaves/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/el634dev","download_url":"https://codeload.github.com/el634dev/waves/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245451222,"owners_count":20617477,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["custom-engine","react-jsx","searchengine","tail","vite"],"created_at":"2024-12-03T05:28:13.833Z","updated_at":"2025-03-25T11:24:42.771Z","avatar_url":"https://github.com/el634dev.png","language":"JavaScript","readme":"# Waves 🌊\n[![made-with-javascript](https://img.shields.io/badge/Made%20with-JavaScript-1f425f.svg)](https://www.javascript.com)\n![Issues](https://img.shields.io/github/issues/el634dev/waves.svg)\n[![Documentation Status](https://readthedocs.org/projects/ansicolortags/badge/?version=latest)](http://ansicolortags.readthedocs.io/?badge=latest)\n[![Website shields.io](https://img.shields.io/website-up-down-green-red/http/shields.io.svg)](http://shields.io/)\n\n\u003e Web Application where users can search and find what they need\n\u003e\u003e Live demo [_here_](https://waves-beryl.vercel.app/).\n\n## Table of Contents\n- [Technologies Used](#technologies-used)\n- [Getting Started](#getting-started)\n- [Screenshot](#screenshot)\n- [Usage](#usage)\n- [Project Status](#project-status)\n- [Deployment](#deployment)\n- [Author](#author)\n- [Acknowledgements](#acknowledgements)\n\n## Technologies Used\n- [React](https://react.dev/) - the JS library to create web and native user interfaces\n- [Tailwind](https://tailwindcss.com/) - A utility-first CSS framework designed to rapidly build modern looking websites\n- [HTML](https://developer.mozilla.org/en-US/docs/Web/HTML) - markup language used to create web pages, basic building block\n- [JavaScript](https://developer.mozilla.org/en-US/docs/Web/javascript) - popular lighweight programming language\n- [Vite](https://vitejs.dev/) - Development environment\n- VSCode - Free code editor\n- Google Custom Search Engine - Search engine showing search results page and images\n- Git/GitHub - GitHub is the place to store your projects while Git is a version control tool\n- Postman - used to test API endpoints\n\n## Getting Started\nThese instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.\n\n### Prerequisites\nWhat things you need to install the software and how to install them\n- First you need a code editor of your choice, I use [VSCode](https://code.visualstudio.com/) by Microsoft then you will need the current version of [Node](https://nodejs.org/en) to get your React app created and running on your local server.\n- After you need to choose between Vite or Create React App if you are going to code from scratch, if not then just run `npm run dev` in your terminal to get your project showing after changing the directory to your project folder(should be the same name as the one you used to create the app) after running `npm install`.\n  - a. If you choose Vite then this article can help with [getting started](https://www.makeuseof.com/set-up-react-app-with-vite/)\n  - b. If you choose Create React App then this doc page can [help](https://create-react-app.dev/docs/getting-started/)\n- You may need to initilize Tailwind depending on if you use [Create React App](https://tailwindcss.com/docs/guides/create-react-app) or [Vite](https://tailwindcss.com/docs/guides/vite), the process is different and these doc pages will also show you how to setup your app if you choose to code from scratch.\n- The rest are dependencies and those require either `npm i` or `npm install`, this page can [help](https://www.npmjs.com/) and you can search the package you need\n\n## Screenshot\n**Previous Design:** \u003cimg width=\"1402\" alt=\"Screenshot 2024-03-15 at 4 21 47 PM\" src=\"https://github.com/el634dev/waves/assets/84924260/779b15f5-30ce-4c2c-800c-181fae23c691\"\u003e\n\u003e \n**Current Design:** \u003cimg width=\"1402\" alt=\"Screenshot 2024-11-18 at 1 13 53 PM\" src=\"https://github.com/user-attachments/assets/e74fb444-deab-41b1-a76c-3cbd28c65cb9\"\u003e\n\n## Usage\nHow does one go about using it?\n\u003e\n`User can navigate to landing page and see a input bar to search the web`\n\u003e\n`User can see a navbar with a hamburger menu and two links`\n\u003e\n`User can see their results on a search results page`\n\n## Project Status\n- Project is: _being re-designed_\n\u003e \n- Project is begin re-designed to become more responsive on all devices, modern but clean and screen reader friendly\n\n## Deployment\nTo deploy this project you could run `npm run build`, this creates a version of your project that is bundled and ready for production. However I used Vercel, a frontend deployment tool that is free to help deploy this project. I noticed that running `npm run build` does help Vercel build your project a little faster but that could be because of Vite for creating this project and not Create React App (CRA). \n\n### Setup on Vercel\n- To create an account sign up using a third-party account such as GitHub or you could do it using a differen username and password, if you use GitHub it will deploy your project straight from GitHub\n- After signup you can login or skip step 1 and log in, go to your overview where you see a space for projects and on the right side click `Add New`\n- After clicking on `Add New` choose what you are adding, this will be project\n- Then aftering the last step, if you choose GitHub you can choose your repository and click on import\n- You are all done!\n\n## Author\n- Created by [@el634dev](https://github.com/el634dev)\n\n## Acknowledgements\n- This project was inspired by Ecosia\n- Hat tip to this video [Build \u0026 Deploy Google Search Application](https://www.youtube.com/watch?v=nvWwAYqL2U0\u0026t=7377s)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fel634dev%2Fwaves","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fel634dev%2Fwaves","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fel634dev%2Fwaves/lists"}