Skip to content

Commit f16b556

Browse files
Initial Release (#1)
* initial commit * adding changelog * fixing action submission * 1.0.0 * adding deploy workflow * removing old README * adding code of conduct * adding contribution guidelines * updating README
1 parent 96d2dd4 commit f16b556

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+18362
-2
lines changed

.github/workflows/deploy.yaml

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Deploys to Heroku when a release is created
2+
3+
name: Deploy to Heroku
4+
5+
on:
6+
release:
7+
types: [created]
8+
9+
jobs:
10+
publish-npm:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@v2
14+
- uses: actions/setup-node@v1
15+
with:
16+
node-version: 12
17+
registry-url: https://registry.npmjs.org/
18+
- run: git push heroku master

.gitignore

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
2+
3+
# dependencies
4+
/node_modules
5+
/.pnp
6+
.pnp.js
7+
8+
# testing
9+
/coverage
10+
11+
# production
12+
/build
13+
14+
# misc
15+
.DS_Store
16+
.env.local
17+
.env.development.local
18+
.env.test.local
19+
.env.production.local
20+
21+
npm-debug.log*
22+
yarn-debug.log*
23+
yarn-error.log*

CHANGELOG.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog][kac], and this project adheres to
6+
[Semantic Versioning][semver].
7+
8+
[kac]: https://keepachangelog.com/en/1.0.0
9+
[semver]: https://semver.org/spec/v2.0.0.html
10+
11+
## Unreleased
12+
13+
### Added
14+
15+
- Error response reporting
16+
- Non-Siren response handling
17+
- Tags for actions' `method` and `type`
18+
- Configuration options
19+
- Siren client headers
20+
- Title casing property names
21+
- Display original JSON source (in addition to current state)
22+
23+
### Changed
24+
25+
- Center location input control
26+
- Update location input control value to show current location
27+
28+
## 1.0.0
29+
30+
### Added
31+
32+
- Fetch entry point URL
33+
- Display an (embedded) entity
34+
- Render the `title` as the header, the `class` elements as tags, and panels
35+
for the `actions`, `links`, and `entities`
36+
- JSON representation of the entity
37+
- Follow (embedded) links
38+
- Submit actions

CODE_OF_CONDUCT.md

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to make participation in our project and our
7+
community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, sex characteristics, gender identity and
9+
expression, level of experience, education, socio-economic status, nationality,
10+
personal appearance, race, religion, or sexual identity and orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
- Using welcoming and inclusive language
18+
- Being respectful of differing viewpoints and experiences
19+
- Gracefully accepting constructive criticism
20+
- Focusing on what is best for the community
21+
- Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
- The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
- Trolling, insulting/derogatory comments, and personal or political attacks
28+
- Public or private harassment
29+
- Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
- Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or reject
41+
comments, commits, code, wiki edits, issues, and other contributions that are
42+
not aligned to this Code of Conduct, or to ban temporarily or permanently any
43+
contributor for other behaviors that they deem inappropriate, threatening,
44+
offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies within all project spaces, and it also applies when
49+
an individual is representing the project or its community in public spaces.
50+
Examples of representing a project or community include using an official
51+
project e-mail address, posting via an official social media account, or acting
52+
as an appointed representative at an online or offline event. Representation of
53+
a project may be further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the project team at <[email protected]>.
59+
All complaints will be reviewed and investigated and will result in a response
60+
that is deemed necessary and appropriate to the circumstances. The project team
61+
is obligated to maintain confidentiality with regard to the reporter of an
62+
incident. Further details of specific enforcement policies may be posted
63+
separately.
64+
65+
Project maintainers who do not follow or enforce the Code of Conduct in good
66+
faith may face temporary or permanent repercussions as determined by other
67+
members of the project's leadership.
68+
69+
## Attribution
70+
71+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
72+
[version 1.4][v1.4]
73+
74+
[homepage]: https://www.contributor-covenant.org
75+
[v1.4]: https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
76+
77+
For answers to common questions about this code of conduct, see the [FAQ].
78+
79+
[faq]: https://www.contributor-covenant.org/faq

