Skip to content

bkbuilt/react-concept

 
 

Repository files navigation

react-concept

Frontend proof of concept of CodeBuddies v3 using React.

For Backend proof of concepts, see:

Contribution instructions

  1. Fork this repo.
  2. Find an issue and leave a comment if you're interested in it.
  3. Run npm install and npm start

We have a "fake" API set up in the db.json file, which our React components pull from.

Design

View proof of concept designs over on the official V3 repo labeled "design". Note that the designs are only meant to serve as a guide and the output does not need to be pixel perfect. Instead, use Material-UI components as a starting point and extend as needed.

The PoC for the frontend will revolve around querying and posting the Resource model based on the defined API spec.

Using Material UI

We're using Material-UI's Hooks API, which means you can (and should) use Material UI's components as a starting point, and extend them as needed using makeStyles and useStyles.

See the Nav component for an example that uses several Material-UI components, and the makeStyles hook to customize the rest.

Pages

Index

The main landing page will have a small copy as well as a Sign Up and Sign in form (see You can find these pages at Figma for reference).

After authenticating, the root page should be defined as the Resources Index page.

Resources

The Resources page displays a search form. From this page, a user can search for a resource and add a new resource. After searching for a resource, it should populate with the search results. Clicking on Add a Resource should open a modal with a form to add a Resource. On success, it should give a message that a resource was added successfully, or if there are errors, display error messages in an flash message.

Things to Validate

  • Testing frameworks (Jest or Mocha)
  • UI Framework - is it easily extendable and manageable?
  • Any cons?

CRA Notes

This project was bootstrapped with Create React App.

Available Scripts

In the project directory, you can run:

npm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

npm test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

npm run build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

npm run eject

Note: this is a one-way operation. Once you eject, you can’t go back!

If you aren’t satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (Webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.

You don’t have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.

Learn More

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.

Code Splitting

This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting

Analyzing the Bundle Size

This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size

Making a Progressive Web App

This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app

Advanced Configuration

This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration

Deployment

This section has moved here: https://facebook.github.io/create-react-app/docs/deployment

npm run build fails to minify

This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify

About

Frontend concept with React for CBv3

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 93.6%
  • HTML 4.5%
  • CSS 1.9%