miguel456
/
rbrecruiter
1
0
Fork 1
Code Issues Pull Requests 1 Projects Releases 2 Wiki Activity

Update outdated information

This commit is contained in:
Miguel Nogueira 2020-07-09 08:53:56 +01:00
parent c3a6b16a13
commit 635f8593d3
1 changed files with 16 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

56
README.md
View File

@ -24,11 +24,11 @@ Wish you had a better application managemet strategy? Well, then Raspberry Teams
- Controllable permissions - Every user has permissions! Control who has access to what (You can skip the application process and add staff members directly here). - Controllable permissions - Every user has permissions! Control who has access to what (You can skip the application process and add staff members directly here).
- Ban system - Having trouble with pesky spammers? Ban them! This will publicly shame their profile and keep them from signing up or logging in. - Ban system - Having trouble with pesky spammers? Ban them! This will publicly shame their profile and keep them from signing up or logging in.
- Notifications: Notifies slack and email primarily - Notifications: Notifies slack and email primarily
And many more features! And many more features!
# Roadmap # Roadmap
Many other features are currently planned for this app, such as: Many other features are currently planned for this app, such as:
- Discord role management (approved applicants) - Discord role management (approved applicants)
- Luckperms/PEX integration - For now, you'll have to promote users manually in-game - Luckperms/PEX integration - For now, you'll have to promote users manually in-game
@ -36,8 +36,8 @@ Many other features are currently planned for this app, such as:
- Customisable front page (**priority**) - Customisable front page (**priority**)
- Auto provisioning - Sign up on a website and get your instance of Raspberry Teams up and running in no time - Auto provisioning - Sign up on a website and get your instance of Raspberry Teams up and running in no time
- Suggestions accepted! - Suggestions accepted!
# Technical overview # Technical overview
Tech stack: Tech stack:
@ -46,53 +46,29 @@ Tech stack:
- AdminLTE / Bootstrap 4 - AdminLTE / Bootstrap 4
- jQuery / Plain Javascript - jQuery / Plain Javascript
- vueJS (in the future) - vueJS (in the future)
# Operating System Requirements # Operating System Requirements
Currently, this application is only supported on Linux environments (Ubuntu 20.04 or derivatives are recommended). Currently, this application is only supported on Linux environments (Ubuntu 20.04 or derivatives are recommended).
# Software Requirements # Software Requirements
- ``composer`` (min version: 1.8.4) - ``composer`` (min version: 1.8.4)
- ``npm`` (tested w/ v 5.8.0) - ``npm`` (tested w/ v 5.8.0)
- ``php`` (required PHP 7 or newer - lower versions unsupported!) - ``php`` (required PHP 7 or newer - lower versions unsupported!)
# PHP Extension Requirements # PHP Extension Requirements
- JSON - JSON
- Curl (highly recommended) - Curl (highly recommended)
# Installation # Installation
Make sure all prerequisites are installed. Afterwards, clone this repository, make ``install.sh``executable and run it. Make sure all prerequisites are installed. Afterwards, clone this repository, make ``install.sh``executable and run it.
Note that this script will change the database credentials to Vagrant's defaults, so if you're not using Vagrant, make sure to edit the ``.env`` file with your database settings.
# Configuration # Configuration
Configuration is currently done via the installer. Alternatively, you may also edit the ``.env`` file directly.
This app requires other configuration parameters: This process will be moved to the browser later.
- Google Recaptcha - [create captcha key pair](https://www.google.com/recaptcha/admin/create)
- IP Geolocation API Key - [get your key here](https://ipgeolocation.io/signup.html)
- SMTP Server and Email account (for email notifications)
- Slack integration webhook URL (create an application in Slack Dev Center - Check webhook docs)
These configuration settings are fairly self explanatory, but here's a list of what you need to fill on the ``.env`` file:
``RECAPTCHA_SITE_KEY``
``RECAPTCHA_PRIVATE_KEY``
``IPGEO_API_KEY``
``MAIL_PORT``
``MAIL_HOST``
``MAIL_USERNAME``
``MAIL_PASSWORD``
And the database settings, located at the top.
This process will be later streamlined with a web installer.
# Bug reports # Bug reports