This commit is contained in:
Elijah Lucian 2021-03-16 20:15:33 -06:00
parent 90b00b4736
commit 8a9604966c
35 changed files with 29279 additions and 0 deletions

View File

@ -1,2 +1,22 @@
# mvp-django-react # mvp-django-react
An MVP boilerplate for a django / react app. An MVP boilerplate for a django / react app.
# Boilerplate Features
- Authentication
- User Table (username, email, password)
# Extras
- dockerized
# Frontend
- [x] useGet hook
- [x] User context
- [x] auth api
- [ ] user crud api (new user flow)
- [ ] socket hook
# Backend
- user CRUD
- login / logout / forgot password
- serve static index (prod)

23
frontend/.gitignore vendored Normal file
View File

@ -0,0 +1,23 @@
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
# dependencies
/node_modules
/.pnp
.pnp.js
# testing
/coverage
# production
/build
# misc
.DS_Store
.env.local
.env.development.local
.env.test.local
.env.production.local
npm-debug.log*
yarn-debug.log*
yarn-error.log*

5
frontend/.prettierrc Normal file
View File

@ -0,0 +1,5 @@
{
"semi": false,
"singleQuote": true,
"trailingComma": "all"
}

46
frontend/README.md Normal file
View File

@ -0,0 +1,46 @@
# Getting Started with Create React App
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
## Available Scripts
In the project directory, you can run:
### `yarn start`
Runs the app in the development mode.\
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
The page will reload if you make edits.\
You will also see any lint errors in the console.
### `yarn test`
Launches the test runner in the interactive watch mode.\
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
### `yarn build`
Builds the app for production to the `build` folder.\
It correctly bundles React in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.\
Your app is ready to be deployed!
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
### `yarn eject`
**Note: this is a one-way operation. Once you `eject`, you cant go back!**
If you arent satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point youre on your own.
You dont have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldnt feel obligated to use this feature. However we understand that this tool wouldnt be useful if you couldnt customize it when you are ready for it.
## Learn More
You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
To learn React, check out the [React documentation](https://reactjs.org/).

17125
frontend/package-lock.json generated Normal file

File diff suppressed because it is too large Load Diff

50
frontend/package.json Normal file
View File

@ -0,0 +1,50 @@
{
"name": "frontend",
"version": "0.1.0",
"private": true,
"dependencies": {
"@testing-library/jest-dom": "^5.11.4",
"@testing-library/react": "^11.1.0",
"@testing-library/user-event": "^12.1.10",
"@types/jest": "^26.0.15",
"@types/node": "^12.0.0",
"@types/react": "^17.0.0",
"@types/react-dom": "^17.0.0",
"antd": "^4.14.0",
"axios": "^0.21.1",
"node-sass": "^5.0.0",
"react": "^17.0.1",
"react-dom": "^17.0.1",
"react-router-dom": "^5.2.0",
"react-scripts": "4.0.3",
"typescript": "^4.1.2",
"web-vitals": "^1.0.1"
},
"scripts": {
"start": "react-scripts start",
"build": "react-scripts build",
"test": "react-scripts test",
"eject": "react-scripts eject"
},
"eslintConfig": {
"extends": [
"react-app",
"react-app/jest"
]
},
"browserslist": {
"production": [
">0.2%",
"not dead",
"not op_mini all"
],
"development": [
"last 1 chrome version",
"last 1 firefox version",
"last 1 safari version"
]
},
"devDependencies": {
"@types/react-router-dom": "^5.1.7"
}
}

BIN
frontend/public/favicon.ico Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.8 KiB

View File

@ -0,0 +1,40 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<link rel="icon" href="%PUBLIC_URL%/favicon.ico" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="theme-color" content="#000000" />
<meta name="description" content="The emmest of vee pees" />
<link rel="apple-touch-icon" href="%PUBLIC_URL%/logo192.png" />
<!--
manifest.json provides metadata used when your web app is installed on a
user's mobile device or desktop. See https://developers.google.com/web/fundamentals/web-app-manifest/
-->
<link rel="manifest" href="%PUBLIC_URL%/manifest.json" />
<!--
Notice the use of %PUBLIC_URL% in the tags above.
It will be replaced with the URL of the `public` folder during the build.
Only files inside the `public` folder can be referenced from the HTML.
Unlike "/favicon.ico" or "favicon.ico", "%PUBLIC_URL%/favicon.ico" will
work correctly both with client-side routing and a non-root public URL.
Learn how to configure a non-root public URL by running `npm run build`.
-->
<title>MVP Django React</title>
</head>
<body>
<noscript>You need to enable JavaScript to run this app.</noscript>
<div id="root"></div>
<!--
This HTML file is a template.
If you open it directly in the browser, you will see an empty page.
You can add webfonts, meta tags, or analytics to this file.
The build step will place the bundled scripts into the <body> tag.
To begin the development, run `npm start` or `yarn start`.
To create a production bundle, use `npm run build` or `yarn build`.
-->
</body>
</html>

BIN
frontend/public/logo192.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.2 KiB

BIN
frontend/public/logo512.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 9.4 KiB

View File

@ -0,0 +1,25 @@
{
"short_name": "React App",
"name": "Create React App Sample",
"icons": [
{
"src": "favicon.ico",
"sizes": "64x64 32x32 24x24 16x16",
"type": "image/x-icon"
},
{
"src": "logo192.png",
"type": "image/png",
"sizes": "192x192"
},
{
"src": "logo512.png",
"type": "image/png",
"sizes": "512x512"
}
],
"start_url": ".",
"display": "standalone",
"theme_color": "#000000",
"background_color": "#ffffff"
}

View File

@ -0,0 +1,3 @@
# https://www.robotstxt.org/robotstxt.html
User-agent: *
Disallow:

17
frontend/src/App.tsx Normal file
View File

@ -0,0 +1,17 @@
import React from 'react'
import { BrowserRouter } from 'react-router-dom'
import { UserContextProvider } from './contexts/UserContext'
import { CoreLayout } from './layout/CoreLayout'
import './scss/App.scss'
function App() {
return (
<BrowserRouter>
<UserContextProvider>
<CoreLayout />
</UserContextProvider>
</BrowserRouter>
)
}
export default App

41
frontend/src/api/index.ts Normal file
View File

@ -0,0 +1,41 @@
import { message } from 'antd'
import axios from 'axios'
import { User } from '../types'
import { mockUser } from '../data'
import { JWT, getJWT, setHeaders, setJWT, wipeJWT } from '../utils/jwt'
const dev = process.env.NODE_ENV === 'development'
export const logIn = async (username: string, password: string) => {
if (dev) return mockUser
try {
const { data: jwt } = await axios.post<JWT>(`/api/login`, {
username,
password,
})
setJWT(jwt)
const user = await getLoggedInUser()
return user
} catch (err) {
console.log(err)
message.error('Error logging in!')
}
}
export const logOut = () => {
wipeJWT()
// axios -> delete session?
}
export const getLoggedInUser = async () => {
if (dev) return mockUser
const jwt = getJWT()
if (!jwt) throw new Error('User not logged in') // TODO: decorator
const { data } = await axios.get<User>(`/users/${jwt.id}`, setHeaders())
return data
}

3
frontend/src/config.ts Normal file
View File

@ -0,0 +1,3 @@
const namespace = 'mvp-brudda-bwa-bwa'
export { namespace }

View File

@ -0,0 +1,86 @@
import React, {
createContext,
useContext,
useState,
useEffect,
Dispatch,
SetStateAction,
} from 'react'
import { message } from 'antd'
import { useHistory } from 'react-router'
import { User } from '../types'
import { getLoggedInUser, logIn, logOut } from '../api'
type Props = {
children: React.ReactNode
}
type Context = {
user: User | null
setUser: Dispatch<SetStateAction<User | null>>
handleLogin: (username: string, password: string) => void
handleLogout: () => void
}
const UserContext = createContext<Context | null>(null)
export const UserContextProvider = ({ children }: Props) => {
const history = useHistory()
const [user, setUser] = useState<User | null>(null)
useEffect(() => {
const login = async () => {
try {
const user = await getLoggedInUser()
if (!user) throw new Error()
setUser(user)
message.success(`logged in as ${user?.username}`, 0.5)
} catch {
// this can possibly be handled better
message.error('Login Failed')
window.location.reload()
}
}
login()
}, [])
const handleLogin = async (username: string, password: string) => {
try {
const user = await logIn(username, password)
if (!user) throw new Error('Problem logging in!')
setUser(user)
message.success(`logged in as ${user?.username}`, 0.5)
} catch (err) {
message.error('Login Failed!')
}
}
const handleLogout = async () => {
await logOut()
setUser(null)
message.success('logged out!', 0.5)
history.push('/')
}
return (
<UserContext.Provider value={{ user, setUser, handleLogin, handleLogout }}>
{children}
</UserContext.Provider>
)
}
export const useUserContext = () => {
const context = useContext(UserContext)
if (!context)
throw new Error(
'UserContext must be called from within the UserContextProvider',
)
return context
}

View File

@ -0,0 +1,6 @@
import { User } from '../types'
export const mockUser: User = {
username: 'TestUser42',
id: '4242-4242-4242-4242',
}

View File

@ -0,0 +1,53 @@
import { useCallback, useEffect, useState } from 'react'
import Axios from 'axios'
import { setHeaders } from '../utils/jwt'
type Options = {
subscribe: boolean
}
export type Response<T> =
| {
data: T
loading: false
error: false
refetch: () => void
}
| {
data: null
loading: false
error: true
refetch: () => void
}
| {
data: null
loading: true
error: false
refetch: () => void
}
export const useGet = <T>(path: string, options?: Options): Response<T> => {
const [data, setData] = useState<T | null>(null)
const [error, setError] = useState(false)
const get = useCallback(async () => {
try {
const { data } = await Axios.get<T>(`/api/${path}`, { ...setHeaders() })
setData(data)
} catch (err) {
setError(true)
}
}, [path])
useEffect(() => {
get()
}, [get])
if (data) {
return { data, loading: false, error: false, refetch: get }
} else if (error) {
return { data: null, loading: false, error: true, refetch: get }
} else {
return { data: null, loading: true, error: false, refetch: get }
}
}

15
frontend/src/index.css Normal file
View File

@ -0,0 +1,15 @@
@import '~antd/dist/antd.dark.css';
body {
margin: 0;
font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', 'Roboto', 'Oxygen',
'Ubuntu', 'Cantarell', 'Fira Sans', 'Droid Sans', 'Helvetica Neue',
sans-serif;
-webkit-font-smoothing: antialiased;
-moz-osx-font-smoothing: grayscale;
}
code {
font-family: source-code-pro, Menlo, Monaco, Consolas, 'Courier New',
monospace;
}

18
frontend/src/index.tsx Normal file
View File

@ -0,0 +1,18 @@
import React from 'react'
import ReactDOM from 'react-dom'
import App from './App'
import reportWebVitals from './reportWebVitals'
import './index.css'
ReactDOM.render(
<React.StrictMode>
<App />
</React.StrictMode>,
document.getElementById('root'),
)
// If you want to start measuring performance in your app, pass a function
// to log results (for example: reportWebVitals(console.log))
// or send to an analytics endpoint. Learn more: https://bit.ly/CRA-vitals
reportWebVitals()

View File

@ -0,0 +1,43 @@
import React from 'react'
import { Avatar, Typography } from 'antd'
import { Header } from 'antd/lib/layout/layout'
import { User } from '../types'
import { Link } from 'react-router-dom'
export type NavRoute = {
path: string
component: any
label: string
exact?: boolean
}
type Props = {
user: User | null
routes?: NavRoute[]
}
export const AppHeader = ({ user, routes }: Props) => {
// Unauthed Header
if (!user)
return (
<Header className="app-header">
<Typography.Title level={3}>MVP Django React! 🤠</Typography.Title>
</Header>
)
// Authed Header
return (
<Header className="app-header">
<div className="header-left">
<Typography.Title level={3}>MVP Django React! 🤠</Typography.Title>
{routes?.map((route) => (
<Link to={route.path}>{route.label}</Link>
))}
</div>
<div className="header-right">
<Typography.Paragraph>Welcome, {user.username}!!</Typography.Paragraph>
<Avatar />
</div>
</Header>
)
}

View File

@ -0,0 +1,39 @@
import React from 'react'
import { Layout } from 'antd'
import { useUserContext } from '../contexts/UserContext'
import { Login } from '../pages/Login'
import { Route, Switch } from 'react-router'
import { Dashboard } from '../pages/Dashboard'
import { NavRoute, AppHeader } from './AppHeader'
import { Profile } from '../pages/Profile'
export const CoreLayout = () => {
const { user } = useUserContext()
const routes: NavRoute[] = [
{ exact: true, path: '/', label: 'Dashboard', component: Dashboard },
{ path: '/profile', label: 'Profile', component: Profile },
]
if (!user)
return (
<Layout className="layout">
<AppHeader user={user} />
<Login />
</Layout>
)
// header, sidebar, avatar?
return (
<Layout className="layout">
<AppHeader user={user} routes={routes} />
<Switch>
<Layout.Content>
{routes.map(({ exact, path, component }) => (
<Route exact={exact} key={path} path={path} component={component} />
))}
</Layout.Content>
</Switch>
</Layout>
)
}

1
frontend/src/logo.svg Normal file
View File

@ -0,0 +1 @@
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 841.9 595.3"><g fill="#61DAFB"><path d="M666.3 296.5c0-32.5-40.7-63.3-103.1-82.4 14.4-63.6 8-114.2-20.2-130.4-6.5-3.8-14.1-5.6-22.4-5.6v22.3c4.6 0 8.3.9 11.4 2.6 13.6 7.8 19.5 37.5 14.9 75.7-1.1 9.4-2.9 19.3-5.1 29.4-19.6-4.8-41-8.5-63.5-10.9-13.5-18.5-27.5-35.3-41.6-50 32.6-30.3 63.2-46.9 84-46.9V78c-27.5 0-63.5 19.6-99.9 53.6-36.4-33.8-72.4-53.2-99.9-53.2v22.3c20.7 0 51.4 16.5 84 46.6-14 14.7-28 31.4-41.3 49.9-22.6 2.4-44 6.1-63.6 11-2.3-10-4-19.7-5.2-29-4.7-38.2 1.1-67.9 14.6-75.8 3-1.8 6.9-2.6 11.5-2.6V78.5c-8.4 0-16 1.8-22.6 5.6-28.1 16.2-34.4 66.7-19.9 130.1-62.2 19.2-102.7 49.9-102.7 82.3 0 32.5 40.7 63.3 103.1 82.4-14.4 63.6-8 114.2 20.2 130.4 6.5 3.8 14.1 5.6 22.5 5.6 27.5 0 63.5-19.6 99.9-53.6 36.4 33.8 72.4 53.2 99.9 53.2 8.4 0 16-1.8 22.6-5.6 28.1-16.2 34.4-66.7 19.9-130.1 62-19.1 102.5-49.9 102.5-82.3zm-130.2-66.7c-3.7 12.9-8.3 26.2-13.5 39.5-4.1-8-8.4-16-13.1-24-4.6-8-9.5-15.8-14.4-23.4 14.2 2.1 27.9 4.7 41 7.9zm-45.8 106.5c-7.8 13.5-15.8 26.3-24.1 38.2-14.9 1.3-30 2-45.2 2-15.1 0-30.2-.7-45-1.9-8.3-11.9-16.4-24.6-24.2-38-7.6-13.1-14.5-26.4-20.8-39.8 6.2-13.4 13.2-26.8 20.7-39.9 7.8-13.5 15.8-26.3 24.1-38.2 14.9-1.3 30-2 45.2-2 15.1 0 30.2.7 45 1.9 8.3 11.9 16.4 24.6 24.2 38 7.6 13.1 14.5 26.4 20.8 39.8-6.3 13.4-13.2 26.8-20.7 39.9zm32.3-13c5.4 13.4 10 26.8 13.8 39.8-13.1 3.2-26.9 5.9-41.2 8 4.9-7.7 9.8-15.6 14.4-23.7 4.6-8 8.9-16.1 13-24.1zM421.2 430c-9.3-9.6-18.6-20.3-27.8-32 9 .4 18.2.7 27.5.7 9.4 0 18.7-.2 27.8-.7-9 11.7-18.3 22.4-27.5 32zm-74.4-58.9c-14.2-2.1-27.9-4.7-41-7.9 3.7-12.9 8.3-26.2 13.5-39.5 4.1 8 8.4 16 13.1 24 4.7 8 9.5 15.8 14.4 23.4zM420.7 163c9.3 9.6 18.6 20.3 27.8 32-9-.4-18.2-.7-27.5-.7-9.4 0-18.7.2-27.8.7 9-11.7 18.3-22.4 27.5-32zm-74 58.9c-4.9 7.7-9.8 15.6-14.4 23.7-4.6 8-8.9 16-13 24-5.4-13.4-10-26.8-13.8-39.8 13.1-3.1 26.9-5.8 41.2-7.9zm-90.5 125.2c-35.4-15.1-58.3-34.9-58.3-50.6 0-15.7 22.9-35.6 58.3-50.6 8.6-3.7 18-7 27.7-10.1 5.7 19.6 13.2 40 22.5 60.9-9.2 20.8-16.6 41.1-22.2 60.6-9.9-3.1-19.3-6.5-28-10.2zM310 490c-13.6-7.8-19.5-37.5-14.9-75.7 1.1-9.4 2.9-19.3 5.1-29.4 19.6 4.8 41 8.5 63.5 10.9 13.5 18.5 27.5 35.3 41.6 50-32.6 30.3-63.2 46.9-84 46.9-4.5-.1-8.3-1-11.3-2.7zm237.2-76.2c4.7 38.2-1.1 67.9-14.6 75.8-3 1.8-6.9 2.6-11.5 2.6-20.7 0-51.4-16.5-84-46.6 14-14.7 28-31.4 41.3-49.9 22.6-2.4 44-6.1 63.6-11 2.3 10.1 4.1 19.8 5.2 29.1zm38.5-66.7c-8.6 3.7-18 7-27.7 10.1-5.7-19.6-13.2-40-22.5-60.9 9.2-20.8 16.6-41.1 22.2-60.6 9.9 3.1 19.3 6.5 28.1 10.2 35.4 15.1 58.3 34.9 58.3 50.6-.1 15.7-23 35.6-58.4 50.6zM320.8 78.4z"/><circle cx="420.9" cy="296.5" r="45.7"/><path d="M520.5 78.1z"/></g></svg>

After

Width:  |  Height:  |  Size: 2.6 KiB

View File

@ -0,0 +1,8 @@
import React from 'react'
import { RouteChildrenProps } from 'react-router'
type Props = RouteChildrenProps & {}
export const Dashboard = (_: Props) => {
return <p>a dashboard</p>
}

View File

@ -0,0 +1,31 @@
import React, { FormEvent, useState } from 'react'
import { useUserContext } from '../contexts/UserContext'
export const Login = () => {
const { handleLogin } = useUserContext()
const [username, setUsername] = useState('')
const [password, setPassword] = useState('')
const handleSubmit = (e: FormEvent) => {
e.preventDefault()
handleLogin(username, password)
}
return (
<form onSubmit={handleSubmit}>
<input
onChange={(e) => setUsername(e.target.value)}
type="text"
value={username}
/>
<input
onChange={(e) => setPassword(e.target.value)}
type="text"
value={password}
/>
<button type="submit">Login!</button>
</form>
)
}

View File

@ -0,0 +1,7 @@
import React from 'react'
type Props = {}
export const Profile = (props: Props) => {
return <p>Look, A user profile!</p>
}

1
frontend/src/react-app-env.d.ts vendored Normal file
View File

@ -0,0 +1 @@
/// <reference types="react-scripts" />

View File

@ -0,0 +1,15 @@
import { ReportHandler } from 'web-vitals';
const reportWebVitals = (onPerfEntry?: ReportHandler) => {
if (onPerfEntry && onPerfEntry instanceof Function) {
import('web-vitals').then(({ getCLS, getFID, getFCP, getLCP, getTTFB }) => {
getCLS(onPerfEntry);
getFID(onPerfEntry);
getFCP(onPerfEntry);
getLCP(onPerfEntry);
getTTFB(onPerfEntry);
});
}
};
export default reportWebVitals;

View File

@ -0,0 +1,39 @@
.ant-layout-header.app-header {
display: flex;
flex-direction: row;
justify-content: space-between;
vertical-align: middle;
padding: 0 1rem;
a {
font-size: 1.2rem;
font-weight: bold;
}
div {
display: flex;
vertical-align: middle;
height: 100%;
* {
margin: auto 0.5rem;
}
}
h3.ant-typography {
margin: auto 0 !important;
}
div.ant-typography {
font-size: 1.6rem;
}
}
.ant-layout.layout {
min-height: 100vh;
// background-color: #444;
// color: white;
}

View File

@ -0,0 +1,5 @@
// jest-dom adds custom jest matchers for asserting on DOM nodes.
// allows you to do things like:
// expect(element).toHaveTextContent(/react/i)
// learn more: https://github.com/testing-library/jest-dom
import '@testing-library/jest-dom';

View File

@ -0,0 +1,4 @@
export type User = {
id: string;
username: string;
};

45
frontend/src/utils/jwt.ts Normal file
View File

@ -0,0 +1,45 @@
import { namespace } from '../config'
export type JWT = {
id: string
token: string
exp: number
}
const getJWT = (): null | JWT => {
const id = window.localStorage.getItem(`${namespace}-id`)
const token = window.localStorage.getItem(`${namespace}-token`)
const exp = parseInt(window.localStorage.getItem(`${namespace}-exp`) || '')
if (!id || !token || exp < +new Date()) {
wipeJWT()
return null
}
return {
id,
token,
exp,
}
}
const setJWT = (token: JWT): void => {
window.localStorage.setItem(`${namespace}-id`, token.id)
window.localStorage.setItem(`${namespace}-token`, token.token)
window.localStorage.setItem(`${namespace}-exp`, token.exp + '')
}
const wipeJWT = (): void => {
window.localStorage.removeItem(`${namespace}-id`)
window.localStorage.removeItem(`${namespace}-token`)
window.localStorage.removeItem(`${namespace}-exp`)
}
const setHeaders = () => {
const token = window.localStorage.getItem(`${namespace}-token`)
if (!token) throw new Error('Token gone!')
return { headers: { Authorization: token } }
}
export { getJWT, setJWT, wipeJWT, setHeaders }

26
frontend/tsconfig.json Normal file
View File

@ -0,0 +1,26 @@
{
"compilerOptions": {
"target": "es5",
"lib": [
"dom",
"dom.iterable",
"esnext"
],
"allowJs": true,
"skipLibCheck": true,
"esModuleInterop": true,
"allowSyntheticDefaultImports": true,
"strict": true,
"forceConsistentCasingInFileNames": true,
"noFallthroughCasesInSwitch": true,
"module": "esnext",
"moduleResolution": "node",
"resolveJsonModule": true,
"isolatedModules": true,
"noEmit": true,
"jsx": "react-jsx"
},
"include": [
"src"
]
}

11439
frontend/yarn.lock Normal file

File diff suppressed because it is too large Load Diff

0
server/.keep Normal file
View File