🟣

Create your Space in the Sismo App Store (Accessible by non devs)

To add an app to the Sismo App Store, you need to create your Space first. In this tutorial, we will explain step by step how to do it.

Pre-requisites

  • A GitHub Account
  • A Profile Picture for you Space: 400x400px JPG or PNG

The whole process will happen entirely on the GitHub interface. We will guide you through the creation of commits within the interface:

  • Create your Space config
  • Upload your image
🆘
If you have any questions or need help, contact us in Telegram or Discord

Here is the resulting Pull Request of this tutorial: https://github.com/sismo-core/app-store/pull/213

Step 1: Fork the Sismo App Store GitHub repository

image

Click on “Create fork”.

image

Step 2: Update the Space config in your fork of the app-store

A. Go to the space-configs/main folder
image
image
image

You will arrive on this page where you can see the configuration file of all other Spaces! In the next steps, you will add your own Space configuration in this list.

B. Add your config file space-config/main/my-awesome-space.ts file

Click on “Add file” and then “Create new file”.

image
image
C. Modify your Space name and file content (first commit)

Name your file. ⚠️  Don’t forget the .ts at the end.

image

Copy the code below to your new empty file. Then modify the content of the file.

import { SpaceConfig } from "../types";

//           UPDATE HERE ↓↓↓
export default {
  metadata: {
    name: "My Awesome Space", // UPDATE HERE
    description:
      "This Space is dedicated to my new project. It's a great project, you should check it out!", // UPDATE HERE
    image: "my_awesome_space_picture_400x400.png", // UPDATE HERE
    socialLinks: [
      {
        type: "link", 
        link: "https://www.my-awesome-website.io/", // UPDATE HERE
      },
      // OTHER TYPE OF LINK YOU CAN USE
      // {
      //   type: "twitter",
      //   link: "https://twitter.com/Sismo_eth",
      // },
      // {
      //   type: "discord",
      //   link: "https://discord.com/invite/sismo",
      // },
      // {
      //   type: "github",
      //   link: "https://github.com/sismo-core",
      // },
    ],
  },
  apps: [],
} as SpaceConfig;
🔎
Example of the modified file:
image

Click on “Commit changes…”.

image
image
D. Add the 400x400 picture for your Space (second commit)

Go to the /space-configs/images folder to add your image.

image
image

You will see the list of all current images.

image

To add your image, click on “Add file” then “Upload files”.

image

⚠️ The name of the file should exactly match what you used in the my-awesome-space.ts config (e.g my_awesome_space_picture_400x400.png ) .

image

Click on “Commit changes”.

Step 3: Create the Pull Request to the App Store

Click on “Contribute” then “Open pull request”.

image

Enter a title and click on “Create pull request”.

image
🎉
Congrats you have submitted your Pull Request!

➡️
Please, contact us in Telegram or Discord when you create a Pull Request. We will quickly review it and provide the next steps about the apps. Once the PR is merged, your changes will appear in the App Store.
image