eea6cd3ffb
* Make the channel importer versions dynamic * few things fromt he list 1. add nixos-org-configurations as input to flake.nix 2. evaluate channels.nix file and export channels via environment variable. that environment variable (lets call it NIXOS_CHANNELS) should be present during the build and inside the nix shell. the content of the variable can be JSON. 3. we pickup the NIXOS_CHANNELS environment variable in frontend/webpack.config.js and pass it further to webpack process, just like we do with ELASTICSEARCH_MAPPING_SCHEMA_VERSION. 4. we forward NIXOS_CHANNELS to Elm via frontend/src/index.js as an Elm application flag. Just like we do with other variables there. * Decode nixosChannels in Elm * Use nixosChannels that came via application flag * read nixos channels in github action * defaultNixOSChannel should be calculated * add two pointers where the check should be added * pass nixosChannels to flake-info and remove title, rather calculate it * Add NixosChannels struct validation and validation Error * Read NIXOS_CHANNEL variable * Check channel * Add channel struct to fix parsing NIXOS_CHANNELS * Use `eachDefaultSystem` instead of listing them manually * Add individual dev shells for frontend and backend * Update .github/workflows/import-to-elasticsearch.yml Co-authored-by: Naïm Favier <n@monade.li> * use both development environments by default (as it was) but still provide devShells for each of the subprojects * pkgs.lib → lib everywhere and define lib = nixpkgs.lib before the call to eachDefaultSystem Also, version = lib.fileContents ./VERSION; * Update flake.nix Co-authored-by: Naïm Favier <n@monade.li> * typo * bumping version to test the changes to import-to-elasticsearch github action * some invisibile characters needed to be removed * typo * will this work * typo * forgot the checkout step * add some debugging * typo * read NIXOS_CHANNELS from environment not via argument * fix for the NIXOS_CHANNELS variable Co-authored-by: Janne Heß <janne@hess.ooo> Co-authored-by: ysndr <me@ysndr.de> Co-authored-by: Naïm Favier <n@monade.li> |
||
|---|---|---|
| .github | ||
| flake-info | ||
| flakes | ||
| frontend | ||
| .envrc | ||
| .gitignore | ||
| flake.lock | ||
| flake.nix | ||
| overlay.nix | ||
| README.md | ||
| VERSION | ||
search.nixos.org
This repository contains the scripts and the web application for
search.nixos.org.
How this project came to be
Initial idea was to replace NixOS packages and options search which was fetching one JSON file which contained all packages (or options). This approach is good for its simple setup, but started to show its problems when packages number was getting bigger and bigger. I'm sure we could optimize it further, but ideas what all could we do if there would be some database in the back were to tempting not to try.
For backend we are using Elasticsearch instance which is kindly sponsored by bonsai.io. On the frontend we are using Elm.
How search works?
The use case we want to solve is that a visitor want to see if a package exists or to look up certain package's details.
A user wants to converge to a single result if possible. The more characters are added to a search query the more narrow is search is and we should show less results.
Very important is also ranking of search results. This will bring more relevant search results to the top, since a lot of times it is hard to produce search query that will output only one result item.
A less important, but providing better user experience. are suggestions for writing better search query. Suggesting feature should guide user to write better queries which in turn will produce better results.
Development
To start developing open a terminal and run:
nix-shell --run "cd frontend && yarn dev"
You can point your browser to http://localhost:3000 and start developing.
Any changes to source files (./frontend/src) will trigger a hot reload of an
application.
Deploying
- On each commit to
mainbranch a GitHub Action is triggered. - GitHub Action then builds production version of the web application using
yarn prodcommand. - The built web application (in
./dist) is then deployed to Netlify. - GitHub Action can also be triggered via Pull Request, which if Pull Request was created from a non-forked repo's branch, will provide a preview url in a comment.
Adding flakes
To add your own flakes to the search index edit ./flakes/manual.toml.
Possible types are github, gitlab, and git (which is the fallback for any kind of git repository but requires to set a revision key manually as of now).
To test whether your flake is compatible with nix flake-info you can try running flake-info against it
$ nix run github:nixos/nixos-search#flake-info -- flake <your flake handle>