Skip to content
This repository was archived by the owner on May 21, 2025. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2024 Deskpro
Copyright (c) 2025 Deskpro

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
106 changes: 101 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,105 @@
<img align="right" alt="Deskpro" src="https://raw.githubusercontent.com/DeskproApps/space/master/docs/assets/deskpro-logo.svg" />
<div align="center">
<a target="_blank" href=""><img src="https://img.shields.io/github/contributors/deskproapps/space.svg?style=for-the-badge" alt="Contributors" /></a>
<a target="_blank" href="https://github.com/deskproapps/space/issues"><img src="https://img.shields.io/github/issues/deskproapps/space.svg?style=for-the-badge" alt="Issues" /></a>
<a target="_blank" href="https://github.com/deskproapps/space/blob/master/LICENSE.md"><img src="https://img.shields.io/github/license/deskproapps/space.svg?style=for-the-badge" alt="MIT License" /></a>
<a target="_blank" href="https://github.com/deskproapps/space/releases"><img src="https://img.shields.io/github/v/release/deskproapps/space?style=for-the-badge" alt="GitHub Release" /></a>
<a target="_blank" href="https://www.linkedin.com/company/deskpro"><img src="https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555" alt="LinkedIn" /></a>

# Space App
<img src="readme.svg">
</div>

View your Jetbrains Space issues from Deskpro and link them to tickets you are working on
<div align="center">
<h1>Space App</h1>
<p>View your Jetbrains Space issues from Deskpro and link them to tickets you are working on.</p>
<a href="https://support.deskpro.com/ga/guides/developers/anatomy-of-an-app" target="_blank">Deskpro Apps Documentation</a>
<span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
<a href="https://www.jetbrains.com/help/space/http-api-reference.html" target="_blank">Space API Documentation</a>
<span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
<a href="./SETUP.md" target="_blank">Space App Setup Guide</a>
<br />
<hr />
<br />
</div>

![Space App - Deskpro](./docs/assets/screenshot.png)

[Find out more about our Space App](https://www.deskpro.com/apps/space)
<p align="center">
<img src="./docs/readme/app-screenshot.png" alt="Screenshot of the Space App" style="max-width:100%; height:auto;" />
</p>


## **About the app**
JetBrains Space is an intelligent code collaboration platform designed for developer-driven teams. It's an all-in-one solution that combines various tools and features to streamline software development, project management, and team collaboration.
JetBrains Space offers a unified platform that eliminates the need for multiple tools, allowing teams to work more efficiently. It provides native integration with JetBrains IDEs and supports third-party integrations and custom APIs for extensibility.

## **Setting up the app in Deskpro**
You can follow our [setup guide](./SETUP.md) for a step-by-step guide to setting up the Space app in Deskpro.

## Development

### With DevContainers (Recommended)
To make development easier and avoid version conflicts, we recommend using **DevContainers** for local development. This approach ensures that everyone on the team uses the same environment, reducing setup issues and version mismatches between dependencies.

#### Why use DevContainers?
- **Consistency:** All developers work in the same environment, with the same versions of dependencies, tools, and configurations.
- **Speed:** The DevContainer setup is quick to start, letting you focus on coding rather than environment setup.
- **Isolation:** Avoid conflicts between different versions of Node.js, PNPM, or other dependencies by using the predefined container setup.

#### Getting Started with DevContainers
1. Ensure that you have [Docker](https://www.docker.com/get-started) and [VS Code](https://code.visualstudio.com/) installed.
2. Open the project in [VS Code](https://code.visualstudio.com/).
3. If you have the **Remote - Containers** extension installed, [VS Code](https://code.visualstudio.com/) should automatically detect the `.devcontainer` configuration in this project and prompt you to reopen the folder in the container.
4. After opening the project in the DevContainer, run:
```bash
pnpm start
```

You should now be able to view the app in your browser. For more information about developing [Deskpro apps](https://www.deskpro.com/apps), [Visit the docs](https://support.deskpro.com/ga/guides/developers/anatomy-of-an-app).

### Natively
_We recommend using the DevContainer mentioned above for Consistency, Speed and Isolation._

This app was developed primarily using **Typescript**, **React**, and **Vite**.

#### Setup
To run this project locally:

```bash
# Clone the repository
git clone https://github.com/DeskproApps/space.git

# Change to the project directory
cd space

# Install dependencies
pnpm install

# Run the development server.
pnpm start
```

You should now be able to view the app in your browser. For more information about developing [Deskpro apps](https://www.deskpro.com/apps), [Visit the docs](https://support.deskpro.com/ga/guides/developers/anatomy-of-an-app).

### Testing
We've included `jest` to run tests. It will look anywhere in `/src` for test suite files ending in `.test.tsx` or `.test.ts`.

You can run all tests using:

```bash
pnpm test
```

## Versioning
Every app deployment requires that the version property in the `manifest.json` file be updated to reflect the new app version. This is so Deskpro can detect changes and add/upgrade apps accordingly. As such, we've made altering versions easy by having CI make the actual version change for you. Here's what we do:

* We increment patch versions, i.e. 1.0.1, automatically. You don't need to do anything and this will happen
* Minor versions, i.e. 1.1.0, are incremented if you add the minor-version GitHub label to your PR
* Major versions, i.e. 2.0.0, are incremented if you add the major-version GitHub label to your PR

## Top contributors
[![Contributors](https://contrib.rocks/image?repo=deskproapps/space)](https://github.com/deskproapps/space/graphs/contributors)


## License
Distributed under the MIT License. See [LICENSE.md](LICENSE.md) for more information.


Binary file added docs/readme/app-screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Loading