Skip to content

Commit

Permalink
Updated the README by complying with Samvera component standards and
Browse files Browse the repository at this point in the history
referencing React and Redux; Adding the SUPPORT document
  • Loading branch information
jrgriffiniii committed Feb 17, 2020
1 parent e8dae76 commit 1f7f803
Show file tree
Hide file tree
Showing 2 changed files with 49 additions and 18 deletions.
62 changes: 44 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,49 @@
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
# BrowseEverything Redux/React
_A [React](https://reactjs.org/) and [Redux](https://redux.js.org/) user interface implementation for the [BrowseEverything Core Component](https://github.com/samvera/browse-everything)_

Jump in: [![Slack Status](http://slack.samvera.org/badge.svg)](http://slack.samvera.org/)

## Primary Contacts

### Technical Lead
[James Griffin](https://github.com/jrgriffiniii)

## Help

The Samvera community is here to help. Please see our [support guide](./SUPPORT.md).

## Available Scripts
## Getting Started

### Installing the Packages

`yarn install` or `npm install`

### Running the Server
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).

In the project directory, you can run:
### `npm install`
### `npm start`

`yarn start` or `npm start`

Runs the app in the development mode.<br>
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.

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

### `npm test`
## Development

### Validating the Style of the Code

`yarn lint` or `npm lint`

### Running the Test Suites
`npm test`

Launches the test runner in the interactive watch mode.<br>
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.

### `npm run build`
`npm run build`

Builds the app for production to the `build` folder.<br>
It correctly bundles React in production mode and optimizes the build for the best performance.
Expand All @@ -27,17 +53,7 @@ Your app is ready to be deployed!

See the section about [deployment](https://facebook.github.io/create-react-app/docs/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
## Learn More About React

You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).

Expand All @@ -63,6 +79,16 @@ This section has moved here: https://facebook.github.io/create-react-app/docs/ad

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

### `npm run build` fails to minify
### `yarn build` or `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

## Acknowledgments
This software has been developed by and is brought to you by the Samvera community. Learn more at the
[Samvera website](http://samvera.org/).

![Samvera Logo](https://wiki.duraspace.org/download/thumbnails/87459292/samvera-fall-font2-200w.png?version=1&modificationDate=1498550535816&api=v2)

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/samvera-labs/browse-everything-redux-react/.
5 changes: 5 additions & 0 deletions SUPPORT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
If you would like to report an issue, first search [the list of issues](https://github.com/samvera-labs/browse-everything-redux-react/issues/) to see if someone else has already reported it, and then feel free to [create a new issue](https://github.com/samvera-labs/browse-everything-redux-react/issues/new).

If you have questions or need help, please email [the Samvera community tech list](https://groups.google.com/forum/#!forum/samvera-tech) or stop by the #dev channel in [the Samvera community Slack team](https://wiki.duraspace.org/pages/viewpage.action?pageId=87460391#Getintouch!-Slack).

You can learn more about the various Samvera communication channels on the [Get in touch!](https://wiki.duraspace.org/pages/viewpage.action?pageId=87460391) wiki page.

0 comments on commit 1f7f803

Please sign in to comment.