algolia / algolia.github.io Goto Github PK

Algolia's community projects

Home Page: https://community.algolia.com

JavaScript 27.27% Haml 14.62% SCSS 41.65% Sass 16.46%

algolia community github open-source instantsearch

algolia.github.io's Introduction

Algolia Community website

This is the source code of https://community.algolia.com/. The deployment to this live website is automated when changes are pushed to the source branch.

Local setup

Requirements

To run this project, you will need:

Node.js >= 9.80, via nvm - install instructions
Yarn >= 1.5.1 - install instructions ("Alternatives" tab): curl -o- -L https://yarnpkg.com/install.sh

Pro tip: Remove any brew installed/globall system installed Node.js and Yarn, just use nvm and Alternatives installation, they works perfectly.

Then:

nvm install
nvm use

Dev

To develop on this project, do:

yarn
yarn dev

Deploy

The deploy steps are directly handled by Gulp.js in the gulpfile.

yarn build
yarn deploy

Updating the underlying index

The current appId storing the data is latency (accessible for writes by Algolia employees). If you want to update the data, first test it on a new index: modify algolia-projects.json and run:

appId= adminApiKey= yarn update-index

Once you are sure this is the right config, then run the same command using latency credentials.

You may encounter issues while running yarn deploy, you can fix it by following this GH thread

algolia.github.io's People

Contributors

Stargazers

Watchers

Forkers

softwareking 0xedb cesarhub kznmft isabella232

algolia.github.io's Issues

The ecommerce show event we will participate is the middle east edition.

http://www.terrapinn.com/exhibition/ecommerce-show-middle-east/index.stm

Client feedback

Very good feedback from @gduvaux about the community page:

instantsearch.js and the helper.js are the biggest areas.

It confuses potential clients because they ask "Should I use instantsearch.js or helper.js? What are the differences between them? What about autocomplete.js" and the page is not able to answer that, nor the projects.

The answer to that could be "We promote first instantsearch.js and autocomplete.js as the two main UI libraries of Algolia"

To solve this, we though about:

make instantsearch.js and autocomplete.js the two most important areas
make the two areas of equal size
add "UI LIBRARY" label instead of "LIBRARY"
swap magento and helper.js areas (so magento gets bigger)
change helper library to "code" to make it more obvious its not a full blown UI library

What do you think?

Dependency deprecation warning: gulp-minify-css (nvm)

On registry https://registry.npmjs.org/, the "latest" version (v1.2.4) of dependency gulp-minify-css has the following deprecation notice:

Please use gulp-clean-css

Marking the latest version of an npm package as deprecated results in the entire package being considered deprecated, so contact the package author you think this is a mistake.

Please take the actions necessary to rename or substitute this deprecated package and commit to your base branch. If you wish to ignore this deprecation warning and continue using gulp-minify-css as-is, please add it to your ignoreDeps array in Renovate config before closing this issue, otherwise another issue will be recreated the next time Renovate runs.

Affected package file(s): package.json

Dependency deprecation warning: gulp-minify-css (npm)

On registry https://registry.npmjs.org/, the "latest" version (v1.2.4) of dependency gulp-minify-css has the following deprecation notice:

Please use gulp-clean-css

Marking the latest version of an npm package as deprecated results in the entire package being considered deprecated, so contact the package author you think this is a mistake.

Affected package file(s): package.json

If you don't care about this, you can close this issue and not be warned about gulp-minify-css's deprecation again. If you would like to completely disable all future deprecation warnings then add the following to your config:

"suppressNotifications": ["deprecationWarningIssues"]

Bug with places icon

Text escaping issue.

Will be fixed by 03ce18b

cc @JonasBa

Dependency deprecation warning: gulp-util (nvm)

On registry https://registry.npmjs.org, the "latest" version (v3.0.8) of dependency gulp-util has the following deprecation notice:

gulp-util is deprecated - replace it, following the guidelines at https://medium.com/gulpjs/gulp-util-ca3b1f9f9ac5

Marking the latest version of an npm package as deprecated results in the entire package being considered deprecated, so contact the package author you think this is a mistake.

Please take the actions necessary to rename or substitute this deprecated package and commit to your base branch. If you wish to ignore this deprecation warning and continue using gulp-util as-is, please add it to your ignoreDeps array in Renovate config before closing this issue, otherwise another issue will be recreated the next time Renovate runs.

Affected package file(s): package.json

Sort the projects by stars (if applicable)

This would require to have the number of stars in the dataset and add this count to the custom ranking.

Styling issue on All Projects refinement list

Add the super secret message generator

Tools section

Add steps to update index

JavaScript not working on old browser

Seems like the JS of the page is not working on old browser, as per this bug report: algolia/jekyll-algolia#57

