https://github.com/navono/component-lib-playground
This is a test project for component-lib.
https://github.com/navono/component-lib-playground
Last synced: over 1 year ago
JSON representation
This is a test project for component-lib.
- Host: GitHub
- URL: https://github.com/navono/component-lib-playground
- Owner: navono
- Created: 2017-06-26T12:06:01.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2017-06-26T12:34:50.000Z (almost 9 years ago)
- Last Synced: 2025-02-26T03:36:24.064Z (over 1 year ago)
- Language: JavaScript
- Size: 50.8 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# React Component Library Playground
_for [Heroku](https://www.heroku.com/) deployment_
### OVERIVEW
This is a playground for experimenting with a component library. This is intended to provide:
* a small app to experiment with a component library locally.
* a lightweight webpack config (for development and production)
* some helpful tooling for development workflow
* a similar setup to what you'll see in the wild
* Heroku-ready deployment setup
_*NOTE:* This app is based on my [React + Node Starter](https://github.com/alanbsmith/react-node-example)._
### UP & RUNNING
* Install dependencies
`$ npm install` or `$ yarn`
* Fire up a development server:
* `$ npm run dev`
Once the server is running, you can visit `http://localhost:8080/`
### Linting
_This assumes you have eslint and eslint-watch installed. If you don't, run the following:_
```
$ npm i -g eslint eslint-watch
```
or if you need permissions:
```
$ sudo npm i -g eslint eslint-watch
```
To run the linter once:
```
$ npm run lint
```
To run the watch task:
```
$ npm run lint:watch
```
### Testing
To run the tests:
```
$ npm test
```
### Production Build
To build your production assets and run the server:
```
$ npm start
```
### DEPLOYING TO HEROKU
This app is set up for deployment to Heroku!
_This assumes you have already have a Heroku account and have the [Heroku CLI](https://devcenter.heroku.com/articles/heroku-cli) installed_
```
$ heroku login
$ heroku create -a name-of-your-app
$ git push heroku master
$ heroku open
```
Heroku will follow the `build` command in your `package.json` and compile assets with `webpack.prod.config.js`. It runs the Express web server in `server.js`.
If you're unfamiliar with Heroku deployment (or just need a refresher), they have a really great walkthrough [here](https://devcenter.heroku.com/articles/getting-started-with-nodejs#introduction).