Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/schalkneethling/developer-toolchest

Collect all your tools. Tag, filter, find, and use.
https://github.com/schalkneethling/developer-toolchest

css jsx reactjs tools

Last synced: 5 days ago
JSON representation

Collect all your tools. Tag, filter, find, and use.

Awesome Lists containing this project

README

        

# developer-toolchest

All your tools in one place.

[![Netlify Status](https://api.netlify.com/api/v1/badges/4dfb254f-61fb-449f-9583-4e19774de6e9/deploy-status)](https://app.netlify.com/sites/romantic-chandrasekhar-499964/deploys)

## Tools

All tools are listed in `public/tools.json`. To add a tool:

- [Fork the repository](https://docs.github.com/en/get-started/quickstart/fork-a-repo)
- Clone to your local machine or edit on GitHub using either the [Web Editor](https://docs.github.com/en/codespaces/the-githubdev-web-based-editor) or [Codespaces](https://github.com/features/codespaces)
- Create a [feature branch](https://www.atlassian.com/git/tutorials/comparing-workflows/feature-branch-workflow) for the tool you wish to add
- Open `tools.json` and add the tool to the list(see below for an example)
- Open a pull request 🎉

```json
{
"id": 4,
"title": "RealFaviconGenerator",
"url": "https://realfavicongenerator.net/",
"description": "With so many platforms and icons, it's hard to know exactly what you should do. What are the dimensions of favicon.ico? How many Touch icons do I need? RealFaviconGenerator did the reseach and testing for you.",
"logo": "realfavicongenerator.png",
"alt": "A square that is half blue and half yellow with a capital R in the center",
"tag": ["realfavicongenerator", "utility", "online", "favicon"]
}
```

> NOTE: All fields except the `alt` property is required. Remember to bump the `id` !important 😄

## Images

You can now also add a logo for the service or tool you are adding. The steps to add a logo are as follows:

1. Create a PNG file with a size of 500px by 300px.
2. Ensure the logo is appropriately sized and centered within the canvas.
3. Add the image file to `public/logos`
4. Add the `logo` and possibly the `alt` properties to the JSON entry. For the `logo` property, only add the file name, for example, `codepen.png`

> NOTE: As the logos are more for visual interest or aesthetic, you generally do not _need_ to add the `alt` property. If you do, keep the description concise and avoid starting the sentence with, "An image of." Screen reader software will already announce the resource as an image.

> NOTE: It is also a good idea to run the image through a tool such as [squoosh.app](https://squoosh.app/)

## Libraries used

- [Flexsearch](https://github.com/nextapps-de/flexsearch)

## Available Scripts

In the project directory, you can run:

### `npm run dev`

Runs the app in the development mode.
Open [http://localhost:3000](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.

### `npm test`

Launches the test runner in the interactive watch mode.
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.

### `npm 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!