Seems like it's failing on iOS 9 (and conkeror?). I don't have the devices to tests.

I don't know if we should fix this or not, I have no idea how old those browsers are. I think we should have at least the same compatibility that what we have to the instantsearch.js library.

Weird colors on the header

I had never realized it before (so maybe it's new), but the background color on each side of the header is not the exact same as the one of the header.

Few W3C validation errors

https://validator.w3.org/nu/?doc=https%3A%2F%2Fcommunity.algolia.com%2F

ps: Not sure we want to fix them all, especially the ripple links.

Text search should let the user find all libraries based on language

For example if I type JS, I will only get the JS API client. I want to be able to find instantsearch.js and react-intstantsearch.

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Rate-Limited

These updates are currently rate-limited. Click on a checkbox below to force their creation now.

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

Detected dependencies

npm

package.json

algoliasearch 3.33.0

async 2.6.3

babel-eslint 8.2.6

babel-loader 8.0.6

critical 1.3.4

del 3.0.0

eslint 4.19.1

eslint-config-algolia 13.4.0

eslint-config-prettier 2.10.0

eslint-plugin-import 2.18.2

eslint-plugin-prettier 2.7.0

fragments.css 1.0.49-alpha

gh-pages 1.2.0

glob 7.1.4

gulp 3.9.1

gulp-autoprefixer 5.0.0

gulp-critical-css 1.0.1

gulp-filter 5.1.0

gulp-haml 1.0.1

gulp-imagemin 4.1.0

gulp-livereload 3.8.1

gulp-minify-css 1.2.4

gulp-notify 3.2.0

gulp-rename 1.4.0

gulp-rev 8.1.1

gulp-rev-rewrite 1.1.4

gulp-sass 4.0.2

gulp-uglify-es 1.0.4

gulp-util 3.0.8

gulp-webserver 0.9.1

html-escape 2.0.0

image-size 0.7.4

imagemin-pngquant 5.1.0

instantsearch.js 2.10.5

lodash 4.17.15

prettier 1.18.2

run-sequence 2.2.1

svgmin 0.1.0

svgo 1.3.0

svgstore-cli 1.3.1

sw-toolbox 3.6.0

webpack 4.36.1

webpack-stream 4.0.3

node ^9.8.0

yarn ^1.7.0

nvm

.nvmrc

node 9.11.2

Check this box to trigger a request for Renovate to run again on this repository

add a link to the forum

see https://github.com/algolia/discourse/issues/29

See this forum thread.

Could we add a link from somewhere (maybe the header) to community.algolia.com and also algolia.com? Visually I don't know the best way to propose this, open to ideas @JonasBa :)

@dzello

Re-work categories

Here are the current categories:

API Client
Library
Live
Plugin
Tool
Misc

I think we should / we could come up with more explicit names.

Here are a few suggestions:

API Client & Library => Libraries
I think it is not necessary to separate the 2 concepts. In the end they are both libraries.
Also, the moment we have faceting on the language, we would always yield only one result for API Client which would be weird.
Also this would solve the issue of wrongly classifying Framework integrations into the API Client category.

Live => Live demos || Live examples || Demos
I don't know what "live" alone means.

Plugin => Integrations
It looks like "Integrations" is the more abstracted way to define plugin/module/extension/bundle/whatever.

Tool => Projects
The current list of "tools" are really more "projects using Algolia".

**Misc => /dev/null **
I feel we should not have a "catch all" but rather make other categories more explicit.
Not sure where the Swag thing could fit in.

Other remarks:

expectJSX should go to Libraries.
GitHub awesome autocomplete should go to "projects"

I hope these comments make sense @dzello , let me know what you think.

Dependency deprecation warning: gulp-util (npm)

On registry https://registry.npmjs.org, the "latest" version (v3.0.8) of dependency gulp-util has the following deprecation notice:

gulp-util is deprecated - replace it, following the guidelines at https://medium.com/gulpjs/gulp-util-ca3b1f9f9ac5

Marking the latest version of an npm package as deprecated results in the entire package being considered deprecated, so contact the package author you think this is a mistake.

Affected package file(s): package.json

If you don't care about this, you can close this issue and not be warned about gulp-util's deprecation again. If you would like to completely disable all future deprecation warnings then add the following to your config:

"suppressNotifications": ["deprecationWarningIssues"]

Observed:

Header is crowded on mobile

Thoughts on how we should fix? cc @JonasBa

algolia / algolia.github.io Goto Github PK

algolia.github.io's Introduction

Algolia Community website

Local setup

Requirements

Dev

Deploy

Updating the underlying index

algolia.github.io's People

Contributors

Stargazers

Watchers

Forkers

algolia.github.io's Issues

Rate-Limited

Open

Detected dependencies

Recommend Projects

Recommend Topics

Recommend Org

Jobs