Skip to content
This repository has been archived by the owner on Dec 10, 2023. It is now read-only.

Latest commit

 

History

History
72 lines (51 loc) · 3.71 KB

README.md

File metadata and controls

72 lines (51 loc) · 3.71 KB
Raw

WorkWise

WorkWise is a productivity tool designed to assist users in staying focused and efficiently managing their projects. It features a focus timer and the ability to customize a selection of minimal widgets, including the time, weather, bookmarks, etc. Additionally, WorkWise utilizes the Kanban Board approach to project management, which involves visually representing work at various stages using cards and columns. This method aims to improve visualization, limit work-in-progress, and optimize efficiency.

To summarise, the first page would be like a lockscreen, it will display various widgets the user wants to see. the second page would be the Kanban Board Page, similar to websites like Trello, etc.

Tech Stack

  • Node.js (v16.18.0)
  • React.js
  • Tailwind

Dependencies

In order to run this app, you will need to have npm or yarn installed on your local machine.

Installation

To install the dependencies for this project, run the following commands in the workwise directory of the project:

npm install

To start the app, run the following command:

npm start

The app will be live on localhost:3000.

How To Setup

  • Make sure your machine is connected to the internet.
  • Fork the repository.
  • Open a shell (command prompt, terminal, etc.) on your machine.
  • Change to the directory where you want to copy the project.
  • Clone it to your local setup by using command git clone <repo link>.
  • Once cloned, Run the following command in the root directory of the project npm install.
  • After the process is completed, run the command npm start.
  • The website will be live on localhost:3000.

Reference Links

Claim an Issue

Comment on the issue. In case of no activity on the issue even after 2 days, the issue will be reassigned. If you have difficulty approaching the issue, feel free to ask on our discord channel.

Communication

Whether you are working on a new feature or facing a doubt please feel free to ask us on our discord channel. We will be happy to help you out.

Contributing

We welcome contributions to WorkWise! If you would like to contribute, please follow these guidelines:

  • Follow the best practices and coding standards to make it easy for reviewers and contributors. We want to focus on the code quality more than on managing pull request ethics.

  • Single commit per pull request and name the commit something meaningful (e.g. "Add user login feature" instead of "Update").

  • If your commit resolves an open issue, please reference the issue number in the commit message (e.g. "Fixes #12"). Follow the PR Template strictly.

  • Provide a link to a live demo or relevant screenshots for easier review.

  • Pull Request older than 3 days with no response from the contributor shall be marked closed.

  • Do not create pull requests for changes that are not related to any open issues. Please create an issue first and wait for approval before working on it.

  • Avoid creating duplicate pull requests. If necessary, please comment on the original pull request with the number of the new one, and close the obsolete one yourself.

  • Be polite and respectful to other members of the community.

Our Top Contributors ♥️