Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs #250

Merged
merged 4 commits into from
May 22, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# A Web Frontend for ABE

[![Build Status](https://travis-ci.org/olinlibrary/abe-web.svg?branch=dev)](https://travis-ci.org/olinlibrary/abe-web)
[![Coverage Status](https://coveralls.io/repos/github/olinlibrary/abe-web/badge.svg?branch=dev)](https://coveralls.io/github/olinlibrary/abe-web?branch=dev)
[![Build Status](https://travis-ci.org/olin-build/abe-web.svg?branch=dev)](https://travis-ci.org/olin-build/abe-web)
[![Coverage Status](https://coveralls.io/repos/github/olin-build/abe-web/badge.svg?branch=dev)](https://coveralls.io/github/olin-build/abe-web?branch=dev)

This is a Web front end to the [Olin College of Engineering
Library](http://www.olin.build)'s [Amorphous Blob of
Events](https://github.com/olinlibrary/ABE).
Events](https://github.com/olin-build/ABE).

## Contributing

Expand All @@ -24,9 +24,9 @@ Design, developer, Olin community member — you can help:
### Designers

Usability and design issues are labeled with
[`usability`](https://github.com/olinlibrary/abe-web/issues?q=is%3Aopen+is%3Aissue+label%3Ausability)
[`usability`](https://github.com/olin-build/abe-web/issues?q=is%3Aopen+is%3Aissue+label%3Ausability)
and
[`design`](https://github.com/olinlibrary/abe-web/issues?q=is%3Aopen+is%3Aissue+label%3Adesign).
[`design`](https://github.com/olin-build/abe-web/issues?q=is%3Aopen+is%3Aissue+label%3Adesign).

### Developers

Expand Down Expand Up @@ -55,5 +55,5 @@ service free of charge. BrowserStack allows us to test our project in a
multitude of browsers on various platforms, including IE, Safari, Android and
iOS, to ensure compatibility with as many as possible.

[issues]: https://github.com/olinlibrary/abe-web/issues
[good-first-issue]: https://github.com/olinlibrary/abe-web/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22
[issues]: https://github.com/olin-build/abe-web/issues
[good-first-issue]: https://github.com/olin-build/abe-web/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22
2 changes: 1 addition & 1 deletion app.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "abe-web",
"description": "Web frontend for Olin College's Amorphous Blob of Events",
"repository": "https://github.com/olinlibrary/abe-web",
"repository": "https://github.com/olin-build/abe-web",
"success_url": "/",
"env": {
"ABE_URL": "https://abe-dev.olin.build"
Expand Down
13 changes: 7 additions & 6 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Please check out the [the open issues][issues].
You first need to clone the code from this repository to your computer. To do that, run the following:

```shell
git clone https://github.com/olinlibrary/abe-web.git
git clone https://github.com/olin-build/abe-web.git
cd abe-web
```

Expand Down Expand Up @@ -52,7 +52,7 @@ yarn install
#### (Optional) Configure Environment variables

Certain environment variables may be set before running the server. In
particular, set `ABE_URL` to the URL of an [ABE server](https://github.com/olinlibrary/abe).
particular, set `ABE_URL` to the URL of an [ABE server](https://github.com/olin-build/ABE).

* `ABE_URL` (optional) - the URL of the ABE back-end instance you'd like to
connect to. (Please use a dev instance when developing.) This defaults to
Expand All @@ -73,7 +73,7 @@ and the values in that file.
### Run

To launch the web app, make sure you have a local ABE instance running on port
3000 (go to <https://github.com/olinlibrary/ABE> for instructions on how to run
3000 (go to <https://github.com/olin-build/ABE> for instructions on how to run
ABE) and run the following:

yarn dev
Expand All @@ -88,9 +88,10 @@ seconds for Webpack to recompile everything.

`yarn test` runs [Jest](https://facebook.github.io/jest/).

`yarn test:watch` runs Jest in watch mode.
`yarn test --watch` runs Jest in watch mode. Jest will run until you press `q`,
and re-run the tests when a source file changes.

`yarn test:coverage` creates a test coverage report. View the HTML at `./coverage/lcov-report/index.html`.
`yarn test --coverage` creates a test coverage report. View the HTML at `./coverage/lcov-report/index.html`.

### Lint

Expand Down Expand Up @@ -124,4 +125,4 @@ For working on the server or the build system:
server.
* [Webpack](https://webpack.js.org/) combines and optimizes source files.

[issues]: https://github.com/olinlibrary/abe-web/issues
[issues]: https://github.com/olin-build/abe-web/issues
22 changes: 10 additions & 12 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,24 +4,22 @@
"description": "Web frontend utilizing React for Olin College of Engineering's Amorphous Blob of Events (ABE).",
"main": "server.js",
"scripts": {
"clean": "rimraf bundle.js bundle.js.map",
"build": "webpack --config=webpack.config.js -p",
"postinstall": "$npm_execpath run clean && $npm_execpath run build",
"start": "node server.js",
"clean": "rimraf bundle.js bundle.js.map",
"dev": "webpack-dev-server --inline --hot",
"lint": "$npm_execpath run lint:js && $npm_execpath run lint:markdown",
"lint:js": "eslint --cache --ext .js,.jsx src *.js",
"format": "eslint --fix --ext .js,.jsx src *.js && $npm_execpath run lint:markdown --fix",
"heroku-postbuild": "$npm_execpath run clean && $npm_execpath run build",
"lint:js": "eslint --cache --ext .js,.jsx src *.js",
"lint:markdown": "markdownlint *.md && markdownlint .github/PULL_REQUEST_TEMPLATE.md -c .github/.markdownlintrc",
"test": "jest",
"test:coverage": "jest --coverage",
"test:watch": "jest --watch",
"stats": "webpack --json > stats.json"
"lint": "$npm_execpath run lint:js && $npm_execpath run lint:markdown",
"start": "node server.js",
"stats": "webpack --json > stats.json",
"test": "jest"
},
"engines": {
"node": "^9"
},
"repository": "github:olinlibrary/abe-web",
"repository": "github:olin-build/abe-web",
"keywords": [
"abe",
"events",
Expand All @@ -34,9 +32,9 @@
"author": "Olin College of Engineering Library",
"license": "MIT",
"bugs": {
"url": "https://github.com/olinlibrary/abe-web/issues"
"url": "https://github.com/olin-build/abe-web/issues"
},
"homepage": "https://github.com/olinlibrary/abe-web#readme",
"homepage": "https://github.com/olin-build/abe-web#readme",
"dependencies": {
"axios": "^0.16.2",
"babel-core": "^6.26.0",
Expand Down
2 changes: 1 addition & 1 deletion src/data/encoding.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import moment from 'moment';
// user creates an event in an empty database), but only needs to get us through
// an API transition and can then be removed.
//
// TODO: Remove this variable, and simplify its users, once olinlibrary/ABE#243
// TODO: Remove this variable, and simplify its users, once olin-build/ABE#243
// is on production and active developer branches.
let useSnakeCaseProperties = true;

Expand Down
2 changes: 1 addition & 1 deletion src/docs.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
const integrateCalendarPageUrl =
'https://github.com/olinlibrary/abe-web/wiki/Integrate-with-Your-Calendar';
'https://github.com/olin-build/abe-web/wiki/Integrate-with-Your-Calendar';

const urls = {
integrateCalendarUrl: `${integrateCalendarPageUrl}#wiki-wrapper`,
Expand Down
2 changes: 1 addition & 1 deletion src/sidebar/footer.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ const Footer = props => (
Report a problem
</a>
&nbsp;|&nbsp;
<a href="https://github.com/olinlibrary/abe-web" title="View on GitHub" target="_blank">
<a href="https://github.com/olin-build/abe-web" title="View on GitHub" target="_blank">
View on GitHub
</a>
</p>
Expand Down
2 changes: 1 addition & 1 deletion src/sidebar/markdown-guide.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ const MarkdownGuide = _props => (
<div className="markdown-guide-section">
<span className="markdown-guide-section-title">Links</span>
<p className="markdown-sample">[link text](url)</p>
<p className="markdown-sample">[url]</p>
<p className="markdown-sample">&lt;url&gt;</p>
</div>
<div className="markdown-guide-section">
<span className="markdown-guide-section-title">Headers</span>
Expand Down