impact / search Goto Github PK

View Code? Open in Web Editor NEW

12.0 4.0 5.0 4.78 MB

A web application to search the impact index

License: MIT License

CSS 3.33% HTML 10.23% TypeScript 86.44%

search's Introduction

This project was bootstrapped with Create React App.

Available Scripts

In the project directory, you can run:

`yarn start`

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

`yarn test`

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

`yarn build`

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

`yarn eject`

Note: this is a one-way operation. Once you eject, you can’t go back!

If you aren’t satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (Webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.

You don’t have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.

Learn More

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.

search's People

Contributors

Stargazers

Watchers

Forkers

xie-dongping dietmarw stjordanis shiningsunny

search's Issues

Add "Fork me on GitHub ribbon"

I think it would be a good idea to add a "Fork me on GitHub" ribbon. I found https://github.com/simonwhitaker/github-fork-ribbon-css which makes this rather lightweight and via css only.

I would go for a simple black, bottom right variant.

Link to released package

It would be nice if the release buttons of the found libs would actually link to the released lib. Thanks.

Add routes

Use routes to allow selection of a single library and, perhaps, even represent the search term.

Needs a Gruntfile (vs. make)

Spinner

Add a spinner when index is loading.

Add semantic version

We should add a semantic version to this and then publish it on the web page somewhere so people know what version they are using.

Add a "Back to search results" button on the detailed view

Currently when one clicks on the library name and gets to the detailed library description then that page is missing a "Back to search results" button. I know that the browsers back button and the impact logo gets you there but people don't expect that anymore. So having a small button with "<- back" or similar would help.

Star button does nothing

In the search window, we get a button N stars, but the button does nothing when I click it. I don't know what I expect it would do, but I really want to click it.

Switch to using redux

Sharing of the index (when it gets loaded) would be improved by using redux which adds an "elm-ish" like approach to state (which looks very cool).

Combine library page with search page

When thinking of moving the generation of the current library page I wondered if we perhaps should not combine that page with the search page.

What I have in mind is a page that by default displays all the libraries in the groups:

MA libs standard conform
MA libs
3rd party libs

and if the user types something in the search field it basically acts as a filter and only displays libraries matching the filter criteria but still with the group in which they reside.

Only deploy distribution files to impact.github.io

Currently, impact.github.io contains all kinds of development files from bower. I think only the dist/* parts should be sufficient for deployment. Right?

Refactor so application is built once index is loaded

This will simplify a lot of async handling and error cases (knowing that the index is loaded and static).

Add filter tick-boxes under the search field

Once the index supports this it would be nice to have tick boxes under the search.

E.g.,

Search for ...
Show: ❏ MA libs ❏ 3rd-party libs ❏ active libs

Add support for emoji icons

Search for "xml" in the search field. The only hit contains an emoji Icon in its description which is displayed as text.

Display also libraries w/o releases?

Currently modelica.org/libraries lists all libraries of the modelica and modelica-3rdparty accounts. Also those that haven't yet (or never had) a proper release. Also listing those in impact would encourage people to get their libraries listed by impact and might lead to people getting involved.

I see of course a problem here. Which is that the nature of impact itself is to index installable releases of libraries. Not sure how to solve this so that the search part also lists others.
Ideas?

Need favicon.ico

Why can't "IDEAS" or "FastBuildings" be found?

Why does a search for "ideas" or "IDEAS" give no hits though it is listed on mo-3rd-party? Is it due to the missing releases?

What badges to display.

I'd like to discuss what kind of badges we should (if at all) include in the more detailed search results.

Main groups are:

Origin:
- Modelica Association :
- 3rd-party (unaffiliated with the MA)
License:
Should we still mark unlicensed libraries as currently done? E.g.,
Status:
- last activity during the last year:
- last activity more than a year:
- marked as obsolete in the descripton: