Giter Club home page Giter Club logo

search's Introduction

search

Creative Commons Search Portal

Code of Conduct

CODE_OF_CONDUCT.md:

The Creative Commons team is committed to fostering a welcoming community. This project and all other Creative Commons open source projects are governed by our Code of Conduct. Please report unacceptable behavior to [email protected] per our reporting guidelines.

Contributing

See CONTRIBUTING.md.

Development

Setting up the Project

Perform the following steps to create a copy of this repository on your local machine:

  1. Fork the CC Search Portal repository:

    • Log into GitHub (or create a GitHub account and then log into it).

      • Go to the creativecommons repository.
      • Click the Fork button at the top of the screen.
      • Choose the user for the fork from the options you are given, usually your GitHub ID.

    A copy of this repository is available in your GitHub account.

  2. Get the string to use when cloning your fork:

    • Click the green "Code" button on the UI page.
    • Select the protocol to use for this clone (either HTTPS or SSH).
    • A box is displayed that gives the URL for the selected protocol.

    Click the icon at the right end of that box to copy that URL.

  3. Clone the forked repository from the shell in a local directory with the git clone command, pasting in the URl you saved in the previous step:

    git clone https://github.com/<UserName>/search.git

    or

    git clone [email protected]:<UserName>/search.github.io.git

    Where <UserName> is your GitHub username. The search.github.io directory is now available in the local directory.

  4. Remember to sync your fork with the main branch regularly.

    To Perform the same:-

    Go to GitHub and copy the url of the main creativecommons/search repo:

    https://github.com/creativecommons/search.git

    make sure to be in the root folder of the project and the branch should be main branch and type:

    git remote add upstream https://github.com/creativecommons/search.git

    Now you have your upstream setup in your local machine, whenever you need to make a new branch for making changes make sure your main branch is in sync with the main repository, to do this, make sure to be in the main branch:

    git pull upstream main
    git push origin main

Docker Compose Setup

