Skip to content

Repository files navigation

Boardy

Welcome to Boardy project! This project is a simplified version of the popular project management tool, Trello. It allows users to create boards, lists, and cards to organize their tasks and projects efficiently.

Screenshots

image image

Features

  • User Authentication: Secure user authentication using Supabase.
  • Boards: Create and manage multiple boards.
  • Lists: Add lists to boards to categorize tasks.
  • Cards: Create, edit, and delete cards within lists.
  • Drag and Drop: Easily move cards between lists using drag and drop.

Technologies Used

  • Frontend: React, TypeScript, CSS
  • Backend: Supabase (PostgreSQL)
  • State Management: React Context API
  • Routing: React Router

Getting Started

Prerequisites

  • Node.js (v14 or higher)
  • npm or yarn
  • Supabase account

Installation

  1. Clone the repository:
    git clone https://github.com/your-username/trello-clone.git
    cd trello-clone
  2. Install dependencies
    npm install
    # or
    yarn install
  3. Set up environment variables:
  • Create a .env file in the root directory.
  • Add your Supabase URL and API key
    REACT_APP_SUPABASE_URL=your-supabase-url
    REACT_APP_SUPABASE_ANON_KEY=your-anon-key
  1. Run the development server:
    npm start
    # or
    yarn start
  2. Open your browser and navigate to: http://localhost:3000 🚀

🧑‍💻 Contributing

  1. Cloning a fork: Click on the fork button at the top right corner of the repository to create a copy of the project in your GitHub account.
  2. Clone the Repository: Clone your forked repository to your local machine using the command (git clone <fork URL>) in your terminal.
  3. Set upstream branch: To keep your forked repository updated with the original repository, use the command (git remote add upstream <repository original URL>).
  4. Create branch: (git checkout -b feature/some-feature).
  5. Stage the changed files: by using git-add to incrementally "add" changes to the index before using the commit command (git add <file>).
  6. Record changes to the repository: Create a new commit containing the current contents of the index and the given log message describing the changes(git commit -m 'Add: some feature').
  7. Submit your Contribution: Upload your branch with the changes to forked repository on GitHub using (git push origin feature/some-feature).
  8. Generate a request: To complete the process of creating your PR, simply hit pull request

🎉 Acknowledgments

A huge thank you to the Afordin community for their invaluable guidance and support throughout the development of this project.

Special thanks to the afor_digital Twitch channel for their insightful feedback and encouragement, which greatly contributed to refining and enhancing Boardy.

Authors

🛠️ Stack

Vite React CSS3

About

Resources

Stars

1 star

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages