diff --git a/.dockerignore b/.dockerignore new file mode 100644 index 0000000..73b834f --- /dev/null +++ b/.dockerignore @@ -0,0 +1,6 @@ +node_modules/ +**/node_modules/ +.git_ignore +package-lock.json +README.md +yarn.lock \ No newline at end of file diff --git a/.eslintignore b/.eslintignore new file mode 100644 index 0000000..7debfee --- /dev/null +++ b/.eslintignore @@ -0,0 +1,5 @@ +client/config/ +client/scripts/ +client/src/registerServiceWorker.js +server/bin/www +node_modules/ \ No newline at end of file diff --git a/.eslintrc.json b/.eslintrc.json new file mode 100644 index 0000000..4a47709 --- /dev/null +++ b/.eslintrc.json @@ -0,0 +1,33 @@ +{ + "extends": ["airbnb", "plugin:flowtype/recommended", "prettier"], + "plugins": ["flowtype", "compat", "prettier"], + "env": { + "es6": true, + "node": true, + "browser": true, + "jest": true + }, + "rules": { + "semi": [2, "always"], + "compat/compat": 2, + "no-param-reassign": 0, + "jsx-a11y/interactive-supports-focus": 0, + "flowtype/define-flow-type": 2, + "import/prefer-default-export": 1, + "no-underscore-dangle": 1, + "comma-dangle": [ + "error", + { + "arrays": "never", + "objects": "always", + "imports": "never", + "exports": "never", + "functions": "never" + } + ] + }, + "parser": "babel-eslint", + "parserOptions": { + "sourceType": "module" + } +} diff --git a/.flowconfig b/.flowconfig new file mode 100644 index 0000000..e7a2106 --- /dev/null +++ b/.flowconfig @@ -0,0 +1,6 @@ +[options] +suppress_comment= \\(.\\|\n\\)*\\flow-disable-next-line +suppress_comment= \\(.\\|\n\\)*\\$FlowFixMe +module.name_mapper.extension='scss' -> 'empty/object' +[ignore] +.vscode/.* \ No newline at end of file diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..b55750c --- /dev/null +++ b/.gitignore @@ -0,0 +1,31 @@ +# See https://help.github.com/ignore-files/ for more about ignoring files. + +# dependencies +/node_modules +*/node_modules + +# testing +/coverage + +# production +/client/build +/server/dist + +# DB +/server/mongo + +# CSS files (exclude build files) +client/src/**/*.css + +# misc +.vscode/ +.DS_Store +.env.local +.env.development.local +.env.test.local +.env.production.local +.aws + +npm-debug.log* +yarn-debug.log* +yarn-error.log* \ No newline at end of file diff --git a/.prettierrc b/.prettierrc new file mode 100644 index 0000000..b2218c2 --- /dev/null +++ b/.prettierrc @@ -0,0 +1,6 @@ +{ + "semi": true, + "trailingComma": "es5", + "singleQuote": true, + "printWidth": 100 +} diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..6f4853a --- /dev/null +++ b/Dockerfile @@ -0,0 +1,28 @@ +FROM node:8.8.1-alpine +LABEL name="ForecastMeProd" +LABEL version="1.0" +ENV NPM_CONFIG_LOGLEVEL verbose + +# Set ENV variables for babel to compile server code +ENV BABEL_ENV=production NODE_ENV=production + +# Setup working directory for the server container +RUN mkdir /app +WORKDIR /app +RUN mkdir /client +RUN mkdir /server + +# Copy over server package.json and install dependencies +COPY ./package.json /app/ +RUN npm install + +# Copy client files over and install dependencies and build bundle +COPY ./client /app/client +RUN cd client && npm install && npm run build + +# Copy server files over and install dependencies and compile server code +COPY ./server/ /app/server +RUN cd server && NODE_ENV=development npm install && npm run build:server:prod + +EXPOSE 80 +CMD ["npm", "run", "start:app:prod"] \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..8ded408 --- /dev/null +++ b/README.md @@ -0,0 +1,21 @@ +## Powered by Surfline (https://new.surfline.com) and NOAA (http://www.ndbc.noaa.gov/) + +#### Welcome to my ForecastMe. This is an open-source application for displaying the surf forecast. The app is currently in beta version and available at http://forecastme.io + +#### If you are interested in running the app locally to develop or contribute: + +#### First clone the Repo on to your local machine +#### Ensure you have docker installed (required) +- CD into the directory +``` +cd repo-clone-dir-name +``` +- Run the following +``` +npm run docker:build:local +``` +After those the containers are booted up the app will be available on port 3005, the server will be available on port 3006. + +After those steps, the app can be accessed at localhost:3005 + +If you would like to make a PR, that would be awesome. Any new features are welcome. diff --git a/client/config/env.js b/client/config/env.js new file mode 100644 index 0000000..8b39b6c --- /dev/null +++ b/client/config/env.js @@ -0,0 +1,90 @@ +'use strict'; + +const fs = require('fs'); +const path = require('path'); +const paths = require('./paths'); + +// Make sure that including paths.js after env.js will read .env variables. +delete require.cache[require.resolve('./paths')]; + +const NODE_ENV = process.env.NODE_ENV; +if (!NODE_ENV) { + throw new Error( + 'The NODE_ENV environment variable is required but was not specified.' + ); +} + +// https://github.com/bkeepers/dotenv#what-other-env-files-can-i-use +var dotenvFiles = [ + `${paths.dotenv}.${NODE_ENV}.local`, + `${paths.dotenv}.${NODE_ENV}`, + // Don't include `.env.local` for `test` environment + // since normally you expect tests to produce the same + // results for everyone + NODE_ENV !== 'test' && `${paths.dotenv}.local`, + paths.dotenv, +].filter(Boolean); + +// Load environment variables from .env* files. Suppress warnings using silent +// if this file is missing. dotenv will never modify any environment variables +// that have already been set. +// https://github.com/motdotla/dotenv +dotenvFiles.forEach(dotenvFile => { + if (fs.existsSync(dotenvFile)) { + require('dotenv').config({ + path: dotenvFile, + }); + } +}); + +// We support resolving modules according to `NODE_PATH`. +// This lets you use absolute paths in imports inside large monorepos: +// https://github.com/facebookincubator/create-react-app/issues/253. +// It works similar to `NODE_PATH` in Node itself: +// https://nodejs.org/api/modules.html#modules_loading_from_the_global_folders +// Note that unlike in Node, only *relative* paths from `NODE_PATH` are honored. +// Otherwise, we risk importing Node.js core modules into an app instead of Webpack shims. +// https://github.com/facebookincubator/create-react-app/issues/1023#issuecomment-265344421 +// We also resolve them to make sure all tools using them work consistently. +const appDirectory = fs.realpathSync(process.cwd()); +process.env.NODE_PATH = (process.env.NODE_PATH || '') + .split(path.delimiter) + .filter(folder => folder && !path.isAbsolute(folder)) + .map(folder => path.resolve(appDirectory, folder)) + .join(path.delimiter); + +// Grab NODE_ENV and REACT_APP_* environment variables and prepare them to be +// injected into the application via DefinePlugin in Webpack configuration. +const REACT_APP = /^REACT_APP_/i; + +function getClientEnvironment(publicUrl) { + const raw = Object.keys(process.env) + .filter(key => REACT_APP.test(key)) + .reduce( + (env, key) => { + env[key] = process.env[key]; + return env; + }, + { + // Useful for determining whether we’re running in production mode. + // Most importantly, it switches React into the correct mode. + NODE_ENV: process.env.NODE_ENV || 'development', + // Useful for resolving the correct path to static assets in `public`. + // For example, . + // This should only be used as an escape hatch. Normally you would put + // images into the `src` and `import` them in code to get their paths. + PUBLIC_URL: publicUrl, + } + ); + // Stringify all values so we can feed into Webpack DefinePlugin + const stringified = { + 'process.env': Object.keys(raw).reduce((env, key) => { + env[key] = JSON.stringify(raw[key]); + return env; + }, {}), + }; + + return { raw, stringified }; +} + +module.exports = getClientEnvironment; diff --git a/client/config/jest/cssTransform.js b/client/config/jest/cssTransform.js new file mode 100644 index 0000000..f1534f6 --- /dev/null +++ b/client/config/jest/cssTransform.js @@ -0,0 +1,14 @@ +'use strict'; + +// This is a custom Jest transformer turning style imports into empty objects. +// http://facebook.github.io/jest/docs/tutorial-webpack.html + +module.exports = { + process() { + return 'module.exports = {};'; + }, + getCacheKey() { + // The output is always the same. + return 'cssTransform'; + }, +}; diff --git a/client/config/jest/fileTransform.js b/client/config/jest/fileTransform.js new file mode 100644 index 0000000..ffce0da --- /dev/null +++ b/client/config/jest/fileTransform.js @@ -0,0 +1,12 @@ +'use strict'; + +const path = require('path'); + +// This is a custom Jest transformer turning file imports into filenames. +// http://facebook.github.io/jest/docs/tutorial-webpack.html + +module.exports = { + process(src, filename) { + return `module.exports = ${JSON.stringify(path.basename(filename))};`; + }, +}; diff --git a/client/config/paths.js b/client/config/paths.js new file mode 100644 index 0000000..6d16efc --- /dev/null +++ b/client/config/paths.js @@ -0,0 +1,55 @@ +'use strict'; + +const path = require('path'); +const fs = require('fs'); +const url = require('url'); + +// Make sure any symlinks in the project folder are resolved: +// https://github.com/facebookincubator/create-react-app/issues/637 +const appDirectory = fs.realpathSync(process.cwd()); +const resolveApp = relativePath => path.resolve(appDirectory, relativePath); + +const envPublicUrl = process.env.PUBLIC_URL; + +function ensureSlash(path, needsSlash) { + const hasSlash = path.endsWith('/'); + if (hasSlash && !needsSlash) { + return path.substr(path, path.length - 1); + } else if (!hasSlash && needsSlash) { + return `${path}/`; + } else { + return path; + } +} + +const getPublicUrl = appPackageJson => + envPublicUrl || require(appPackageJson).homepage; + +// We use `PUBLIC_URL` environment variable or "homepage" field to infer +// "public path" at which the app is served. +// Webpack needs to know it to put the right