README.md

djangoReact Template

This is the most convenient starter template of Django+React code with following features -

• Django serving React
• Contains all the dependencies required to create django-rest-api.
• Contains pre-commit for optimized and clean code.
• Secure application with production grade env system.

A perfect template for you to focus on starting your hack project or your deployed project. Leave all the gibberish of setup and just focus on innovating and creating amazing tech ❤️

Installation and Setup

Prerequisites

• You should have NodeJS installed (12.x or above)
• pipenv should be installed in the system. It can be done using sudo pip3 install pipenv.
• Change the version of the python in Pipfile according to the python version available in your system

Setup and running of project (Frontend + Backend)

• Fork the repo and clone it.
• Navigate to the cloned repo.
• Activate env using pipenv shell and install dependencies by pipenv install
• Install all react dependencies by running yarn install
• Run build_local.sh. (Make sure it's in executable mode by sudo chmod +x build_local.sh)
• Start the backend server python ./manage.py runserver

This runs the backend server at default port 8000. Open http://localhost:8000 to view it in the browser.

Setup and running of project (Only Frontend)

• At your root directory run yarn install to install all the dependencies
• To start react dev server yarn start

This runs the app in the development mode. Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.

Production grade deployment

This project tried to follow the best practices and you can directly deploy the repo with the following points -

• Create an .env in your deployment environment(refer .env.example file for the same).
  • For django SECRET_KEY you can generate one from here
  • Set DEBUG = 'False' when using in production/live deployment.
• Add the hostname/url(the one on which your deployed server is working) in the settings.py file (under allowed hosts array)
• Add your suitable TIME_ZONE and LANGUAGE_CODE in settings.py according to your zone and locale.

Note [Important]

• The manage.py file is moved out of the default django project. So everytime you run manage.py startapp app, it will create the required app in the root of the project. So you will have to move it in the backend folder and while registering the app in settings.py, you will have to mention backend.app.
• The config folder in the backend directory is the actual root project of the django project (one which has django settings and main app urls).
• There is a folder named demo in the backend folder. That's a demo api folder for reference.
• This project has pre-commit. So if you are using this project on which a lot of people are contributing, make sure you run pre-commit install in the project repo so that git hooks are enabled.
• Stuff you can delete (I added them just to refer)
  • index.js and related files in ./src/ and app.js and related files in ./src/components/
  • demo folder from ./backend/

Contribution to the project

Git workflow

Please follow a systematic Git Workflow -

• Create a fork of this repo.
• Clone your fork of your repo on your pc.
• Add Upstream to your clone
• Every change that you do, it has to be on a branch. Commits on master would directly be closed.
• Make sure that before you create a new branch for new changes,syncing with upstream is neccesary.

Commits

• Write clear meaningful git commit messages (Do read this).
• Make sure your PR's description contains GitHub's special keyword references that automatically close the related issue when the PR is merged. (Check this for more info)
• When you make very very minor changes to a PR of yours (like for example fixing a failing Travis build or some small style corrections or minor changes requested by reviewers) make sure you squash your commits afterward so that you don't have an absurd number of commits for a very small fix. (Learn how to squash at here)
• When you're submitting a PR for a UI-related issue, it would be really awesome if you add a screenshot of your change or a link to a deployment where it can be tested out along with your PR. It makes it very easy for the reviewers and you'll also get reviews quicker.

Todo

• Create a pip package (current focus)
• Create a CI/CD branch to automate testing (if any)
• Create a GCP Deployment (both engine and VM) branch
• Create a Azure deployment branch
• Create a AWS deployment branch

Thank you!

If you find this project useful, please Leave a star on this repo! Also, if you can , buy me coffee! ❤️