What would you like to be added:
Implement the workspace creation logic with the following requirements:

• Ability to input the name of the Workspace.
• Call the Workspace creation REST API to initiate the Workspace creation process.
• Upon successful completion of the Workspace creation, navigate to the newly created Workspace.

Why is this needed:
To provide workspace feature

Additional Information

What would you like to be added:
Implement the workspace creation logic with the following specifications:

• A Workspace has a name.
• Creating a Workspace results in the creation of a single row in the database.
• The user creating the Workspace becomes a member of that Workspace.

Why is this needed:
To provide workspace feature

Additional Information

Description:

I need documentation for the following aspects:

As we are currently in the development phase, with frequent changes occurring rapidly, documentation for the project is postponed.

• README.md

• Frontend

  • Initial setup guide
  • Directory structure
  • Deployment guide
  • React-query structure
  • Redux structure

• Backend

  • Initial setup guide
  • Directory structure
  • Architecture
  • Implementation method for login
  • Deployment guide
  • Auth webhook setup guide

• AI

  • LLM App Structure

This list will be continually updated.

Why:

To aid quick understanding for other open-source contributors

What would you like to be added:
Issue #9
Implement the logout functionality on the frontend as discussed in the above issue.

Why is this needed:
To provide user feature

Additional Information:

What would you like to be added:

• Add support for MongoDB

Why is this needed:

• To decrease management for database

Additional Information:

• Prisma MongoDB Connector

What would you like to be added:
Implement the Workspace Member List Retrieval API.
Refer to the API specifications discussed in the following issue.
#27

Why is this needed:
To provide workspace

Additional Information:

What would you like to be added:
Call the Workspace Member List Retrieval API to display the list of Workspaces.

Why is this needed:
To provide workspace

Additional Information:

What would you like to be added:
A decision needs to be made on how to implement the login logic, and the following options are under consideration:

• Firebase
• Supabase
• Custom Implementation

It would be beneficial to benchmark and implement based on how other services have implemented login functionalities. The chosen implementation should allow for easy addition of other social logins in the future and provide users with flexibility in their choices.

Why is this needed:

For providing workspace for users

Additional Information:

What would you like to be added:
Implement a Markdown editor with collaborative editing capabilities using the yorkie-js-sdk.

Why is this needed:
For new CodePair Service

Additional Information:
#2
Implement using the selected Markdown editor as specified in the above issue.

What would you like to be added:
Implement the workspace invitation logic with the following features:

• Invite users using a distinguishing token (email, ID, etc.).
  • Alternatively, provide an invitation link.
• Invited users have the option to accept or decline the invitation.

Why is this needed:

• To provide workspace feature

Additional Information:

What would you like to be added:
Call the Workspace Document List Retrieval API to display the list of Workspaces.

Why is this needed:
To provide workspace

Additional Information:

What would you like to be added:
Implementing Document Sharing Scope:
Considering both Public and Private scopes for document sharing, it's necessary to discuss how to implement this feature.
Please refer to the details in the following issue for a discussion on the chosen approach for implementation.
#21

Why is this needed:
To provide document sharing

Additional Information:

What would you like to be added:

• Support supabase for db and auth with one service

Why is this needed:

• Decrease managing point with supabase (DB, Auth, Serverless function, ...)

Additional Information:

Supabase

• Provides essential features for scaling up.
• In the course of operating our services, we have gathered top-notch fully managed services from Supabase.
• Currently, it seems appropriate to introduce Database and Authentication to meet our requirements.

Database

• Remove backend and convert to Serverless architecture
• How to conduct tests:
  • Simply spin up a Docker container locally.

Authentication

• Utilize Supabase functionality for all logins.

What would you like to be added:
Implement the Workspace Document Retrieval API.
Refer to the API specifications discussed in the following issue.
#27

Why is this needed:
To provide workspace

Additional Information:

What would you like to be added:
Call the Workspace Retrieval API to display the workspace.

Why is this needed:
To provide workspace

