Giter VIP home page Giter VIP logo

vellxr's Introduction

VellXR

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.

VirtualENV Setup

This is required to setup the dependencies for the app to start.
Inside the project directory -

  • virtualenv env
    • .\env\Scripts\activate - For Windows users
    • source env/bin/activate - For Linux/MacOS users
  • pip install -r requirements.txt

Setup local settings

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 the vellxr/ directory.
  • put the following contents in it -
    • DEBUG = True
      SECURE_SSL_REDIRECT = False
      SECURE_PROXY_SSL_HEADER = None

Initialize the app

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.

Sendgrid E-mail Configuration

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 console
  • ADMIN_EMAIL_ID - E-mail ID used to signup on Sendgrid
  • SENDGRID_API_KEY - Sendgrid API key
  • MAILER_LIST - list of users to send e-mail
  • DEFAULT_FROM_EMAIL - E-mail ID used to signup on Sendgrid
  • EMAIL_HOST_USER - Username on Sendgrid console
  • EMAIL_HOST_PASSWORD - Password of Sendgrid account

Cloudinary CDN Configuration

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 console
  • CLOUDINARY_API_KEY - Cloudinary API key
  • CLOUDINARY_API_SECRET - Cloudinary API secret

NOTE

  • Feel freely to open issues ๐Ÿ˜„.
  • The configuration for Heroku is still left to be added in the documentation. Contributing to this will be helpful.

vellxr's People

Contributors

fireping32 avatar dependabot[bot] avatar

Stargazers

David Anyatonwu avatar Camilo Caquimbo Tabares avatar  avatar  avatar Victor Peace Ogbonna avatar PEP 8 Speaks avatar

Watchers

 avatar  avatar Victor Peace Ogbonna avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.