Welcome to the Workspace Frontend Repository!

This repository comprises the frontend aspect of the Workspace project, constructed using React.

Setup Instructions

Note

Before proceeding, please ensure Yarn is installed on your system.

You can install Yarn using the following command:

npm i --global yarn

In windows you can get this error while running yarn

yarn : File C:\Users\User\AppData\Roaming\npm\yarn.ps1 cannot be loaded because running scripts is disabled on this system. For more information, see about_Execution_Policies at
https:/go.microsoft.com/fwlink/?LinkID=135170.
At line:1 char:1

+ yarn --version
    + CategoryInfo          : SecurityError: (:) [], PSSecurityException
    + FullyQualifiedErrorId : UnauthorizedAccess

You can resolve it by executing the following command:

Set-ExecutionPolicy -Scope CurrentUser -ExecutionPolicy Unrestricted

Setting Up Locally

To set up the Workspace frontend locally, follow these steps:

1. Clone The Repo:

git clone https://github.com/CodeQuotient/workspacefrontend.git

OR

gh repo clone CodeQuotient/workspacefrontend

2. Install Dependencies:

cd workspacefrontend && yarn

3. Config Environment Variable

1. In the root directory create .env file.
2. Please Check .env.example for the required fields.
3. For local development .env.example data can be used directly, copy .env.example data into .env file.

4. Start the Development Server

yarn start

Contribution Guidlines

If you'd like to contribute to this project, feel free to submit pull requests or open issues. Please follow the exisiting code styles and ensure your changes are well-tested.

This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.