Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add changes to gear up for deployment #31

Merged
merged 5 commits into from
Mar 30, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 24 additions & 33 deletions .github/workflows/pipeline.yml
Original file line number Diff line number Diff line change
Expand Up @@ -67,39 +67,33 @@ jobs:
start: npm run server:test, npm start
wait-on: 'http://localhost:3001/health, http://localhost:3000'
working-directory: ./frontend

build:
runs-on: ubuntu-20.04
defaults:
run:
working-directory: backend
needs: [test_lint_backend, test_lint_frontend]
steps:
- uses: actions/checkout@v3
- uses: actions/setup-node@v2
with:
node-version: '16'
- name: npm install
run: npm install
- name: install frontend dependencies
run: cd ../frontend && npm install
- name: build ui
run: npm run build:ui
deploy:
if: ${{ github.ref == 'refs/head/main' }}
needs: [test_lint_backend, test_lint_frontend]
runs-on: ubuntu-20.04
needs: [build]
steps:
- uses: actions/checkout@v2
- uses: akhileshns/[email protected]
with:
heroku_api_key: ${{secrets.HEROKU_API_KEY}}
heroku_app_name: "instaclone-sc"
heroku_email: "[email protected]"
appdir: "backend"
healthcheck: ""
checkstring: "ok"
rollbackonhealthcheckfailed: true
- uses: actions/checkout@v2
- name: Login to Heroku Container registry
env:
HEROKU_API_KEY: ${{ secrets.HEROKU_API_KEY }}
run: heroku container:login
- name: Set Heroku Config Vars
env:
HEROKU_API_KEY: ${{ secrets.HEROKU_API_KEY }}
run: |
heroku config:set JWT_SECRET=${{ secrets.JWT_SECRET }} -a instaclone
heroku config:set CLOUDINARY_API_SECRET=${{ secrets.CLOUDINARY_API_SECRET }} -a instaclone
heroku config:set CLOUDINARY_API_KEY=${{ secrets.CLOUDINARY_API_KEY }} -a instaclone
heroku config:set CLOUDINARY_NAME=${{ secrets.CLOUDINARY_NAME }} -a instaclone
heroku config:set PROD_MONGODB_URI=${{ secrets.PROD_MONGODB_URI }} -a instaclone
- name: Build and push
env:
HEROKU_API_KEY: ${{ secrets.HEROKU_API_KEY }}
run: heroku container:push -a instaclone web
- name: Release
env:
HEROKU_API_KEY: ${{ secrets.HEROKU_API_KEY }}
run: heroku container:release -a instaclone web
tag_release:
if: ${{ github.ref == 'refs/head/main' }}
needs: [deploy]
Expand All @@ -111,7 +105,4 @@ jobs:
- name: Bump version and push tag
uses: anothrNick/[email protected]
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

# for deploying, make sure to have all final dependencies installed before deploying at all. aka, don't deploy, realize you need a new dep and then deploy again
# todo: research how i can add new packages after deployment and then redeploy
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
36 changes: 36 additions & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# BUILD STAGE

FROM node:16 as build-stage
WORKDIR /app

# copying the all the frontend and backend code
COPY frontend ./frontend
COPY backend ./backend

# installing the frontend and backend dependencies
RUN cd frontend && npm install
RUN cd backend && npm install

# building the frontend UI from the backend
RUN cd backend && npm run build:ui

# compiling TypeScript code
RUN cd backend && npm run tsc

# RUN STAGE

FROM node:16 as run-stage
WORKDIR /app

# copying the built frontend and backend code
COPY --from=build-stage /app/backend/build /app

# copying the backend package.json
COPY --from=build-stage /app/backend/package.json /app

# Installing the backend dependencies
RUN npm install --omit=dev

EXPOSE 3001