Use the following instructions to start the Project with docker compose.

  1. Install Docker (https://docs.docker.com/engine/install/)

  2. Navigate to the creativecommon/search Project that you have cloned

  3. Run the containers

    docker compose up
  4. After running the Above command, Docker will use the docker-compose.yml file and Build a local enivronment for you

  5. Navigate to http://localhost:8080 in your browser and the app would be running.

  6. stop the containers

    To stop the app from running, simply open an another instance of terminal and type

    docker compose down

    or

    You can simply revisit the existing terminal which is running the container and type CTRL + C

Format HTML with Prettier

docker compose run node prettier --write docs/index.html

License

Code

LICENSE: the code within this repository is licensed under the Expat/MIT license.

Content/Text

CC BY 4.0 license button

The content/text within the project is licensed under a Creative Commons Attribution 4.0 International License.

search's People

Contributors

biki-das avatar bkimcode avatar bunmix avatar dhruvkb avatar dikehprosper avatar dullbenz avatar fmann avatar francofrancis avatar hugosolar avatar imajin14 avatar jennysimen avatar kgodey avatar marshalng avatar mattl avatar mbonamensa avatar mdsahil-oss avatar possumbilities avatar preciousoritsedere avatar rubadel avatar timidrobot avatar vthunder avatar xdevs23 avatar zackkrida avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

search's Issues

[Bug] Removing line inconsistency and correcting tab spacing in style.css

Description

I will like to remove line inconsistency and correct tab spacing in style.css

Reproduction

  1. open cc search in editor.
  2. navigate to style.css file.
  3. check lines 9, 15, 23...
  4. see error.

Expectation

The line spacing in

style.css file should be consistent so that the code will be more organized.
tab spacing should be corrected as well.

Screenshots

1st Report

Resolution

  • I would be interested in resolving this bug.

[Bug] Improve readability by correcting tab inconsistencies in home-buckets.php

Description

The tab inconsistencies and spacing make the code difficult to read even with the comments indicating closing tags.

Reproduction

  1. Open cc search in the editor
  2. Navigate to cc-wp/home-buckets.php
  3. Check lines 3-5, 74-108
  4. See error.

Expectation

I expected to see indexing in the code that would make it a bit more readable

Screenshots

Screenshot (38)

Resolution

  • I would be interested in resolving this bug.

[Bug] Wikimedia Commons search does not open a new tab/window

Description

Wikimedia Commons search does not open a new tab/window

Reproduction

  1. type search term in search field
  2. click Wikimedia Commons button

Expectation

Searches should always open in a new tab/window to allow multiple engines to be used with the same search term

[Feature] Redesign Footer component

Problem

The current footer is really bad visually and does not meet the current standards of other UI/UX trend

Description

This feature will make the Footer more pleasing to look at and more accessible

Additional context

For me personally as a Frontend Developer the current Footer is way below standard with the ever evolving world of UI/UX
The overall goal for the new footer is to put it in alignment with the current universal footer found on newer Creative Commons sites. See an example here: https://opensource.creativecommons.org/

Screenshot (161)

Implementation

  • I would be interested in implementing this feature.

[Bug] correct typing errors in search.js

Description

wrong spelling of buttons on lines 15 of search.js file

Reproduction

  1. open cc search in editor
  2. navigate to search.js file
  3. check comment on line 15
  4. See error.
    ##Expectations
    errors should be corrected and updated to the right spelling

Resolution

  • I would be interested in resolving this bug.

[Bug] Google Image search is not limited to "Creative Commons licenses"

Description

Google Image search is not limited to "Creative Commons licenses"

Reproduction

  1. input cat into search field
  2. click Google Images button
  3. Resulting query:
    https://www.google.com/search?site=imghp&tbm=isch&q=cat&tbs=sur:fmc
    

Expectation

  • Resulting query should be limited to "Creative Commons licenses":
    https://www.google.com/search?site=imghp&tbm=isch&q=cat&tbs=sur:fmc%2Cil:cl
    

Screenshots

Current

Screenshot 2022-07-13 at 09-39-09 cat - Google Search

Limited to "Creative Commons licenses"

Screenshot 2022-07-13 at 09-38-45 cat - Google Search

Redesigning the header component and improving the transition feature and line spacing

Problem

The current header component of the legacy site does not match the visuals of the other cc web entities. The line and character spacing of the text are also squeezed thus making it difficult to read the text. Lastly, the transition effect in the 'search using' area does not create much of a contrast between the before and after.

Description

Adding this feature will ensure that the header components of the legacy site matches the visuals of the rest of the creative commons web entities. This feature will also improve readability by increasing line spacing and character spacing. The feature will also add more contrast to the transition during the hover effect in the components within the 'search using area'

Currently, the header only has the creative commons logo

Screenshot (4)

Additional Context

I intend to use the header on the site linked below as a template for the information to add to the header such as the blog, contact, information, social media handles, and support.
https://creativecommons.org/use-remix/

Alternatives

Adding links to the blog, contribute, community, and work programs pages; as is in the other creative commons page. https://opensource.creativecommons.org/

[Bug] Accessibility issues with the search engine buttons

Description

There are a few a11y concerns with the approach taken by the actual buttons for each search engine:

The buttons are not accessible via keyboard, because they use labeled divs instead of actual input controls. An <input type="radio"> group might be an elegant solution that allows the buttons to be keyboard navigable and to update the value of the currently-selected search engine without any custom javascript.

Reproduction

  1. See error.

Expectation

Screenshots

Environment

  • Device: (eg. iPhone Xs; laptop)
  • OS: (eg. iOS 13.5; Fedora 32)
  • Browser: (eg. Safari; Firefox)
  • Version: (eg. 13; 73)
  • Other info: (eg. display resolution, ease-of-access settings)

Additional context

Resolution

  • I would be interested in resolving this bug.

license update to 4.0

The license information in the footer of search.creativecommons.org should be updated to 4.0.

[Bug] SoundCloud search does not open a new tab/window

Description

SoundCloud search does not open a new tab/window

Reproduction

  1. type search term in search field
  2. click SoundCloud button

Expectation

Searches should always open in a new tab/window to allow multiple engines to be used with the same search term

Repo doesn't include theme

The live server has a "cc-wp" directory originally pulled in from subversion with a bunch of php, js, css. search uses this for the theme.

It should be added to this repository so it can be properly version controlled.

[Bug] ccMixter search does not open a new tab/window

Description

ccMixter search does not open a new tab/window

Reproduction

  1. type search term in search field
  2. click ccMixter button

Expectation

Searches should always open in a new tab/window to allow multiple engines to be used with the same search term

footer issues and misspelled comment

the footer design is not the most good looking. some social media icons should be included e.g instagram, Tiktok. Also,
some code comments is mispelled. And, i'll like to fix those two stuff if given opportunity.

Toggle button of "cc-global-header" in the home page is not completely visible.

Description

Toggle button of "cc-global-header" in the home page is not completely visible.

Reproduction

  1. Go to Home page.
  2. On the top-right side 'the explore button' is not visible completely.

Expectation

Screenshots

CC-BUG-1

Environment

  • Device: ( laptop )
  • OS: (Linux ubuntu 18.01)
  • Browser: (Chrome)
  • Version: ( 87.0.4280.66)
    -resoltution ( 1920 * 1080p )

Resolution

  • [x ] I would be interested in resolving this bug.

[Feature] README.md file update

Problem

README.md

Description

README.md file does not contain the steps required to setup the project locally on a personal work environment

Alternatives

This will help new contributors to be able to setup their environment with ease... This is especially for those who are new to open source

Additional context

Links to various sites that could help the contributor during setup phase

Implementation

  • [ x] I would be interested in implementing this feature.

[Bug] Js error `j.handler.apply is not a function` showing in the console locally

Description

After running the project, there is an error in the console Uncaught TypeError: j.handler.apply is not a function. This error does not seem to affect the platform so far but it needs to be fixed.

Upon investigation, the error comes from script.js file on line 114 where we are displaying a carousel. On the instance where the carousel is not displayed, this causes the error in the console.

Reproduction

  1. Run the project locally
  2. Inspect the home page
  3. Go to the console tab
  4. See error.

Expectation

The platform should run without any JS error in the console.

Screenshots

Screen Shot 2022-10-14 at 10 23 14

Environment

  • Browser: (Chrome, Safari; Firefox)

Additional context

On the current version of the platform, the carousel is not displayed but the component is found in the codebase. This error might not be experienced by others who have the carousel displayed but it would be good to have a solution which would not show an error in both cases.

Resolution

  • I would be interested in resolving this bug.

feedback from user

Here's a message someone wrote to info@ to give some feedback to search.

==============
Hi,

Some feedback:

  • good concept
  • helpful way to search on multiple sources, if it actually works
  • bug: if you search for something, and it doesn't find anything, you can just enter in that results page a new query, and it'll search with the same parameters. That is good. However, if it does find something, you can still enter something - but no matter what you enter, it returns you to the empty search form. Seems unintended behavior.
  • Add a link in the request for feedback :)
  • Wikimedia Commons is missing - a big repository that would make a lot of sense to tap into... good for me because I am looking for images to add to Wikimedia Commons, but perhaps less perfect for externals :)
  • The page breaks when privacy badger is active. That is usually a bad sign for the amount of data you're trying to collect.

