Social App Template

The Social Application Template (SAT) is an example client app that demonstrates how to use Gateway Services.

📗 Table of Contents

• 📖 About the Project
• 🔍 Arch Map
• 🛠 Built With
  • Tech Stack
  • Key Features
• 🚀 Live OpenAPI Docs
• 💻 Getting Started
  • Prerequisites
  • Setup
  • Deployment
• 🤝 Contributing
• ❓FAQ
• 📝 License

The Social Application Template (SAT) is an example client app that demonstrates how to use [Gateway Services](https://github.com/AmplicaLabs/gateway). # 📖 Social Application Template (SAT) The [Gateway Services](https://github.com/AmplicaLabs/gateway) are a suite of services designed to make interacting with [Frequency](https://github.com/frequency-chain/frequency) easy for applications integrating with [DSNP](https://dsnp.org/). The SAT is an example client that shows you how to use Gateway. Gateway enables web2 companies to use a simple gateway into web3 using tooling they are accustomed to. It aims to let service providers self-serve with minimal help outside of docs and tools, rather than interacting with Frequency directly. Providers no longer need to fully understand blockchain tooling to build on DSNP over Frequency.

🔭 Arch Maps

Overview of the Social App Template in relation to Gateway Services.

Key: * = coming soon

(back to top)

🛠 Built With

Tech Stack

Frontend

• Framework: React
• Language: Typescript
• Testing Library:
  • Jest
  • Testing Library
• UI Library: Ant Design

Backend

• Framework: Node.js with Express
• Language: Typescript
• Testing Library:Vitest
• API Documentation:
  • Swagger
  • OpenAPI

Key Features

• Sign in with Frequency
• Create a post
• Create a comment on a post
• View a feed
• View other users' profiles
• Follow a user

(back to top)

🚀 Live Docs

• Gateway Live Docs
• Open Api docs coming soon...

(back to top)

💻 Getting Started

• Frontend

  See Frontend Readme

• Backend

  See Backend Readme

Prerequisites

In order to run this project you need to...

• Become a provider. To do so, visit the Provider Dashboard!
• Get Docker

Setup

Clone this repository to your desired folder:

Example commands:

  git clone git@github.com:AmplicaLabs/social-app-template.git
  cd social-app-template

Deployment

You can deploy using containers. Check the docker-compose.yaml file for more details.

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

• Contributing Guidelines
• Open Issues

(back to top)

❓FAQ

• Who is the Gateway built for?

• Developers wanting a better understanding of how DSNP/Frequency works.

• Developers wanting an example of integrating Gateway Services.

• Who is a provider and how do you become one?

  • Visit the Provider Dashboard!

• Do I need Web 3 experience?

  • Nope! The Gateway is an open source suite that enables Frequency integrations without web3 programming skills. The Gateway makes building/integrating a social network on the DSNP/Frequency stack as easy as a Web2 API integration.

• Do I need to know anything about cryptocurrency?

  • Nope! The Gateway has a coinless user interface that does not require using cryptocurrency tokens.

(back to top)

📝 License

This project is Apache 2.0 licensed.

(back to top)