README.md 824 Bytes
Newer Older
Andrew Hrdy's avatar
Andrew Hrdy committed
1
# What's Open Web
Mattias J Duffy's avatar
Mattias J Duffy committed
2

Andrew Hrdy's avatar
Andrew Hrdy committed
3 4 5
What's Open Web is a React application that uses data retrieved from 
the [What's Open API](https://git.gmu.edu/srct/whats-open) to display information about the facilities on 
George Mason University's campuses.
Mattias J Duffy's avatar
Mattias J Duffy committed
6

Andrew Hrdy's avatar
Andrew Hrdy committed
7 8 9 10
## Contributing
- Join `#whats-open-web` on [slack](https://srct.slack.com)
- Tag a fixed issue within the commit by ending the commit with `closes #issue`
- Open issues can be found [here](https://git.gmu.edu/srct/whats-open-web/issues)
Mattias J Duffy's avatar
Mattias J Duffy committed
11

Andrew Hrdy's avatar
Andrew Hrdy committed
12 13 14
### Requirements
- [git](https://git-scm.com/)
- [npm](https://www.npmjs.com/) or [yarn](https://yarnpkg.com/)
Mattias J Duffy's avatar
Mattias J Duffy committed
15

Andrew Hrdy's avatar
Andrew Hrdy committed
16 17 18
### Setup
1. Clone the repository
2. Install dependencies either by `npm install` or `yarn`
Mattias J Duffy's avatar
Mattias J Duffy committed
19

Andrew Hrdy's avatar
Andrew Hrdy committed
20 21 22
### Debugging
- A development server can be accessed by `npm start` or `yarn start`
- It is highly recommended to use the React and Redux dev tools