initial, express-typescript config, react-vite created
This commit is contained in:
Mikayla Dobson
24
.gitignore
vendored
Normal file
24
.gitignore
vendored
Normal file
@@ -0,0 +1,24 @@
|
|||||||
|
# Logs
|
||||||
|
logs
|
||||||
|
*.log
|
||||||
|
npm-debug.log*
|
||||||
|
yarn-debug.log*
|
||||||
|
yarn-error.log*
|
||||||
|
pnpm-debug.log*
|
||||||
|
lerna-debug.log*
|
||||||
|
|
||||||
|
node_modules
|
||||||
|
dist
|
||||||
|
dist-ssr
|
||||||
|
*.local
|
||||||
|
|
||||||
|
# Editor directories and files
|
||||||
|
.vscode/*
|
||||||
|
!.vscode/extensions.json
|
||||||
|
.idea
|
||||||
|
.DS_Store
|
||||||
|
*.suo
|
||||||
|
*.ntvs*
|
||||||
|
*.njsproj
|
||||||
|
*.sln
|
||||||
|
*.sw?
|
||||||
15
README.md
Normal file
15
README.md
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
# RECIPIN RECIPE MANAGER
|
||||||
|
|
||||||
|
A concept developed by Mikayla Dobson
|
||||||
|
|
||||||
|
## Simple Recipe Management and Sharing for the Home
|
||||||
|
|
||||||
|
Keep all your most-used recipes handy in your own personal collection.
|
||||||
|
|
||||||
|
## Share Your Recipe Collection
|
||||||
|
|
||||||
|
Share your personal collection with your friends and family, and subscribe to their collections.
|
||||||
|
|
||||||
|
## Build Shopping Lists Directly from Your Recipes
|
||||||
|
|
||||||
|
Lay out your meal plan for the week, and let Recipin automatically generate your grocery list, ingredient by ingredient.
|
||||||
24
client/.gitignore
vendored
Normal file
24
client/.gitignore
vendored
Normal file
@@ -0,0 +1,24 @@
|
|||||||
|
# Logs
|
||||||
|
logs
|
||||||
|
*.log
|
||||||
|
npm-debug.log*
|
||||||
|
yarn-debug.log*
|
||||||
|
yarn-error.log*
|
||||||
|
pnpm-debug.log*
|
||||||
|
lerna-debug.log*
|
||||||
|
|
||||||
|
node_modules
|
||||||
|
dist
|
||||||
|
dist-ssr
|
||||||
|
*.local
|
||||||
|
|
||||||
|
# Editor directories and files
|
||||||
|
.vscode/*
|
||||||
|
!.vscode/extensions.json
|
||||||
|
.idea
|
||||||
|
.DS_Store
|
||||||
|
*.suo
|
||||||
|
*.ntvs*
|
||||||
|
*.njsproj
|
||||||
|
*.sln
|
||||||
|
*.sw?
|
||||||
13
client/index.html
Normal file
13
client/index.html
Normal file
@@ -0,0 +1,13 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html lang="en">
|
||||||
|
<head>
|
||||||
|
<meta charset="UTF-8" />
|
||||||
|
<link rel="icon" type="image/svg+xml" href="/vite.svg" />
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||||
|
<title>Vite + React + TS</title>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<div id="root"></div>
|
||||||
|
<script type="module" src="/src/main.tsx"></script>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
2373
client/package-lock.json
generated
Normal file
2373
client/package-lock.json
generated
Normal file
File diff suppressed because it is too large
Load Diff
22
client/package.json
Normal file
22
client/package.json
Normal file
@@ -0,0 +1,22 @@
|
|||||||
|
{
|
||||||
|
"name": "client",
|
||||||
|
"private": true,
|
||||||
|
"version": "0.0.0",
|
||||||
|
"type": "module",
|
||||||
|
"scripts": {
|
||||||
|
"dev": "vite",
|
||||||
|
"build": "tsc && vite build",
|
||||||
|
"preview": "vite preview"
|
||||||
|
},
|
||||||
|
"dependencies": {
|
||||||
|
"react": "^18.2.0",
|
||||||
|
"react-dom": "^18.2.0"
|
||||||
|
},
|
||||||
|
"devDependencies": {
|
||||||
|
"@types/react": "^18.0.24",
|
||||||
|
"@types/react-dom": "^18.0.8",
|
||||||
|
"@vitejs/plugin-react": "^2.2.0",
|
||||||
|
"typescript": "^4.6.4",
|
||||||
|
"vite": "^3.2.3"
|
||||||
|
}
|
||||||
|
}
|
||||||
1
client/public/vite.svg
Normal file
1
client/public/vite.svg
Normal file
@@ -0,0 +1 @@
|
|||||||
|
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" class="iconify iconify--logos" width="31.88" height="32" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 257"><defs><linearGradient id="IconifyId1813088fe1fbc01fb466" x1="-.828%" x2="57.636%" y1="7.652%" y2="78.411%"><stop offset="0%" stop-color="#41D1FF"></stop><stop offset="100%" stop-color="#BD34FE"></stop></linearGradient><linearGradient id="IconifyId1813088fe1fbc01fb467" x1="43.376%" x2="50.316%" y1="2.242%" y2="89.03%"><stop offset="0%" stop-color="#FFEA83"></stop><stop offset="8.333%" stop-color="#FFDD35"></stop><stop offset="100%" stop-color="#FFA800"></stop></linearGradient></defs><path fill="url(#IconifyId1813088fe1fbc01fb466)" d="M255.153 37.938L134.897 252.976c-2.483 4.44-8.862 4.466-11.382.048L.875 37.958c-2.746-4.814 1.371-10.646 6.827-9.67l120.385 21.517a6.537 6.537 0 0 0 2.322-.004l117.867-21.483c5.438-.991 9.574 4.796 6.877 9.62Z"></path><path fill="url(#IconifyId1813088fe1fbc01fb467)" d="M185.432.063L96.44 17.501a3.268 3.268 0 0 0-2.634 3.014l-5.474 92.456a3.268 3.268 0 0 0 3.997 3.378l24.777-5.718c2.318-.535 4.413 1.507 3.936 3.838l-7.361 36.047c-.495 2.426 1.782 4.5 4.151 3.78l15.304-4.649c2.372-.72 4.652 1.36 4.15 3.788l-11.698 56.621c-.732 3.542 3.979 5.473 5.943 2.437l1.313-2.028l72.516-144.72c1.215-2.423-.88-5.186-3.54-4.672l-25.505 4.922c-2.396.462-4.435-1.77-3.759-4.114l16.646-57.705c.677-2.35-1.37-4.583-3.769-4.113Z"></path></svg>
|
||||||
|
After Width: | Height: | Size: 1.5 KiB |
41
client/src/App.css
Normal file
41
client/src/App.css
Normal file
@@ -0,0 +1,41 @@
|
|||||||
|
#root {
|
||||||
|
max-width: 1280px;
|
||||||
|
margin: 0 auto;
|
||||||
|
padding: 2rem;
|
||||||
|
text-align: center;
|
||||||
|
}
|
||||||
|
|
||||||
|
.logo {
|
||||||
|
height: 6em;
|
||||||
|
padding: 1.5em;
|
||||||
|
will-change: filter;
|
||||||
|
}
|
||||||
|
.logo:hover {
|
||||||
|
filter: drop-shadow(0 0 2em #646cffaa);
|
||||||
|
}
|
||||||
|
.logo.react:hover {
|
||||||
|
filter: drop-shadow(0 0 2em #61dafbaa);
|
||||||
|
}
|
||||||
|
|
||||||
|
@keyframes logo-spin {
|
||||||
|
from {
|
||||||
|
transform: rotate(0deg);
|
||||||
|
}
|
||||||
|
to {
|
||||||
|
transform: rotate(360deg);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@media (prefers-reduced-motion: no-preference) {
|
||||||
|
a:nth-of-type(2) .logo {
|
||||||
|
animation: logo-spin infinite 20s linear;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
.card {
|
||||||
|
padding: 2em;
|
||||||
|
}
|
||||||
|
|
||||||
|
.read-the-docs {
|
||||||
|
color: #888;
|
||||||
|
}
|
||||||
34
client/src/App.tsx
Normal file
34
client/src/App.tsx
Normal file
@@ -0,0 +1,34 @@
|
|||||||
|
import { useState } from 'react'
|
||||||
|
import reactLogo from './assets/react.svg'
|
||||||
|
import './App.css'
|
||||||
|
|
||||||
|
function App() {
|
||||||
|
const [count, setCount] = useState(0)
|
||||||
|
|
||||||
|
return (
|
||||||
|
<div className="App">
|
||||||
|
<div>
|
||||||
|
<a href="https://vitejs.dev" target="_blank">
|
||||||
|
<img src="/vite.svg" className="logo" alt="Vite logo" />
|
||||||
|
</a>
|
||||||
|
<a href="https://reactjs.org" target="_blank">
|
||||||
|
<img src={reactLogo} className="logo react" alt="React logo" />
|
||||||
|
</a>
|
||||||
|
</div>
|
||||||
|
<h1>Vite + React</h1>
|
||||||
|
<div className="card">
|
||||||
|
<button onClick={() => setCount((count) => count + 1)}>
|
||||||
|
count is {count}
|
||||||
|
</button>
|
||||||
|
<p>
|
||||||
|
Edit <code>src/App.tsx</code> and save to test HMR
|
||||||
|
</p>
|
||||||
|
</div>
|
||||||
|
<p className="read-the-docs">
|
||||||
|
Click on the Vite and React logos to learn more
|
||||||
|
</p>
|
||||||
|
</div>
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
export default App
|
||||||
1
client/src/assets/react.svg
Normal file
1
client/src/assets/react.svg
Normal file
@@ -0,0 +1 @@
|
|||||||
|
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" class="iconify iconify--logos" width="35.93" height="32" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 228"><path fill="#00D8FF" d="M210.483 73.824a171.49 171.49 0 0 0-8.24-2.597c.465-1.9.893-3.777 1.273-5.621c6.238-30.281 2.16-54.676-11.769-62.708c-13.355-7.7-35.196.329-57.254 19.526a171.23 171.23 0 0 0-6.375 5.848a155.866 155.866 0 0 0-4.241-3.917C100.759 3.829 77.587-4.822 63.673 3.233C50.33 10.957 46.379 33.89 51.995 62.588a170.974 170.974 0 0 0 1.892 8.48c-3.28.932-6.445 1.924-9.474 2.98C17.309 83.498 0 98.307 0 113.668c0 15.865 18.582 31.778 46.812 41.427a145.52 145.52 0 0 0 6.921 2.165a167.467 167.467 0 0 0-2.01 9.138c-5.354 28.2-1.173 50.591 12.134 58.266c13.744 7.926 36.812-.22 59.273-19.855a145.567 145.567 0 0 0 5.342-4.923a168.064 168.064 0 0 0 6.92 6.314c21.758 18.722 43.246 26.282 56.54 18.586c13.731-7.949 18.194-32.003 12.4-61.268a145.016 145.016 0 0 0-1.535-6.842c1.62-.48 3.21-.974 4.76-1.488c29.348-9.723 48.443-25.443 48.443-41.52c0-15.417-17.868-30.326-45.517-39.844Zm-6.365 70.984c-1.4.463-2.836.91-4.3 1.345c-3.24-10.257-7.612-21.163-12.963-32.432c5.106-11 9.31-21.767 12.459-31.957c2.619.758 5.16 1.557 7.61 2.4c23.69 8.156 38.14 20.213 38.14 29.504c0 9.896-15.606 22.743-40.946 31.14Zm-10.514 20.834c2.562 12.94 2.927 24.64 1.23 33.787c-1.524 8.219-4.59 13.698-8.382 15.893c-8.067 4.67-25.32-1.4-43.927-17.412a156.726 156.726 0 0 1-6.437-5.87c7.214-7.889 14.423-17.06 21.459-27.246c12.376-1.098 24.068-2.894 34.671-5.345a134.17 134.17 0 0 1 1.386 6.193ZM87.276 214.515c-7.882 2.783-14.16 2.863-17.955.675c-8.075-4.657-11.432-22.636-6.853-46.752a156.923 156.923 0 0 1 1.869-8.499c10.486 2.32 22.093 3.988 34.498 4.994c7.084 9.967 14.501 19.128 21.976 27.15a134.668 134.668 0 0 1-4.877 4.492c-9.933 8.682-19.886 14.842-28.658 17.94ZM50.35 144.747c-12.483-4.267-22.792-9.812-29.858-15.863c-6.35-5.437-9.555-10.836-9.555-15.216c0-9.322 13.897-21.212 37.076-29.293c2.813-.98 5.757-1.905 8.812-2.773c3.204 10.42 7.406 21.315 12.477 32.332c-5.137 11.18-9.399 22.249-12.634 32.792a134.718 134.718 0 0 1-6.318-1.979Zm12.378-84.26c-4.811-24.587-1.616-43.134 6.425-47.789c8.564-4.958 27.502 2.111 47.463 19.835a144.318 144.318 0 0 1 3.841 3.545c-7.438 7.987-14.787 17.08-21.808 26.988c-12.04 1.116-23.565 2.908-34.161 5.309a160.342 160.342 0 0 1-1.76-7.887Zm110.427 27.268a347.8 347.8 0 0 0-7.785-12.803c8.168 1.033 15.994 2.404 23.343 4.08c-2.206 7.072-4.956 14.465-8.193 22.045a381.151 381.151 0 0 0-7.365-13.322Zm-45.032-43.861c5.044 5.465 10.096 11.566 15.065 18.186a322.04 322.04 0 0 0-30.257-.006c4.974-6.559 10.069-12.652 15.192-18.18ZM82.802 87.83a323.167 323.167 0 0 0-7.227 13.238c-3.184-7.553-5.909-14.98-8.134-22.152c7.304-1.634 15.093-2.97 23.209-3.984a321.524 321.524 0 0 0-7.848 12.897Zm8.081 65.352c-8.385-.936-16.291-2.203-23.593-3.793c2.26-7.3 5.045-14.885 8.298-22.6a321.187 321.187 0 0 0 7.257 13.246c2.594 4.48 5.28 8.868 8.038 13.147Zm37.542 31.03c-5.184-5.592-10.354-11.779-15.403-18.433c4.902.192 9.899.29 14.978.29c5.218 0 10.376-.117 15.453-.343c-4.985 6.774-10.018 12.97-15.028 18.486Zm52.198-57.817c3.422 7.8 6.306 15.345 8.596 22.52c-7.422 1.694-15.436 3.058-23.88 4.071a382.417 382.417 0 0 0 7.859-13.026a347.403 347.403 0 0 0 7.425-13.565Zm-16.898 8.101a358.557 358.557 0 0 1-12.281 19.815a329.4 329.4 0 0 1-23.444.823c-7.967 0-15.716-.248-23.178-.732a310.202 310.202 0 0 1-12.513-19.846h.001a307.41 307.41 0 0 1-10.923-20.627a310.278 310.278 0 0 1 10.89-20.637l-.001.001a307.318 307.318 0 0 1 12.413-19.761c7.613-.576 15.42-.876 23.31-.876H128c7.926 0 15.743.303 23.354.883a329.357 329.357 0 0 1 12.335 19.695a358.489 358.489 0 0 1 11.036 20.54a329.472 329.472 0 0 1-11 20.722Zm22.56-122.124c8.572 4.944 11.906 24.881 6.52 51.026c-.344 1.668-.73 3.367-1.15 5.09c-10.622-2.452-22.155-4.275-34.23-5.408c-7.034-10.017-14.323-19.124-21.64-27.008a160.789 160.789 0 0 1 5.888-5.4c18.9-16.447 36.564-22.941 44.612-18.3ZM128 90.808c12.625 0 22.86 10.235 22.86 22.86s-10.235 22.86-22.86 22.86s-22.86-10.235-22.86-22.86s10.235-22.86 22.86-22.86Z"></path></svg>
|
||||||
|
After Width: | Height: | Size: 4.0 KiB |
70
client/src/index.css
Normal file
70
client/src/index.css
Normal file
@@ -0,0 +1,70 @@
|
|||||||
|
:root {
|
||||||
|
font-family: Inter, Avenir, Helvetica, Arial, sans-serif;
|
||||||
|
font-size: 16px;
|
||||||
|
line-height: 24px;
|
||||||
|
font-weight: 400;
|
||||||
|
|
||||||
|
color-scheme: light dark;
|
||||||
|
color: rgba(255, 255, 255, 0.87);
|
||||||
|
background-color: #242424;
|
||||||
|
|
||||||
|
font-synthesis: none;
|
||||||
|
text-rendering: optimizeLegibility;
|
||||||
|
-webkit-font-smoothing: antialiased;
|
||||||
|
-moz-osx-font-smoothing: grayscale;
|
||||||
|
-webkit-text-size-adjust: 100%;
|
||||||
|
}
|
||||||
|
|
||||||
|
a {
|
||||||
|
font-weight: 500;
|
||||||
|
color: #646cff;
|
||||||
|
text-decoration: inherit;
|
||||||
|
}
|
||||||
|
a:hover {
|
||||||
|
color: #535bf2;
|
||||||
|
}
|
||||||
|
|
||||||
|
body {
|
||||||
|
margin: 0;
|
||||||
|
display: flex;
|
||||||
|
place-items: center;
|
||||||
|
min-width: 320px;
|
||||||
|
min-height: 100vh;
|
||||||
|
}
|
||||||
|
|
||||||
|
h1 {
|
||||||
|
font-size: 3.2em;
|
||||||
|
line-height: 1.1;
|
||||||
|
}
|
||||||
|
|
||||||
|
button {
|
||||||
|
border-radius: 8px;
|
||||||
|
border: 1px solid transparent;
|
||||||
|
padding: 0.6em 1.2em;
|
||||||
|
font-size: 1em;
|
||||||
|
font-weight: 500;
|
||||||
|
font-family: inherit;
|
||||||
|
background-color: #1a1a1a;
|
||||||
|
cursor: pointer;
|
||||||
|
transition: border-color 0.25s;
|
||||||
|
}
|
||||||
|
button:hover {
|
||||||
|
border-color: #646cff;
|
||||||
|
}
|
||||||
|
button:focus,
|
||||||
|
button:focus-visible {
|
||||||
|
outline: 4px auto -webkit-focus-ring-color;
|
||||||
|
}
|
||||||
|
|
||||||
|
@media (prefers-color-scheme: light) {
|
||||||
|
:root {
|
||||||
|
color: #213547;
|
||||||
|
background-color: #ffffff;
|
||||||
|
}
|
||||||
|
a:hover {
|
||||||
|
color: #747bff;
|
||||||
|
}
|
||||||
|
button {
|
||||||
|
background-color: #f9f9f9;
|
||||||
|
}
|
||||||
|
}
|
||||||
10
client/src/main.tsx
Normal file
10
client/src/main.tsx
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
import React from 'react'
|
||||||
|
import ReactDOM from 'react-dom/client'
|
||||||
|
import App from './App'
|
||||||
|
import './index.css'
|
||||||
|
|
||||||
|
ReactDOM.createRoot(document.getElementById('root') as HTMLElement).render(
|
||||||
|
<React.StrictMode>
|
||||||
|
<App />
|
||||||
|
</React.StrictMode>
|
||||||
|
)
|
||||||
1
client/src/vite-env.d.ts
vendored
Normal file
1
client/src/vite-env.d.ts
vendored
Normal file
@@ -0,0 +1 @@
|
|||||||
|
/// <reference types="vite/client" />
|
||||||
21
client/tsconfig.json
Normal file
21
client/tsconfig.json
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
{
|
||||||
|
"compilerOptions": {
|
||||||
|
"target": "ESNext",
|
||||||
|
"useDefineForClassFields": true,
|
||||||
|
"lib": ["DOM", "DOM.Iterable", "ESNext"],
|
||||||
|
"allowJs": false,
|
||||||
|
"skipLibCheck": true,
|
||||||
|
"esModuleInterop": false,
|
||||||
|
"allowSyntheticDefaultImports": true,
|
||||||
|
"strict": true,
|
||||||
|
"forceConsistentCasingInFileNames": true,
|
||||||
|
"module": "ESNext",
|
||||||
|
"moduleResolution": "Node",
|
||||||
|
"resolveJsonModule": true,
|
||||||
|
"isolatedModules": true,
|
||||||
|
"noEmit": true,
|
||||||
|
"jsx": "react-jsx"
|
||||||
|
},
|
||||||
|
"include": ["src"],
|
||||||
|
"references": [{ "path": "./tsconfig.node.json" }]
|
||||||
|
}
|
||||||
9
client/tsconfig.node.json
Normal file
9
client/tsconfig.node.json
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
{
|
||||||
|
"compilerOptions": {
|
||||||
|
"composite": true,
|
||||||
|
"module": "ESNext",
|
||||||
|
"moduleResolution": "Node",
|
||||||
|
"allowSyntheticDefaultImports": true
|
||||||
|
},
|
||||||
|
"include": ["vite.config.ts"]
|
||||||
|
}
|
||||||
7
client/vite.config.ts
Normal file
7
client/vite.config.ts
Normal file
@@ -0,0 +1,7 @@
|
|||||||
|
import { defineConfig } from 'vite'
|
||||||
|
import react from '@vitejs/plugin-react'
|
||||||
|
|
||||||
|
// https://vitejs.dev/config/
|
||||||
|
export default defineConfig({
|
||||||
|
plugins: [react()]
|
||||||
|
})
|
||||||
0
server/controllers/GroceryListCtl.ts
Normal file
0
server/controllers/GroceryListCtl.ts
Normal file
0
server/controllers/IngredientCtl.ts
Normal file
0
server/controllers/IngredientCtl.ts
Normal file
0
server/controllers/RecipeCtl.ts
Normal file
0
server/controllers/RecipeCtl.ts
Normal file
0
server/controllers/UserCtl.ts
Normal file
0
server/controllers/UserCtl.ts
Normal file
11
server/index.ts
Normal file
11
server/index.ts
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
import express, { Request, Response } from 'express';
|
||||||
|
const app = express();
|
||||||
|
const port = 8080;
|
||||||
|
|
||||||
|
app.get('/', (req: Request, res: Response) => {
|
||||||
|
res.send('express');
|
||||||
|
})
|
||||||
|
|
||||||
|
app.listen(port, () => {
|
||||||
|
console.log('listening on ' + port);
|
||||||
|
})
|
||||||
0
server/loaders/express.ts
Normal file
0
server/loaders/express.ts
Normal file
0
server/loaders/passport.ts
Normal file
0
server/loaders/passport.ts
Normal file
0
server/loaders/swagger.ts
Normal file
0
server/loaders/swagger.ts
Normal file
0
server/models/groceryList.ts
Normal file
0
server/models/groceryList.ts
Normal file
0
server/models/ingredient.ts
Normal file
0
server/models/ingredient.ts
Normal file
0
server/models/recipe.ts
Normal file
0
server/models/recipe.ts
Normal file
0
server/models/user.ts
Normal file
0
server/models/user.ts
Normal file
2455
server/package-lock.json
generated
Normal file
2455
server/package-lock.json
generated
Normal file
File diff suppressed because it is too large
Load Diff
23
server/package.json
Normal file
23
server/package.json
Normal file
@@ -0,0 +1,23 @@
|
|||||||
|
{
|
||||||
|
"name": "server",
|
||||||
|
"version": "1.0.0",
|
||||||
|
"description": "REST API for recipe manager",
|
||||||
|
"main": "dist/index.js",
|
||||||
|
"scripts": {
|
||||||
|
"start": "tsc && nodemon dist/index.js",
|
||||||
|
"test": "echo \"Error: no test specified\" && exit 1"
|
||||||
|
},
|
||||||
|
"author": "",
|
||||||
|
"license": "ISC",
|
||||||
|
"dependencies": {
|
||||||
|
"express": "^4.18.2",
|
||||||
|
"swagger-ui-express": "^4.6.0"
|
||||||
|
},
|
||||||
|
"devDependencies": {
|
||||||
|
"@types/express": "^4.17.14",
|
||||||
|
"@types/node": "^18.11.9",
|
||||||
|
"nodemon": "^2.0.20",
|
||||||
|
"tslint": "^6.1.3",
|
||||||
|
"typescript": "^4.9.3"
|
||||||
|
}
|
||||||
|
}
|
||||||
0
server/routes/collection.ts
Normal file
0
server/routes/collection.ts
Normal file
0
server/routes/groceryList.ts
Normal file
0
server/routes/groceryList.ts
Normal file
0
server/routes/index.ts
Normal file
0
server/routes/index.ts
Normal file
0
server/routes/recipe.ts
Normal file
0
server/routes/recipe.ts
Normal file
0
server/routes/users.ts
Normal file
0
server/routes/users.ts
Normal file
492
server/swagger.yaml
Normal file
492
server/swagger.yaml
Normal file
@@ -0,0 +1,492 @@
|
|||||||
|
openapi: 3.0.0
|
||||||
|
servers:
|
||||||
|
# Added by API Auto Mocking Plugin
|
||||||
|
- description: SwaggerHub API Auto Mocking
|
||||||
|
url: https://virtserver.swaggerhub.com/innocuous-symmetry/recipin-api/1.0.0
|
||||||
|
- description: No server
|
||||||
|
url: https://doesnotexistyet.com
|
||||||
|
info:
|
||||||
|
description: REST API for Recipin home recipe manager
|
||||||
|
version: "1.0.0"
|
||||||
|
title: Recipin REST API
|
||||||
|
contact:
|
||||||
|
email: mikaylaherself@gmail.com
|
||||||
|
license:
|
||||||
|
name: Apache 2.0
|
||||||
|
url: 'http://www.apache.org/licenses/LICENSE-2.0.html'
|
||||||
|
tags:
|
||||||
|
- name: admins
|
||||||
|
description: Secured Admin-only calls
|
||||||
|
- name: developers
|
||||||
|
description: Operations available to developers
|
||||||
|
- name: users
|
||||||
|
description: Operations available to users without special access
|
||||||
|
paths:
|
||||||
|
/users:
|
||||||
|
get:
|
||||||
|
tags:
|
||||||
|
- admins
|
||||||
|
summary: gets all users
|
||||||
|
operationId: getAllUsers
|
||||||
|
description: |
|
||||||
|
If this route is called without parameters and proper permissions exist,
|
||||||
|
a list of all registered users will be returned.
|
||||||
|
responses:
|
||||||
|
'200':
|
||||||
|
description: results received
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
type: array
|
||||||
|
items:
|
||||||
|
$ref: '#/components/schemas/User'
|
||||||
|
'403':
|
||||||
|
description: Forbidden. Proper clearance required for this request.
|
||||||
|
'404':
|
||||||
|
description: "no results found"
|
||||||
|
|
||||||
|
/users/{id}:
|
||||||
|
get:
|
||||||
|
tags:
|
||||||
|
- users
|
||||||
|
summary: get one user by ID
|
||||||
|
operationId: getUserByID
|
||||||
|
description: |
|
||||||
|
Supplying a user ID as parameter will return the information
|
||||||
|
corresponding to the user whose ID matches the provided value.
|
||||||
|
parameters:
|
||||||
|
- in: path
|
||||||
|
name: id
|
||||||
|
description: an argument for querying data about a specific user
|
||||||
|
required: true
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
responses:
|
||||||
|
'200':
|
||||||
|
description: results received
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
type: object
|
||||||
|
items:
|
||||||
|
$ref: '#/components/schemas/User'
|
||||||
|
'404':
|
||||||
|
description: "no results found"
|
||||||
|
'500':
|
||||||
|
description: 'internal server error'
|
||||||
|
put:
|
||||||
|
tags:
|
||||||
|
- users
|
||||||
|
- developers
|
||||||
|
- admins
|
||||||
|
summary: update a user by their ID
|
||||||
|
operationId: updateUserByID
|
||||||
|
description: |
|
||||||
|
Update a single user profile, other than one's own, by a specified
|
||||||
|
user ID. New information specified in request body.
|
||||||
|
parameters:
|
||||||
|
- in: path
|
||||||
|
name: id
|
||||||
|
description: an argument for querying data about a specific user
|
||||||
|
required: true
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
requestBody:
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: '#/components/schemas/User'
|
||||||
|
description: new profile information to be received
|
||||||
|
responses:
|
||||||
|
'200':
|
||||||
|
description: Update successful.
|
||||||
|
'400':
|
||||||
|
description: Bad request. Likely a problem with the request body.
|
||||||
|
'403':
|
||||||
|
description: Request forbidden. Proper authorization needed
|
||||||
|
delete:
|
||||||
|
tags:
|
||||||
|
- admins
|
||||||
|
summary: delete a user by their ID
|
||||||
|
operationId: deleteUserByID
|
||||||
|
description: delete a user by their ID
|
||||||
|
parameters:
|
||||||
|
- in: path
|
||||||
|
name: id
|
||||||
|
required: true
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
description: the ID of the user to delete
|
||||||
|
responses:
|
||||||
|
'204':
|
||||||
|
description: "Deletion successful, no content found."
|
||||||
|
'403':
|
||||||
|
description: Not authorized for this action.
|
||||||
|
'404':
|
||||||
|
description: No user found with this ID.
|
||||||
|
|
||||||
|
/recipes:
|
||||||
|
get:
|
||||||
|
tags:
|
||||||
|
- admins
|
||||||
|
summary: get all recipes
|
||||||
|
operationId: getAllRecipes
|
||||||
|
description: |
|
||||||
|
Returns a list of all recipe entries in the database, regardless of
|
||||||
|
auth status.
|
||||||
|
responses:
|
||||||
|
'200':
|
||||||
|
description: results received
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
type: array
|
||||||
|
items:
|
||||||
|
$ref: '#/components/schemas/Recipe'
|
||||||
|
'403':
|
||||||
|
description: Forbidden. Proper clearance required for this request.
|
||||||
|
'404':
|
||||||
|
description: "no results found"
|
||||||
|
|
||||||
|
/recipes/{id}:
|
||||||
|
get:
|
||||||
|
tags:
|
||||||
|
- users
|
||||||
|
summary: view one recipe by its ID
|
||||||
|
operationId: getRecipeByID
|
||||||
|
description: |
|
||||||
|
Access a single recipe by its recipe ID, if authorized. Will return
|
||||||
|
all data about this recipe and populate it in a full recipe view.
|
||||||
|
parameters:
|
||||||
|
- in: path
|
||||||
|
name: id
|
||||||
|
description: the ID of the queried recipe
|
||||||
|
required: true
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
responses:
|
||||||
|
'200':
|
||||||
|
description: Content found
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
type: object
|
||||||
|
items:
|
||||||
|
$ref: '#/components/schemas/Recipe'
|
||||||
|
'403':
|
||||||
|
description: Access forbidden
|
||||||
|
'404':
|
||||||
|
description: No recipe found with this ID
|
||||||
|
put:
|
||||||
|
tags:
|
||||||
|
- users
|
||||||
|
- developers
|
||||||
|
- admins
|
||||||
|
summary: update one recipe by its ID
|
||||||
|
operationId: updateRecipeByID
|
||||||
|
description: |
|
||||||
|
When authorized to do so, update a recipe's data by its recipe ID. Admins and
|
||||||
|
developers may override this auth requirement.
|
||||||
|
parameters:
|
||||||
|
- in: path
|
||||||
|
name: id
|
||||||
|
description: the ID of the queried recipe
|
||||||
|
required: true
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
requestBody:
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: '#/components/schemas/Recipe'
|
||||||
|
description: New recipe details received from request body, parsed from HTML input form.
|
||||||
|
responses:
|
||||||
|
'200':
|
||||||
|
description: Content updated successfully.
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
type: object
|
||||||
|
items:
|
||||||
|
$ref: '#/components/schemas/Recipe'
|
||||||
|
'400':
|
||||||
|
description: Bad request. Likely a malformed request body.
|
||||||
|
'403':
|
||||||
|
description: Access forbidden
|
||||||
|
delete:
|
||||||
|
tags:
|
||||||
|
- admins
|
||||||
|
summary: delete a recipe by its ID
|
||||||
|
operationId: deleteRecipeByID
|
||||||
|
description: delete a recipe by its ID
|
||||||
|
parameters:
|
||||||
|
- in: path
|
||||||
|
name: id
|
||||||
|
description: recipe ID to delete
|
||||||
|
required: true
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
responses:
|
||||||
|
'204':
|
||||||
|
description: "Deletion successful, no content found."
|
||||||
|
'403':
|
||||||
|
description: Not authorized for this action.
|
||||||
|
'404':
|
||||||
|
description: No recipe found with this ID.
|
||||||
|
|
||||||
|
|
||||||
|
/collection/{id}:
|
||||||
|
get:
|
||||||
|
tags:
|
||||||
|
- users
|
||||||
|
summary: get a collection of recipes by its ID
|
||||||
|
operationId: getCollectionByID
|
||||||
|
description: |
|
||||||
|
Access a unique collection by its collection ID. Within this route,
|
||||||
|
one may also query a specific recipe by its recipe ID
|
||||||
|
in the query params.
|
||||||
|
parameters:
|
||||||
|
- in: path
|
||||||
|
name: id
|
||||||
|
description: ID of the collection to request
|
||||||
|
required: true
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
- in: query
|
||||||
|
name: recipeID
|
||||||
|
description: the ID of a recipe to search for within the collection
|
||||||
|
required: false
|
||||||
|
schema:
|
||||||
|
type: integer
|
||||||
|
- in: query
|
||||||
|
name: ingredient
|
||||||
|
description: an ingredient to search for within the results
|
||||||
|
required: false
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
- in: query
|
||||||
|
name: cuisine
|
||||||
|
description: a type of cuisine to search for in the results
|
||||||
|
required: false
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
- in: query
|
||||||
|
name: course
|
||||||
|
description: a specific course to search for in the results
|
||||||
|
required: false
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
responses:
|
||||||
|
'200':
|
||||||
|
description: search successful, found results
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
type: array
|
||||||
|
items:
|
||||||
|
$ref: '#/components/schemas/Recipe'
|
||||||
|
'403':
|
||||||
|
description: Access forbidden. Likely attempting to access an unauthorized resource.
|
||||||
|
'404':
|
||||||
|
description: No matching content found.
|
||||||
|
post:
|
||||||
|
tags:
|
||||||
|
- users
|
||||||
|
summary: post a new recipe to a collection with ID {id}
|
||||||
|
operationId: postRecipeToCollection
|
||||||
|
description: |
|
||||||
|
Allows a user to post a new recipe to a collection they manage
|
||||||
|
(eventual support may exist for collaborative collections)
|
||||||
|
requestBody:
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: "#/components/schemas/Recipe"
|
||||||
|
parameters:
|
||||||
|
- in: path
|
||||||
|
name: id
|
||||||
|
description: the ID of the collection to receive the new recipe
|
||||||
|
required: true
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
responses:
|
||||||
|
'201':
|
||||||
|
description: New content created
|
||||||
|
'400':
|
||||||
|
description: Bad request. Request body likely malformed.
|
||||||
|
delete:
|
||||||
|
tags:
|
||||||
|
- admins
|
||||||
|
summary: delete a collection by its ID
|
||||||
|
operationId: deleteCollectionByID
|
||||||
|
description: delete a collection by its ID
|
||||||
|
parameters:
|
||||||
|
- in: path
|
||||||
|
name: id
|
||||||
|
required: true
|
||||||
|
description: ID of the collection to delete
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
responses:
|
||||||
|
'204':
|
||||||
|
description: "Deletion successful, no content found."
|
||||||
|
'403':
|
||||||
|
description: Not authorized for this action.
|
||||||
|
'404':
|
||||||
|
description: No collection found with this ID.
|
||||||
|
|
||||||
|
/grocerylist:
|
||||||
|
post:
|
||||||
|
tags:
|
||||||
|
- users
|
||||||
|
summary: create a new grocery list instance
|
||||||
|
operationId: createGroceryList
|
||||||
|
description: Creates a new grocery list instance associated with the currently logged-in user.
|
||||||
|
requestBody:
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: "#/components/schemas/GroceryList"
|
||||||
|
responses:
|
||||||
|
'201':
|
||||||
|
description: New content created
|
||||||
|
'400':
|
||||||
|
description: Bad request. Request body likely malformed.
|
||||||
|
|
||||||
|
/grocerylist/{id}:
|
||||||
|
get:
|
||||||
|
tags:
|
||||||
|
- users
|
||||||
|
summary: method for a user to get the data for their grocery list
|
||||||
|
operationId: getGroceryListByID
|
||||||
|
description: method for a user to get the data for their grocery list
|
||||||
|
parameters:
|
||||||
|
- in: path
|
||||||
|
name: id
|
||||||
|
required: true
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
description: the ID which corresponds to a user's grocery list instance
|
||||||
|
responses:
|
||||||
|
'200':
|
||||||
|
description: Request successful
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
type: object
|
||||||
|
items:
|
||||||
|
$ref: "#/components/schemas/GroceryList"
|
||||||
|
'403':
|
||||||
|
description: Access forbidden.
|
||||||
|
'404':
|
||||||
|
description: No cart found with this ID.
|
||||||
|
put:
|
||||||
|
tags:
|
||||||
|
- users
|
||||||
|
summary: update details of a specific grocery list instance
|
||||||
|
operationId: updateGroceryListByID
|
||||||
|
description: modify a grocery list instance, update its details with the request body
|
||||||
|
parameters:
|
||||||
|
- in: path
|
||||||
|
name: id
|
||||||
|
required: true
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
description: the ID which corresponds to a user's grocery list instance
|
||||||
|
requestBody:
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: "#/components/schemas/GroceryList"
|
||||||
|
responses:
|
||||||
|
'200':
|
||||||
|
description: Updated successfully
|
||||||
|
'400':
|
||||||
|
description: Bad request
|
||||||
|
'403':
|
||||||
|
description: Access forbidden. Likely not authorized to view or modify this content.
|
||||||
|
'404':
|
||||||
|
description: No grocery list instance found with this ID.
|
||||||
|
|
||||||
|
components:
|
||||||
|
schemas:
|
||||||
|
User:
|
||||||
|
required:
|
||||||
|
- firstname
|
||||||
|
- lastname
|
||||||
|
- handle
|
||||||
|
- email
|
||||||
|
- password
|
||||||
|
properties:
|
||||||
|
firstname:
|
||||||
|
type: string
|
||||||
|
example: Mikayla
|
||||||
|
lastname:
|
||||||
|
type: string
|
||||||
|
example: Dobson
|
||||||
|
handle:
|
||||||
|
type: string
|
||||||
|
example: innocuoussymmetry
|
||||||
|
email:
|
||||||
|
type: string
|
||||||
|
example: mikaylaherself@gmail.com
|
||||||
|
password:
|
||||||
|
type: string
|
||||||
|
example: supercoolpassword
|
||||||
|
type: object
|
||||||
|
Recipe:
|
||||||
|
required:
|
||||||
|
- name
|
||||||
|
- preptime
|
||||||
|
- ingredients
|
||||||
|
- removed
|
||||||
|
properties:
|
||||||
|
name:
|
||||||
|
type: string
|
||||||
|
example: Pad Thai
|
||||||
|
description:
|
||||||
|
type: string
|
||||||
|
example: noodle dish
|
||||||
|
preptime:
|
||||||
|
type: string
|
||||||
|
example: '1 hour'
|
||||||
|
ingredients:
|
||||||
|
type: array
|
||||||
|
items:
|
||||||
|
$ref: "#/components/schemas/Ingredient"
|
||||||
|
removed:
|
||||||
|
type: boolean
|
||||||
|
type: object
|
||||||
|
Ingredient:
|
||||||
|
required:
|
||||||
|
- name
|
||||||
|
- removed
|
||||||
|
properties:
|
||||||
|
name:
|
||||||
|
type: string
|
||||||
|
example: Cilantro
|
||||||
|
description:
|
||||||
|
type: string
|
||||||
|
example: 'A common herb'
|
||||||
|
removed:
|
||||||
|
type: boolean
|
||||||
|
example: false
|
||||||
|
type: object
|
||||||
|
GroceryList:
|
||||||
|
required:
|
||||||
|
- user
|
||||||
|
- name
|
||||||
|
- removed
|
||||||
|
properties:
|
||||||
|
user:
|
||||||
|
type: object
|
||||||
|
items:
|
||||||
|
$ref: "#/components/schemas/User"
|
||||||
|
name:
|
||||||
|
type: string
|
||||||
|
recipes:
|
||||||
|
type: array
|
||||||
|
items:
|
||||||
|
$ref: "#/components/schemas/Recipe"
|
||||||
|
removed:
|
||||||
|
type: boolean
|
||||||
20
server/tsconfig.json
Normal file
20
server/tsconfig.json
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
{
|
||||||
|
"compilerOptions": {
|
||||||
|
"module": "commonjs",
|
||||||
|
"esModuleInterop": true,
|
||||||
|
"target": "es6",
|
||||||
|
"noImplicitAny": true,
|
||||||
|
"moduleResolution": "node",
|
||||||
|
"sourceMap": true,
|
||||||
|
"outDir": "dist",
|
||||||
|
"baseUrl": ".",
|
||||||
|
"paths": {
|
||||||
|
"*": [
|
||||||
|
"node_modules/*"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"include": [
|
||||||
|
"./**/*"
|
||||||
|
]
|
||||||
|
}
|
||||||
11
server/tslint.json
Normal file
11
server/tslint.json
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
{
|
||||||
|
"defaultSeverity": "error",
|
||||||
|
"extends": [
|
||||||
|
"tslint:recommended"
|
||||||
|
],
|
||||||
|
"jsRules": {},
|
||||||
|
"rules": {
|
||||||
|
"trailing-comma": [ false ]
|
||||||
|
},
|
||||||
|
"rulesDirectory": []
|
||||||
|
}
|
||||||
Reference in New Issue
Block a user