From 48cf437a9395c0490c0f9af725801ee42f48b604 Mon Sep 17 00:00:00 2001 From: Tom Naessens Date: Sun, 19 May 2024 12:12:26 +0200 Subject: [PATCH] Refresh README.md --- README.md | 22 +++++++++------------- 1 file changed, 9 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 7340fb4d..c202d053 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# [Gandalf](https://event.student.ugent.be) [![Analytics](https://ga-beacon.appspot.com/UA-25444917-6/ZeusWPI/Gandalf/README.md?pixel)](https://github.com/igrigorik/ga-beacon) [![Code Climate](https://codeclimate.com/github/ZeusWPI/Gandalf/badges/gpa.svg)](https://codeclimate.com/github/ZeusWPI/Gandalf) [![Coverage Status](https://coveralls.io/repos/ZeusWPI/Gandalf/badge.svg?branch=master&service=github)](https://coveralls.io/github/ZeusWPI/Gandalf?branch=master) [![Build Status](https://travis-ci.org/ZeusWPI/Gandalf.png?branch=master)](https://travis-ci.org/ZeusWPI/Gandalf) +# [Gandalf](https://event.student.ugent.be) [![Code Climate](https://codeclimate.com/github/ZeusWPI/Gandalf/badges/gpa.svg)](https://codeclimate.com/github/ZeusWPI/Gandalf) [![Coverage Status](https://coveralls.io/repos/ZeusWPI/Gandalf/badge.svg?branch=master&service=github)](https://coveralls.io/github/ZeusWPI/Gandalf?branch=master) ![You. Shall. Not. Pass.](http://media.giphy.com/media/njYrp176NQsHS/giphy.gif) @@ -7,18 +7,20 @@ In short, Gandalf is a project that does everything that makes organising and ma # Getting started -If you have NixOS or Nix installed, you can use the `flake.nix` to avoid the hassle of installing the right dependencies. Scroll down for more info. +## Common setup -0. Install the prerequisites: ruby 3.3.1, preferably using [asdf](https://asdf-vm.com/), and some system libraries depending on your OS (e.g. imagemagick) -1. Install the ruby dependencies: `bin/bundle` -2. Start up the database, sidekiq and rails server by running `bin/dev` -3. Set up some database data using `rails db:setup` -4. Browse to http://localhost:3000 +1. Install the prerequisites: ruby 3.3.1, preferably using [asdf](https://asdf-vm.com/), and some system libraries depending on your OS (e.g. imagemagick) +2. Install the ruby dependencies: `bin/bundle` +3. Start up the database, sidekiq and rails server by running `bin/dev` +4. Set up some database data using `rails db:setup` +5. Browse to http://localhost:3000 In case you want to start the webserver in your IDE, just run `docker-compose up -d` and start Sidekiq manually (`bundle exec sidekiq`) ## Development using Nix +If you have NixOS or Nix installed, you can use the `flake.nix` to avoid the hassle of installing the right dependencies. + - Make sure you have [Nix](https://nixos.org/download.html#download-nix) installed. - Run `nix develop` - Done! You have everything installed. You can now: @@ -50,9 +52,3 @@ openssl x509 -req -sha256 -days 365 -in server.csr -signkey server.key -out serv rails s -b 'ssl://localhost:8080?key=server.key&cert=server.crt' ``` - -# Contributors (in order of contribution) -1. Felix Van der Jeugt -2. Toon Willems -3. Tom Naessens -4. Maarten Herthoge