Bright - Get Things Done

Bright is an all-in-one project management tool designed to streamline and enhance your team's workflow.

Table of Contents

• Installation
• Usage
• Commit Guidelines
• Tech Stack
• Contributing
• Feedback

Installation

To run Bright locally, follow these steps:

1. Clone the project repository:

   git clone https://github.com/Mudoker/Bright_FE.git

2. Navigate to the project directory:

   cd bright_frontend

3. Install the necessary dependencies:

   npm i -g pnpm && pnpm i && pnpm i prop-types

4. Start the development server:

   pnpm start

Usage

Once the server is running, you can access Bright through your web browser at the designated local server address.

Commit Guidelines

To maintain a consistent codebase, please adhere to the Conventional Commits specification for your commit messages. This practice facilitates easier code reviews and debugging.

Refer to the Conventional Commits guidelines: Conventional Commits

After making your commits, ensure you run the following command to format all files in the repository:

pnpm format

Tech Stack

Client: React, Redux, TailwindCSS, JavaScript, TypeScript

Server: Node, ExpressJs, MongoDB, RabbitMQ

Contributing

As this project is open source and encourages non-commercial use, we welcome community involvement! If you'd like to contribute, please explore the project's issues tab, select an unassigned task, create a new branch named feat/, and submit a pull request to the development branch for review.

Feedback

We value your feedback! If you have any suggestions or encounter any issues, please contact us at: huuquoc7603@gmail.com