├── README.md └── contest-category3-sandbox.md /README.md: -------------------------------------------------------------------------------- 1 |

2 | 3 |

4 | 5 | [Algolia](https://www.algolia.com) is happy to kick off a **Coding Contest**! 6 | 7 | To participate, it's simple: 8 | - Build a project using Algolia, choosing one of the 3 categories listed below 9 | - Place your submission in a GitHub repository 10 | - Send your project to **_codingcontest[at]algolia.com_**. In the subject line, please specify First, Second or Third category. In the body of the email, mention your first and last name, as well as a short description of the project (in 1 or 2 sentences). 11 | 12 | The deadline for all submissions is **Wednesday, May 5th, 11:59pm PST**. 13 | 14 | # The prizes 15 | 16 | Exciting news! For each category, the winner will receive one of the following: 17 | - A smartphone of your choice between an iPhone 12 64 Gb / a Samsung S21 128 Gb / an OPPO Find X3 Neo 256 Gb 18 | - Or an $800 Amazon giftcard. 19 | 20 | On top of that, each participant is entitled to a 1-month coupon to use Algolia for free. Please send us an email to codingcontest[at]algolia.com with “Coupon request” in the subject line. 21 | 22 | # Project requirements 23 | 24 | Build a search interface using Algolia. It can be for mobile or the web. You can integrate it into an existing website or app that has no search yet, or create a simple, standalone interface for the contest. 25 | 26 | If you are not familiar with Algolia, we suggest you follow our [Quick Start guide](https://www.algolia.com/doc/guides/getting-started/quick-start/), which will help you (a) send data to Algolia and (b) build a UI. You can also use our [Interactive Tutorial](https://www.algolia.com/doc/onboarding/#/pick-dataset) for the same purposes. 27 | 28 | To help with the UI, we encourage you to use our InstantSearch (IS) front-end libary that comes in different flavors: [JS IS](https://www.algolia.com/doc/guides/building-search-ui/what-is-instantsearch/js/), [Android](https://www.algolia.com/doc/guides/building-search-ui/what-is-instantsearch/android/), [Angular](https://www.algolia.com/doc/guides/building-search-ui/what-is-instantsearch/angular/), [iOS IS](https://www.algolia.com/doc/guides/building-search-ui/what-is-instantsearch/ios/), [React IS](https://www.algolia.com/doc/guides/building-search-ui/what-is-instantsearch/react/), [Vue IS](https://www.algolia.com/doc/guides/building-search-ui/what-is-instantsearch/vue/). InstantSearch gives you all of the front-end widgets of a great sSearch UI. Check out the [widget showcase](https://www.algolia.com/doc/guides/building-search-ui/widgets/showcase/vue/) for inspiration. 29 | 30 | Additionally, feel free to use any of Algolia’s features: facets, solutions, paging, menus, and so on. Check out our [solutions page](https://www.algolia.com/doc/guides/solutions/gallery-overview/) in the docs for tutorials, and check our [inspiration library](https://www.algolia.com/search-inspiration-library/) to see what you can build. 31 | 32 | We will not accept projects that display violence, pornography, abuse, or any kind of hate speech, as stated in the Coding Contest [Official Rules](https://drive.google.com/file/d/1tO_zOR_noyTxfkpB18gI6MNmcSu9TWRs/view?usp=sharing). 33 | 34 | 35 | 36 | # Criteria 37 | 38 | To evaluate your submitted project, we will take into account: 39 | - **Functionality:** Is your code clean, does it work well? 40 | - **User experience:** Once you've got the features, now it’s time to design the interface. Are features well placed on the screen? Are they nicely styled? Extra points for creativity or novelty! 41 | 42 | # Your project - Pick one: 43 | 44 | **Important note**: you can only submit _one_ project. 45 | 46 | Choose from one of the following three categories: 47 | 48 | 49 | ## First category 50 | 51 | **Build a project using both the [Strapi](https://strapi.io/) and [Algolia](https://www.algolia.com/) APIs.** 52 | You can also include any other APIs or tool you'd like for this project. 53 | 54 | 55 | ## Second category 56 | 57 | If you're not familiar with Strapi, we offer you a broader option: **build a project using the Algolia API**. 58 | You can also include any other APIs or tools you'd like for this project. Please refer to our [documentation](https://www.algolia.com/doc) if you have any questions. 59 | 60 | 61 | ## Third category 62 | 63 | **Build an Algolia implementation using a pre-made Codesandbox**. 64 | 65 | See the [rules here](https://github.com/algolia/algolia-coding-contest/blob/main/contest-category3-sandbox.md). 66 | 67 | 68 | # Frequently Asked Questions 69 | - Can Algolia offer me a free plan for this project? 70 | 71 | _Yes. Algolia offers a 14-day full-featured free trial for all new users. We are also offering a 1-month coupon for each participant to thank you for joining the contest. If you’re interested in receiving the coupon, please send us an additional email to codingcontest[at]algolia.com with “Coupon request” in the subject line._ 72 | 73 | - Can I use Strapi for free for this project? 74 | 75 | _Yes. Strapi offers a Community plan that is free and available to everyone._ 76 | 77 | - Can I participate in several categories? 78 | 79 | _No. You can only participate in one of the 3 categories, as stated in the Coding Contest [Official Rules](https://drive.google.com/file/d/1tO_zOR_noyTxfkpB18gI6MNmcSu9TWRs/view?usp=sharing)._ 80 | 81 | - When will the results will be announced? 82 | 83 | _The Algolia jury will deliberate during 2 weeks after the last day of submissions._ 84 | 85 | - How will I know I am the winner of my category? 86 | 87 | _You will receive an email from the Algolia team. They will contact you about the prize and how to organize the shipping._ 88 | 89 | - If I have some questions for the organizers, where should I send them? 90 | 91 | _Please send them to codingcontest[at]algolia.com_ 92 | 93 | - Can a website/app already using Algolia be submitted? 94 | 95 | _No. The goal of this contest is for you to build something new. We want to make the contest fair to every participant who has until May 5th to build their project. However, you can definitely get inspired by one of your previous projects using Algolia!_ 96 | 97 | - Does the code have to be public or can I submit a private repository? 98 | 99 | _You can submit a private repository, but we will ask you to give access to the jury members when you submit on the codingcontest[at]algolia.com email adress._ 100 | 101 | ### Coding Contest Official Rules 102 | 103 | The Official Rules of the Coding Contest are available here. By participating to the Coding Contest, you agree with the Algolia Coding Contest [Official Rules](https://drive.google.com/file/d/1tO_zOR_noyTxfkpB18gI6MNmcSu9TWRs/view?usp=sharing). 104 | 105 | -------------------------------------------------------------------------------- /contest-category3-sandbox.md: -------------------------------------------------------------------------------- 1 | ## Solve a problem! 2 | Company ABC has asked you to revamp their existing search interface. 3 | 4 | Their only requirement is that it includes [Autocomplete](https://autocomplete.algolia.com/). 5 | 6 | ### The contest 7 | 8 | To participate: 9 | 10 | - Start with the following Codesandbox: 11 | https://codesandbox.io/s/autocomplete-starter-lobbu 12 | 13 | - Fork this sandbox 14 | - Make all coding changes in your forked version 15 | - Submit the final version of your sandbox 16 | 17 | You have **two options** in terms of how you can improve the sandbox: 18 | 1. A great UI 19 | 2. Multiple data sources. 20 | 21 | #### Option 1 - Create a great autocomplete UI 22 | 23 | Implement an **instant results, autocomplete experience**, which means that users see results instantly, as they type. 24 | For this option, you can use the data that's already plugged into the Sandbox. The goal is to add great functionality and design to your implementation. 25 | 26 | Here are some inspiring examples: 27 | - [docs](https://www.algolia.com/doc/) 28 | - [docsearch](https://docsearch.algolia.com/) 29 | 30 | Take a look at this article on [how to implement Autocomplete](https://www.algolia.com/blog/ux/taking-documentation-search-to-new-heights-with-algolia-and-autocomplete/). 31 | 32 | 33 | #### Option 2 - Plug in multiple data sources 34 | 35 | Focus on the data: plug in your own service(s) and add multiple data sources to the Autocomplete library. Be creative - you can use sources that add social networks, products from diverse catalogs, and multiple sources of streaming services, such as GitHub API, YouTube API, [Algolia](https://github.com/algolia/datasets), [Locations](https://index.okfn.org/dataset/postcodes/), etc.. 36 | 37 | You can find out more about combining multiple sources in our guide on [federated search](https://www.algolia.com/doc/guides/solutions/ecommerce/autocomplete/tutorials/federated-search/). 38 | 39 | The most interesting use case for multiple data sources wins! You will be judged on the creativity of how you integrate and manage multiple data sources. The only front-end requirement is that your UI properly display the mulitple data sources. 40 | 41 | **Happy coding!** --------------------------------------------------------------------------------