Skip to content

Maestro: An Open Source File Management Application

Notifications You must be signed in to change notification settings

SHIV5T3R/Maestro

Repository files navigation

Getting Started (For Contributors)

Install Dependencies

npm install

Run App

npx expo start


What is Maestro?

Maestro is an open source file manager, designed to help users to have true control of their files.

Maestro is a part of the Ship-In-30 project from David's Developer Safeplace Discord server.

Features

Throughout the next 30 days, we as a team aim to add the following:

  • Basic file management (as a file manager would have :P)
  • An original yet interesting way to visualise storage space on a drive
  • A sleek, creative, and helpful user interface to make managing your storage much more efficient
  • A way to protect your valuable file contents with passwords and encryption

Tech Stack

Maestro uses React Native to interface managament of files, using Typescript for general functionality.

Contribution

Workflow

This project uses a 3 legged branching strategy with main being the production version of the code; Main reflects the current version that is currently live to the public. The development branch contains the active changes that are made by the engineers to implement new features or fixes; pull requests are needed to contribute into development with 2 approvals from other engineers.

When you are contributing to the project, you will need to create a new branch based off of the development branch. Please format the branch with a prefix and a name that best describes the type of change being implemented these contain:

  • feature/(New feature branches)
  • fix/ (Fixes for branches)
  • task/(Generic branches for mundane tasks, such as updating a lang file or dependencies)

Once you have selected the branch type please create a branch name as a suffix. For example, if you had a branch that implemented a login button on the home page you would call it feature/home-page-login-button

Upon completing your changes that are tested, please raise a pull request that merges into development, fill out the template and drop a link to the pull request in the "Ship-In-30" discussion channel. Upon review and approval your changes will be submitted into the development branch. Then once the version is ready, it is released into production.

Tasks

Within this project, contributors can help to work on tasks. Tasks will be split into different issues. To claim a task, find the issue that includes your chosen task and comment that you would like to work on a specific part of the issue. It's key that we communicate with each other to create a more productive and effecient development environment. You can also mention that you've claimed a task in the discussion channel.

Make sure to read all the discussion within the issue to know what needs to be completed, there will be a checklist of tasks and who's working on them in the issue description to help things flow smoothly.

If you would like to unclaim a task, make sure to comment on the relevent issue to let everybody else know that the issue is open for contribution.

You can also collaborate on a task with another contributor, just let the rest of the team know in the issue discussion.


alt text

About

Maestro: An Open Source File Management Application

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published