clarion/README.md

# Clarion

A CfP automation system for OpenFest.

## Installation

### For local development

1. `git clone https://git.openfest.org/Site/clarion/`
2. Run `rvm install "ruby-$(cat .ruby-version)"; rvm install "ruby-$(cat .ruby-version)"`
3. Start up postgresql
4. Run `bundle install; bin/rake bootstrap`
5. You can now run the rails server with `bin/rails s`

### For production

`docker build -t clarion:latest -f Dockerfile .`

Note that the docker image contains a default user (for credentials see `db/seeds.rb`).

### docker-compose

`docker-compose up` will bring everything up on `http://127.0.0.1:3000` with production configuration.

## Initial Usage

1. Go to `http://127.0.0.1:3000/management/`
2. Login (for initial creds see `db/seeds.rb`)
3. Change the credentials
4. Create a conference.
  - NB: When creating a conference make sure to use the same `domain` as the one you are currently using, otherwise nothing will be shown.
Add docker-compose (#47) This is a docker-compose based on production config, without mounting of the local folders, which I admit is a strange setup, but this was the simplest for me to get the local development going. I'm perfectly ok with not merging this PR. Reviewed-on: https://git.openfest.org/Site/clarion/pulls/47 Co-authored-by: Tocho Tochev <tocho@tochev.net> Co-committed-by: Tocho Tochev <tocho@tochev.net> 2024-06-01 12:29:46 +03:00			`# Clarion`
Add a simple README file 2014-07-28 13:23:14 +03:00
			`A CfP automation system for OpenFest.`

Add docker-compose (#47) This is a docker-compose based on production config, without mounting of the local folders, which I admit is a strange setup, but this was the simplest for me to get the local development going. I'm perfectly ok with not merging this PR. Reviewed-on: https://git.openfest.org/Site/clarion/pulls/47 Co-authored-by: Tocho Tochev <tocho@tochev.net> Co-committed-by: Tocho Tochev <tocho@tochev.net> 2024-06-01 12:29:46 +03:00			`## Installation`

			`### For local development`
Add a simple README file 2014-07-28 13:23:14 +03:00
Use ruby 3.3.5 in all places 2024-09-22 22:44:30 +03:00			1. `git clone https://git.openfest.org/Site/clarion/`
			2. Run `rvm install "ruby-$(cat .ruby-version)"; rvm install "ruby-$(cat .ruby-version)"`
			`3. Start up postgresql`
			4. Run `bundle install; bin/rake bootstrap`
			5. You can now run the rails server with `bin/rails s`
Add docker-compose (#47) This is a docker-compose based on production config, without mounting of the local folders, which I admit is a strange setup, but this was the simplest for me to get the local development going. I'm perfectly ok with not merging this PR. Reviewed-on: https://git.openfest.org/Site/clarion/pulls/47 Co-authored-by: Tocho Tochev <tocho@tochev.net> Co-committed-by: Tocho Tochev <tocho@tochev.net> 2024-06-01 12:29:46 +03:00
			`### For production`

			`docker build -t clarion:latest -f Dockerfile .`

			Note that the docker image contains a default user (for credentials see `db/seeds.rb`).

			`### docker-compose`

			`docker-compose up` will bring everything up on `http://127.0.0.1:3000` with production configuration.

			`## Initial Usage`

			1. Go to `http://127.0.0.1:3000/management/`
			2. Login (for initial creds see `db/seeds.rb`)
			`3. Change the credentials`
Use ruby 3.3.5 in all places 2024-09-22 22:44:30 +03:00			`4. Create a conference.`
Add docker-compose (#47) This is a docker-compose based on production config, without mounting of the local folders, which I admit is a strange setup, but this was the simplest for me to get the local development going. I'm perfectly ok with not merging this PR. Reviewed-on: https://git.openfest.org/Site/clarion/pulls/47 Co-authored-by: Tocho Tochev <tocho@tochev.net> Co-committed-by: Tocho Tochev <tocho@tochev.net> 2024-06-01 12:29:46 +03:00			- NB: When creating a conference make sure to use the same `domain` as the one you are currently using, otherwise nothing will be shown.