Skip to content
itsMett edited this page May 21, 2020 · 2 revisions

ToooMail logo

A little story

ToooMail (too many mail) is a desktop application with the aim of creating an open source platform to manipulate your mailboxes. This project is suitable for everyone because thanks to the intuitive interface, even those who have been used to using other clients for years will find a good product. Currently the project is not available for a stable release and we are developing a lot during both the backend part (written in Python) and the frontend part (with the famous VueJS framework).

Being friendly

If you are a developer who finds this project interesting or if you simply want to help us by reporting bugs or improvements then the following guide is for you.

How to run the base version of the application

First of all you need to clone or download this repository. Please note that the active branch is dev so clone this one for testing. You will then need the following things to be able to start everything correctly in development mode:

Python > 3.5.x PIP3 nodejs yarn

Personally I use PyCharm because it hase a lighter venv management, in any case now you will have to install all the necessary packages. Open a console, enter in your venv (if you prefer) and run the following command:

pip3 install -r requirements.txt cd ui/ yarn i

Nice, now you have installed all required packages and you should be able to start the application. Open a new console and go inside the UI folder.

Warning! If this is the first time that you carry out the procedure, the registration page to enter your email information will open automatically and you will not have to use yarn.

Now, in the console you used to install the packages you need to start the python server using

python3 app.py

In the new console (the one you used to enter UI) run this command: yarn run serve

Congratulations!

Clone this wiki locally