Skip to content

TereseBo/baddle

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Getting Started with Baddle, the band-weaving vizualiser

Functionality

Welcome to Baddle. In this application you can visualise a warpfaced draft made on a backstrap heddle loom and extract the warping order. Choose a color and thread the heddle by point and click. The warping order will update automatically as the warp in the heddle is filled. To move the hedddle up or down, click the corresponding arrow on the row you wish to update.

Getting started

Navigate to the link above and try it out. For continued development, clone the repository from gitHub and navigate to the root folder:

git clone https://github.com/TereseBo/baddle.git

cd baddle

To install requirements run:

npm i

Environment

The application does not require any additional sign-ups or registrations but relies on react-gh-pages for it's deployment.

Testing

Testing has not been implemented beyond having a run command:

npm run test

See the section about running tests for more information on implementing testing.

Available Scripts

In the project directory, you can run:

npm start

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

The page will reload when you make changes.\

npm deploy

Will update production branch (gh-pages) with the newest changes in main. No fail-safes or checks before deploy are implemented, verify successfull deploy manually and reset if failing.

npm test

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

npm run 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.

npm run 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.

This project was bootstrapped with Create React App.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published