PM-Lille

A small planning manager

About The Project

A small application used by the Lille's local police (but it could be used by anybody with a bit of rewording)

Features

• Team & ranks management
• Login-less access for agents (using a private magic-link)
• Logged access for managers
• Recurring absences
• Chat & room system (with e-mail notifications and broadcast tools)
• Global dashboard (latest messages, most occuring absences)

(back to top)

Built With

• Ruby on Rails
• AdminLTE
• Chart.js

(back to top)

Getting Started

Prerequisites

Ruby, node and yarn should be installed.

This project was built using ASDF.

If you're also using ASDF, make sure all the required plugins are also installed and run asdf install You might also check .tool-versions if you're using another version manager.

Installation

1. Clone the repository
2. Create and fill .env with

DATABASE_USERNAME=
DATABASE_PASSWORD=
DATABASE_HOST=
DEFAULT_ROOM_ID=1

3. Run bin/rails setup and yarn install
4. Run bin/rails db:seed
5. You should be able to run the app using Foreman foreman start -f Procfile.dev
6. a. The first user must be manually created through bin/rails console using

User.create!(
  email: "fillme@example.com",
  password: "my_secret_password",
  password_confirmation: "my_secret_password",
  rank: :superadmin
)

6. b. Users can also be registered using the signup form, but the account must then be manually activated through the interface by an admin or superadmin.

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

Credits

• The template used for this README was created by @othneildrew