Skip to content

Commit

Permalink
It now does something useful
Browse files Browse the repository at this point in the history
  • Loading branch information
thewilkybarkid committed Dec 4, 2023
1 parent e63e7a7 commit d56402f
Showing 1 changed file with 38 additions and 1 deletion.
39 changes: 38 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,40 @@
# PREreview COAR Notify

⚠️ This repo doesn't yet do anything useful.
The source code for PREreview’s [COAR Notify] integration.

## Development

<details>

<summary>Requirements</summary>

- [Docker]
- [Docker Compose]
- [GNU Make]
- [Node.js]
- Unix-like operating system

</details>

### Running the app

To build and run the app for development, execute:

```shell
make start
```

You can now access the app at <https://localhost:3000>.

You will also have a `.env` file. This file contains environment variables controlling specific behaviours, including credentials for accessing external services.

## Operations

Once it passes CI, we deploy every commit on the `main` branch, which [Fly.io] hosts.

[coar notify]: https://www.coar-repositories.org/notify/
[docker]: https://www.docker.com/
[docker compose]: https://docs.docker.com/compose/
[fly.io]: https://fly.io/
[gnu make]: https://www.gnu.org/software/make/
[node.js]: https://nodejs.org/

0 comments on commit d56402f

Please sign in to comment.