-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
mjaquiery
committed
Mar 31, 2021
1 parent
ca0c62e
commit 6d55a1d
Showing
2 changed files
with
61 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
MIT License | ||
|
||
Copyright (c) 2021 UKRN Open Research | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,25 +1,59 @@ | ||
[![Netlify Status](https://api.netlify.com/api/v1/badges/608d28c1-597c-4437-9a68-d94077244ca4/deploy-status)](https://app.netlify.com/sites/nervous-payne-efa831/deploys) | ||
# ukrn-open-research-resources | ||
|
||
## Project setup | ||
# UKRN Open Research Resources Browser | ||
|
||
## About | ||
|
||
The [UK Reproducibility Network (UKRN)](https://ukrn.org/) is an organisation that promotes open research practices in the United Kingdom. | ||
As part of its operations, it maintains a list of open research resources. | ||
These resources are listed in a Google Sheets document. | ||
This Browser makes exploring, viewing, and filtering the resources easier. | ||
|
||
## Local development | ||
|
||
This project's dependencies are managed by npm. | ||
To get started, fork this repository and then navigate to the project directory and follow the instructions below: | ||
|
||
### Project setup | ||
To install the project dependencies run: | ||
``` | ||
npm install | ||
``` | ||
|
||
### Compiles and hot-reloads for development | ||
#### `.env` file | ||
The project is powered by its connectivity to the Google Sheets API. | ||
It therefore needs a `.env` file with the following keys: | ||
* `GOOGLE_SPREADSHEET_ID_FROM_URL` - the URL of the Google Sheet to represent | ||
* `GOOGLE_SERVICE_ACCOUNT_EMAIL` - the email of the [Google Service Account](https://cloud.google.com/iam/docs/service-accounts) responsible for the API calls | ||
* `GOOGLE_PRIVATE_KEY` - the private key of the above for authorisation | ||
|
||
#### Serve for local testing | ||
Uses webpack compiling and supports hot-reloading of files. | ||
``` | ||
npm run serve | ||
``` | ||
|
||
### Compiles and minifies for production | ||
#### Compiles and minifies for production | ||
``` | ||
npm run build | ||
``` | ||
|
||
### Lints and fixes files | ||
#### Lints and fixes files | ||
``` | ||
npm run lint | ||
``` | ||
|
||
### Customize configuration | ||
#### Customize configuration | ||
See [Configuration Reference](https://cli.vuejs.org/config/). | ||
|
||
### Component Guides | ||
The project is built on several core components. | ||
If you run into difficulty with them, more information can be found at: | ||
* [VueJS](https://vuejs.org/) | ||
* [VueX](https://vuex.vuejs.org/) | ||
* [Bulma](https://bulma.io/) / [Buefy](https://buefy.org/) | ||
* [Google Sheets API](https://developers.google.com/sheets/api) | ||
* [Netlify](https://docs.netlify.com/) | ||
|
||
## License | ||
This project is licensed under the [MIT license](https://github.com/UKRN-Open-Research/ukrn-open-research-resources/blob/master/LICENSE.txt). |