Polygram

Social media exclusive for creating & viewing polls

           

A simple, convenient & efficient way to seek, share & ask opinions, views & questions with society for better decision making

Features

• 🔥 PWA : Install as a PWA on your device.
• 🌓 Theme Support : Supports Dark & Light Mode
• 🔐 Authentication : Uses JWT & OAuth for authentication
• 🔔 Push Notification : Receive push notifications for events in your account

Built With

• React
• React Rhino (State Managment)
• Sass (Styling)

Setup

Requirements

• Node.js
• Git

Installation

Clone the repo locally then install all the dependencies using NPM

git clone https://github.com/aromalanil/polygram-frontend.git
cd polygram-frontend
npm install

Local Development

1. Create a .env file in the project root and add all the envrionment variables mentioned here
2. Execute the following command.

npm start

This will create a local development server at http://localhost:3000

Generate Production Build

1. Create a .env file in the project root and add all the envrionment variables mentioned here
2. Execute the following command.

npm run build

This will generate a production ready build in build folder.

Environment Variables

Variable	Description
REACT_APP_API_ORIGIN	Base URL of the REST api
REACT_APP_GOOGLE_CLIENT_ID	Client ID received from google for OAuth
REACT_APP_PUBLIC_VAPID_KEY	Public vapid key of server for push notification

License

This project is licensed under GNU GPL v3.0 - see the LICENSE file for details.