diff --git a/LICENSE.md b/LICENSE.md index c275327..40dd96c 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -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 diff --git a/README.md b/README.md index eb8c0de..ba8bf4a 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,105 @@ -Deskpro +
+ Contributors + Issues + MIT License + GitHub Release + LinkedIn -# Space App + +
-View your Jetbrains Space issues from Deskpro and link them to tickets you are working on +
+

Space App

+

View your Jetbrains Space issues from Deskpro and link them to tickets you are working on.

+ Deskpro Apps Documentation +   •   + Space API Documentation +   •   + Space App Setup Guide +
+
+
+
-![Space App - Deskpro](./docs/assets/screenshot.png) -[Find out more about our Space App](https://www.deskpro.com/apps/space) +

+ Screenshot of the Space App +

+ + +## **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. + + \ No newline at end of file diff --git a/docs/readme/app-screenshot.png b/docs/readme/app-screenshot.png new file mode 100644 index 0000000..70c7f0c Binary files /dev/null and b/docs/readme/app-screenshot.png differ diff --git a/readme.svg b/readme.svg new file mode 100644 index 0000000..d1a57eb --- /dev/null +++ b/readme.svg @@ -0,0 +1,229 @@ + + +
+ + +
+ +
+ +
+
+ + + +
+
+
+ + + + + + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ +
+
+
+ + + \ No newline at end of file