CMD ["node", "index.js"]
4 changes: 2 additions & 2 deletions backend/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@
"description": "Backend for Instaclone",
"main": "index.js",
"scripts": {
"tsc": "tsc",
"tsc": "tsc -p tsconfig.build.json",
"ts-jest:init": "npx ts-jest config:init",
"test": "cross-env NODE_ENV=test jest --verbose --detectOpenHandles",
"start": "cross-env NODE_ENV=production node src/index.ts",
"start": "cross-env NODE_ENV=production node build/src/index.js",
"dev": "cross-env NODE_ENV=development nodemon --files src/index.ts",
"start:test": "cross-env NODE_ENV=test ts-node --files src/index.ts",
"start:cypress-test": "cross-env NODE_ENV=cypress ts-node --files src/index.ts",
Expand Down
22 changes: 20 additions & 2 deletions backend/src/app.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ import express from 'express';
import cors from 'cors';
import morgan from 'morgan';
import cookieParser from 'cookie-parser';
import path from 'path';
import mongodbConnect, { testMongodb } from './mongo';
import config from './utils/config';
import postRouter from './routes/posts';
Expand All @@ -15,8 +16,16 @@ import { errorHandler, logErrorCodes } from './utils/middleware';
const { NODE_ENV } = process.env;
const app = express();

if (NODE_ENV === 'development') {
mongodbConnect(config.DEV_MONGODB_URI!);
if (NODE_ENV === 'production' || NODE_ENV === 'development') {
const mongodbUri = NODE_ENV === 'production'
? config.PROD_MONGODB_URI
: config.DEV_MONGODB_URI;

if (!mongodbUri) {
throw new Error(`The ${NODE_ENV} MongoDB URI is not defined.`);
}

mongodbConnect(mongodbUri);
} else if (NODE_ENV === 'cypress') {
(async () => {
await testMongodb.connect();
Expand All @@ -42,6 +51,15 @@ app.use('/api/auth', authRouter);
app.use('/api/likes', likeRouter);
app.use('/api/notifications', notificationRouter);

if (NODE_ENV === ('production' || 'development')) {
app.get('*', (_req, res) => {
const prodPath = path.join(__dirname, 'index.html');
const devPath = path.join(__dirname, '..', 'build', 'index.html');

res.sendFile(NODE_ENV === 'production' ? prodPath : devPath);
});
}

if (NODE_ENV !== 'production') {
app.use('/api/test', testRouter);
}
Expand Down
4 changes: 3 additions & 1 deletion backend/src/mongo/index.ts
Original file line number Diff line number Diff line change
@@ -1,13 +1,15 @@
import mongoose from 'mongoose';
import logger from '../utils/logger';

const { NODE_ENV } = process.env;

const connect = async (uri: string) => {
try {
await mongoose.connect(uri);
logger.info('Connected to: ', uri);
} catch (error) {
const message = logger.getErrorMessage(error);
logger.error('Error connecting to dev MongoDB: ', message);
logger.error(`Error connecting to ${NODE_ENV} MongoDB: `, message);
}
};

Expand Down
2 changes: 2 additions & 0 deletions backend/src/utils/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ require('dotenv').config();

const {
DEV_MONGODB_URI,
PROD_MONGODB_URI,
PORT,
CLOUDINARY_NAME,
CLOUDINARY_API_KEY,
Expand All @@ -16,4 +17,5 @@ export default {
CLOUDINARY_API_KEY,
CLOUDINARY_API_SECRET,
JWT_SECRET,
PROD_MONGODB_URI,
};
103 changes: 103 additions & 0 deletions backend/tsconfig.build.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,103 @@
{
"compilerOptions": {
/* Visit https://aka.ms/tsconfig.json to read more about this file */

/* Projects */
// "incremental": true, /* Enable incremental compilation */
// "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */
// "tsBuildInfoFile": "./", /* Specify the folder for .tsbuildinfo incremental compilation files. */
// "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects */
// "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */
// "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */

/* Language and Environment */
"target": "ES2022", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
// "lib": [], /* Specify a set of bundled library declaration files that describe the target runtime environment. */
// "jsx": "preserve", /* Specify what JSX code is generated. */
// "experimentalDecorators": true, /* Enable experimental support for TC39 stage 2 draft decorators. */
// "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */
// "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h' */
// "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
// "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using `jsx: react-jsx*`.` */
// "reactNamespace": "", /* Specify the object invoked for `createElement`. This only applies when targeting `react` JSX emit. */
// "noLib": true, /* Disable including any library files, including the default lib.d.ts. */
// "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */

/* Modules */
"module": "commonjs", /* Specify what module code is generated. */
// "rootDir": "./", /* Specify the root folder within your source files. */
// "moduleResolution": "node", /* Specify how TypeScript looks up a file from a given module specifier. */
// "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */
// "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */
// "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */
// "typeRoots": [], /* Specify multiple folders that act like `./node_modules/@types`. */
// "types": [], /* Specify type package names to be included without being referenced in a source file. */
// "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */
// "resolveJsonModule": true, /* Enable importing .json files */
// "noResolve": true, /* Disallow `import`s, `require`s or `<reference>`s from expanding the number of files TypeScript should add to a project. */

/* JavaScript Support */
// "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the `checkJS` option to get errors from these files. */
// "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */
// "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from `node_modules`. Only applicable with `allowJs`. */

/* Emit */
// "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
// "declarationMap": true, /* Create sourcemaps for d.ts files. */
// "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */
// "sourceMap": true, /* Create source map files for emitted JavaScript files. */
// "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If `declaration` is true, also designates a file that bundles all .d.ts output. */
"outDir": "./build/", /* Specify an output folder for all emitted files. */
// "removeComments": true, /* Disable emitting comments. */
// "noEmit": true, /* Disable emitting files from a compilation. */
// "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
// "importsNotUsedAsValues": "remove", /* Specify emit/checking behavior for imports that are only used for types */
// "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
// "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */
// "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
// "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */
// "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */
// "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
// "newLine": "crlf", /* Set the newline character for emitting files. */
// "stripInternal": true, /* Disable emitting declarations that have `@internal` in their JSDoc comments. */
// "noEmitHelpers": true, /* Disable generating custom helper functions like `__extends` in compiled output. */
// "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */
// "preserveConstEnums": true, /* Disable erasing `const enum` declarations in generated code. */
// "declarationDir": "./", /* Specify the output directory for generated declaration files. */
// "preserveValueImports": true, /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */

/* Interop Constraints */
// "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */
// "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */
"esModuleInterop": true, /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables `allowSyntheticDefaultImports` for type compatibility. */
// "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
"forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */

/* Type Checking */
"strict": true, /* Enable all strict type-checking options. */
"noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied `any` type.. */
// "strictNullChecks": true, /* When type checking, take into account `null` and `undefined`. */
// "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
// "strictBindCallApply": true, /* Check that the arguments for `bind`, `call`, and `apply` methods match the original function. */
// "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */
// "noImplicitThis": true, /* Enable error reporting when `this` is given the type `any`. */
// "useUnknownInCatchVariables": true, /* Type catch clause variables as 'unknown' instead of 'any'. */
// "alwaysStrict": true, /* Ensure 'use strict' is always emitted. */
"noUnusedLocals": true, /* Enable error reporting when a local variables aren't read. */
"noUnusedParameters": true, /* Raise an error when a function parameter isn't read */
// "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */
"noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */
"noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */
// "noUncheckedIndexedAccess": true, /* Include 'undefined' in index signature results */
// "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */
// "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type */
// "allowUnusedLabels": true, /* Disable error reporting for unused labels. */
// "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */

/* Completeness */
// "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */
"skipLibCheck": true, /* Skip type checking all .d.ts files. */
"typeRoots": ["./node_modules/@types", "./src/typings"]
},
"include": ["src/**/*.ts"],
}
Loading