Skip to content

Latest commit

 

History

History
233 lines (153 loc) · 6.37 KB

README.md

File metadata and controls

233 lines (153 loc) · 6.37 KB

Social App Template Frontend

📗 Table of Contents

📖 Social Application Template (SAT)

The Gateway Services are a suite of services designed to make interacting with Frequency easy for applications integrating with DSNP. 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.

Arch Map

Key: * = coming soon

(back to top)

🛠 Built With

Tech Stack

Key Features

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

(back to top)

🚀 Live Docs

(back to top)

💻 Getting Started

This project was bootstrapped with Create React App.

To get a local copy up and running, follow these steps.

Prerequisites

In order to run this project you need:

Setup

Clone this repository to your desired folder:

Example commands:

  git clone [email protected]:ProjectLibertyLabs/social-app-template.git
  cd social-app-template

Environment Variables

The application is configured by way of environment variables. A complete list of available environment variables is here. Environment variables are supplied to the application through environment files. The environment is loaded by the create-react-app framework. Details on specific naming of environment files for different environments (dev, test, prod, etc) can be found here. For local development, the environment file is .env.local.

A sample configuration file can be found here.

  cp ./env.template ./.env

Install

Install this project with:

Install NPM Dependencies:

  npm install

Usage

To run the project, execute the following command:

Dev Mode:

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

  npm start

Build:

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

  npm run build

Eject:

Note: this is a one-way operation. Once you eject, you can’t go back!

If you aren’t satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.

You don’t have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.

  npm run eject

Run tests

Tests:

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

  npm test

Linting:

  npm run lint

Auto-format:

  npm run format

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!

(back to top)

📝 License

This project is Apache 2.0 licensed.

(back to top)