https://github.com/buildit/bookit-client-react
https://github.com/buildit/bookit-client-react
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/buildit/bookit-client-react
- Owner: buildit
- Created: 2017-09-26T18:57:27.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-05-14T20:56:08.000Z (almost 7 years ago)
- Last Synced: 2025-02-04T23:31:49.941Z (3 months ago)
- Language: JavaScript
- Size: 1.18 MB
- Stars: 0
- Watchers: 13
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: docs/CONTRIBUTING.md
Awesome Lists containing this project
README
# Bookit
This is the front end for Bookit, a room booking app created by Buildit. It runs against the [Bookit API](https://github.com/buildit/bookit-api) (which you must have running locally).
## Quick start
Clone the [Bookit API](https://github.com/buildit/bookit-api) locally. From the bookit-api root run a
Docker command to create the back-end.
```Shell
git clone [email protected]:buildit/bookit-api.git
cd bookit-api
docker-compose up
# Make sure to run `docker-compose down` to turn off the API when you're done
```
Clone this repo. Set the proper Node version ([Node Version Manager](https://github.com/creationix/nvm)
is recommended). Navigate to the root and install the dependencies. Then run the app.
```Shell
nvm use
# If you don't already have it
$ brew install yarn
# Install dependencies
$ yarn
# Also ensure bookit-api is running on localhost:8080
$ yarn start
# Run the app in dev mode on localhost:3001
```
## Testing
```
# Run unit tests as a one-off
$ yarn test
# Run unit tests continuously
$ yarn test:watch
# Run unit test against a single test suite
$ yarn test path/to/source.test.js
```
To run unit tests
### Run end-to-end UI testing
```
# Again ensure bookit-api is running on localhost:8080
yarn cucumber
```
## Linting
```
# Lint all source typescript
$ yarn lint
# Lint all stylesheets (SASS and css)
$ yarn lint:style
```
## Building
```
# Builds self-contained deployable production code under ./build
$ yarn build
# Outputs webpack.stats.json for use with any bundle analyzer
$ yarn analyze
```
## Troubleshooting
React has recently moved to version 16 which has caused a cascade of incorrect peerDependencies.
The source of this codebase has been modified to cope with these issues, but in case of total failure to make things work, the following commands can be used to install the correct dependencies overall.
```sh
$ yarn add history immutable react react-dom react-redux react-router-redux@next redux redux-actions redux-saga reselect reselect-immutable-helpers
$ yarn add @types/chai-enzyme@beta @types/history @types/jest @types/node @types/react @types/react-dom @types/react-hot-loader @types/react-redux @types/react-router @types/react-router-redux @types/redux @types/redux-actions @types/webpack-env autoprefixer awesome-typescript-loader babel-core babel-loader babel-plugin-transform-class-properties babel-plugin-transform-object-rest-spread babel-plugin-transform-runtime babel-preset-env babel-preset-react browserslist chai chai-enzyme chromedriver cheerio clean-webpack-plugin css-loader cucumber enzyme enzyme-adapter-react-16 extract-text-webpack-plugin file-loader html-webpack-plugin identity-obj-proxy jest name-all-modules-plugin node-sass postcss-loader react-hot-loader@next react-test-renderer sass-loader script-ext-html-webpack-plugin selenium-webdriver style-loader stylelint ts-jest tslint tslint-loader tslint-no-unused-expression-chai typescript url-loader webpack webpack-dev-server webpack-merge -D
```
## Build information
* [Build Pipeline](https://console.aws.amazon.com/codepipeline/home?region=us-east-1#/view/buildit-bookit-build-bookit-client-react-master-pipeline)
* [Build Reports](http://rig.buildit.bookit.us-east-1.build.s3-website-us-east-1.amazonaws.com/buildit-bookit-build-bookit-client-react-master/reports)
## Deployment information
### Deployments
* [Integration](https://integration-bookit-client-react.buildit.tools)
* [Staging](https://staging-bookit-client-react.buildit.tools)
* [Production](https://bookit-client-react.buildit.tools)
## Operational information
### Logging
* [Integration](https://console.aws.amazon.com/cloudwatch/home?region=us-east-1#logStream:group=buildit-bookit-integration-app-bookit-client-react-master)
* [Staging](https://console.aws.amazon.com/cloudwatch/home?region=us-east-1#logStream:group=buildit-bookit-staging-app-bookit-client-react-master)
* [Production](https://console.aws.amazon.com/cloudwatch/home?region=us-east-1#logStream:group=buildit-bookit-production-app-bookit-client-react-master)
## Contributing
See [Contributing](./docs/CONTRIBUTING.md) and [Web Development Stack](./docs/bookit-web-development-stack.md)
## Design Screens & Prototypes
* [Bookit-design](https://github.com/buildit/bookit-design)