feat: add self-hosting

Author: gustavotoyota

.gitignore

@@ -14,4 +14,7 @@ dist
 
 .DS_Store
 
-deploy-*.sh
+deploy-*.sh
+
+postgres_data
+keydb_data

README.md

@@ -13,6 +13,22 @@ DeepNotes is an open source, end-to-end encrypted infinite canvas note-taking ap
 - **Flexible note system:** Organize your notes in whatever way you want.
 - **Lifelong storage:** Never lose your notes ever again.
 
+## Development
+
+```console
+git clone https://github.com/DeepNotesApp/DeepNotes && cd DeepNotes && cp template.env .env && pnpm install && pnpm run repo:build && docker-compose up -d
+```
+
+(On Windows, use WSL or Git Bash to run the commands above)
+
+1. Run `pnpm run dev` to start the backend servers.
+2. Run one of these commands to start the frontend server:
+   - `pnpm run dev:spa` to start the Single Page Application app.
+   - `pnpm run dev:ssr` to start the Server Side Rendered app.
+   - `pnpm run dev:electron` to start the Electron app.
+   - `pnpm run dev:android` to start the Android app (requires Android Studio).
+   - `pnpm run dev:ios` to start the iOS app (requires Xcode).
+
 ## Special thanks to these libraries for making DeepNotes possible:
 
 - [Vue.js](https://vuejs.org/): Reactivity, component system, and more

apps/app-server/src/data/redis.ts

@@ -1,6 +1,5 @@
 import { createRedisInstance } from '@deeplib/data';
-import type { Cluster } from 'ioredis';
 import { once } from 'lodash';
 
-export const getRedis = once((): Cluster => createRedisInstance());
-export const getSub = once((): Cluster => createRedisInstance());
+export const getRedis = once(() => createRedisInstance());
+export const getSub = once(() => createRedisInstance());

apps/app-server/src/env.d.ts

@@ -3,6 +3,8 @@ declare namespace NodeJS {
     DEV?: string;
     STAGING?: string;
 
+    SEND_EMAILS: string;
+
     HOST: string;
 
     APP_SERVER_PORT: string;

apps/app-server/src/trpc/api/sessions/login.ts

@@ -10,6 +10,7 @@ import type { DataTransaction } from '@stdlib/data';
 import { allAsyncProps, w3cEmailRegex } from '@stdlib/misc';
 import { TRPCError } from '@trpc/server';
 import type { Cluster } from 'ioredis';
+import type { Redis } from 'ioredis';
 import sodium from 'libsodium-wrappers';
 import { once } from 'lodash';
 import { nanoid } from 'nanoid';
@@ -242,7 +243,7 @@ export async function login({
 }
 
 async function _checkFailedLoginAttempts(input: {
-  redis: Cluster;
+  redis: Redis | Cluster;
 
   ip: string;
   email: string;
@@ -289,7 +290,7 @@ async function _checkFailedLoginAttempts(input: {
 }
 
 async function _incrementFailedLoginAttempts(input: {
-  redis: Cluster;
+  redis: Redis | Cluster;
 
   email: string;
   ip: string;

apps/app-server/src/trpc/api/users/account/email-change/request.ts

@@ -74,18 +74,24 @@ export async function request({
 
         // Send email
 
-        await sendMail({
-          from: {
-            name: 'DeepNotes',
-            email: '[email protected]',
-          },
-          to: [input.newEmail],
-          subject: 'Verify your email address',
-          html: `
-            Use the following code to verify your email address: <b>${emailVerificationCode}</b>.<br/>
-            If you did not request this action, you can safely ignore this email.
-          `,
-        });
+        if (process.env.SEND_EMAILS !== 'false') {
+          await sendMail({
+            from: {
+              name: 'DeepNotes',
+              email: '[email protected]',
+            },
+            to: [input.newEmail],
+            subject: 'Verify your email address',
+            html: `
+              Use the following code to verify your email address: <b>${emailVerificationCode}</b>.<br/>
+              If you did not request this action, you can safely ignore this email.
+            `,
+          });
+        } else {
+          return {
+            emailVerificationCode,
+          };
+        }
       });
     },
   );

apps/app-server/src/trpc/api/users/account/register.ts

@@ -10,6 +10,8 @@ import { derivePasswordValues } from 'src/utils/crypto';
 import { registerUser, userRegistrationSchema } from 'src/utils/users';
 import { z } from 'zod';
 
+import { verifyEmail } from './verify-email';
+
 const baseProcedure = publicProcedure.input(
   z
     .object({
@@ -28,7 +30,9 @@ export async function register({
   ctx,
   input,
 }: InferProcedureOpts<typeof baseProcedure>) {
-  return await ctx.dataAbstraction.transaction(async (dtrx) => {
+  let emailVerificationCode: string | null;
+
+  await ctx.dataAbstraction.transaction(async (dtrx) => {
     // Get user
 
     let user = await UserModel.query()
@@ -79,11 +83,24 @@ export async function register({
 
     // Send email
 
-    await sendRegistrationEmail({
-      email: input.email,
-      emailVerificationCode: user.email_verification_code,
-    });
+    if (process.env.SEND_EMAILS !== 'false') {
+      await sendRegistrationEmail({
+        email: input.email,
+        emailVerificationCode: user.email_verification_code,
+      });
+    }
+
+    emailVerificationCode = user.email_verification_code;
   });
+
+  if (process.env.SEND_EMAILS === 'false') {
+    await verifyEmail({
+      ctx,
+      input: {
+        emailVerificationCode: emailVerificationCode!,
+      },
+    });
+  }
 }
 
 export async function sendRegistrationEmail(input: {

apps/app-server/src/websocket/users/account/email-change/finish.ts

@@ -202,8 +202,10 @@ export async function changeEmailStep2({
       invalidateAllSessions(ctx.userId, { dtrx }),
     ]);
 
-    await ctx.stripe.customers.update(user.customer_id!, {
-      email: newEmail,
-    });
+    if (user.customer_id != null) {
+      await ctx.stripe.customers.update(user.customer_id!, {
+        email: newEmail,
+      });
+    }
   });
 }

apps/client/quasar.config.js

@@ -17,13 +17,15 @@ const dotenv = require('dotenv');
 
 const env = Object.assign(
   {},
-  require('dotenv-expand').expand(
-    dotenv.config({ path: '../../.env' }).parsed?.DEV
+  require('dotenv-expand').expand({
+    ...dotenv.config({ path: '../../.env' }),
+
+    ...(dotenv.config({ path: '../../.env' }).parsed?.DEV
       ? dotenv.config({ path: '../../.env' }).parsed?.PRODEV
         ? dotenv.config({ path: '../../.env.prodev' })
         : dotenv.config({ path: '../../.env.dev' })
-      : dotenv.config({ path: '../../.env.prod' }),
-  ).parsed,
+      : dotenv.config({ path: '../../.env.prod' })),
+  }).parsed,
   objFromEntries(
     Object.entries(process.env ?? {}).filter(([key]) => /^\w+$/.test(key)),
   ),

apps/client/src/env.d.ts

@@ -15,6 +15,8 @@ declare namespace NodeJS {
 
     STAGING?: string;
 
+    SEND_EMAILS: string;
+
     HOST: string;
 
     APP_SERVER_PORT: string;