VellXR is a global forum for technology enthusiasts where they can write articles and collaborate with others.
This is the source code of the entire website/web app along with Sendgrid E-mail and Cloudinary CDN configurations.
This is required to setup the dependencies for the app to start.
Inside the project directory -
virtualenv env
.\env\Scripts\activate
- For Windows userssource env/bin/activate
- For Linux/MacOS users
pip install -r requirements.txt
The settings defined in the vellxr/settings.py
is configured for production only environments. To use locally -
- Create a file named
local_settings.py
inside thevellxr/
directory. - put the following contents in it -
-
DEBUG = True SECURE_SSL_REDIRECT = False SECURE_PROXY_SSL_HEADER = None
-
Inside the same directory -
python manage.py makemigrations
python manage.py migrate
python manage.py collectstatic
python manage.py runserver 80
This will start the server locally. Visit http://localhost:80 or http://127.0.0.1:80 to explore the app.
This feature will help in error reporting while the app is in production.
This is not necessary for the app to run properly. If you don't want to use this feature, simply comment out the code lines 42
to 53
in settings.py
.
ADMIN_FULL_NAME
- full name on Sendgrid consoleADMIN_EMAIL_ID
- E-mail ID used to signup on SendgridSENDGRID_API_KEY
- Sendgrid API keyMAILER_LIST
- list of users to send e-mailDEFAULT_FROM_EMAIL
- E-mail ID used to signup on SendgridEMAIL_HOST_USER
- Username on Sendgrid consoleEMAIL_HOST_PASSWORD
- Password of Sendgrid account
This is a necessary configuration as media files are no longer handled by Django. But still, if you want to continue with Django, Comment the lines 15
to 20
in models.py
and follow this.
CLOUDINARY_CLOUD_NAME
- Cloud name in Cloudinary consoleCLOUDINARY_API_KEY
- Cloudinary API keyCLOUDINARY_API_SECRET
- Cloudinary API secret
- Feel freely to open issues ๐.
- The configuration for Heroku is still left to be added in the documentation. Contributing to this will be helpful.