Skip to content

Latest commit

 

History

History
53 lines (36 loc) · 1.75 KB

CONTRIBUTING.md

File metadata and controls

53 lines (36 loc) · 1.75 KB
Raw

Contributing

Thanks for your interest in contributing to buridan/ui.

Please take a moment to review this document before submitting your first pull request. We also strongly recommend that you check for open issues and pull requests to see if someone else is working on something similar.

Important Directories & Files

Path Description
buridan_ui/routes The dir where all the routes are held.
buridan_ui/pantry The main dir where all compoenents are stored.
buridan_ui/pages/pantry_items/items.py The main export file for all pages related to pantry.

Development

Fork this repo

You can fork this repo by clicking the fork button in the top right corner of this page.

Clone on your local machine

git clone https://github.com/your-username/buridan-ui.git

Navigate to project directory

cd buridan-ui

Create a new Branch

git checkout -b my-new-branch

Install dependencies

Make sure to install or have installed Reflex

pip install reflex

Build Steps

The following steps should be taken to facilitate adding a new component:

  1. Create the pre-built design inside one of the main sections (pantry, charts, or interactive apps).
  2. Add the route, name, and dir inside the routes/route.py file, under the correct section.
  3. If it's a new category of pantry item, find the relative SVG image for it.
  4. Add and normalize the dir name for the thumbnails.
  5. Add the necessary config details.