Additional Information:

What would you like to be added:
Implement the Workspace List Retrieval API.
Refer to the API specifications discussed in the following issue.
#27

Why is this needed:
To provide workspace

Additional Information:

What would you like to be added:
Call the Workspace List Retrieval API to display the list of Workspaces.

Why is this needed:
To provide workspace

Additional Information:

What would you like to be added:
Issue #9
Implement the user login functionality on the frontend as discussed in the above issue.

Why is this needed:
To provide user feature

Additional Information:

What would you like to be added:
Implement the Plugin using the structure decided in the following issue.
#25

Why is this needed:
To provide Rewriting Plugin

Additional Information:

What would you like to be added:
Considering the current options, the deployment method will be selected. The following option is under consideration:

• GitHub Page

Why is this needed:
For users who want to use CodePair

Additional Information:

What would you like to be added:
Implement the Plugin Structure discussed in the following issue.
#23

Why is this needed:
To provide plugin

Additional Information:

What happened:

• GitHub Page for CodePair POC is not working
  • The GitHub Actions works well, but users can't access the page.

What you expected to happen:

• Users can access the CodePair POC well.

How to reproduce it (as minimally and precisely as possible):

GitHub Page for CodePair POC

Anything else we need to know?:

NONE

Environment:

• Operating system: ALL
• Browser and version: ALL
• CodePair version: ALL

What would you like to be added:
Issue #5, #6
Convert the selected designs from the two previous issues into ORM code.

Why is this needed:
For the feature of users and workspaces for CodePair

Additional Information:

What would you like to be added:

Create a logic to generate a random key and utilize it for implementing the creation of a new Yorkie Document.

Why is this needed:

For new CodePair service

Additional Information:

Refer the document generation logic of CodePair

What would you like to be added:
Implement the Workspace Document List Retrieval API.
Refer to the API specifications discussed in the following issue.
#27

Why is this needed:
To provide workspace

Additional Information:

What would you like to be added:

Develop a system for storing tokens used in generating share and invitation links in the database and subsequently providing these tokens to users.

Why is this needed:

Modify to Store Tokens in the Database to Prevent Excessive URL Length from JWT Usage.

Additional Information:

What would you like to be added:

• Configuring for test environment
  • Test DB
  • Mocking
  • Convention
  • Etc...
• Testing strategies are needed for code that has dependencies on other services, such as GitHub

Why is this needed:

• To provide stable CodePair service

Additional Information:

What would you like to be added:
Discuss how to define the REST API spec for the following functionalities:

• SignUp
• LogIn
• Workspace creation
• Workspace invitation
• Workspace member retrieval
• Document retrieval within a workspace
• Document retrieval
• And more...

Why is this needed:
To provide CodePair backend

Additional Information:

What would you like to be added:
Issue #9
Implement the login functionality on the backend as discussed in the above issue.

Why is this needed:
To provide user feature

Additional Information:

What would you like to be added:

The task involves establishing a clear and comprehensive specification for the URL and slug that users will use to access the frontend.

Why is this needed:

In order to ensure a standardized approach and enhance user experience, it is essential to define the specifications for the URL that users will access on the frontend.

Additional Information:

• What Is a Slug?

What would you like to be added:

Creating a new frontend project setup for CodePair involves the following tasks:

• Create a Vite + React project.
• Configure ESLint.
• Set up CI (GitHub Actions): Consider the coexistence of Frontend and Backend in a Monorepo.
• Configure Park UI + TailwindCSS.
• ETC...

Why is this needed:

For new codepair service

Additional Information:

What would you like to be added:
Considering the current options, the deployment method will be selected. The following option is under consideration:

• Docker + Docker-compose

Subsequently, containerization will be carried out to facilitate rapid deployment for Kubernetes and on-premise users.

Why is this needed:
For users who want to use CodePair

Additional Information:

What would you like to be added:
Implement the Plugin Structure discussed in the following issue.
#23

