Skip to content

_Prtcl dev guide 2: Looking around

guillem.cordoba edited this page Nov 12, 2019 · 9 revisions

All the code in _Prtcl is intended to be reusable, configurable and extendable as much as possible. However, joining all the stack together results in fully ready and functional modules that can be composed together to build bigger applications.

This allows for a wide range of different strategies when using these tools. When navigating this guide, you'll often be offered more than one way to proceed (remember Choose Your Own Adventure books?). The only thing you have to remember is that the higher the number of the step, the more advanced its guide is.

Here is your first choice:

  • If you want to configure and use already developed modules, go to 3 - Cortex modules.
  • If you want to configure and use separate components and services without using the modules, go to [TBD]
  • If you want to learn how to develop and add your own service providers, go [TBD]
  • If you want to learn how to extend the modues with custom functionality, go to [TBD]
  • If you want to learn how to build your own modules, go to [TBD]

Ah! And before you go on your adventure, maybe you should prepare by reading the Cortex framework documentation and vision. Things will make much more sense with that vision in mind.

Packages overview

There are 3 packages that make up the necessary infrastructure to build applications using Cortex modules:

The package @uprtcl/common: contains opinionated basic modules and patterns needed for many applications (version control, access control, drafting...). This is were the current implementation of web client of the _Prtcl is.

Developer guide

1 - Installing the tools

2 - Looking around

3 - Cortex modules

4 - Configuring service providers

5 - Configuring modules

6 - Loading modules with micro-orchestrator

7 - Displaying an entity

8 - Adding the Evees module

9 - Adding multiple backends

[TBD]10 - adding lens selection

[TBD] Using Cortex without modules

[TBD] Building a pattern

[TBD] Building a lens

[TBD] Building a service provider

[TBD] Building a Cortex module

[TBD] Customizing the lenses module

[TBD] Building a plugin for the lenses module

Clone this wiki locally