postgres -c log_statement=all
42 | ```
43 |
44 | Update db.js to connect with your local PostgreSQL set up. The [Sequelize documentation](https://sequelize.org/master/manual/getting-started.html) can help with this.
45 |
46 | Create a .env file in the server directory and add your session secret (this can be any string):
47 |
48 | ```
49 | SESSION_SECRET = "your session secret"
50 | ```
51 |
52 | In the server folder, install dependencies and then seed the database:
53 |
54 | ```
55 | cd server
56 | npm install
57 | npm run seed
58 | ```
59 |
60 | In the client folder, install dependencies:
61 |
62 | ```
63 | cd client
64 | npm install
65 | ```
66 |
67 | ### Running the Application Locally
68 |
69 | In one terminal, start the front end:
70 |
71 | ```
72 | cd client
73 | npm start
74 | ```
75 |
76 | In a separate terminal, start the back end:
77 |
78 | ```
79 | cd server
80 | npm run dev
81 | ```
82 |
83 | ## How to Run E2E Tests
84 |
85 | 1. Seed the database with `npm run seed` in `server` directory.
86 | 1. Start the backend server with `npm run dev` in `server` directory.
87 | 1. Start the frontend server with `npm start` in `client` directory.
88 |
--------------------------------------------------------------------------------
/client/src/routes.js:
--------------------------------------------------------------------------------
1 | import React, { useEffect, useState } from "react";
2 | import axios from "axios";
3 | import { Route, Switch, withRouter } from "react-router-dom";
4 |
5 | import Signup from "./components/Auth/Signup.js";
6 | import Login from "./components/Auth/Login.js";
7 | import { SnackbarError, Home } from "./components";
8 | import UserContext from "./context/userContext";
9 |
10 | const Routes = (props) => {
11 | const [user, setUser] = useState({
12 | isFetching: true,
13 | });
14 |
15 | const [errorMessage, setErrorMessage] = useState("");
16 | const [snackBarOpen, setSnackBarOpen] = useState(false);
17 |
18 | const login = async (credentials) => {
19 | try {
20 | const { data } = await axios.post("/auth/login", credentials);
21 | await localStorage.setItem("statistic-token", data.token);
22 | setUser(data);
23 | } catch (error) {
24 | console.error(error);
25 | setUser({ error: error.response.data.error || "Server Error" });
26 | }
27 | };
28 |
29 | const register = async (credentials) => {
30 | try {
31 | const { data } = await axios.post("/auth/register", credentials);
32 | await localStorage.setItem("statistic-token", data.token);
33 | setUser(data);
34 | } catch (error) {
35 | console.error(error);
36 | setUser({ error: error.response.data.error || "Server Error" });
37 | }
38 | };
39 |
40 | const logout = async (id) => {
41 | try {
42 | await axios.delete("/auth/logout");
43 | await localStorage.removeItem("statistic-token");
44 | setUser({});
45 | } catch (error) {
46 | console.error(error);
47 | }
48 | };
49 |
50 | // Lifecycle
51 |
52 | useEffect(() => {
53 | const fetchUser = async () => {
54 | setUser((prev) => ({ ...prev, isFetching: true }));
55 | try {
56 | const { data } = await axios.get("/auth/user");
57 | setUser(data);
58 | } catch (error) {
59 | console.error(error);
60 | } finally {
61 | setUser((prev) => ({ ...prev, isFetching: false }));
62 | }
63 | };
64 |
65 | fetchUser();
66 | }, []);
67 |
68 | useEffect(() => {
69 | if (user?.error) {
70 | // check to make sure error is what we expect, in case we get an unexpected server error object
71 | if (typeof user.error === "string") {
72 | setErrorMessage(user.error);
73 | } else {
74 | setErrorMessage("Internal Server Error. Please try again");
75 | }
76 | setSnackBarOpen(true);
77 | }
78 | }, [user?.error]);
79 |
80 | if (user?.isFetching) {
81 | return Loading...
;
82 | }
83 |
84 | return (
85 |
86 | {snackBarOpen && (
87 |
92 | )}
93 |
94 | }
97 | />
98 | }
101 | />
102 |
105 | user?.id ? (
106 |
107 | ) : (
108 |
109 | )
110 | }
111 | />
112 |
113 |
114 | );
115 | };
116 |
117 | export default withRouter(Routes);
118 |
--------------------------------------------------------------------------------
/client/src/components/Main/RequestDialog.js:
--------------------------------------------------------------------------------
1 | import React, { useEffect, useState } from "react";
2 | import {
3 | Button,
4 | Dialog,
5 | DialogActions,
6 | DialogContent,
7 | DialogContentText,
8 | DialogTitle,
9 | FormControlLabel,
10 | Checkbox,
11 | FormGroup,
12 | RadioGroup,
13 | Radio,
14 | Box,
15 | } from "@material-ui/core";
16 |
17 | export default function FormDialog({ requestData }) {
18 | const [open, setOpen] = useState(false);
19 | const [desiredTypes, setDesiredTypes] = useState({
20 | byFemale: true,
21 | byLastName: true,
22 | byAge: true,
23 | });
24 | const [requestButtonStatus, setRequestButtonStatus] = useState(true);
25 |
26 | useEffect(() => {
27 | setRequestButtonStatus(
28 | desiredTypes.byAge | desiredTypes.byFemale | desiredTypes.byLastName
29 | );
30 | }, [desiredTypes.byAge, desiredTypes.byFemale, desiredTypes.byLastName]);
31 |
32 | const handleClickOpen = () => {
33 | setOpen(true);
34 | };
35 |
36 | const handleClose = () => {
37 | setOpen(false);
38 | };
39 |
40 | const handleChange = (event) => {
41 | setDesiredTypes({
42 | ...desiredTypes,
43 | [event.target.name]: event.target.checked,
44 | });
45 | };
46 |
47 | const handleRequest = () => {
48 | setOpen(false);
49 | requestData({ desiredTypes });
50 | };
51 |
52 | return (
53 |
54 |
57 |
120 |
121 | );
122 | }
123 |
--------------------------------------------------------------------------------
/client/src/components/Auth/Signup.js:
--------------------------------------------------------------------------------
1 | import React, { useState, useEffect } from "react";
2 | import { Link, useHistory } from "react-router-dom";
3 | import {
4 | Grid,
5 | Box,
6 | Typography,
7 | Button,
8 | FormControl,
9 | TextField,
10 | FormHelperText,
11 | } from "@material-ui/core";
12 |
13 | const Signup = ({ user, register }) => {
14 | const history = useHistory();
15 |
16 | const [formErrorMessage, setFormErrorMessage] = useState({});
17 |
18 | const handleRegister = async (event) => {
19 | event.preventDefault();
20 | const form = event.currentTarget;
21 | const formElements = form.elements;
22 | const username = formElements.username.value;
23 | const email = formElements.email.value;
24 | const password = formElements.password.value;
25 | const confirmPassword = formElements.confirmPassword.value;
26 |
27 | if (password !== confirmPassword) {
28 | setFormErrorMessage({ confirmPassword: "Passwords must match" });
29 | return;
30 | }
31 | await register({ username, email, password });
32 | };
33 |
34 | useEffect(() => {
35 | if (user && user.id) history.push("/");
36 | }, [user, history]);
37 |
38 | return (
39 |
40 |
41 |
42 | Need to log in?
43 |
44 |
47 |
48 |
49 |
113 |
114 |
115 | );
116 | };
117 |
118 | export default Signup;
119 |
--------------------------------------------------------------------------------
/client/src/components/Main/Home.js:
--------------------------------------------------------------------------------
1 | import React, { useEffect, useState, useContext } from "react";
2 | import axios from "axios";
3 | import { useHistory } from "react-router-dom";
4 | import {
5 | Grid,
6 | Button,
7 | Select,
8 | MenuItem,
9 | FormControl,
10 | InputLabel,
11 | Container,
12 | Box,
13 | } from "@material-ui/core";
14 | import { makeStyles } from "@material-ui/core/styles";
15 | import StatisticChart from "./StatisticChart";
16 |
17 | import RequestDialog from "./RequestDialog";
18 | import UserContext from "../../context/userContext";
19 | import { Chart as ChartJS, ArcElement, Tooltip, Legend } from "chart.js";
20 |
21 | ChartJS.register(ArcElement, Tooltip, Legend);
22 |
23 | const useStyles = makeStyles((theme) => ({
24 | root: {
25 | display: "flex",
26 | flexDirection: "column",
27 | },
28 | formElement: {
29 | width: "30rem",
30 | margin: "1rem 2rem",
31 | },
32 | }));
33 |
34 | const Home = ({ user, logout }) => {
35 | const history = useHistory();
36 | const User = useContext(UserContext);
37 |
38 | const classes = useStyles();
39 | const [isLoggedIn, setIsLoggedIn] = useState(false);
40 | const [requests, setRequests] = useState([]);
41 | const [statistic, setStatistic] = useState(null);
42 | const [currentRequestId, setCurrentRequestId] = useState("");
43 |
44 | // Lifecycle
45 |
46 | useEffect(() => {
47 | // when fetching, prevent redirect
48 | if (user?.isFetching) return;
49 |
50 | if (user && user.id) {
51 | setIsLoggedIn(true);
52 | } else {
53 | // If we were previously logged in, redirect to login instead of register
54 | if (isLoggedIn) history.push("/login");
55 | else history.push("/register");
56 | }
57 | }, [user, history, isLoggedIn]);
58 |
59 | useEffect(() => {
60 | const fetchPastRequests = async () => {
61 | try {
62 | const { data } = await axios.get("/api/requests");
63 | setCurrentRequestId(data[0].id);
64 | setRequests(data);
65 | } catch (error) {
66 | console.error(error);
67 | }
68 | };
69 | if (!user.isFetching) {
70 | fetchPastRequests();
71 | }
72 | }, [user]);
73 |
74 | useEffect(async () => {
75 | const { data } = await axios.get(
76 | `/api/requests/${currentRequestId}?format=json`
77 | );
78 | setStatistic(data.statistic);
79 | }, [currentRequestId]);
80 |
81 | const handleLogout = async () => {
82 | if (user && user.id) {
83 | await logout(user.id);
84 | }
85 | };
86 |
87 | const handleChange = (e) => {
88 | setCurrentRequestId(e.target.value);
89 | };
90 |
91 | const requestData = async ({ desiredTypes }) => {
92 | const { data } = await axios.post("/api/requests/new", { desiredTypes });
93 | setRequests([data, ...requests]);
94 | setCurrentRequestId(data.id);
95 | };
96 |
97 | function downloadCsv(csvString, filename) {
98 | var blob = new Blob([csvString]);
99 | if (window.navigator.msSaveOrOpenBlob) {
100 | window.navigator.msSaveBlob(blob, "filename.csv");
101 | } else {
102 | var a = window.document.createElement("a");
103 |
104 | a.href = window.URL.createObjectURL(blob, {
105 | type: "text/plain",
106 | });
107 | a.download = filename;
108 | document.body.appendChild(a);
109 | a.click();
110 | document.body.removeChild(a);
111 | }
112 | }
113 |
114 | const download = async (id) => {
115 | const { data } = await axios.get(`/api/requests/${id}?format=csv`);
116 | const createdAt = requests.find(
117 | (req) => req.id === currentRequestId
118 | ).created_at;
119 |
120 | downloadCsv(
121 | data.join("\n"),
122 | `report-${createdAt.slice(0, 10)} ${createdAt.slice(11, 19)}.csv`
123 | );
124 | };
125 |
126 | return (
127 |
128 |
129 |
130 |
131 |
132 |
133 |
134 |
135 |
142 |
143 |
144 |
145 |
148 |
149 |
150 |
151 | Request Date
152 |
166 |
167 |
168 |
169 |
170 | );
171 | };
172 |
173 | export default Home;
174 |
--------------------------------------------------------------------------------
/client/src/serviceWorker.js:
--------------------------------------------------------------------------------
1 | // This optional code is used to register a service worker.
2 | // register() is not called by default.
3 |
4 | // This lets the app load faster on subsequent visits in production, and gives
5 | // it offline capabilities. However, it also means that developers (and users)
6 | // will only see deployed updates on subsequent visits to a page, after all the
7 | // existing tabs open on the page have been closed, since previously cached
8 | // resources are updated in the background.
9 |
10 | // To learn more about the benefits of this model and instructions on how to
11 | // opt-in, read https://bit.ly/CRA-PWA
12 |
13 | const isLocalhost = Boolean(
14 | window.location.hostname === "localhost" ||
15 | // [::1] is the IPv6 localhost address.
16 | window.location.hostname === "[::1]" ||
17 | // 127.0.0.1/8 is considered localhost for IPv4.
18 | window.location.hostname.match(
19 | /^127(?:\.(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}$/
20 | )
21 | );
22 |
23 | export function register(config) {
24 | if (process.env.NODE_ENV === "production" && "serviceWorker" in navigator) {
25 | // The URL constructor is available in all browsers that support SW.
26 | const publicUrl = new URL(process.env.PUBLIC_URL, window.location.href);
27 | if (publicUrl.origin !== window.location.origin) {
28 | // Our service worker won't work if PUBLIC_URL is on a different origin
29 | // from what our page is served on. This might happen if a CDN is used to
30 | // serve assets; see https://github.com/facebook/create-react-app/issues/2374
31 | return;
32 | }
33 |
34 | window.addEventListener("load", () => {
35 | const swUrl = `${process.env.PUBLIC_URL}/service-worker.js`;
36 |
37 | if (isLocalhost) {
38 | // This is running on localhost. Let's check if a service worker still exists or not.
39 | checkValidServiceWorker(swUrl, config);
40 |
41 | // Add some additional logging to localhost, pointing developers to the
42 | // service worker/PWA documentation.
43 | navigator.serviceWorker.ready.then(() => {
44 | console.log(
45 | "This web app is being served cache-first by a service " +
46 | "worker. To learn more, visit https://bit.ly/CRA-PWA"
47 | );
48 | });
49 | } else {
50 | // Is not localhost. Just register service worker
51 | registerValidSW(swUrl, config);
52 | }
53 | });
54 | }
55 | }
56 |
57 | function registerValidSW(swUrl, config) {
58 | navigator.serviceWorker
59 | .register(swUrl)
60 | .then((registration) => {
61 | registration.onupdatefound = () => {
62 | const installingWorker = registration.installing;
63 | if (installingWorker == null) {
64 | return;
65 | }
66 | installingWorker.onstatechange = () => {
67 | if (installingWorker.state === "installed") {
68 | if (navigator.serviceWorker.controller) {
69 | // At this point, the updated precached content has been fetched,
70 | // but the previous service worker will still serve the older
71 | // content until all client tabs are closed.
72 | console.log(
73 | "New content is available and will be used when all " +
74 | "tabs for this page are closed. See https://bit.ly/CRA-PWA."
75 | );
76 |
77 | // Execute callback
78 | if (config && config.onUpdate) {
79 | config.onUpdate(registration);
80 | }
81 | } else {
82 | // At this point, everything has been precached.
83 | // It's the perfect time to display a
84 | // "Content is cached for offline use." message.
85 | console.log("Content is cached for offline use.");
86 |
87 | // Execute callback
88 | if (config && config.onSuccess) {
89 | config.onSuccess(registration);
90 | }
91 | }
92 | }
93 | };
94 | };
95 | })
96 | .catch((error) => {
97 | console.error("Error during service worker registration:", error);
98 | });
99 | }
100 |
101 | function checkValidServiceWorker(swUrl, config) {
102 | // Check if the service worker can be found. If it can't reload the page.
103 | fetch(swUrl)
104 | .then((response) => {
105 | // Ensure service worker exists, and that we really are getting a JS file.
106 | const contentType = response.headers.get("content-type");
107 | if (
108 | response.status === 404 ||
109 | (contentType != null && contentType.indexOf("javascript") === -1)
110 | ) {
111 | // No service worker found. Probably a different app. Reload the page.
112 | navigator.serviceWorker.ready.then((registration) => {
113 | registration.unregister().then(() => {
114 | window.location.reload();
115 | });
116 | });
117 | } else {
118 | // Service worker found. Proceed as normal.
119 | registerValidSW(swUrl, config);
120 | }
121 | })
122 | .catch(() => {
123 | console.log(
124 | "No internet connection found. App is running in offline mode."
125 | );
126 | });
127 | }
128 |
129 | export function unregister() {
130 | if ("serviceWorker" in navigator) {
131 | navigator.serviceWorker.ready.then((registration) => {
132 | registration.unregister();
133 | });
134 | }
135 | }
136 |
--------------------------------------------------------------------------------