> For the complete documentation index, see [llms.txt](https://resources.collabocate.community/software-engineering/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://resources.collabocate.community/software-engineering/project-local-development-instructions/collabocate-website.md).

# Collabocate \[Website]

***

## General Information about project

{% content-ref url="/spaces/D4inNwzMBU3WuBySeYcV/pages/jokOf42e5GexMUrAiKx2" %}
[Collabocate \[Website\]](https://resources.collabocate.community/projects-overview/collabocate-osc-projects/collabocate-website)
{% endcontent-ref %}

***

## Local development instructions

{% hint style="warning" %}
We've made recent changes to the repository location and local development instructions of this project. Therefore, this section may be outdated. For now and pending the time that this section will be updated, you can get guidance on where to find and how to run this project in our collabo community Discord channel.
{% endhint %}

Find the local development instructions for Collabo Community App projects in the tabs below, depending on the one you want to develop locally.

{% tabs %}
{% tab title="Web Client" %}
***Local development instructions:***

* Head over to the GitHub repository: <https://github.com/collabo-community/web-client>
* Fork and clone the GitHub repository as shown in the [SWE contribution workflow](https://docs.collabo.community/software-engineering#git-workflow-fork-and-clone-repository)

***

***Instructions for installing dependencies and starting the frontend web client:***

{% hint style="info" %}
Once you have the repository on your local computer, ensure you are ***in the root of the project's directory***. Then install and run following the steps below.
{% endhint %}

Install dependencies:

```
npm install
```

Run the development server:

```
npm run dev
```

{% endtab %}

{% tab title="Mobile Client" %}
***First time Setup Instructions for the mobile client:***

* Install flutter, and configure every other thing you need to get flutter apps running on your computer - See [flutter docs](https://docs.flutter.dev/get-started/install).
* Run `flutter doctor` on the flutter console or in your terminal, to confirm that all that you need has been installed or not. Then install whatever is left if any.
* Also set up Android Studio and/or Xcode, and their mobile phone emulators/simulators.

***

***Local development instructions:***

* Head over to the GitHub repository: <https://github.com/collabo-community/mobile_client>
* Fork and clone the GitHub repository as shown in the [SWE contribution workflow](https://docs.collabo.community/software-engineering#git-workflow-fork-and-clone-repository)

***

***Instructions for installing dependencies and starting the mobile client:***

{% hint style="info" %}
Once you have the repository on your local computer, ensure you are ***in the root of the project's directory***. Then follow the steps below.
{% endhint %}

* Install package dependencies with flutter command:

```
Flutter pub get
```

* Run the commands to prevent error:

```
flutter pub outdated
```

```
flutter pub upgrade
```

* Then run the app on your emulator or physical device

***

#### Learning resources

* [Flutter Mapp | Flutter Tutorial For Beginners in 3 Hours](https://www.youtube.com/watch?v=CD1Y2DmL5JM)
  {% endtab %}

{% tab title="Backend Server API" %}
{% hint style="warning" %}
No instructions for now. Please ask about this project on our discord channel if you are interested in contributing.
{% endhint %}
{% endtab %}
{% endtabs %}

***