respectedfx
Respected FX Bureau De Change is a Foreign Exchange company headquartered in Lagos, Nigeria. We are Dun and Bradstreet Certified and are poised to deliver smooth, fast and seamless Foreign Exchange transactions between businesses and individuals within and outside Nigeria. Through us, businesses and individuals can place orders and broker foreign currency transactions in a manner that has never been experienced before. Our trades span across various global currencies which includes, US Dollar, UK Pounds Sterling and the Euro.
License: MIT
Settings
Moved to settings.
Basic Commands
Setting Up Your Users
-
To create a normal user account, just go to Sign Up and fill out the form. Once you submit it, you'll see a "Verify Your E-mail Address" page. Go to your console to see a simulated email verification message. Copy the link into your browser. Now the user's email should be verified and ready to go.
-
To create a superuser account, use this command:
$ python manage.py createsuperuser
For convenience, you can keep your normal user logged in on Chrome and your superuser logged in on Firefox (or similar), so that you can see how the site behaves for both kinds of users.
Type checks
Running type checks with mypy:
$ mypy respectedfx
Test coverage
To run the tests, check your test coverage, and generate an HTML coverage report:
$ coverage run -m pytest
$ coverage html
$ open htmlcov/index.html
Running tests with pytest
$ pytest
Live reloading and Sass CSS compilation
Moved to Live reloading and SASS compilation.
Celery
This app comes with Celery.
To run a celery worker:
cd respectedfx
celery -A config.celery_app worker -l info
Please note: For Celery's import magic to work, it is important where the celery commands are run. If you are in the same folder with manage.py, you should be right.
To run periodic tasks, you'll need to start the celery beat scheduler service. You can start it as a standalone process:
cd respectedfx
celery -A config.celery_app beat
or you can embed the beat service inside a worker with the -B
option (not recommended for production use):
cd respectedfx
celery -A config.celery_app worker -B -l info
Email Server
In development, it is often nice to be able to see emails that are being sent from your application. If you choose to use Mailpit when generating the project a local SMTP server with a web interface will be available.
-
Download the latest Mailpit release for your OS.
-
Copy the binary file to the project root.
-
Make it executable:
$ chmod +x mailpit
-
Spin up another terminal window and start it there:
./mailpit
-
Check out http://127.0.0.1:8025/ to see how it goes.
Now you have your own mail server running locally, ready to receive whatever you send it.
Deployment
The following details how to deploy this application.
Heroku
See detailed cookiecutter-django Heroku documentation.
Custom Bootstrap Compilation
The generated CSS is set up with automatic Bootstrap recompilation with variables of your choice.
Bootstrap v5 is installed using npm and customised by tweaking your variables in static/sass/custom_bootstrap_vars
.
You can find a list of available variables in the bootstrap source, or get explanations on them in the Bootstrap docs.
Bootstrap's javascript as well as its dependencies are concatenated into a single file: static/js/vendors.js
.