Skip to content

Commit

Permalink
complete server readme
Browse files Browse the repository at this point in the history
  • Loading branch information
microstudi committed Dec 20, 2023
1 parent 9e7100b commit a916515
Showing 1 changed file with 19 additions and 7 deletions.
26 changes: 19 additions & 7 deletions bulletin_board/server/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,41 +9,53 @@ The Bulletin Board is a service composed by an Encryption Engine and an Append-O
- System dependencies:
- Python gmpy2 package dependencies: libgmp, libmpfr and libmpc

The Bulletin Board depends on the existence of a Decidim installation.
The Bulletin Board is intended to use alongside a Decidim installation. It's main purpose is to provide a GraphQL interface to a secure, auditable and verifiable voting system. This is currently achieved by using the [ElectionGuard python implementation](https://github.com/microsoft/electionguard-python), developed by Microsoft. So this server acts as a wrapper to the ElectionGuard python code.

- Installation:
Please check the [main documentation](../../README.adoc) for this repository for more convenient ways to run the Bulletin Board.

## Installation:

First, clone the repository and enter in the new folder:

```
```bash
git clone [email protected]:decidim/decidim-bulletin-board.git
cd decidim-bulletin-board/server
```

Now, execute these commands:

```
```bash
bundle install
npm install
rails db:create
rails db:migrate
```

- How to run the rubocop linter
## Run the server

```bash
bin/rails server
```

Conect to the GraphQL interface in http://localhost:3000/api (documentation is embedded)

## other commands

- How to run the rubocop linter

```bash
bundle exec rubocop
```

- How to run the test suite

```
```bash
bundle exec rspec
```

- How to update the GraphQL schema definition run:

```
```bash
bundle exec rake schema:generate
npm run schema:generate
```
Expand Down

0 comments on commit a916515

Please sign in to comment.