Skip to content

Getting started

Gregor Adams edited this page Jul 7, 2022 · 1 revision

Getting started with Pforte

Pforte is a framework agnostic library and should work in various environments.

There are several packages that can be installed separately, depending on the environment.

Name Environment Description
@pforte/core Server The heart of this library
@pforte/adapter-mongoose Server Adapter for mongoose
@pforte/provider-github Server Provider for GitHub
@pforte/utils Server Shared server utilities
@pforte/constants Server, Browser Shared constants
@pforte/client Browser Client side functions
@pforte/react React React specific functions

Currently Pforte is intended to be used with an adapter, therefore a database is mandatory.
We chose mongodb with mongoose as the first adapter since this is easy to setup via mongodb-atlas.
We chose GitHub as the first provider since this library's main usecase is offering an out of the box authentication service for novice developers.

Please take a look at the examples and the documentation.

Clone this wiki locally