Compare commits
2 Commits
Author | SHA1 | Date | |
---|---|---|---|
63ac89e952 | |||
8896f00124 |
@ -20,7 +20,7 @@ SimpleLogin backend consists of 2 main components:
|
||||
## Install dependencies
|
||||
|
||||
The project requires:
|
||||
- Python 3.10 and [rye](https://github.com/astral-sh/rye) to manage dependencies
|
||||
- Python 3.10 and poetry to manage dependencies
|
||||
- Node v10 for front-end.
|
||||
- Postgres 13+
|
||||
|
||||
@ -28,7 +28,7 @@ First, install all dependencies by running the following command.
|
||||
Feel free to use `virtualenv` or similar tools to isolate development environment.
|
||||
|
||||
```bash
|
||||
rye sync
|
||||
poetry sync
|
||||
```
|
||||
|
||||
On Mac, sometimes you might need to install some other packages via `brew`:
|
||||
@ -55,7 +55,7 @@ brew install -s re2 pybind11
|
||||
We use pre-commit to run all our linting and static analysis checks. Please run
|
||||
|
||||
```bash
|
||||
rye run pre-commit install
|
||||
poetry run pre-commit install
|
||||
```
|
||||
|
||||
To install it in your development environment.
|
||||
@ -160,25 +160,25 @@ Here are the small sum-ups of the directory structures and their roles:
|
||||
The code is formatted using [ruff](https://github.com/astral-sh/ruff), to format the code, simply run
|
||||
|
||||
```
|
||||
rye run ruff format .
|
||||
poetry run ruff format .
|
||||
```
|
||||
|
||||
The code is also checked with `flake8`, make sure to run `flake8` before creating the pull request by
|
||||
|
||||
```bash
|
||||
rye run flake8
|
||||
poetry run flake8
|
||||
```
|
||||
|
||||
For HTML templates, we use `djlint`. Before creating a pull request, please run
|
||||
|
||||
```bash
|
||||
rye run djlint --check templates
|
||||
poetry run djlint --check templates
|
||||
```
|
||||
|
||||
If some files aren't properly formatted, you can format all files with
|
||||
|
||||
```bash
|
||||
rye run djlint --reformat .
|
||||
poetry run djlint --reformat .
|
||||
```
|
||||
|
||||
## Test sending email
|
||||
@ -226,3 +226,26 @@ Some features require a job handler (such as GDPR data export). To test such fea
|
||||
```bash
|
||||
python job_runner.py
|
||||
```
|
||||
|
||||
# Setup for Mac
|
||||
|
||||
There are several ways to setup Python and manage the project dependencies on Mac. For info we have successfully used this setup on a Mac silicon:
|
||||
|
||||
```bash
|
||||
# we haven't managed to make python 3.12 work
|
||||
brew install python3.10
|
||||
|
||||
# make sure to update the PATH so python, pip point to Python3
|
||||
# for us it can be done by adding "export PATH=/opt/homebrew/opt/python@3.10/libexec/bin:$PATH" to .zprofile
|
||||
|
||||
# Although pipx is the recommended way to install poetry,
|
||||
# install pipx via brew will automatically install python 3.12
|
||||
# and poetry will then use python 3.12
|
||||
# so we recommend using poetry this way instead
|
||||
curl -sSL https://install.python-poetry.org | python3 -
|
||||
|
||||
poetry install
|
||||
|
||||
# activate the virtualenv and you should be good to go!
|
||||
source .venv/bin/activate
|
||||
```
|
@ -16,12 +16,13 @@ class CannotSetMailbox(Exception):
|
||||
|
||||
|
||||
def set_default_alias_domain(user: User, domain_name: Optional[str]):
|
||||
if domain_name is None:
|
||||
if not domain_name:
|
||||
LOG.i(f"User {user} has set no domain as default domain")
|
||||
user.default_alias_public_domain_id = None
|
||||
user.default_alias_custom_domain_id = None
|
||||
Session.flush()
|
||||
return
|
||||
|
||||
sl_domain: SLDomain = SLDomain.get_by(domain=domain_name)
|
||||
if sl_domain:
|
||||
if sl_domain.hidden:
|
||||
|
@ -18,7 +18,7 @@
|
||||
<br />
|
||||
For generic questions, i.e. not related to your account, we recommend to post the question on
|
||||
our
|
||||
<a href="https://www.reddit.com/r/Simplelogin/">Reddit</a> or <a href="https://forum.simplelogin.io/">our official forum</a>
|
||||
<a href="https://www.reddit.com/r/Simplelogin/">Reddit</a> or <a href="https://github.com/simple-login/app/discussions">forum</a>
|
||||
where our community can help answer the question
|
||||
and other people with the same question can find the answer there.
|
||||
</div>
|
||||
|
@ -43,8 +43,7 @@ Note, if you are a paying Proton Mail user, you automatically receive the premiu
|
||||
{% endcall %}
|
||||
|
||||
{% call text() %}
|
||||
For any question or feedback, please join our <a href="https://forum.simplelogin.io/">official forum</a>.
|
||||
If you want to request a feature, please submit it on our <a href="https://github.com/simple-login/app/discussions">GitHub repo</a>.
|
||||
For any question or if you want to request a feature, please submit it on our <a href="https://github.com/simple-login/app/discussions">forum</a>.
|
||||
You can also join our
|
||||
<a href="https://www.reddit.com/r/Simplelogin/">Reddit</a>
|
||||
or follow our
|
||||
|
@ -27,8 +27,7 @@ Firefox: https://addons.mozilla.org/firefox/addon/simplelogin/
|
||||
Edge: https://microsoftedge.microsoft.com/addons/detail/simpleloginreceive-sen/diacfpipniklenphgljfkmhinphjlfff
|
||||
Android: https://play.google.com/store/apps/details?id=io.simplelogin.android
|
||||
iOS: https://apps.apple.com/app/id1494359858
|
||||
Github repo: https://github.com/simple-login/app/discussions
|
||||
Official forum: https://forum.simplelogin.io/
|
||||
Forum: https://github.com/simple-login/app/discussions
|
||||
Reddit: https://www.reddit.com/r/Simplelogin/
|
||||
Twitter: https://twitter.com/simple_login
|
||||
|
||||
|
@ -71,10 +71,8 @@ Please note that you can't create more than {{ MAX_NB_EMAIL_FREE_PLAN }} aliases
|
||||
|
||||
{% endif %}
|
||||
{% call text() %}
|
||||
For any question or feedback,
|
||||
please join our <a href="https://forum.simplelogin.io/">official forum</a>.
|
||||
If you want to request a feature,
|
||||
please submit it on our <a href="https://github.com/simple-login/app/discussions">GitHub repo</a>.
|
||||
For any question or if you want to request a feature,
|
||||
please submit it on our <a href="https://github.com/simple-login/app/discussions">forum</a>.
|
||||
You can also join our
|
||||
<a href="https://www.reddit.com/r/Simplelogin/">Reddit</a>
|
||||
or follow our
|
||||
|
@ -26,8 +26,6 @@ No worries: all aliases you create during this period will continue to work norm
|
||||
|
||||
At any time, you can reach out to us by simply replying to this email.
|
||||
|
||||
For any question or feedback, please join our official forum at https://forum.simplelogin.io/
|
||||
|
||||
If you want to request a feature, please submit it on our GitHub repo at https://github.com/simple-login/app/discussions
|
||||
For any question or if you want to request a feature, please submit it on our forum at https://github.com/simple-login/app/discussions
|
||||
|
||||
You can also join our Reddit at https://www.reddit.com/r/Simplelogin/ follow our Twitter at https://twitter.com/simplelogin
|
||||
|
@ -93,7 +93,7 @@
|
||||
</li>
|
||||
<li>
|
||||
<a class="list-group-item text-white footer-item "
|
||||
href="https://forum.simplelogin.io">Forum</a>
|
||||
href="https://github.com/simple-login/app/discussions">Forum</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
@ -91,7 +91,7 @@
|
||||
</a>
|
||||
</div>
|
||||
<div class="dropdown-item">
|
||||
<a href="https://forum.simplelogin.io"
|
||||
<a href="https://github.com/simple-login/app/discussions"
|
||||
target="_blank"
|
||||
rel="noopener noreferrer">
|
||||
Forum
|
||||
|
@ -107,7 +107,7 @@
|
||||
</a>
|
||||
</div>
|
||||
<div class="dropdown-item">
|
||||
<a href="https://forum.simplelogin.io/"
|
||||
<a href="https://github.com/simple-login/app/discussions"
|
||||
target="_blank"
|
||||
rel="noopener noreferrer">
|
||||
Forum
|
||||
|
Reference in New Issue
Block a user