aaron-beach / SampleWork

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Welcome to SampleWork 👋

Version Documentation

Profile Forms is a section form a larger React app that allows Users to modify their profile information.

The profile within the app is being constructed by another party outside of React. Data will be updated via API Post request.

SampleWork

Table of contents

Prerequisites

Before you begin, ensure you have met the following requirements:

WARNING

It is bad practice to commit an env file because it can lead to credentials and/or secrets getting committed. I am including it in this sample project to reduce setup steps for the reviewer of this project

Technologies

Project is created with:

  • Bootstrap: "^4.4.1"
  • React: "^16.12.0"
  • React-bootstrap: "^1.0.0-beta.16"
  • React-hook-form: "^4.9.6"
  • React-router-dom: "^5.1.2"
  • i18next: "^19.1.0"

Installing Samplework

To install this project, follow these steps:

yarn install

Using Samplework

To use this project, follow these steps:

yarn run start

Author

👤 Aaron Beach

License

This project uses the following license: MIT License

Copyright (c) 2020 Aaron Beach

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

About


Languages

Language:JavaScript 72.0%Language:CSS 22.7%Language:HTML 5.2%