Skip to main content

Getting Started

Create Abyss app​

The easiest way to get started with creating Abyss Parcels is by using create-abyss-app.

Before you begin, be sure to follow our workplace setup guide. Once your workspace is fully configured, open your terminal, navigate to the directory you'd like to create the app in, and run the following command:

npx github:uhc-tech/abyss-app my-new-app

Project structure​

Below is the structure of the Parcels section in the create-abyss-app. The Workshop product is where you will be creating and building your Parcels.

└── products
    ├── workshop
       ├── .abyss
       |   ├── environments.json
       |   └── settings.json
       ├── src
       |   ├── common
       |   ├── parcels
       |   |   ├── ReactLogo
       |   |   |     ├── index.ts
       |   |   |     ├── ParcelApp.tsx
       |   |   └─────└── ParcelApp.stories.tsx
       |   ├── decorator.tsx
       └── package.json

Running Abyss app​

To test the application locally you will need to be in the project directory and run the following command:

npm run dev

Learning React​

Just starting your journey with React? Abyss is a framework built on top of the popular ReactJS library. To get started, visit the React documentation for more in-depth tutorials. If you are interested in learning high-level concepts, check out the getting started guide for React.

Support​

If you're ready to get started with Abyss for your next project, check out our Contact Us page. Submit a new support request and let us know how we can help your team. If you found Abyss to be helpful, please give us a star on GitHub!

Table of Contents