Table of Contents
The story of this project begins in Arab Digital Expression Foundation when we needed to make our friends from non-profit organizations and civil associations life easier with mangaging there own spaces and renting thier tools. We needed to find a online solution for spaces and tools reservations.
We've quickly evaluated a couple of existing solutions, but they were either too big and complicated and/or too expensive. As We assumed that other people would have the same challenge We had, We decided to spend our after-hours time making an open-source tailored platform for the need and it is for free use.
What our platform can do:
- It allows people to reserve, de-reserve spaces and tools in your organization.
- It allows people to pay online by virtual wallet for their own reservations.
- Platform can deployed online or on a dedicated internal server inside your organization.
- Administrators has a visually statistics for reservations.
Of course, no platform will serve all organizations needs since your needs may be different. So I'll be adding more soon. You may also suggest changes by forking this repo and creating a pull request or opening an issue. Thanks in advance to all the people who will contribute to expanding this platform!
The next steps are for running Space Reservation System on a local or remote server.
So please take steps forward in order for doing it in the right way.
You should:
- Know how to deal with Linux environment.
- Programmed with python before and flask.
- Used database management system before ex: (MySQL)
-
In this project, we used MySQL in our development process but you can use other database management systems that SQLAlchemy supporting it.
You can install your database service depending on your operating system. In this process, I used ubuntu Linux OS.
$ sudo apt update
$ sudo apt install mysql-server libmysqlclient21
$ sudo systemctl start mysql.service
$ mysql_secure_installation
after installation use, this commands to create a new database for this application
mysql -u root -p
mysql> CREATE DATABASE 'database_name' CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
mysql> CREATE USER 'username'@'host' IDENTIFIED BY 'password';
mysql> GRANT PRIVILEGE ON 'database_name'.* TO 'username'@'host';
mysql> FLUSH PRIVILEGES;
-
Clone the repo
git clone https://github.com/arabdigitalexpression/Mestek.git
-
Install dependencies
$ sudo apt-get install python3 python3-dev python3-pip
$ sudo pip3 install virtualenv
$ cd Mestek$ virtualenv -p python3 myenv
$ source venv/bin/activate$ pip3 install -r requirements.txt
- Create environment variables (see example .env file):
$ vi .env
$ flask db upgrade
$ flask run
After the installation process, you can run the application on your browser and start creating new space and tools.
And when you are finished anyone is ready to reserve and space or tool that they want.
See the open issues for a full list of proposed features (and known issues).
Contributions are what makes 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 GNU General Public License v3.0
License. See LICENSE.txt for more information.
Arab Digital Expression Foundation - Visit website
Project Link: https://github.com/arabdigitalexpression/Mestek