Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/2004seraph/projman

Mirror of a group project in which we developed an internal system for the Univeristy of Sheffield. Projman helps module administrators orchestrate, manage, and assess student group assignments. Credits can be found in the README.md
https://github.com/2004seraph/projman

2024 rails-application university-of-sheffield university-project

Last synced: about 11 hours ago
JSON representation

Host: GitHub
URL: https://github.com/2004seraph/projman
Owner: 2004seraph
Created: 2024-07-16T15:40:48.000Z (2 months ago)
Default Branch: master
Last Pushed: 2024-09-21T02:01:26.000Z (4 days ago)
Last Synced: 2024-09-22T23:30:18.369Z (2 days ago)
Topics: 2024, rails-application, university-of-sheffield, university-project
Language: Ruby
Homepage: https://www.sheffield.ac.uk/cs/undergraduate/course-structure
Size: 1.67 MB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 3
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# Projman

A group project orchestrator and management system, developed for the University of Sheffield as part of Software Hut \[COM3420\].

## Usage

This system requires:

- Ubuntu 22.04 LTS
- PostgreSQL
- `ruby-3.1.2` installed via `rvm`
- Rails 7

Account sign-ins will only work if both the server and client are connected to the University of Sheffield's VPN. Though this can be circumvented by creating a fake account with the rails console, as described in the section below.

### To run the app locally

#### Setup

- Have PostgreSQL running:
`sudo service postgresql start`

- Set up the app, this will install all dependancies, and create and seed the database:
`./INSTALL.sh`

#### Adding your account

Our system uses the UoS SSO, your Muse login, but you must already exist in the database to sign in. You can now add yourself as either a member of staff or a student with the rails console.

You may add yourself as both a student and a member of staff, but you will simply be treated as a member of staff.

```bash
# from within the repositiory root
rails c
```
From within the rails console:
```ruby
# even if you're a student, adding your email to the staff table will allow you to log in as a staff member with your muse credentials
DatabaseHelper.create_staff("[email protected]")

# keep in mind your username and email must be unique to be added to the database
DatabaseHelper.create_student({
username: "YourMuseUsername",
forename: "YourName",
surname: "YourSurname",
title: "Ms",
email: "[email protected]"
})
```

After adding yourself to the database, you're ready to test the app.

#### Starting the app

- Run the app:
`RAILS_ENV=development ./BOOT.sh`

- Visit [http://127.0.0.1:3000](http://127.0.0.1:3000)

### To deploy the app to production

We use Capistrano for our deployments, and interact with the production server via EpiGenesys' `epi_deploy` gem. To deploy the app:

- Ensure there are no changes to commit, that the working tree is clean. If so, use `git restore .` to undo all of them, or commit them.
- Run `./DEPLOY.sh`

## Testing

A bug appeared in our tests close to the project deadline, to correctly test our application you need to run one rspec file at a time. This is because when ran together with `rspec`, they intefere with each other, so they need to be ran in isolation.

` rspec ./spec/path_to_test`

## Maintainers

- Adam Willis
- Jakub Bala
- Joshua Henson
- Sam Taseff
- Oliver Pickford

Sam Taseff contributed several bulk styling commits, which makes the `git blame` output inconsistent with everyone's actual contributions. The hashes of these bulk styling commits can be found in the `.git-blame-ignore-revs` file in our repository root. This file can be passed to git blame to correct its output.

All rights are reserved by the maintainers listed above, this package has no warranty.