Thanks, and keep up the good work,

[Bug] Open Clip Art Library search does not open a new tab/window

Description

Open Clip Art Library search does not open a new tab/window

Reproduction

  1. type search term in search field
  2. click Open Clip Art Library button

Expectation

Searches should always open in a new tab/window to allow multiple engines to be used with the same search term

[Bug] YouTube search does not open a new tab/window

Description

YouTube search does not open a new tab/window

Reproduction

  1. type search term in search field
  2. click YouTube button

Expectation

Searches should always open in a new tab/window to allow multiple engines to be used with the same search term

[Bug] Cleanup Codebase CSS files tab and spacing formatting

Description

The codebase currently has a lot of duplicates of code and files that do not seem necessary. There is also a lot of generic errors especially in the CSS files which can cause a lot of confusion especially to people new to the codebase.

Reproduction

  1. Open ie8-and-down.css
  2. Open primary.styles.css
  3. Open style.css

Expectation

  1. Fix all errors in the CSS files
  2. Remove all unused code

##Additional Context
The errors in the CSS range from wrong Syntax and No opening curly brace in one instance

Screenshots

Screenshot (162)
Screenshot (163)
Screenshot (164)

Resolution

  • I would be interested in resolving this bug.

Rename repository

It may be appropriate to rename the repo to legacy-search for clarity.

[Feature] Include a section with a descriptive content of what CC Search is about

Problem

CC Search doesn't have any descriptive content that tells the user what the site is about.
Screenshot (76)

Description

