Skip to content
This repository has been archived by the owner on Aug 22, 2021. It is now read-only.

A search directory website for the Fontsource monorepo.

License

Notifications You must be signed in to change notification settings

fontsource/search-directory

Repository files navigation

⚠️ Further development of the Fontsource Search Directory will now take place within the website folder of the Fontsource monorepo

Fontsource Search Directory

GitHub workflow status license GitHub stars

A search directory website for the Fontsource monorepo.

Directory link can be found here.

Development

Node.js and NPM must be installed before starting.

Install the necessary packages by running npm ci in the project root directory.

Building

To build, run npm run build in the projects root directory. An index.html file will be generated in the ./build directory. You can open that to view the product.

Develop

To start development, run npm start in the project root directory. This will create a local server in which you can view the project from a browser. Any changes from the source files in the ./src directory, will automatically reload the page.

Built With

  • Babel - Used to compile Javascript in a way that increases backwards compatibility.
  • ESLint - Used to enforce a certain coding style and correct syntax.
  • Material-UI - Used to create a smooth user interface based off Google’s Material Design.
  • Prettier - Used to format code in an efficient manner.
  • React - Used to build and create reusable UI components.
  • Webpack - Used to bundle modules into a browser ready format.

License

This project is licensed under the MIT License - see the LICENSE file for details.