punishell / foam-template

The UX interfaces provide intuitive frontends for the usage of Pakt Suite components, including Fair Open Access Markets (aka FOAMs, Afro.Fund being the first example), Social Playgrounds, and Content Expression Platforms.

FOAM V2

Prerequisites

macOS

1. Download and install node v16.20 & above for macOS - https://nodejs.org/en/download

Install Packages

npm install

Build

npm run build

Start APP

Development

 npm run dev

---

Getting Started 🚀

This project contains 3 environments:

• development
• staging
• production

Setup Environment files

1. Create a .env.local file in the root of the project and copy the content from the sample.env file

Git Workflow 🐙

Code Contribution

• Any new feature or fix added to the project must go through a Pull-Request.
• Names for branches follow the GitFlow conventions
• Every branch name should include the id of the related ticket to make it easier to link them to there requirements:
  • feature/SQ-99_descriptive_title
  • fix/SQ-99_descriptive_title

Branches

Name	Function
development	The current development version of the api including all features that are ready for testing
production	The current store version of the api
fix/{TicketName}_*	Holds a minor fix defined through a ticket
feature/{TicketName}_*	Holds one complete feature defined in a ticket

Testnet Url

  https://foam-template-v2-1937d623d552.herokuapp.com