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.

Sign up for GitHub

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

Adds Figma link and improves readme (#20) #21

Closed
wants to merge 1 commit into from
Closed

Adds Figma link and improves readme (#20) #21

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
40 changes: 30 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,26 +1,40 @@
# Jury

A project designed to create a new pairwise judging system using modern technologies aimed at optimizing the user experience of judges and admin users. See the inspiration for this project: [Gavel by anishathalye](https://github.com/anishathalye/gavel). Refer to [this excellent article](https://www.anishathalye.com/2015/03/07/designing-a-better-judging-system/) for more details on the underlying formulas of Gavel! The majority of our algorithm will be based off of research done in the field of [pairwise comparison](https://en.wikipedia.org/wiki/Pairwise_comparison).
Table of Contents
-----------------
- [Introduction](#introduction)
- [Deployment](#deployment)
- [With Docker](#with-docker)
- [Development](#development)
- [With Docker (Recommended!)](#with-docker-recommended)
- [Manual Installation](#manual-installation)
- [License](#license)

# Deployment
## Introduction

## With Docker
Jury is a project aimed at creating a new pairwise judging system using modern technologies to optimize the user experience for judges and admin users. The inspiration for this project is [Gavel by anishathalye](https://github.com/anishathalye/gavel), and [this excellent article](https://www.anishathalye.com/2015/03/07/designing-a-better-judging-system/) provides more details on the underlying formulas of Gavel. The majority of our algorithm is based on research done in the field of [pairwise comparison](https://en.wikipedia.org/wiki/Pairwise_comparison).

Run `docker compose up`
To see the designs for this project, check out the [Figma page](https://www.figma.com/file/qwBWs4i7pJMpFbcjMffDZU/Jury-(Gavel-Plus)?node-id=8%3A100&t=egLV7iVmwvNRXef5-1).

# Developing
## Deployment

## With Docker (Recommended!)
### With Docker

To deploy the application using Docker, run `docker compose up`.

## Development

### With Docker (Recommended!)

Requirements:

* [Docker](https://www.docker.com/)

Copy `.env.template` into `.env` and fill in the environmental variables
Copy `.env.template` into `.env` and fill in the environmental variables.

Simply run `docker compose -f docker-compose.dev.yml up` and open the page at `localhost:3000`
To start the development environment, simply run `docker compose -f docker-compose.dev.yml up` and open the page at `localhost:3000`.

## Manual Installation
### Manual Installation

Requirements:

Expand All @@ -29,7 +43,7 @@ Requirements:
* [GNU Scientific Library (GSL)](https://www.gnu.org/software/gsl/)

Copy `.env.template` into `.env` and fill in the environmental variables. You will also need a `MONGODB_URI` field.
Additionally, copy `client/.env.template` into `client/.env` and copy over the relavent environmental variables from `.env`.
Additionally, copy `client/.env.template` into `client/.env` and copy over the relevant environmental variables from `.env`.
This is used to expose the correct environmental variables to the running instance of CRA.

Client dev server (PORT 3000):
Expand All @@ -45,3 +59,9 @@ Backend dev server (PORT 8000):
```
cargo run
```

Note that manual installation is not recommended, and the Docker setup is the preferred development environment.

## License

This project is licensed under the [MIT License](LICENSE).