You can find the deployed project HERE.
https://docs.google.com/document/d/1zncksxCLfrR-m23zvb7jucV0p-_j_gzlHv1ofJPmuW8/edit?usp=sharing
Matthew Orth slack: @Matthew Orth github: https://github.com/mattorth
Loralie Flint slack: @Laflint92 github: https://github.com/LoralieFlint
Heber Gonzalez slack: @Heber github: https://github.com/hebergonza719
Grant Wylie slack: @J github: https://github.com/iesous-kurios
Guillermo Arria-Devoe slack: @Guillermo Arria-Devoe github: https://github.com/arriadevoe
Nicholas George slack: @Nicholas George github: https://github.com/npgeorge
Farid Hamida slack: @Farid Hamida email: farid-hamida@lambdastudents.com
Jacob Prudent slack: @Jacob Prudent email: jacob-prudent@lambdastudents.com
Derek Peters slack: @Derek email: derek.peters@lambdaschool.com
| Dakota Pope | Elisabeth Shah | Gwen Purcell | Martin Lehman | Eric SarragaLugo |
|---|---|---|---|---|
| Team Lead | Data Science | Data Science | Data Science | Full-Stack Web Development |
 |
 |
 |
 |
 |
 |
|
|
|
People interact with repositories all the time, but there is no visibility into how it correlates to the "success" of the repositories. There are plenty of articles out there outlining GitHub "best practices", but the vast majority seem to be subjective, based on intuition and experience, not evidence-based.
Our Mission is to make open source a better experience for developers and maintainers by committing to actionable insights for project success.
- Social SignIn with GitHub
- Automatic Account Sync
- Easy Repo Selection
- Easy Repo Search
- Framework:
ReactOur web team is most comfortable with this framework and it's available toolset. We feel React is well suited to the type of webapp we want to build and we can move from an SPA to a PWA with relative ease to potentially allow some offline use.
- Low-Frequency State Management:
React's ContextAPIBuilt-in to React and quite useful for passing state between multiple components but not suited to high-frequency updates.
- Styling Library:
Primer ComponentsEasy to use styling library provided by GitHub that allows us to make sure our product feels familiar to our users.
Back end built using:
-
Database:
PostgreSQLThe standard to follow per the Labs Engineering Standards.
-
API Framework: REST
Although we are retrieving information from GitHub's v4 GraphQL API, internal endpoints were built as a RESTful API to keep within scope.
-
RunTime:
NodeJSWe feel that product quality will be improved through the sharing of common knowledge and reusable components.
-
Web Application Framework:
ExpressMinimal and Flexible. We feel that it provides a robust set of features that will support our development process.
Custom Social SignIn and Authentication with Passport JS on Node/Express.
- Redirect to
${process.env.REACT_APP_BACKEND_URL}/auth/githubto initiate Authentication process. - User must authorize sign in through GitHub.
- Passport JS will grab code and use it to verify and obtain token which will be returned to front-end.
Main data source for our app. Will provide all of the base information that the app will display.
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_ENV - used during Sentry initialization to decide wether to initialize or not
* REACT_APP_VERSION - used during Sentry initialization for prompt
* REACT_APP_NAME - used during Sentry initialization for prompt
* REACT_APP_SENTRY_DSN - used for reporting
* REACT_APP_BACKEND_URL - centralized link location
🚫Document what you used for testing and why
To initialize this project simply run:
$ npm ior
$ yarn "scripts": {
"start": "react-scripts start",
"build": "react-scripts build",
"test": "react-scripts test",
"coverage": "npm run test -- --coverage --watchAll=false",
"eject": "react-scripts eject"
},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.
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.
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.
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.
- 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.
These contribution guidelines have been adapted from this good-Contributing.md-template.
See Backend Documentation for details on the backend of our project.