Skip to content

bahaaTuffaha/Project-ClosetArchive

Repository files navigation

Contributors Forks Stargazers Issues MIT License LinkedIn

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

Closet-Archive is an open-source app designed to assist people in organizing, categorizing, and, most importantly, logging their recent outfit choices. This functionality prevents wearing the same clothes again for that specific event, aids in laundry management, and offers various other features.

(back to top)

Built With

(back to top)

Donations

Buy Me A Coffee

Download

Get it on F-Droid

Or download the latest APK from the Releases Section.

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Installation

installing all packages.

  • npm

    npm install
    
    • then run the emulation you prefer (am focusing on android):
    npx react-native start
    

Usage

  • Adding a Clothing Item:

Press the "+" button , press on adding an item and choose your category. Fill in the details of the clothing item, such as name, type, image or colors, and size.(min req. :name,type) Click "Save" to add the item to your closet.

  • Recording an Event:

Press the "+" button , press on adding a log then select a clothing item from your closet. Provide event details, including the date, name, and any notes. Click "Save" to record the event for that item.

  • Managing Collections:

Create a new collection by clicking collection at main screen.

  • Importing and Exporting Data:

Use the "Import" and "Export" features in the app's settings to manage your data.

(back to top)

Roadmap

  • Fixing issues.
  • Improving filters.
  • Selecting a whole collection when logging an event.
  • Adding a bulk by snapping images for a quick way.
    • color filter
    • Adding Ai to recongnize and recommend what to wear maybe later?

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See MIT License for more information.

(back to top)

Contact

Bahaa Tuffaha - bahaa.tuffaha@yahoo.com

Project Link: https://github.com/bahaaTuffaha/Project-ClosetArchive

(back to top)