CONTRIBUTING.md

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
# Contribution Guidelines
2+
3+
Thank you for taking the time and consideration to contribute to [Siren.js]!
4+
5+
[siren.js]: https://github.com/siren-js
6+
7+
This document outlines our guidelines for contributing to this repository, which
8+
is part of the Siren.js project. Following these guidelines helps communicate
9+
that you respect the time of the developers managing and developing this open
10+
source project. In return, they should reciprocate that respect in addressing
11+
your issue, assessing changes, and helping you finalize your pull requests.
12+
Check out the [Code of Conduct](CODE_OF_CONDUCT.md) to learn about our core
13+
values and norms.
14+
15+
If you have feedback or questions, your contribution has been sitting for a
16+
while, you need help, or would like to talk through a contribution, feel free to
17+
join the [Google Group][gg]!
18+
19+
[gg]: https://groups.google.com/g/sirenjs
20+
21+
> First time contributing to open source? You can learn how from this _free_
22+
> video series: [How to Contribute to an Open Source Project on GitHub][course].
23+
24+
[course]: https://kcd.im/pull-request
25+
26+
## Bugs and Feature Requests
27+
28+
If you find a bug or would like to request a new feature, be sure to check out
29+
the current list of [issues]. If you can't find anything, feel free to
30+
[create a new one][create-issue].
31+
32+
[issues]: https://github.com/siren-js/api-browser/issues
33+
[create-issue]: https://github.com/siren-js/api-browser/issues/new
34+
35+
## Pull Requests
36+
37+
If you'd like to contribute a change, follow these steps:
38+
39+
1. Fork the repository.
40+
1. Clone your fork.
41+
1. Create a branch.
42+
1. Make and commit your changes (see [Development](#development)).
43+
- Be sure to update the [changelog](CHANGELOG.md).
44+
- If you're making code changes, be sure to write tests!
45+
1. Push your changes to your fork.
46+
1. If your build is passing, create a pull request.
47+
1. Wait for a review and make changes as requested.
48+
1. Get merged!
49+
50+
## Development
51+
52+
Setup is simple. `cd` into the project directory and run `npm install`. Now
53+
you're ready to code!
54+
55+
In the project directory, you can run the following commands
56+
57+
- `npm start` - Runs the app in the development mode. Open
58+
<http://localhost:3000> to view it in the browser. The page will reload if you
59+
make edits. You will also see any lint errors in the console.
60+
- `npm test` - Launches the test runner in the interactive watch mode. See the
61+
section about [running tests][testing] for more information.
62+
- `npm run build` - Builds the app for production to the `build` folder. It
63+
correctly bundles React in production mode and optimizes the build for the
64+
best performance.
65+
66+
The build is minified and the filenames include the hashes. Your app is ready
67+
to be deployed!
68+
69+
See the section about [deployment] for more information.
70+
71+
[testing]: https://facebook.github.io/create-react-app/docs/running-tests
72+
[deployment]: https://facebook.github.io/create-react-app/docs/deployment
73+
74+
This project uses [SemVer](https://semver.org/). When making code changes, be
75+
sure to increment the version accordingly with the
76+
[`npm version` command][npm-version]. We recommend using the
77+
`--no-git-tag-version` option to avoid potential issues.
78+
79+
[npm-version]: https://docs.npmjs.com/cli/v7/commands/npm-version

README.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,13 @@
1-
# api-browser
2-
Siren API browser that uses Siren.js
1+
# Siren.js API Browser
2+
3+
Siren API browser implemented with [Siren.js client][client], [React], and
4+
[Bulma].
5+
6+
[client]: https://github.com/siren-js/client
7+
[bulma]: https://bulma.io/documentation
8+
[react]: https://reactjs.org
9+
10+
## Contributing
11+
12+
If you would like to contribute anything from a bug report to a code change, see
13+
our [contribution guidelines](CONTRIBUTING.md).

0 commit comments

Comments
 (0)