21 | If you are seeing the green Django logo on a white background and this text color is
22 | #092e20, frontend static files serving is working
23 |
24 |
25 | 
30 |
31 |
26 | Below this text, you should see an img tag with the white Django logo on a green
27 | background
28 |
29 | {restCheck.result}
32 |
35 | {showBugComponent && showBugComponent.field.notexist}
36 |
37 | );
38 | };
39 |
40 | export default Home;
41 |
--------------------------------------------------------------------------------
/CONTRIBUTING.md:
--------------------------------------------------------------------------------
1 | # Contributing
2 |
3 | ## Pull requests
4 |
5 | Read [this checklist](http://pullrequests.devchecklists.com) for a more detailed guide on best practices for opening pull requests.
6 |
7 | ## Testing your changes
8 |
9 | ### Testing `django-admin startproject`
10 |
11 | If you made changes to this boilerplate and want to test them, do as follows:
12 |
13 | - [Make sure you have pre-commit installed](https://github.com/vintasoftware/django-react-boilerplate#pre-commit-hooks)
14 | - Commit your changes
15 | - Run `git archive -o boilerplate.zip HEAD` to create the template zip file
16 | - Run the following:
17 | ```bash
18 | cd .. && django-admin startproject theprojectname --extension py,yml,json --name Procfile,README.md,.env.example,Dockerfile --template=django-react-boilerplate/boilerplate.zip
19 | ```
20 | - A new folder called `theprojectname` will be created and now you can test your changes
21 | - Make sure that the project is still running fine with and without docker
22 |
23 | ### Testing Heroku deployment
24 |
25 | Push your changes to a branch and visit the link below
26 |
27 | https://dashboard.heroku.com/new?template=https://github.com/fill-org-or-user/fill-project-repo-name/tree/fill-branch
28 |
29 | > Make sure to replace all `fill-*`
30 |
31 | ## How to add a "Deploy to Heroku" button
32 |
33 | Read [this](https://devcenter.heroku.com/articles/heroku-button#adding-the-heroku-button).
34 |
35 | P.S. if you want to deploy in a different way, please check the `app.json` file for what needs to be configured.
36 |
37 |
--------------------------------------------------------------------------------
/.pre-commit-config.yaml:
--------------------------------------------------------------------------------
1 | fail_fast: true
2 | repos:
3 | - repo: git://github.com/pre-commit/pre-commit-hooks
4 | rev: v0.9.2
5 | hooks:
6 | - id: check-added-large-files
7 | args: ['--maxkb=500']
8 | - id: check-byte-order-marker
9 | - id: check-case-conflict
10 | - id: check-merge-conflict
11 | - id: check-symlinks
12 | - id: debug-statements
13 | - id: detect-private-key
14 |
15 | - repo: local
16 | hooks:
17 | - id: isort
18 | name: isort-local
19 | entry : isort
20 | language: python
21 | types: [python]
22 | exclude: .+/(settings|migrations)/.+
23 | pass_filenames: true
24 | - id: black
25 | name: black-local
26 | entry: black
27 | language: python
28 | types: [python]
29 | exclude: .+/(settings|migrations)/.+
30 | pass_filenames: true
31 | - id: eslint
32 | name: eslint-local
33 | entry: npm run lint
34 | language: system
35 | types: [javascript]
36 | exclude: >
37 | (?x)^(
38 | .+\.config\.js|
39 | server\.js|
40 | \.eslintrc\.js
41 | )$
42 | pass_filenames: true
43 | - id: missing-migrations
44 | name: missing-migrations-local
45 | entry: python manage.py makemigrations --check --dry-run
46 | language: system
47 | always_run: true
48 | pass_filenames: false
49 | - id: prospector
50 | name: prospector-local
51 | entry: prospector --messages-only
52 | language: python
53 | types: [python]
54 | exclude: .+/(settings|migrations)/.+
55 | pass_filenames: true
56 |
--------------------------------------------------------------------------------
/frontend/js/utils/SentryBoundary.js:
--------------------------------------------------------------------------------
1 | import * as Sentry from '@sentry/browser';
2 | import PropTypes from 'prop-types';
3 | import React, { Component } from 'react';
4 |
5 | const FallbackUI = ({ eventId }) => (
6 | <>
7 | Check if there is an error on your Sentry app
8 | 11 | 12 | ); 13 | 14 | FallbackUI.propTypes = { 15 | eventId: PropTypes.string, 16 | }; 17 | 18 | FallbackUI.defaultProps = { 19 | eventId: '', 20 | }; 21 | 22 | class ExampleBoundary extends Component { 23 | static getDerivedStateFromError() { 24 | return { hasError: true }; 25 | } 26 | 27 | constructor(props) { 28 | super(props); 29 | this.state = { eventId: null }; 30 | } 31 | 32 | componentDidCatch(error, errorInfo) { 33 | Sentry.withScope((scope) => { 34 | scope.setExtras(errorInfo); 35 | const eventId = Sentry.captureException(error); 36 | this.setState({ eventId }); 37 | }); 38 | } 39 | 40 | render() { 41 | const { eventId, hasError } = this.state; 42 | const { children } = this.props; 43 | 44 | // render fallback UI 45 | if (hasError) { 46 | return
30 |
46 | );
47 | }
48 | }
49 |
50 | ColorChanger.defaultProps = {
51 | title: 'React App Loaded!',
52 | };
53 |
54 | ColorChanger.propTypes = {
55 | title: PropTypes.string,
56 | };
57 |
58 | export default ColorChanger;
59 |
--------------------------------------------------------------------------------
/app.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "{{project_name}}",
3 | "description": "{{project_name|title}} Heroku app.",
4 | "env": {
5 | "ALLOWED_HOSTS": {
6 | "description": "Django ALLOWED_HOSTS setting, e.g.: .appname.herokuapp.com"
7 | },
8 | "DISABLE_COLLECTSTATIC": {
9 | "description": "Disables Heroku collectstatic",
10 | "value": "1"
11 | },
12 | "ENABLE_DJANGO_COLLECTSTATIC": {
13 | "description": "Enables post-compile collectstatic (it is run by bin/post_compile)",
14 | "value": "1"
15 | },
16 | "AUTO_MIGRATE": {
17 | "description": "Heroku setting to run Django migrate automatically (it is run by bin/post_compile)",
18 | "value": "1"
19 | },
20 | "DJANGO_SETTINGS_MODULE": {
21 | "description": "Django settings Python import path",
22 | "value": "{{project_name}}.settings.production"
23 | },
24 | "SECRET_KEY": {
25 | "description": "Django SECRET_KEY setting",
26 | "generator": "secret"
27 | }
28 | },
29 | "formation": {
30 | "web": {
31 | "quantity": 1,
32 | "size": "free"
33 | },
34 | "worker": {
35 | "quantity": 1,
36 | "size": "free"
37 | }
38 | },
39 | "addons": [
40 | {
41 | "plan": "heroku-postgresql:hobby-dev",
42 | "options": {
43 | "version": "13"
44 | },
45 | "as": "DATABASE"
46 | },
47 | {
48 | "plan": "heroku-redis:hobby-dev",
49 | "options": {
50 | "version": "6"
51 | },
52 | "as": "REDIS"
53 | },
54 | {
55 | "plan": "sendgrid:starter"
56 | },
57 | {
58 | "plan": "papertrail:choklad"
59 | }
60 | ],
61 | "buildpacks": [
62 | {
63 | "url": "heroku/nodejs"
64 | },
65 | {
66 | "url": "heroku/python"
67 | }
68 | ]
69 | }
70 |
--------------------------------------------------------------------------------
/webpack.prod.config.js:
--------------------------------------------------------------------------------
1 | const autoprefixer = require('autoprefixer');
2 | const webpack = require('webpack');
3 | const MiniCssExtractPlugin = require('mini-css-extract-plugin');
4 | const BundleTracker = require('webpack-bundle-tracker');
5 | const path = require('path');
6 |
7 | const baseConfig = require('./webpack.base.config');
8 |
9 | const nodeModulesDir = path.resolve(__dirname, 'node_modules');
10 |
11 | baseConfig.mode = 'production';
12 | baseConfig.devtool = 'source-map';
13 |
14 | baseConfig.entry = ['whatwg-fetch', '@babel/polyfill', './frontend/js/index.js'];
15 |
16 | baseConfig.output = {
17 | path: path.resolve('./frontend/webpack_bundles/'),
18 | publicPath: '/static/webpack_bundles/',
19 | filename: '[name]-[hash].js',
20 | };
21 |
22 | baseConfig.module.rules.push(
23 | {
24 | test: /\.jsx?$/,
25 | exclude: [nodeModulesDir],
26 | use: {
27 | loader: 'babel-loader',
28 | options: {
29 | presets: ['@babel/preset-env', '@babel/preset-react'],
30 | },
31 | },
32 | },
33 | {
34 | test: /\.(woff(2)?|eot|ttf)(\?v=\d+\.\d+\.\d+)?$/,
35 | loader: 'file-loader?name=fonts/[name].[ext]',
36 | }
37 | );
38 |
39 | baseConfig.optimization = {
40 | minimize: true,
41 | splitChunks: {
42 | chunks: 'all',
43 | },
44 | };
45 |
46 | baseConfig.plugins = [
47 | new webpack.DefinePlugin({
48 | // removes React warnings
49 | 'process.env': {
50 | NODE_ENV: JSON.stringify('production'),
51 | },
52 | }),
53 | new MiniCssExtractPlugin({ filename: '[name]-[hash].css', disable: false, allChunks: true }),
54 | new BundleTracker({
55 | filename: './webpack-stats.json',
56 | }),
57 | new webpack.LoaderOptionsPlugin({
58 | options: {
59 | context: __dirname,
60 | postcss: [autoprefixer],
61 | },
62 | }),
63 | ];
64 |
65 | module.exports = baseConfig;
66 |
--------------------------------------------------------------------------------
/Makefile:
--------------------------------------------------------------------------------
1 | SHELL := /bin/bash # Use bash syntax
2 | ARG := $(word 2, $(MAKECMDGOALS) )
3 |
4 | clean:
5 | @find . -name "*.pyc" -exec rm -rf {} \;
6 | @find . -name "__pycache__" -delete
7 |
8 | test:
9 | python backend/manage.py test backend/ $(ARG) --parallel --keepdb
10 |
11 | test_reset:
12 | python backend/manage.py test backend/ $(ARG) --parallel
13 |
14 | backend_format:
15 | black backend
16 |
17 | upgrade: ## update the *requirements.txt files with the latest packages satisfying *requirements.in
18 | pip install -U -q pip-tools
19 | pip-compile --upgrade -o dev-requirements.txt dev-requirements.in
20 | pip-compile --upgrade -o requirements.txt requirements.in
21 | # Make everything =>, not ==
22 | sed 's/==/>=/g' requirements.txt > requirements.tmp
23 | mv requirements.tmp requirements.txt
24 |
25 | compile_install_requirements:
26 | @echo 'Installing pip-tools...'
27 | export PIP_REQUIRE_VIRTUALENV=true; \
28 | pip install pip-tools
29 | @echo 'Compiling requirements...'
30 | pip-compile requirements.in > requirements.txt
31 | pip-compile dev-requirements.in > dev-requirements.txt
32 | @echo 'Installing requirements...'
33 | pip install -r requirements.txt && pip install -r dev-requirements.txt
34 |
35 | # Commands for Docker version
36 | docker_setup:
37 | docker volume create {{project_name}}_dbdata
38 | docker-compose build --no-cache backend
39 | docker-compose run frontend npm install
40 |
41 | docker_test:
42 | docker-compose run backend python manage.py test $(ARG) --parallel --keepdb
43 |
44 | docker_test_reset:
45 | docker-compose run backend python manage.py test $(ARG) --parallel
46 |
47 | docker_up:
48 | docker-compose up -d
49 |
50 | docker_update_dependencies:
51 | docker-compose down
52 | docker-compose up -d --build
53 |
54 | docker_down:
55 | docker-compose down
56 |
57 | docker_logs:
58 | docker-compose logs -f $(ARG)
59 |
60 | docker_makemigrations:
61 | docker-compose run --rm backend python manage.py makemigrations
62 |
63 | docker_migrate:
64 | docker-compose run --rm backend python manage.py migrate
65 |
--------------------------------------------------------------------------------
/webpack.local.config.js:
--------------------------------------------------------------------------------
1 | const autoprefixer = require('autoprefixer');
2 | const webpack = require('webpack');
3 | const BundleTracker = require('webpack-bundle-tracker');
4 | const CircularDependencyPlugin = require('circular-dependency-plugin');
5 | const path = require('path');
6 |
7 | const baseConfig = require('./webpack.base.config');
8 |
9 | const nodeModulesDir = path.resolve(__dirname, 'node_modules');
10 |
11 | baseConfig.mode = 'development';
12 |
13 | baseConfig.entry = [
14 | 'react-hot-loader/patch',
15 | 'whatwg-fetch',
16 | '@babel/polyfill',
17 | './frontend/js/index.js',
18 | ];
19 |
20 | baseConfig.optimization = {
21 | splitChunks: {
22 | chunks: 'all',
23 | },
24 | };
25 |
26 | baseConfig.output = {
27 | path: path.resolve('./frontend/bundles/'),
28 | publicPath: 'http://localhost:3000/frontend/bundles/',
29 | filename: '[name].js',
30 | };
31 |
32 | baseConfig.module.rules.push(
33 | {
34 | test: /\.jsx?$/,
35 | exclude: [nodeModulesDir],
36 | loader: require.resolve('babel-loader'),
37 | },
38 | {
39 | test: /\.(woff(2)?|eot|ttf)(\?v=\d+\.\d+\.\d+)?$/,
40 | loader: 'url-loader?limit=100000',
41 | }
42 | );
43 |
44 | baseConfig.plugins = [
45 | new webpack.EvalSourceMapDevToolPlugin({
46 | exclude: /node_modules/
47 | }),
48 | new webpack.NamedModulesPlugin(),
49 | new webpack.NoEmitOnErrorsPlugin(), // don't reload if there is an error
50 | new BundleTracker({
51 | filename: './webpack-stats.json',
52 | }),
53 | new webpack.LoaderOptionsPlugin({
54 | options: {
55 | context: __dirname,
56 | postcss: [autoprefixer],
57 | },
58 | }),
59 | new CircularDependencyPlugin({
60 | // exclude detection of files based on a RegExp
61 | exclude: /a\.js|node_modules/,
62 | // add errors to webpack instead of warnings
63 | failOnError: true,
64 | // set the current working directory for displaying module paths
65 | cwd: process.cwd(),
66 | }),
67 | ];
68 |
69 | baseConfig.resolve.alias = {
70 | 'react-dom': '@hot-loader/react-dom',
71 | };
72 |
73 | module.exports = baseConfig;
74 |
--------------------------------------------------------------------------------
/frontend/js/app/example-app/components/ColorChanger/__tests__/__snapshots__/ColorChanger.snaps.spec.js.snap:
--------------------------------------------------------------------------------
1 | // Jest Snapshot v1, https://goo.gl/fbAQLP
2 |
3 | exports[`ColorChanger no title (should use default) 1`] = `
4 | {title}
31 |Color Changer App
32 |Check this example app: change the color to see it reflected in the text next to it.
33 | 34 |
35 |
42 |
43 |
45 |
7 |
56 | `;
57 |
58 | exports[`ColorChanger some title 1`] = `
59 | 8 | React App Loaded! 9 |
10 |13 | Color Changer App 14 |
15 |16 | Check this example app: change the color to see it reflected in the text next to it. 17 |
18 |
21 |
51 |
55 |
62 |
111 | `;
112 |
--------------------------------------------------------------------------------
/backend/common/utils/tests.py:
--------------------------------------------------------------------------------
1 | from django.test import Client, TestCase
2 | from django.urls import reverse
3 |
4 | from model_bakery import baker
5 |
6 |
7 | class TestCaseUtils(TestCase):
8 | def setUp(self):
9 | self._user_password = "123456"
10 | self.user = baker.prepare("users.User", email="user@email.com")
11 | self.user.set_password(self._user_password)
12 | self.user.save()
13 |
14 | self.auth_client = Client()
15 | self.auth_client.login(email=self.user.email, password=self._user_password)
16 |
17 | def reverse(self, name, *args, **kwargs):
18 | """ Reverse a url, convenience to avoid having to import reverse in tests """
19 | return reverse(name, args=args, kwargs=kwargs)
20 |
21 | def assertResponse200(self, response):
22 | """ Given response has status_code 200 OK"""
23 | self.assertEqual(response.status_code, 200)
24 |
25 | def assertResponse201(self, response):
26 | """ Given response has status_code 201 CREATED"""
27 | self.assertEqual(response.status_code, 201)
28 |
29 | def assertResponse301(self, response):
30 | """ Given response has status_code 301 MOVED PERMANENTLY"""
31 | self.assertEqual(response.status_code, 301)
32 |
33 | def assertResponse302(self, response):
34 | """ Given response has status_code 302 FOUND"""
35 | self.assertEqual(response.status_code, 302)
36 |
37 | def assertResponse400(self, response):
38 | """ Given response has status_code 400 BAD REQUEST"""
39 | self.assertEqual(response.status_code, 400)
40 |
41 | def assertResponse401(self, response):
42 | """ Given response has status_code 401 UNAUTHORIZED"""
43 | self.assertEqual(response.status_code, 401)
44 |
45 | def assertResponse403(self, response):
46 | """ Given response has status_code 403 FORBIDDEN"""
47 | self.assertEqual(response.status_code, 403)
48 |
49 | def assertResponse404(self, response):
50 | """ Given response has status_code 404 NOT FOUND"""
51 | self.assertEqual(response.status_code, 404)
52 |
53 |
54 | class TestGetRequiresAuthenticatedUser:
55 | def test_get_requires_authenticated_user(self):
56 | response = self.client.get(self.view_url)
57 | self.assertResponse403(response)
58 |
59 |
60 | class TestAuthGetRequestSuccess:
61 | def test_auth_get_success(self):
62 | response = self.auth_client.get(self.view_url)
63 | self.assertResponse200(response)
64 |
--------------------------------------------------------------------------------
/.bootstraprc:
--------------------------------------------------------------------------------
1 | ---
2 | # Output debugging info
3 | # loglevel: debug
4 |
5 | # Major version of Bootstrap: 3 or 4
6 | bootstrapVersion: 4
7 |
8 | # Webpack loaders, order matters
9 | styleLoaders:
10 | - style-loader
11 | - css-loader
12 | - sass-loader
13 | - postcss-loader
14 |
15 | # Extract styles to stand-alone css file
16 | # Different settings for different environments can be used,
17 | # It depends on value of NODE_ENV environment variable
18 | # This param can also be set in webpack config:
19 | # entry: 'bootstrap-loader/extractStyles'
20 | # env:
21 | # development:
22 | # extractStyles: false
23 | # production:
24 | # extractStyles: true
25 |
26 |
27 | # Customize Bootstrap variables that get imported before the original Bootstrap variables.
28 | # Thus, derived Bootstrap variables can depend on values from here.
29 | # See the Bootstrap _variables.scss file for examples of derived Bootstrap variables.
30 | #
31 | # preBootstrapCustomizations: ./path/to/bootstrap/pre-customizations.scss
32 |
33 |
34 | # This gets loaded after bootstrap/variables is loaded
35 | # Thus, you may customize Bootstrap variables
36 | # based on the values established in the Bootstrap _variables.scss file
37 | #
38 | bootstrapCustomizations: ./frontend/sass/vendor/custom-bootstrap.scss
39 |
40 |
41 | # Import your custom styles here
42 | # Usually this endpoint-file contains list of @imports of your application styles
43 | #
44 | # appStyles: ./path/to/your/app/styles/endpoint.scss
45 | appStyles: ./frontend/sass/style.scss
46 |
47 |
48 | ### Bootstrap styles
49 | styles:
50 |
51 | # Mixins
52 | mixins: true
53 |
54 | # Reset and dependencies
55 | print: true
56 |
57 | # Core CSS
58 | buttons: true
59 | code: true
60 | forms: true
61 | grid: true
62 | images: true
63 | reboot: true
64 | tables: true
65 | type: true
66 |
67 | # Components
68 | alert: false
69 | badge: false
70 | breadcrumb: false
71 | button-group: false
72 | card: true
73 | close: false
74 | custom-forms: false
75 | dropdown: false
76 | input-group: false
77 | jumbotron: true
78 | list-group: false
79 | media: false
80 | nav: true
81 | navbar: true
82 | pagination: false
83 | progress: false
84 | transitions: true
85 |
86 | # Components w/ JavaScript
87 | carousel: false
88 | modal: false
89 | popover: false
90 | tooltip: false
91 |
92 | # Utility classes
93 | utilities: true
94 |
95 | ### Bootstrap scripts
96 | scripts:
97 | alert: false
98 | button: true
99 | carousel: false
100 | collapse: true
101 | dropdown: false
102 | modal: false
103 | popover: false
104 | scrollspy: false
105 | tab: false
106 | tooltip: false
107 | util: true
108 |
--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "{{project_name}}-frontend",
3 | "version": "0.0.1",
4 | "private": true,
5 | "description": "{{project_name}} frontend.",
6 | "main": "index.js",
7 | "prettier": "eslint-config-vinta/prettier",
8 | "scripts": {
9 | "test": "jest",
10 | "test:watch": "npm test -- --watch",
11 | "test:update": "npm test -- --u",
12 | "start": "babel-node server.js",
13 | "build": "NODE_ENV=production webpack -p --progress --colors --config webpack.prod.config.js --bail",
14 | "lint": "eslint frontend",
15 | "coverage": "jest --coverage"
16 | },
17 | "dependencies": {
18 | "@babel/cli": "~7.13.10",
19 | "@babel/polyfill": "~7.8.3",
20 | "@babel/preset-env": "~7.13.10",
21 | "@babel/preset-react": "~7.12.13",
22 | "@sentry/browser": "~6.2.2",
23 | "@types/react": "~16.14.5",
24 | "autoprefixer": "~9.8.6",
25 | "axios": "~0.21.1",
26 | "babel-loader": "~8.2.2",
27 | "bootstrap": "~4.6.0",
28 | "classnames": "~2.2.6",
29 | "connected-react-router": "~6.9.1",
30 | "cookie": "~0.4.0",
31 | "css-loader": "~5.1.3",
32 | "expose-loader": "~0.7.5",
33 | "file-loader": "~6.2.0",
34 | "history": "~4.10.1",
35 | "imports-loader": "~0.8.0",
36 | "lodash": "~4.17.21",
37 | "marked": "~2.0.1",
38 | "node-sass": "~4.14.1",
39 | "postcss": "~8.2.8",
40 | "postcss-loader": "~2.1.6",
41 | "prop-types": "~15.7.2",
42 | "react": "~16.14.0",
43 | "react-bootstrap": "~1.5.2",
44 | "react-dom": "~16.14.0",
45 | "react-hot-loader": "~4.13.0",
46 | "react-redux": "~7.2.3",
47 | "react-router": "~5.2.0",
48 | "redux": "~4.0.5",
49 | "redux-devtools-extension": "~2.13.9",
50 | "redux-thunk": "~2.3.0",
51 | "resolve-url-loader": "~3.1.2",
52 | "sass-loader": "~8.0.2",
53 | "script-loader": "~0.7.2",
54 | "style-loader": "~2.0.0",
55 | "url-loader": "~4.1.1",
56 | "webpack": "~4.46.0",
57 | "webpack-bundle-tracker": "~1.0.0",
58 | "webpack-dev-server": "~3.11.2",
59 | "whatwg-fetch": "~3.6.2"
60 | },
61 | "devDependencies": {
62 | "@babel/core": "~7.13.10",
63 | "@babel/node": "~7.13.10",
64 | "@hot-loader/react-dom": "~16.14.0",
65 | "ajv": "~6.12.6",
66 | "babel-core": "~7.0.0-bridge.0",
67 | "babel-eslint": "~10.1.0",
68 | "babel-jest": "~26.6.3",
69 | "circular-dependency-plugin": "~5.2.2",
70 | "enzyme": "~3.11.0",
71 | "enzyme-adapter-react-16": "~1.15.6",
72 | "enzyme-to-json": "~3.6.1",
73 | "eslint": "~6.8.0",
74 | "eslint-config-prettier": "~6.15.0",
75 | "eslint-config-vinta": "~1.4.5",
76 | "eslint-import-resolver-webpack": "~0.13.0",
77 | "eslint-plugin-babel": "~5.3.1",
78 | "eslint-plugin-import": "~2.22.1",
79 | "eslint-plugin-jest": "~22.21.0",
80 | "eslint-plugin-jsx-a11y": "~6.4.1",
81 | "eslint-plugin-prettier": "~3.3.1",
82 | "eslint-plugin-promise": "~4.3.1",
83 | "eslint-plugin-react": "~7.22.0",
84 | "eslint-plugin-react-hooks": "~2.5.1",
85 | "eslint-plugin-sonarjs": "~0.5.0",
86 | "eslint-plugin-unicorn": "~15.0.1",
87 | "identity-obj-proxy": "~3.0.0",
88 | "jest": "~26.6.3",
89 | "jest-css-modules": "~2.1.0",
90 | "mini-css-extract-plugin": "~0.12.0",
91 | "prettier": "~1.19.1",
92 | "redux-mock-store": "~1.5.4",
93 | "webpack-cli": "~3.3.12"
94 | },
95 | "resolutions": {
96 | "babel-core": "7.0.0-bridge.0"
97 | }
98 | }
99 |
--------------------------------------------------------------------------------
/backend/project_name/settings/production.py:
--------------------------------------------------------------------------------
1 | import sentry_sdk
2 | from decouple import Csv, config
3 | from sentry_sdk.integrations.django import DjangoIntegration
4 |
5 | from .base import * # noqa
6 |
7 |
8 | DEBUG = False
9 |
10 | SECRET_KEY = config("SECRET_KEY")
11 |
12 | DATABASES["default"]["ATOMIC_REQUESTS"] = True
13 |
14 | ALLOWED_HOSTS = config("ALLOWED_HOSTS", cast=Csv())
15 |
16 | STATIC_ROOT = base_dir_join("staticfiles")
17 | STATIC_URL = "/static/"
18 |
19 | MEDIA_ROOT = base_dir_join("mediafiles")
20 | MEDIA_URL = "/media/"
21 |
22 | SERVER_EMAIL = "foo@example.com"
23 |
24 | EMAIL_HOST = "smtp.sendgrid.net"
25 | EMAIL_HOST_USER = config("SENDGRID_USERNAME")
26 | EMAIL_HOST_PASSWORD = config("SENDGRID_PASSWORD")
27 | EMAIL_PORT = 587
28 | EMAIL_USE_TLS = True
29 |
30 | # Security
31 | SECURE_HSTS_PRELOAD = True
32 | SECURE_PROXY_SSL_HEADER = ("HTTP_X_FORWARDED_PROTO", "https")
33 | SECURE_SSL_REDIRECT = True
34 | SESSION_COOKIE_SECURE = True
35 | CSRF_COOKIE_SECURE = True
36 | SECURE_HSTS_SECONDS = config("SECURE_HSTS_SECONDS", default=3600, cast=int)
37 | SECURE_HSTS_INCLUDE_SUBDOMAINS = True
38 |
39 | SECURE_CONTENT_TYPE_NOSNIFF = True
40 | SECURE_BROWSER_XSS_FILTER = True
41 | X_FRAME_OPTIONS = "DENY"
42 |
43 | # Webpack
44 | WEBPACK_LOADER["DEFAULT"]["CACHE"] = True
45 |
46 | # Celery
47 | CELERY_BROKER_URL = config("REDIS_URL")
48 | CELERY_RESULT_BACKEND = config("REDIS_URL")
49 | CELERY_SEND_TASK_ERROR_EMAILS = True
50 |
51 | # Redbeat https://redbeat.readthedocs.io/en/latest/config.html#redbeat-redis-url
52 | redbeat_redis_url = config("REDBEAT_REDIS_URL", default="")
53 |
54 | # Whitenoise
55 | STATICFILES_STORAGE = "whitenoise.storage.CompressedManifestStaticFilesStorage"
56 |
57 | # django-log-request-id
58 | MIDDLEWARE.insert( # insert RequestIDMiddleware on the top
59 | 0, "log_request_id.middleware.RequestIDMiddleware"
60 | )
61 |
62 | LOG_REQUEST_ID_HEADER = "HTTP_X_REQUEST_ID"
63 | LOG_REQUESTS = True
64 |
65 | LOGGING = {
66 | "version": 1,
67 | "disable_existing_loggers": False,
68 | "filters": {
69 | "require_debug_false": {"()": "django.utils.log.RequireDebugFalse"},
70 | "request_id": {"()": "log_request_id.filters.RequestIDFilter"},
71 | },
72 | "formatters": {
73 | "standard": {
74 | "format": "%(levelname)-8s [%(asctime)s] [%(request_id)s] %(name)s: %(message)s"
75 | },
76 | },
77 | "handlers": {
78 | "null": {"class": "logging.NullHandler",},
79 | "mail_admins": {
80 | "level": "ERROR",
81 | "class": "django.utils.log.AdminEmailHandler",
82 | "filters": ["require_debug_false"],
83 | },
84 | "console": {
85 | "level": "DEBUG",
86 | "class": "logging.StreamHandler",
87 | "filters": ["request_id"],
88 | "formatter": "standard",
89 | },
90 | },
91 | "loggers": {
92 | "": {"handlers": ["console"], "level": "INFO"},
93 | "django.security.DisallowedHost": {"handlers": ["null"], "propagate": False,},
94 | "django.request": {"handlers": ["mail_admins"], "level": "ERROR", "propagate": True,},
95 | "log_request_id.middleware": {
96 | "handlers": ["console"],
97 | "level": "DEBUG",
98 | "propagate": False,
99 | },
100 | },
101 | }
102 |
103 | JS_REVERSE_EXCLUDE_NAMESPACES = ["admin"]
104 |
105 | # Sentry
106 | sentry_sdk.init(dsn=SENTRY_DSN, integrations=[DjangoIntegration()], release=COMMIT_SHA)
107 |
--------------------------------------------------------------------------------
/backend/project_name/settings/base.py:
--------------------------------------------------------------------------------
1 | # https://docs.djangoproject.com/en/1.10/ref/settings/
2 |
3 | import os
4 |
5 | from decouple import config # noqa
6 | from dj_database_url import parse as db_url # noqa
7 |
8 |
9 | BASE_DIR = os.path.dirname(os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
10 |
11 |
12 | def base_dir_join(*args):
13 | return os.path.join(BASE_DIR, *args)
14 |
15 |
16 | SITE_ID = 1
17 |
18 | DEBUG = True
19 |
20 | ADMINS = (("Admin", "foo@example.com"),)
21 |
22 | AUTH_USER_MODEL = "users.User"
23 |
24 | ALLOWED_HOSTS = []
25 |
26 | DATABASES = {
27 | "default": config("DATABASE_URL", cast=db_url),
28 | }
29 |
30 | INSTALLED_APPS = [
31 | "django.contrib.admin",
32 | "django.contrib.auth",
33 | "django.contrib.contenttypes",
34 | "django.contrib.sessions",
35 | "django.contrib.messages",
36 | "django.contrib.staticfiles",
37 | "django_js_reverse",
38 | "webpack_loader",
39 | "import_export",
40 | "rest_framework",
41 | "common",
42 | "users",
43 | ]
44 |
45 | MIDDLEWARE = [
46 | "debreach.middleware.RandomCommentMiddleware",
47 | "django.middleware.security.SecurityMiddleware",
48 | "whitenoise.middleware.WhiteNoiseMiddleware",
49 | "django.contrib.sessions.middleware.SessionMiddleware",
50 | "django.middleware.common.CommonMiddleware",
51 | "django.middleware.csrf.CsrfViewMiddleware",
52 | "django.contrib.auth.middleware.AuthenticationMiddleware",
53 | "django.contrib.messages.middleware.MessageMiddleware",
54 | "django.middleware.clickjacking.XFrameOptionsMiddleware",
55 | ]
56 |
57 | ROOT_URLCONF = "{{project_name}}.urls"
58 |
59 | TEMPLATES = [
60 | {
61 | "BACKEND": "django.template.backends.django.DjangoTemplates",
62 | "DIRS": [base_dir_join("templates")],
63 | "OPTIONS": {
64 | "context_processors": [
65 | "django.template.context_processors.debug",
66 | "django.template.context_processors.request",
67 | "django.contrib.auth.context_processors.auth",
68 | "django.contrib.messages.context_processors.messages",
69 | "common.context_processors.sentry_dsn",
70 | "common.context_processors.commit_sha",
71 | ],
72 | "loaders": [
73 | (
74 | "django.template.loaders.cached.Loader",
75 | [
76 | "django.template.loaders.filesystem.Loader",
77 | "django.template.loaders.app_directories.Loader",
78 | ],
79 | ),
80 | ],
81 | },
82 | },
83 | ]
84 |
85 | WSGI_APPLICATION = "{{project_name}}.wsgi.application"
86 |
87 | AUTH_PASSWORD_VALIDATORS = [
88 | {"NAME": "django.contrib.auth.password_validation.UserAttributeSimilarityValidator",},
89 | {"NAME": "django.contrib.auth.password_validation.MinimumLengthValidator",},
90 | {"NAME": "django.contrib.auth.password_validation.CommonPasswordValidator",},
91 | {"NAME": "django.contrib.auth.password_validation.NumericPasswordValidator",},
92 | ]
93 |
94 | REST_FRAMEWORK = {
95 | 'DEFAULT_PAGINATION_CLASS': 'rest_framework.pagination.LimitOffsetPagination',
96 | 'PAGE_SIZE': 10,
97 | 'DEFAULT_AUTHENTICATION_CLASSES': [
98 | 'rest_framework.authentication.SessionAuthentication',
99 | ],
100 | 'DEFAULT_PERMISSION_CLASSES': [
101 | 'rest_framework.permissions.IsAuthenticated',
102 | ],
103 | }
104 |
105 | LANGUAGE_CODE = "en-us"
106 |
107 | TIME_ZONE = "UTC"
108 |
109 | USE_I18N = True
110 |
111 | USE_L10N = True
112 |
113 | USE_TZ = True
114 |
115 | STATICFILES_DIRS = (base_dir_join("../frontend"),)
116 |
117 | # Webpack
118 | WEBPACK_LOADER = {
119 | "DEFAULT": {
120 | "CACHE": False, # on DEBUG should be False
121 | "STATS_FILE": base_dir_join("../webpack-stats.json"),
122 | "POLL_INTERVAL": 0.1,
123 | "IGNORE": [".+\.hot-update.js", ".+\.map"],
124 | }
125 | }
126 |
127 | # Celery
128 | CELERY_ACCEPT_CONTENT = ["json"]
129 | CELERY_TASK_SERIALIZER = "json"
130 | CELERY_RESULT_SERIALIZER = "json"
131 | CELERY_ACKS_LATE = True
132 | CELERY_TIMEZONE = TIME_ZONE
133 |
134 | # Sentry
135 | SENTRY_DSN = config("SENTRY_DSN", default="")
136 | COMMIT_SHA = config("HEROKU_SLUG_COMMIT", default="")
137 |
138 | # Fix for Safari 12 compatibility issues, please check:
139 | # https://github.com/vintasoftware/safari-samesite-cookie-issue
140 | CSRF_COOKIE_SAMESITE = None
141 | SESSION_COOKIE_SAMESITE = None
142 |
143 | # Default primary key field type
144 | # https://docs.djangoproject.com/en/3.2/ref/settings/#default-auto-field
145 | DEFAULT_AUTO_FIELD = "django.db.models.BigAutoField"
146 |
--------------------------------------------------------------------------------
/.github/workflows/shared-build/action.yml:
--------------------------------------------------------------------------------
1 | name: "Shared Build Steps"
2 | description: "Shared build steps for main and nightly"
3 |
4 | runs:
5 | using: "composite"
6 | steps:
7 | - name: Store branch and latest SHA
8 | id: vars
9 | shell: bash
10 | run: |
11 | echo "##[set-output name=branch;]$(echo ${GITHUB_REF#refs/heads/})"
12 | echo "::set-output name=sha_short::$(git rev-parse --short HEAD)"
13 | - name: Setup Python
14 | uses: actions/setup-python@v2
15 | with:
16 | python-version: "3.8"
17 | - name: Setup Node
18 | uses: actions/setup-node@v2
19 | with:
20 | node-version: "14.5"
21 | - name: Cache node modules
22 | uses: actions/cache@v2
23 | env:
24 | cache-name: node-modules-cache
25 | with:
26 | path: ~/.npm
27 | key: build-${{ env.cache-name }}-${{ steps.vars.outputs.branch }}-${{ steps.vars.outputs.sha_short }}
28 | restore-keys: |
29 | build-${{ env.cache-name }}-${{ steps.vars.outputs.branch }}-${{ steps.vars.outputs.sha_short }}
30 | build-${{ env.cache-name }}-${{ steps.vars.outputs.branch }}
31 | build-${{ env.cache-name }}
32 | - name: Cache pip
33 | uses: actions/cache@v2
34 | env:
35 | cache-name: pip-cache
36 | with:
37 | path: ~/.cache/pip
38 | key: build-${{ env.cache-name }}-${{ steps.vars.outputs.branch }}-${{ steps.vars.outputs.sha_short }}
39 | restore-keys: |
40 | build-${{ env.cache-name }}-${{ steps.vars.outputs.branch }}-${{ steps.vars.outputs.sha_short }}
41 | build-${{ env.cache-name }}-${{ steps.vars.outputs.branch }}
42 | build-${{ env.cache-name }}
43 | - run: python -m pip install --upgrade pip
44 | shell: bash
45 | - name: Install Django
46 | run: pip install "django>=3,<4"
47 | shell: bash
48 | - name: Setup testproject
49 | run: django-admin startproject testproject --extension py,yml,json,example --name Procfile,README.md --template=.
50 | shell: bash
51 | - run: |
52 | npm update --save
53 | npm update --save-dev
54 | shell: bash
55 | working-directory: testproject
56 | - run: npm install --no-optional
57 | working-directory: testproject
58 | shell: bash
59 | - run: npm dedupe
60 | working-directory: testproject
61 | shell: bash
62 | - run: npm run test
63 | working-directory: testproject
64 | shell: bash
65 | - run: npm run lint
66 | working-directory: testproject
67 | shell: bash
68 | - run: npm run build
69 | working-directory: testproject
70 | shell: bash
71 | - run: pip install requests pip-tools --upgrade
72 | working-directory: testproject
73 | shell: bash
74 | - run: |
75 | pip-compile requirements.in > requirements.txt
76 | pip-compile dev-requirements.in > dev-requirements.txt
77 | working-directory: testproject
78 | shell: bash
79 | - run: |
80 | pip install --user -r requirements.txt
81 | pip install --user -r dev-requirements.txt
82 | working-directory: testproject
83 | shell: bash
84 | - run: cp testproject/settings/local.py.example testproject/settings/local.py
85 | working-directory: testproject/backend
86 | shell: bash
87 | - run: cp .env.example .env
88 | working-directory: testproject/backend
89 | shell: bash
90 | - run: python manage.py makemigrations
91 | working-directory: testproject/backend
92 | env:
93 | DATABASE_URL: 'sqlite:///'
94 | shell: bash
95 | - run: python manage.py migrate
96 | working-directory: testproject/backend
97 | env:
98 | DATABASE_URL: 'sqlite:///'
99 | shell: bash
100 | - run: python manage.py test
101 | working-directory: testproject/backend
102 | env:
103 | DATABASE_URL: 'sqlite:///'
104 | shell: bash
105 | - name: Generate secret key
106 | run: echo '::set-output name=SECRET_KEY::`python -c "import uuid; print(uuid.uuid4().hex + uuid.uuid4().hex)"`'
107 | id: secret-id-generator
108 | shell: bash
109 | - run: prospector -X
110 | working-directory: testproject/backend
111 | env:
112 | SECRET_KEY: ${{ steps.secret-id-generator.outputs.SECRET_KEY }}
113 | SENDGRID_USERNAME: foo
114 | SENDGRID_PASSWORD: password
115 | DJANGO_SETTINGS_MODULE: 'testproject.settings.local'
116 | ALLOWED_HOSTS: '.example.org'
117 | REDIS_URL: 'redis://'
118 | DATABASE_URL: 'sqlite:///'
119 | shell: bash
120 | - run: python manage.py makemigrations --check --dry-run
121 | working-directory: testproject/backend
122 | env:
123 | DATABASE_URL: 'sqlite:///'
124 | shell: bash
125 | - run: python manage.py check --deploy --fail-level WARNING
126 | working-directory: testproject/backend
127 | env:
128 | SECRET_KEY: ${{ steps.secret-id-generator.outputs.SECRET_KEY }}
129 | SENDGRID_USERNAME: foo
130 | SENDGRID_PASSWORD: password
131 | DJANGO_SETTINGS_MODULE: 'testproject.settings.production'
132 | ALLOWED_HOSTS: '.example.org'
133 | REDIS_URL: 'redis://'
134 | DATABASE_URL: 'sqlite:///'
135 | shell: bash
136 |
--------------------------------------------------------------------------------
/proj_main.yml:
--------------------------------------------------------------------------------
1 | name: main
2 | on: [push, pull_request]
3 |
4 | jobs:
5 | build:
6 | name: Build {{project_name}}
7 | strategy:
8 | matrix:
9 | python: [3.8]
10 | node: [14.5]
11 | env:
12 | DATABASE_URL: 'sqlite:///'
13 | runs-on: ubuntu-latest
14 | steps:
15 | - name: Checkout code
16 | uses: actions/checkout@v2
17 | - name: Store branch and latest SHA
18 | run: |
19 | echo "##[set-output name=branch;]$(echo ${GITHUB_REF#refs/heads/})"
20 | echo "::set-output name=sha_short::$(git rev-parse --short HEAD)"
21 | id: git
22 | - name: Setup Python ${% templatetag openvariable %} matrix.python {% templatetag closevariable %}
23 | uses: actions/setup-python@v2
24 | with:
25 | python-version: ${% templatetag openvariable %} matrix.python {% templatetag closevariable %}
26 | - name: Setup Node ${% templatetag openvariable %} matrix.node {% templatetag closevariable %}
27 | uses: actions/setup-node@v2
28 | with:
29 | node-version: ${% templatetag openvariable %} matrix.node {% templatetag closevariable %}
30 | - name: Cache node modules
31 | uses: actions/cache@v2
32 | env:
33 | cache_name: node-modules-cache
34 | with:
35 | path: ~/.npm
36 | key: build-${% templatetag openvariable%} env.cache_name {% templatetag closevariable %}-${% templatetag openvariable%} steps.git.outputs.branch {% templatetag closevariable %}-${% templatetag openvariable%} steps.git.outputs.sha_short {% templatetag closevariable %}
37 | restore-keys: |
38 | build-${% templatetag openvariable%} env.cache_name {% templatetag closevariable %}-${% templatetag openvariable%} steps.git.outputs.branch {% templatetag closevariable %}-${% templatetag openvariable%} steps.git.outputs.sha_short {% templatetag closevariable %}
39 | build-${% templatetag openvariable%} env.cache_name {% templatetag closevariable %}-${% templatetag openvariable%} steps.git.outputs.branch {% templatetag closevariable %}
40 | build-${% templatetag openvariable%} env.cache_name {% templatetag closevariable %}
41 | - name: Cache pip
42 | uses: actions/cache@v2
43 | env:
44 | cache_name: pip-cache
45 | with:
46 | path: ~/.cache/pip
47 | key: build-${% templatetag openvariable%} env.cache_name {% templatetag closevariable %}-${% templatetag openvariable%} steps.git.outputs.branch {% templatetag closevariable %}-${% templatetag openvariable%} steps.git.outputs.sha_short {% templatetag closevariable %}
48 | restore-keys: |
49 | build-${% templatetag openvariable%} env.cache_name {% templatetag closevariable %}-${% templatetag openvariable%} steps.git.outputs.branch {% templatetag closevariable %}-${% templatetag openvariable%} steps.git.outputs.sha_short {% templatetag closevariable %}
50 | build-${% templatetag openvariable%} env.cache_name {% templatetag closevariable %}-${% templatetag openvariable%} steps.git.outputs.branch {% templatetag closevariable %}
51 | build-${% templatetag openvariable%} env.cache_name {% templatetag closevariable %}
52 | - run: python -m pip install --upgrade pip
53 | - run: curl -s https://packagecloud.io/install/repositories/github/git-lfs/script.deb.sh | sudo bash
54 | - run: sudo apt-get install git-lfs --upgrade
55 | - run: pip install requests pip-tools --upgrade
56 | - run: |
57 | pip-compile requirements.in > requirements.txt
58 | pip-compile dev-requirements.in > dev-requirements.txt
59 | pip install --user -r requirements.txt
60 | pip install --user -r dev-requirements.txt
61 | - run: npm install
62 | - run: npm run build
63 | - run: npm run lint
64 | - name: Generate secret key
65 | run: echo '::set-output name=SECRET_KEY::`python -c "import uuid; print(uuid.uuid4().hex + uuid.uuid4().hex)"`'
66 | id: secret_id_generator
67 | - name: Style check
68 | run: prospector --messages-only
69 | env:
70 | DJANGO_SETTINGS_MODULE: '{{project_name}}.settings.local_base'
71 | SECRET_KEY: ${% templatetag openvariable %} steps.secret_id_generator.outputs.SECRET_KEY {% templatetag closevariable %}
72 | DATABASE_URL: 'sqlite:///'
73 | ALLOWED_HOSTS: '.example.org'
74 | SENDGRID_USERNAME: 'test'
75 | SENDGRID_PASSWORD: 'test'
76 | REDIS_URL: 'redis://'
77 | - name: Security checks
78 | run: bandit -r .
79 | - name: Imports check
80 | run: isort **/*.py --check-only
81 | - run: pre-commit run --all-files
82 | env:
83 | SKIP: prospector,isort,eslint,missing-migrations
84 | - run: python manage.py makemigrations --check --dry-run --ignore authtools
85 | working-directory: backend
86 | - run: python manage.py check --deploy
87 | env:
88 | DJANGO_SETTINGS_MODULE: '{{project_name}}.settings.production'
89 | SECRET_KEY: ${% templatetag openvariable %} steps.secret_id_generator.outputs.SECRET_KEY {% templatetag closevariable %}
90 | DATABASE_URL: 'sqlite:///'
91 | ALLOWED_HOSTS: '.example.org'
92 | SENDGRID_USERNAME: 'test'
93 | SENDGRID_PASSWORD: 'test'
94 | REDIS_URL: 'redis://'
95 | working-directory: backend
96 | - run: python manage.py test
97 | working-directory: backend
98 | - run: npm run test
99 | - run: |
100 | mkdir -p junit
101 | coverage xml -o junit/test-results.xml
102 |
--------------------------------------------------------------------------------
/CODE_OF_CONDUCT.md:
--------------------------------------------------------------------------------
1 |
2 | # Contributor Covenant Code of Conduct
3 |
4 | ## Our Pledge
5 |
6 | We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.
7 |
8 | We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
9 |
10 | ## Our Standards
11 |
12 | Examples of behavior that contributes to a positive environment for our community include:
13 |
14 | * Demonstrating empathy and kindness toward other people
15 | * Being respectful of differing opinions, viewpoints, and experiences
16 | * Giving and gracefully accepting constructive feedback
17 | * Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
18 | * Focusing on what is best not just for us as individuals, but for the overall community
19 |
20 | Examples of unacceptable behavior include:
21 |
22 | * The use of sexualized language or imagery, and sexual attention or advances of any kind
23 | * Trolling, insulting or derogatory comments, and personal or political attacks
24 | * Public or private harassment
25 | * Publishing others' private information, such as a physical or email address, without their explicit permission
26 | * Other conduct which could reasonably be considered inappropriate in a professional setting
27 |
28 | ## Enforcement Responsibilities
29 |
30 | Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
31 |
32 | Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
33 |
34 | ## Scope
35 |
36 | This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
37 |
38 | ## Enforcement
39 |
40 | Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at [flavio@vinta.com.br](flavio@vinta.com.br). All complaints will be reviewed and investigated promptly and fairly.
41 |
42 | All community leaders are obligated to respect the privacy and security of the reporter of any incident.
43 |
44 | ## Enforcement Guidelines
45 |
46 | Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
47 |
48 | ### 1. Correction
49 |
50 | **Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
51 |
52 | **Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
53 |
54 | ### 2. Warning
55 |
56 | **Community Impact**: A violation through a single incident or series of actions.
57 |
58 | **Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
59 |
60 | ### 3. Temporary Ban
61 |
62 | **Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
63 |
64 | **Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
65 |
66 | ### 4. Permanent Ban
67 |
68 | **Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
69 |
70 | **Consequence**: A permanent ban from any sort of public interaction within the community.
71 |
72 | ## Attribution
73 |
74 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0, available at [https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0].
75 |
76 | Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder][Mozilla CoC].
77 |
78 | For answers to common questions about this code of conduct, see the FAQ at [https://www.contributor-covenant.org/faq][FAQ]. Translations are available at [https://www.contributor-covenant.org/translations][translations].
79 |
80 | [homepage]: https://www.contributor-covenant.org
81 | [v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html
82 | [Mozilla CoC]: https://github.com/mozilla/diversity
83 | [FAQ]: https://www.contributor-covenant.org/faq
84 | [translations]: https://www.contributor-covenant.org/translations
85 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # Django React Boilerplate
2 |
3 | [](code_of_conduct.md)
4 | [](LICENSE.txt)
5 |
6 | ## About
7 | A [Django](https://www.djangoproject.com/) project boilerplate/template with lots of state of the art libraries and tools like:
8 | - [React](https://facebook.github.io/react/), for building interactive UIs
9 | - [django-js-reverse](https://github.com/ierror/django-js-reverse), for generating URLs on JS
10 | - [React Bootstrap](https://react-bootstrap.github.io/), for responsive styling
11 | - [Webpack](https://webpack.js.org/), for bundling static assets
12 | - [Celery](https://docs.celeryproject.org/), for background worker tasks
13 | - [WhiteNoise](http://whitenoise.evans.io/en/stable/) with [brotlipy](https://github.com/python-hyper/brotlipy), for efficient static files serving
14 | - [prospector](https://prospector.landscape.io/en/master/) and [ESLint](https://eslint.org/) with [pre-commit](https://pre-commit.com/) for automated quality assurance (does not replace proper testing!)
15 |
16 | For continuous integration, a [Github Action](https://github.com/features/actions) configuration `.github/workflows/main.yml` is included.
17 |
18 | Also, includes a Heroku `app.json` and a working Django `production.py` settings, enabling easy deployments with ['Deploy to Heroku' button](https://devcenter.heroku.com/articles/heroku-button). Those Heroku plugins are included in `app.json`:
19 | - PostgreSQL, for DB
20 | - Redis, for Celery
21 | - Sendgrid, for e-mail sending
22 | - Papertrail, for logs and platform errors alerts (must set them manually)
23 |
24 | This is a good starting point for modern Python/JavaScript web projects.
25 |
26 | ## Project bootstrap [](https://github.com/chocoelho/django-react-boilerplate/actions/workflows/main.yml) [](https://greenkeeper.io/)
27 | - [ ] Make sure you have Python 3.8 installed
28 | - [ ] Install Django with `pip install django`, to have the `django-admin` command available.
29 | - [ ] Open the command line and go to the directory you want to start your project in.
30 | - [ ] Start your project using:
31 | ```
32 | django-admin startproject theprojectname --extension py,yml,json --name Procfile,Dockerfile,README.md,.env.example,.gitignore,Makefile --template=https://github.com/vintasoftware/django-react-boilerplate/archive/boilerplate-release.zip
33 | ```
34 | Alternatively, you may start the project in the current directory by placing a `.` right after the project name, using the following command:
35 | ```
36 | django-admin startproject theprojectname . --extension py,yml,json --name Procfile,Dockerfile,README.md,.env.example,.gitignore,Makefile --template=https://github.com/vintasoftware/django-react-boilerplate/archive/boilerplate-release.zip
37 | ```
38 | In the next steps, always remember to replace theprojectname with your project's name
39 | - [ ] Above: don't forget the `--extension` and `--name` params!
40 | - [ ] Change the first line of README to the name of the project
41 | - [ ] Add an email address to the `ADMINS` settings variable in `{{project_name}}/backend/{{project_name}}/settings/base.py`
42 | - [ ] Change the `SERVER_EMAIL` to the email address used to send e-mails in `{{project_name}}/backend/{{project_name}}/settings/production.py`
43 | - [ ] Rename the folder `github` to `.github` with the command `mv github .github`
44 |
45 | After completing ALL of the above, remove this `Project bootstrap` section from the project README. Then follow `Running` below.
46 |
47 | ## Running
48 | ### Tools
49 | - Setup [editorconfig](http://editorconfig.org/), [prospector](https://prospector.landscape.io/en/master/) and [ESLint](http://eslint.org/) in the text editor you will use to develop.
50 |
51 | ### Setup
52 | - Inside the `backend` folder, do the following:
53 | - Create a copy of `{{project_name}}/settings/local.py.example`:
54 | `cp {{project_name}}/settings/local.py.example {{project_name}}/settings/local.py`
55 | - Create a copy of `.env.example`:
56 | `cp .env.example .env`
57 |
58 | ### If you are using Docker:
59 | - Open the `/backend/.env` file on a text editor and uncomment the line `DATABASE_URL=postgres://{{project_name}}:password@db:5432/{{project_name}}`
60 | - Open a new command line window and go to the project's directory
61 | - Run the initial setup:
62 | `make docker_setup`
63 | - Create the migrations for `users` app:
64 | `make docker_makemigrations`
65 | - Run the migrations:
66 | `make docker_migrate`
67 | - Run the project:
68 | `make docker_up`
69 | - Access `http://localhost:8000` on your browser and the project should be running there
70 | - When you run `make docker_up`, some containers are spinned up (frontend, backend, database, etc) and each one will be running on a different port
71 | - The container with the React app uses port 3000. However, if you try accessing it on your browser, the app won't appear there and you'll probably see a blank page with the "Cannot GET /" error
72 | - This happens because the container responsible for displaying the whole application is the Django app one (running on port 8000). The frontend container is responsible for providing a bundle with its assets for [django-webpack-loader](https://github.com/django-webpack/django-webpack-loader) to consume and render them on a Django template
73 | - To access the logs for each service, run:
74 | `make docker_logs 63 | This is a test title 64 |
65 |68 | Color Changer App 69 |
70 |71 | Check this example app: change the color to see it reflected in the text next to it. 72 |
73 |
76 |
106 |
110 |