Why is this needed:
To provide plugin

Additional Information:

What would you like to be added:

• Add Global Error Handling Code
  • react-query
  • error boundary
• 404 Page

Why is this needed:

• To provide good UX

Additional Information:

What would you like to be added:
Issue #9
Implement the user registration functionality on the backend as discussed in the above issue.

Why is this needed:
To provide user feature

Additional Information:

What would you like to be added:
Implement the REST API related to document creation, referring to the defined REST API specifications in the below issue.
#27

Why is this needed:
To provide workspace features

Additional Information:

What would you like to be added:
Design an Entity-Relationship Diagram (ERD) for CodePair Backend.
The following tables should be included:

• User: Represents users utilizing CodePair.
• Workspace: Represents workspaces to which users belong. Users can belong to one or more workspaces.
• Document: Represents documents within a workspace, storing Yorkie Document Key and title.
• Other tables as necessary.

Why is this needed:

For the feature of users and workspaces for CodePair

Additional Information:

What would you like to be added:
Implementing Document Sharing Scope:
Considering two possible scopes, Public and Private, for document sharing, we need to discuss the design for the implementation. Let's discuss how to design and implement this feature.

Why is this needed:
To provide document sharing

Additional Information:

What would you like to be added:
Implement the User Retrieval API.
Refer to the API specifications discussed in the following issue.
#27

Why is this needed:
To provide workspace

Additional Information:

What would you like to be added:

The choice of a Markdown editor needs to be made, considering the following factors:

• Can collaborative editing functionality be added using Yorkie?
• Does it support VIM keystrokes?
• Is it visually appealing?

Why is this needed:

Additional Information:

What would you like to be added:
Configure Project Settings for Rewriting Plugin
Reflect the detailed specifications decided in the following issue.
#25

Why is this needed:
To providing rewriting plugin

Additional Information:

What would you like to be added:
To allow other users to use plugins, it's essential to research how open-source projects, such as CodePair, provide plugins in both the frontend and backend.
After gathering information on existing practices, we can discuss the most suitable approach for our project.

Why is this needed:
To provide CodePair plugin

Additional Information:

What would you like to be added:
Implement the Workspace Retrieval API.
Refer to the API specifications discussed in the following issue.
#27

Why is this needed:
To provide workspace

Additional Information:

What would you like to be added:
Call the User Retrieval API to display the user info.

Why is this needed:
To provide workspace

Additional Information:

What would you like to be added:
Call the Workspace Document Retrieval API to display the workspace.

Why is this needed:
To provide workspace

Additional Information:

What would you like to be added:
Issue #9
Implement the user registration functionality on the frontend as discussed in the above issue.

Why is this needed:
To provide user feature

Additional Information:

What would you like to be added:
Implement the workspace invitation logic with the following features:

• Invite users using a distinguishing token (email, ID, etc.).
  • Alternatively, provide an invitation link.
• Invited users have the option to accept or decline the invitation.

The specific implementation should be discussed in #17.

Why is this needed:

• To provide workspace feature

Additional Information:

What would you like to be added:
The decision on which LLM (Large Language Model) app structure to use has been made.
Example:

• Prompt Pipelining
• RAG
• ETC...

Why is this needed:
To provide rewriting AI Agent

Additional Information:

What would you like to be added:

Tasks for the development of the new CodePair backend are as follows:

• Configure the Backend Framework (Discuss framework options, considering Node.js ecosystem).
  Set up Linting.
• Configure Continuous Integration (CI).
• Set up Database (DB) and Object-Relational Mapping (ORM) (Discuss requirements and options).

Why is this needed:
For providing the features related to users and workspaces of CodePair

Additional Information:

What would you like to be added:
Implement the functionality to create a new document in a workspace by entering the document name.

• Replace the logic created in #3 with the updated functionality.
• Upon document creation, navigate to the page of the newly created document.
• Call REST API related to document creation. #20

Why is this needed:

To provide workspace feature

Additional Information: