/front-end-1

Social Media Strategy is a web app built on a Postgres Database, and a Node Express back-end. The backend is connected to a DS FastAPI deployment which gathers and processes data from the Twitter API. The front-end is built with React, Redux, Material-UI and uses Okta for authentication.

Primary LanguageJavaScriptMIT LicenseMIT

Maintainability Test Coverage

Social Media Strategy

You can find the deployed project at Social Media Strategy.

Contributors

SoMe was built in Lambda School Labs - you can find the ongoing original repo here: Lambda School Repo

Labs 24

Aja Blanco Eddie Madrigal Fabricio Bezerra Jack S. Kim Tim Shaker


MIT React code style: prettier

Project Overview

Trello Board

Product Canvas

UX Design files v2.0

Small business owners, social media managers and tech professionals aren't sure when and what content will optimize their engagement across various social media platforms

SoMe helps users streamline and optimize their social media presence.

Key Features

  • Improve users' post contents for increased engagement based on their followers' historical engagement habits/data.
  • Clean and modern drag-and-drop interface
  • Suggestive scheduling

Tech Stack

Front end built using:

React

  • Supports reusable components
  • Ease of deployment and maintenance

Redux

  • Integrates well with React
  • State management capabilities match that of application

Material-UI

  • Ease of component styling

Styled Components

  • Ease of component styling
  • Provides easier interaction with React-Beautiful DnD

React-Beautiful-DnD

  • Controls and styles drag-and-drop functionality

Front end deployed with Netlify

Back end built using:

  • Node.js
  • Express.js
  • Postgres

APIs

Okta Authentication APIs

Provided by Okta to handle account creation, user authentication and social media network authorizations.

SoMe Data Science API

A set of endpoints for our ML features, built by our DS Team.

Environment Variables

In order for the app to function correctly, the user must set up their own environment variables. There should be a .env file containing the following:

*  REACT_APP_API_URL - URL to back end server
*  REACT_APP_OKTA_DOMAIN - SoMe account Okta domain (available on Okta
dashboard)
*  REACT_APP_CLIENT_ID - SoMe client ID (available on Okta dashboard)

Testing

Unit Testing conducted with React Testing Library

Installation Instructions

  • Fork and Clone Repository
  • Run NPM install to download dependencies

Other Scripts

* build - creates a build of the application
* start - starts the production server after a build is created
* test - runs tests in **tests** directory \* eject - copy the configuration files and dependencies into the project so you have full control over them

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Please note we have a code of conduct. Please follow it in all your interactions with the project.

Issue/Bug Request

If you are having an issue with the existing project code, please submit a bug report under the following guidelines:

  • Check first to see if your issue has already been reported.
  • Check to see if the issue has recently been fixed by attempting to reproduce the issue using the latest master branch in the repository.
  • Create a live example of the problem.
  • Submit a detailed bug report including your environment & browser, steps to reproduce the issue, actual and expected outcomes, where you believe the issue is originating from, and any potential solutions you have considered.

Feature Requests

We would love to hear from you about new features which would improve this app and further the aims of our project. Please provide as much detail and information as possible to show us why you think your new feature should be implemented.

Pull Requests

If you have developed a patch, bug fix, or new feature that would improve this app, please submit a pull request. It is best to communicate your ideas with the developers first before investing a great deal of time into a pull request to ensure that it will mesh smoothly with the project.

Remember that this project is licensed under the MIT license, and by submitting a pull request, you agree that your work will be, too.

Pull Request Guidelines

  • Ensure any install or build dependencies are removed before the end of the layer when doing a build.
  • Update the README.md with details of changes to the interface, including new plist variables, exposed ports, useful file locations and container parameters.
  • Ensure that your code conforms to our existing code conventions and test coverage.
  • Include the relevant issue number, if applicable.
  • You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.

Attribution

These contribution guidelines have been adapted from this good-Contributing.md-template.

Documentation

See Backend Documentation for details on the backend of our project.