Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/permitio/permit-demo-todos-nodejs

A demo todos application in React+NodeJS that uses Permit.io for permissions
https://github.com/permitio/permit-demo-todos-nodejs

Last synced: about 2 months ago
JSON representation

A demo todos application in React+NodeJS that uses Permit.io for permissions

Awesome Lists containing this project

README

        


Permit.io



Permit.io Demo (Todos)

# What's in this repo?

Permit.io is the permissions infrastructure for the internet. A fullstack authorization solution enabling developers to bake-in access-control into their products within minutes and have them ready for future demands from customers and regulation.

In this repo you'll find a demo todos application implemented in Node.js that uses permit.io to enforce permissions.

# How to run this app

## 1. Prerequisites

This app requires an Auth0 account (for authentication) and Permit.io account (for authorization).

### Auth0 Account
If you want to open your own Auth0 account (for authentication), [click here](https://auth0.com/signup).

By default the app will use an Auth0 account controlled by Permit.io so it's not mandatory.

### Permit.io Account
You'll need to:
1) Open a free Permit.io account [here](https://app.permit.io).
2) Complete the account setup, see video tutorial [here](https://docs.permit.io/tutorials/onboarding_demo).
3) Get your [API Key](https://docs.permit.io/tutorials/quickstart) and save it to `.env` (set the value of `PERMIT_API_KEY`)

#### NOTE: Securely storing secrets
This repo is using `.env` for easy learning. Never store your secrets locally in your repo (i.e: in `.env` or any other file), the "secrets" you see here are auth0 parameters that are public and are usually embedded into frontend applications. You should **never** commit the Permit API key to a repo, always use a secrets storage solution like Hashicorp Vault or AWS Secrets Manager.

## 2. Run the app without permissions enforced
```
make run
```

## 3. Run the app with permissions enforced
```
make run-with-permit
```

# Community and support

- You can find our full documentation at [docs.permit.io](https://docs.permit.io).
- You can join our [slack community][join-slack-link] for help.

[![Button][badge-slack-link]][join-slack-link]

[badge-slack-link]: https://i.ibb.co/wzrGHQL/Group-749.png
[join-slack-link]: https://bit.ly/permitioslack