Current version: 0.3. This app is in Alpha phase of the release life cycle for iOS and web.
Production: www.schematiccapture.com in current state, does not seem to want to render new code?
Staging: staging.schematiccapture.com not currently in use - check AWS!
- Jason Belgard – Github
- Brian Hamilton – LinkedIn
- Gi Pyo John Kim – Github
-
Christopher Johnson - Github
-
Raajn Patel - Github
-
Nattajohn Rojanasupya - Github
-
Brad Zickafoose - Github
Trello Board | Product Canvas | UX Design files
An iOS/web app for capturing and annotating huge machines in some of the countries larger steel manufacturing facilities 🔥 It needs offline capabilities to be able to capture photos and annotate them in facilities that often have no network or signal available to them.
- Authentication with Firebase
- Send registration invitation by email
- Import data from CSV to the database
- Upload PDF to Firebase cloud storage
Front end deployed to Netlify and built using:
Backend deployed to Heroku and built using:
- Express server for resftul API.
- Familiarity and experience in creating production ready code.
- PGAdmin to quickly edit/view database.
- See endpoint on BE
Firebase includes a whole suite of products available to benefit owner/user/developer including Analytics, Authentication, and Storage.
Font Awesome is a default icon set used throughout the Schematic Capture web app.
Sendgrid is a email delivery service which allow Schematic Capture to send invitation emails with invite tokens.
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_BASE_URL - Base URL for the backend
| Filename | Source / Creator | License |
|---|---|---|
| Icons | Font Awesome | Free |
We chose to use Cypress beacuse it is a complete end-to-end testing suite.
Sentry provides cloud-based error monitoring that helps the software team, discover, triage, and prioritize errors in real-time.
Uptime Robot is a service that monitors the website every 5 minutes and alerts the software team if the site is down.
This project is setup using create-react-app (CRA). You will not need to install CRA in order to make this project work. Follow the steps below to setup the project with the proper dependencies.
- Create a forked copy of this project.
- Add your team lead as collaborator on Github.
- Clone your OWN version of the repository in your terminal
- CD into the project base directory
cd schematic-capture-fe - Download project dependencies by running the command
yarn - Using yarn, start up the app using
yarn start - Create a new feature branch: git checkout -b
<new-feature>. Implement the project on your newly created<new-feature>branch, committing changes regularly. - Push commits: git push origin
<new-feature>.
* start - starts the production server after a build is created
* build - creates a build of the application
* coverage - runs test coverage using jest
* test:cypress - initializes cypress testing
* test:jest - initializes jest testing
* eject - copy the configuration files and dependencies into the project so you have full control over them
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.
- See iOS Documentation for details on the backend of our project.
- See PVD for details on product overview.