Skip to content

labs13-delphe/FrontendAuth

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

295 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Delphe

You can find the deployed project at Delphe App.

Contributors

Josh Akeman Kermitt Davis Amarachi Ejiawoko Chad Kidd Lydia Thornton


MIT React Typescript Netlify Status Material UI code style: prettier

Project Overview

Advice: we all need it in all domains of life and we all give it. But sometimes, maybe most times – at a crossroad, or dilemma, or embarrassing life situation, or when we’re stuck – we need a REAL person to talk to. And after all that we learn through our experiences, we become experts in a few areas and get to help others.

Delphe creates room for an online global community just for you to connect with, and only one ask away! You can sign up to be an asker or an expert, and beginning getting the answers you need or answer questions by topics you know well!

"Creating a community for knowledge seekers to connect with experts in a variety of fields."

Key Features

  • Post Questions
  • Edit Questions
  • Delete Questions
  • Post Answers
  • Edit Answers
  • Delete Answers
  • Find Questions by Topic
  • View a Community Thread of Questions
  • View Your Profile and Other Users
  • Edit Profile
  • Delete Profile

Tech Stack

Front end built using:

React JS

  • Allows application creating using multiple reusable components to cater to multiple users
  • Improves efficiency and scalability of application

Material UI

  • Provided a solid design framework for application
  • Provided reusable and customizable components

Materialize

  • Responsive front-end framework based on Material Design
  • Provided classic principles of successful design along with innovation and technology
  • Provided reusable and responsive design components

Front end deployed to Netlify

https://flamboyant-blackwell-be93e6.netlify.com/

Back end deployed to Heroku and built using:

Node JS + Express

  • allows us to build a relational database using knex and sqlite.
  • allows us to create out own middleware wherever neccessary.
  • allows for easy integration with our React app.
  • allows us to create modular, RESTful APIs to call on from our React app.

APIs -UPDATE

Firebase

🚫Replace text below with a description of the API

Firebase is an API that lets developers easily sync and store data in realtime. Firebase Simple Login is an additional service that allows developers to authenticate users using only client-side code. Enable authentication via a number of third-party providers, anonymous login, or email / password authentication without having to manually store authentication credentials or run a server.

Stripe

🚫Replace text below with a description of the API

Stripe is a service that allows users to accept payments online, specifically developers. The Stripe API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

Websocket

🚫Replace text below with a description of the API

You can do anything your heart can imagine. In life you need colors. This is where you take out all your hostilities and frustrations. It's better than kicking the puppy dog around and all that so. I'm sort of a softy, I couldn't shoot Bambi except with a camera. Trees get lonely too, so we'll give him a little friend. We'll lay all these little funky little things in there.

3️⃣ Environment Variables -UPDATE

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_KEY - this is your Google API key, which can be generated in the Google Cloud Console

*  REACT_APP_DOMAIN - when you set up your Firebase project, this information will be in the dashboard

*  REACT_APP_backendURL - optional for your local development 

5️⃣ Content Licenses -UPDATE

🚫For all content - images, icons, etc, use this table to document permission of use. Remove the two placeholders and add you content to this table

Image Filename Source / Creator License
doodles.png Nicole Bennett Creative Commons
rings.svg Sam Herbert MIT

Testing

The @testing-library/react package was used to perform unit tests to ensure specifics for the user interface.

Installation Instructions

To get the project running locally:

  • Clone this repository.
  • CD into the folder where you downloaded the repository.
  • Run yarn or npm i to download all dependencies.
  • Type yarn test or npm test to run the tests. The test script is already configured.

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.

About

Frontend React App with auth0

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 8