This feature will add more context to the website. So that when a user taps in, they can read a brief description of what the site is about. see. This will make it align with the UI of (https://opensource.creativecommons.org/)

Alternatives

Additional context

Below is a screenshot of a similar feature in (https://opensource.creativecommons.org/)
Screenshot (75)

Implementation

  • I would be interested in implementing this feature.

[Feature] Additional source suggestions

Problem

More search engines are always welcome in a project like this, to improve the number of relevant options to users.

Description

While we're in the process of renaming it to 'External Sources', since the meaning of 'meta search' is a bit confusing for folks (not to mention, using the word 'meta' in a project with '-verse' in its name seems ill-advised), a feature similar to this search engine is still quite popular in Openverse.

CleanShot 2022-09-16 at 09 58 42@2x

Our list of sources might be a good reference for some to include in this meta search. We also have the guidelines for how to format their URLs:

https://github.com/WordPress/openverse-frontend/blob/main/src/utils/get-additional-sources.ts#L61

Description

Alternatives

Additional context

Implementation

  • I would be interested in implementing this feature.

[Bug] Flickr search does not open a new tab/window

Description

Flickr search does not open a new tab/window

Reproduction

  1. type search term in search field
  2. click Flickr button

Expectation

Searches should always open in a new tab/window to allow multiple engines to be used with the same search term

[Feature] Redesign the Card and Search Component

Problem

The current card and search component is not attractive visually and does not meet the standard of design.

Description

This feature will make the section more attractive and open to all.

Alternatives

Additional context

As a Frontend developer, the section does not meet a good standard and needs to be worked on. The goal is to make an attractive and good looking search section that will be open to all.

Implementation

  • [ x] I would be interested in implementing this feature.
    Feature  Redesign Card and Search Component

[Feature] Improve the site Responsiveness

Problem

The site responsiveness is already made available via my check on the code base (source code), but from my observation it isn't at least 100% Responsive, i checked this using a screen size starting from 300px X 600px, (widthpx X heightpx), then went down to 255px X 600px and noticed that the page body went out of device width.

cc-search
cc-search2

Description

An improvement is highly required, reason is because, users over the world have various sizes of device, users with low screen size would have a limited visual on the page content.

Alternatives

Working efficiently on the code base to improve the page responsiveness would be a fine solution, after this process, the page in question would take the actual width and height of whatever size of device it is being accessed with, in a well and organized form

Additional context

It is seen that the current responsiveness on the page isn't on a rating of 100% and needs urgent improvements so as to satisfy users of all kinds. A very clear example is the github page below, i reduced the screensize to 300px X 600px and the page could comfortably contain my current screensize. To check this, use google inspect feature.
pagegit
Page url: https://github.com/creativecommons/search/issues

Implementation

  • I would be interested in implementing this feature.

[Feature] Improve on site contrast

Problem

Ran the site through an accessibility checker, and there seem to be some contrast issues. Especially with the white text over the greeny-background. The contrast ratio currently stands at 3.14.

Description

People with low contrast sensitivity will have issues reading the white text on the green background. The green shade could be altered and made a little darker.
Shot of site colors with low contrast background

Adding a background color like #28480F will take the contrast up to 10.38.
Shot of site colors with improved green shade

Alternatives

A shade which is only slightly greener than the current one could also work.

Additional context

Implementation

  • I would be interested in implementing this feature.

[Feature] Redesign the input Component

Problem

The current input component is not attractive visually and also does not meet the standard of design.

Description

This feature will make the section more attractive and open to all

Alternatives

Additional context

As an experienced Front-end developer, the input section does not meet a good standard and needs to be worked-on. The results would make an attractive and good-looking input section that will be open to all.

Implementation

  • I would be interested in implementing this feature.
    redesigned

[Feature] Creating a pop-up message for countries whose laws do not affect the rights of creators and authors

Problem

Countries on the CC Rights Back Resource Page that their laws do not affect the rights of the author or creator have no specific action on the map even when being clicked.

Description

We can change this by adding the dbclick feature in JS which shows the message to the users that the country they are currently in does not affect their rights as the author or creator on their creative works. This way the user does not get confused when checking for their country.

Implementation

  • I would be interested in implementing this feature.

[Feature] Improving the legibility of the site content to enhance readibility

Problem

Website content should be legible to increase readability in the user experience. This is an important aspect that also contributes to users staying or leaving the website.

I checked the website, and the first thing that caught my attention was the font size which was too small. This can prevent users with/without eye problems to read the content of the website.

Description

This is an image with the current font size which I think is not ideal.

Screenshot 2022-10-14 at 9 51 06 AM

My suggestion is to increase the font size to 14px or 16px for paragraphs and for titles it can be 16px with font-weight of 500.

Alternatives

I also believe that using Arial or Roboto font family can improve the user experience.

Implementation

The implementation is quite simple:

  • the paragraph font size can be increased to 14px.
  • the title can be increased to 16px with a font weight of 500.
  • I would be interested in implementing this feature.

[Change] Rename project to CC Search Portal, all text occurrences

Description

The project known as CC Search, CC Meta Search, Old Search, and Legacy CC Search needs all text occurrences to be changed to the new title: CC Search Portal.

Additionally, the wording oldsearch.creativecommons.org in the footer, needs to be changed to CC Search Portal

Resolution

  • I would be interested in resolving this bug.

[Feature] use cc global components to customize site appearrance

Problem

code base doesn't make use of cc global components elements such as footer, header and explorer which will simplify project code base

Description

CC global components provides already customized elements which could be used all over any cc site hence reducing lines of code and making page easily debug-able

Alternatives

could allow site to use alternative components which will make code base more stressful to debug

Additional context

css files for the above could be cleared and modified to use that of cc global components

Implementation

  • I would be interested in implementing this feature.

[Support] Incomplete code no how to run docker on the ReadMe

when I was following the code to run Docker in the section (DOCKER COMPOSE UP) as the code set it did not work for me.

Reproduction

  1. open the terminal in my code editor
  2. run code docker compose up

Screenshots

/home/zoe/Pictures
firstdockererror

the fixed result

  • it took a while to figure out Sudo has to go in front before Docker compose up.
    dockerFinalresult

Resolution

  • [x ] I would be interested in resolving this bug.

[Bug] Pixabay images are no longer CC0 nor public domain and the engine should be removed

Description

Pixabay images are no longer CC0 nor public domain and the engine should be removed

Reproduction

Pixabay License Change - No Longer a CC0 License | SugarFire:

Around the beginning of January 2019 Pixabay changed the type of license they use to make their content available.

Before the change Pixabay used the Creative Commons license “CC0” which dedicates works to the public domain.

Expectation

Search should be limited to CC licensed or public domain content.

[Feature] Improvements on repo Readme.md

Problem

As a beginner and new contributor to the Creative Commons Community, I made some mistakes while trying to install docker and clone the repo.
After reading through the Readme.md, I took the first step under 'Docker compose setup' in the Readme.md and clicked on the link to install Docker. And then I had several failed attempts in starting up Docker.

After successfully setting up Docker, I made a mistake by attempting to clone the repo in Docker, because I did not properly understand the second instruction. Cloning the repo in Docker took so many hours and my PC even lagged behind for a bit.

Description

In this context, I suggest we add more descriptive guidelines in the Readme.md, by adding a few sides notes that state the main tools needed for the project and their uses.
For instance; stating that Docker is just for background work and the code editor/IDE is where the cloning and main work should be done.
This way, new contributors who are most likely beginners will be able to understand the steps and process better and avoid making mistakes.

Implementation

  • I would be interested and happy to implement this feature.
    -Under the 'Setting Up the Project' section, it will be nice to include:
    The three main tools you'll need on most projects here are:

Docker App (Docker does some heavy lifting, but it's mostly for background use)
A code editor/IDE (VS Code, Sublime, Nova, etc.)(This is where the bulk of the work, like cloning your repo, and making your code changes, will be done)
A command-line/terminal client (Terminal, iTerm2, etc.) (if your IDE doesn't have one)
If you have all three of these tools, then you can proceed to the next steps below

Under Docker Setup, I feel like a more detailed step by step instructions should be added.

[Bug] Wrong Spelling(Typing Error)

This PR #71 by me fixes this issue

Description

buttons typed as btutons instead of buttons in search.js file line 15.

Implementation

  • I would be interested in implementing this feature.

Updating the website UI

I want redesign the existing "creativecommons" components into the current standard. I discovered it's necessary to set appealing background color , and use CSS custom property to remove redundency. Also, animate some buttons.

I'm doing that to provide clean design and responsiveness also the user to enjoy exploring the "creativecommon" website

[Bug] Europeana search does not open a new tab/window

Description

Europeana search does not open a new tab/window

Reproduction

  1. type search term in search field
  2. click Europeana button

Expectation

Searches should always open in a new tab/window to allow multiple engines to be used with the same search term

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.