Capable and Accessible Laundry Manager (CALM) is a web application for the management of laundry facilities in rental buildings. It offers features such as monetary management, hourly planning, and reservation management.
Explore the docs »
View Demo
Washing machine icons created by Konkapp - Flaticon
Table of Contents
To get a local copy up and running follow these simple example steps.
If you want to use Docker, install Docker. If you are not using Docker, download a software like Xampp, Wampp, ...
En SSH
git clone [email protected]:HE-Arc/calm.gitEn HTTP
git clone https://github.com/HE-Arc/calm.gitIf you are working with Docker, skip to the Docker section
In a terminal in the project's current folder
docker compose up -dOnce the images have been built, the containers will launch automatically. The application is available at http://localhost:8000.
⚠️ AttentionIt is necessary to run the command
npm installthe first time you get the project to install all dependencies. Also, you need to run this command when new packages are added.
If you are working on a local machine with Xampp, for example, start the apache and mysql services.
To enter the following commands, you need to be in the ~/calm/calm-server/ directory.
Install dependencies and set up the Laravel project.
Before all these operations, you need to copy the .env.example, rename it to .env and place it in the root of the
~\calm-webserver\. You'll need to adapt it to your database configurations.
composer installphp artisan key:generatephp artisan migratephp artisan db:seedℹ️ Important
It is necessary to start the Laravel server and the Vite server during development.
From the subfolder ~\calm\calm-webserver\, in a terminal, enter the following commands:
php artisan servenpm run devThe application is available at http://localhost:8000.
To test the functionality of the application, you can log in as a test user from the login form with the following credentials:
Username
Password
passwordSee the RoadMap
See the open issues for a full list of proposed features (and known issues).
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!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Distributed under the MIT License. See LICENSE for more information.
- Nima Dekhli - github@ylked - [email protected]
- Lucas Gosteli - github@lugopi - [email protected]
- Miranda Fleury - github@ClawdeenFleury - [email protected]