chore: release v3.0.0

+ improve security by not exposing author's email

.dockerignore

@@ -1,8 +1,15 @@
+# Adonis default .gitignore ignores
 node_modules
-.env
-.next
+build
+coverage
 .vscode
-example.env
+.DS_STORE
+.env
+tmp
+storage
+
+# Additional .gitignore ignores (any custom file you wish)
+.idea
 
 # Additional good to have ignores for dockerignore
 Dockerfile*
@@ -11,3 +18,6 @@ docker-compose*
 *.md
 .git
 .gitignore
+
+# App specific
+database/seeders

.editorconfig

@@ -1,10 +1,21 @@
+# http://editorconfig.org
+
 root = true
 
 [*]
-charset = utf-8
-indent_style = space
+indent_style = tab
 indent_size = 2
-tab_width = 4
 end_of_line = lf
-insert_final_newline = true
+charset = utf-8
 trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.json]
+insert_final_newline = unset
+
+[**.min.js]
+indent_style = unset
+insert_final_newline = unset
+
+[*.md]
+trim_trailing_whitespace = false

.env.example

@@ -0,0 +1,16 @@
+# node ace generate:key
+APP_KEY=soY8ZAtItT_fCkNUADfgffZUUo675lOj
+TZ=UTC
+PORT=3333
+HOST=localhost
+LOG_LEVEL=info
+NODE_ENV=development
+SESSION_DRIVER=cookie
+DB_HOST=127.0.0.1
+DB_PORT=5432
+DB_USER=postgres
+DB_PASSWORD=my-links-pwd
+DB_DATABASE=my-links
+GOOGLE_CLIENT_ID=
+GOOGLE_CLIENT_SECRET=
+GOOGLE_CLIENT_CALLBACK_URL=http://localhost:3333/auth/callback

.eslintrc.json

@@ -1,6 +0,0 @@
-{
-  "extends": "next",
-  "rules": {
-    "react/no-unescaped-entities": "off"
-  }
-}

.gitattributes

@@ -1,2 +0,0 @@
-# Auto detect text files and perform LF normalization
-* text=auto

.gitignore

@@ -1,45 +1,24 @@
-# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+# Dependencies and AdonisJS build
+node_modules
+build
+tmp
 
-# dependencies
-/node_modules
-/.pnp
-.pnp.js
-
-# testing
-/coverage
-
-# next.js
-/.next/
-/out/
-
-# production
-/build
-
-# misc
-.DS_Store
-*.pem
-.idea
-.vscode
-
-# debug
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
-
-# local env files
+# Secrets
 .env
 .env.local
-.env.development.local
-.env.test.local
 .env.production.local
+.env.development.local
 
-# vercel
-.vercel
+# Frontend assets compiled code
+public/assets
 
-# sitemap files (they are generated by postbuild script)
-public/sitemap*
-public/robots.txt
+# Build tools specific
+npm-debug.log
+yarn-error.log
 
-# pwa static files
-/public/sw*
-/public/workbox-*
+# Editors specific
+.fleet
+.idea
+
+# Platform specific
+.DS_Store

.husky/pre-commit

@@ -1,4 +1 @@
-#!/usr/bin/env sh
-. "$(dirname -- "$0")/_/husky.sh"
-
 npx lint-staged

.idea/.gitignore

@@ -1,8 +0,0 @@
-# Default ignored files
-/shelf/
-/workspace.xml
-# Editor-based HTTP Client requests
-/httpRequests/
-# Datasource local storage ignored files
-/dataSources/
-/dataSources.local.xml

.idea/codeStyles/Project.xml

@@ -1,63 +0,0 @@
-<component name="ProjectCodeStyleConfiguration">
-  <code_scheme name="Project" version="173">
-    <HTMLCodeStyleSettings>
-      <option name="HTML_SPACE_INSIDE_EMPTY_TAG" value="true" />
-      <option name="HTML_QUOTE_STYLE" value="Single" />
-      <option name="HTML_ENFORCE_QUOTES" value="true" />
-    </HTMLCodeStyleSettings>
-    <JSCodeStyleSettings version="0">
-      <option name="FORCE_SEMICOLON_STYLE" value="true" />
-      <option name="SPACE_BEFORE_FUNCTION_LEFT_PARENTH" value="false" />
-      <option name="USE_DOUBLE_QUOTES" value="false" />
-      <option name="FORCE_QUOTE_STYlE" value="true" />
-      <option name="ENFORCE_TRAILING_COMMA" value="WhenMultiline" />
-      <option name="SPACES_WITHIN_OBJECT_LITERAL_BRACES" value="true" />
-      <option name="SPACES_WITHIN_IMPORTS" value="true" />
-    </JSCodeStyleSettings>
-    <TypeScriptCodeStyleSettings version="0">
-      <option name="FORCE_SEMICOLON_STYLE" value="true" />
-      <option name="SPACE_BEFORE_FUNCTION_LEFT_PARENTH" value="false" />
-      <option name="USE_DOUBLE_QUOTES" value="false" />
-      <option name="FORCE_QUOTE_STYlE" value="true" />
-      <option name="ENFORCE_TRAILING_COMMA" value="WhenMultiline" />
-      <option name="SPACES_WITHIN_OBJECT_LITERAL_BRACES" value="true" />
-      <option name="SPACES_WITHIN_IMPORTS" value="true" />
-    </TypeScriptCodeStyleSettings>
-    <VueCodeStyleSettings>
-      <option name="INTERPOLATION_NEW_LINE_AFTER_START_DELIMITER" value="false" />
-      <option name="INTERPOLATION_NEW_LINE_BEFORE_END_DELIMITER" value="false" />
-    </VueCodeStyleSettings>
-    <codeStyleSettings language="HTML">
-      <option name="SOFT_MARGINS" value="100" />
-      <indentOptions>
-        <option name="INDENT_SIZE" value="2" />
-        <option name="CONTINUATION_INDENT_SIZE" value="2" />
-        <option name="TAB_SIZE" value="2" />
-      </indentOptions>
-    </codeStyleSettings>
-    <codeStyleSettings language="JavaScript">
-      <option name="ALIGN_MULTILINE_PARAMETERS" value="false" />
-      <option name="SOFT_MARGINS" value="100" />
-      <indentOptions>
-        <option name="INDENT_SIZE" value="2" />
-        <option name="CONTINUATION_INDENT_SIZE" value="2" />
-        <option name="TAB_SIZE" value="2" />
-      </indentOptions>
-    </codeStyleSettings>
-    <codeStyleSettings language="TypeScript">
-      <option name="ALIGN_MULTILINE_PARAMETERS" value="false" />
-      <option name="SOFT_MARGINS" value="100" />
-      <indentOptions>
-        <option name="INDENT_SIZE" value="2" />
-        <option name="CONTINUATION_INDENT_SIZE" value="2" />
-        <option name="TAB_SIZE" value="2" />
-      </indentOptions>
-    </codeStyleSettings>
-    <codeStyleSettings language="Vue">
-      <option name="SOFT_MARGINS" value="100" />
-      <indentOptions>
-        <option name="CONTINUATION_INDENT_SIZE" value="2" />
-      </indentOptions>
-    </codeStyleSettings>
-  </code_scheme>
-</component>

.idea/codeStyles/codeStyleConfig.xml

@@ -1,5 +0,0 @@
-<component name="ProjectCodeStyleConfiguration">
-  <state>
-    <option name="USE_PER_PROJECT_SETTINGS" value="true" />
-  </state>
-</component>

.idea/misc.xml

@@ -1,5 +0,0 @@
-<project version="4">
-  <component name="ProjectRootManager">
-    <output url="file://$PROJECT_DIR$/out" />
-  </component>
-</project>

.idea/modules.xml

@@ -1,8 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="ProjectModuleManager">
-    <modules>
-      <module fileurl="file://$PROJECT_DIR$/.idea/my-links.iml" filepath="$PROJECT_DIR$/.idea/my-links.iml" />
-    </modules>
-  </component>
-</project>

.idea/my-links.iml

@@ -1,9 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<module type="JAVA_MODULE" version="4">
-  <component name="NewModuleRootManager" inherit-compiler-output="true">
-    <exclude-output />
-    <content url="file://$MODULE_DIR$" />
-    <orderEntry type="inheritedJdk" />
-    <orderEntry type="sourceFolder" forTests="false" />
-  </component>
-</module>

.idea/prettier.xml

@@ -1,7 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="PrettierConfiguration">
-    <option name="myConfigurationMode" value="AUTOMATIC" />
-    <option name="myRunOnSave" value="true" />
-  </component>
-</project>

.idea/vcs.xml

@@ -1,6 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="VcsDirectoryMappings">
-    <mapping directory="" vcs="Git" />
-  </component>
-</project>

.prettierrc

@@ -1,21 +0,0 @@
-{
-  "arrowParens": "always",
-  "bracketSameLine": false,
-  "bracketSpacing": true,
-  "semi": true,
-  "experimentalTernaries": false,
-  "singleQuote": true,
-  "jsxSingleQuote": true,
-  "quoteProps": "as-needed",
-  "trailingComma": "all",
-  "singleAttributePerLine": true,
-  "htmlWhitespaceSensitivity": "css",
-  "vueIndentScriptAndStyle": false,
-  "proseWrap": "preserve",
-  "insertPragma": false,
-  "printWidth": 80,
-  "requirePragma": false,
-  "tabWidth": 2,
-  "useTabs": false,
-  "embeddedLanguageFormatting": "auto"
-}

.release-it.json

@@ -1,11 +1,15 @@
 {
   "hooks": {
     "before:init": [
-      "npm run lint"
+      "pnpm format",
+      "pnpm lint"
     ]
   },
   "git": {
-    "commitMessage": "chore: release v${version}"
+    "commitMessage": "chore: release v${version}",
+    "commit": true,
+    "tag": true,
+    "push": true
   },
   "github": {
     "release": true

.vscode/extensions.json

@@ -0,0 +1,3 @@
+{
+	"recommendations": ["vunguyentuan.vscode-css-variables"]
+}

.vscode/settings.json

@@ -1,3 +1,20 @@
 {
-  "discord.enabled": false
+	"typescript.preferences.importModuleSpecifier": "non-relative",
+	/* Prefer tabs over spaces for accessibility */
+	"editor.insertSpaces": false,
+	"editor.detectIndentation": false,
+	/* Explorer */
+	"explorer.fileNesting.enabled": true,
+	"explorer.fileNesting.patterns": {
+		"*.js": "${capture}.js.map, ${capture}.min.js, ${capture}.d.ts",
+		"package.json": "pnpm-lock.yaml, tsconfig.json, eslint.config.js, .babelrc, vite.config.ts, .editorconfig",
+		"Makefile": "*compose.yml, Dockerfile, servers_pgadmin.json, .dockerignore"
+	},
+	"cssVariables.lookupFiles": [
+		"**/*.css",
+		"**/*.scss",
+		"**/*.sass",
+		"**/*.less",
+		"node_modules/@mantine/core/styles.css"
+	]
 }

CONTRIBUTING

@@ -0,0 +1,61 @@
+## Contributing to MyLinks
+
+First of all, thank you for considering contributing to MyLinks! We appreciate your time and efforts, and we want to make the contribution process as smooth and transparent as possible.
+
+### Table of Contents
+
+- [How to Contribute](#how-to-contribute)
+- [Code of Conduct](#code-of-conduct)
+- [Bug Reports and Feature Requests](#bug-reports-and-feature-requests)
+- [Pull Requests](#pull-requests)
+- [Development Setup](#development-setup)
+- [Community](#community)
+
+### How to Contribute
+
+There are several ways to contribute to MyLinks:
+- Reporting bugs
+- Suggesting new features
+- Improving the documentation
+- Writing or improving tests
+- Submitting code enhancements
+
+### Code of Conduct
+
+We are committed to fostering a welcoming community. Please review our [Code of Conduct](./CODE_OF_CONDUCT.md) to understand our expectations for all contributors.
+
+### Bug Reports and Feature Requests
+
+If you encounter any bugs or have ideas for new features, please create an issue in our [GitHub Issues](https://github.com/your-repo-url/issues). When reporting bugs, please provide:
+- A clear description of the problem.
+- Steps to reproduce the issue.
+- Any relevant log/error messages.
+
+For feature requests, please describe:
+- The problem you aim to solve.
+- How the feature could benefit users.
+
+### Pull Requests
+
+When making a pull request (PR), please adhere to the following guidelines:
+1. Fork the repository and create your branch from `main` (or the default branch).
+2. Run `pnpm run lint` and ensure your code passes the linter checks.
+3. Add tests for new features or bug fixes.
+4. Ensure your code passes existing tests (`pnpm run test`).
+5. Clearly describe the purpose of your pull request. Provide relevant issue numbers if applicable.
+
+To create a pull request:
+1. Push your branch to your forked repository.
+2. Submit a pull request (PR) to the `main` branch of MyLinks.
+
+> **Note:** All contributions are reviewed by maintainers. We may request changes or improvements before merging.
+
+### Development Setup
+
+For instructions on setting up your development environment, please refer to the [Getting Started](./README.md#getting-started) section in the `README.md`.
+
+### Community
+
+Feel free to join our community discussions on [our Trello board](https://trello.com/b/CwxkMeZp/mylinks) to collaborate on ideas, issues, and features!
+
+Thank you for helping make MyLinks better!

Dockerfile

@@ -1,54 +1,61 @@
-# Source : https://github.com/vercel/next.js/blob/canary/examples/with-docker/Dockerfile
+# Source : https://github.com/adonisjs-community/adonis-packages/blob/main/Dockerfile
 
-FROM node:18-alpine AS base
+FROM node:22.11-alpine3.20 AS base
 
-# Install dependencies only when needed
+RUN apk --no-cache add curl
+RUN corepack enable
+
+# All deps stage
 FROM base AS deps
 WORKDIR /app
+ADD package.json pnpm-lock.yaml ./
+RUN pnpm install --ignore-scripts
 
-# Install dependencies based on the preferred package manager
-COPY package.json package-lock.json* ./
-RUN npm pkg delete scripts.prepare
-RUN npm ci --omit=dev
-
-# Rebuild the source code only when needed
-FROM base AS builder
+# Production only deps stage
+FROM base AS production-deps
 WORKDIR /app
-COPY --from=deps /app/node_modules ./node_modules
-COPY . .
+ADD package.json pnpm-lock.yaml ./
+RUN pnpm install --ignore-scripts --prod
 
-ENV NEXT_TELEMETRY_DISABLED 1
-RUN npx prisma generate
-RUN npm run build
-
-# Production image, copy all the files and run next
-FROM base AS runner
+# Build stage
+FROM base AS build
 WORKDIR /app
+COPY --from=deps /app/node_modules /app/node_modules
+ADD . .
 
-ENV NODE_ENV production
-ENV NEXT_TELEMETRY_DISABLED 1
+ENV PORT=3333
+ENV HOST=localhost
+ENV LOG_LEVEL=info
+ENV APP_KEY=sLoJth45JD1vcS8n92Y2JUd8w3OL4HQb
+ENV NODE_ENV=production
+ENV SESSION_DRIVER=cookie
+ENV DB_HOST=127.0.0.1
+ENV DB_PORT=5432
+ENV DB_USER=db_user
+ENV DB_PASSWORD=db_password
+ENV DB_DATABASE=db_db
+ENV GOOGLE_CLIENT_ID=client_id
+ENV GOOGLE_CLIENT_SECRET=client_secret
+ENV GOOGLE_CLIENT_CALLBACK_URL=http://localhost:3333/auth/callback
 
-RUN addgroup --system --gid 1001 nodejs
-RUN adduser --system --uid 1001 nextjs
+RUN node ace izzy:routes
+RUN node ace build
 
-COPY --from=builder /app/public ./public
-COPY --from=builder /app/prisma ./prisma
+# Production stage
+FROM base
 
-# Set the correct permission for prerender cache
-RUN mkdir .next
-RUN chown nextjs:nodejs .next
+ENV NODE_ENV=production
+ENV LOG_LEVEL=debug
+ENV CACHE_VIEWS=false
+ENV SESSION_DRIVER=cookie
+ENV PORT=$PORT
 
-# Automatically leverage output traces to reduce image size
-# https://nextjs.org/docs/advanced-features/output-file-tracing
-COPY --from=builder --chown=nextjs:nodejs /app/.next/standalone ./
-COPY --from=builder --chown=nextjs:nodejs /app/.next/static ./.next/static
+WORKDIR /app
+COPY --from=production-deps /app/node_modules /app/node_modules
+COPY --from=build /app/build /app
 
-USER nextjs
+# Expose port
+EXPOSE $PORT
 
-EXPOSE 3000
-
-ENV PORT 3000
-# set hostname to localhost
-ENV HOSTNAME "0.0.0.0"
-
-CMD npx prisma migrate deploy && node server.js
+# Start app
+CMD node bin/console.js migration:run --force && node bin/server.js

LICENSE

@@ -0,0 +1,674 @@
+GNU GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+
+  The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works.  By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users.  We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors.  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+  To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights.  Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received.  You must make sure that they, too, receive
+or can get the source code.  And you must show them these terms so they
+know their rights.
+
+  Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+  For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software.  For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+  Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so.  This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software.  The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable.  Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products.  If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+  Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary.  To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                       TERMS AND CONDITIONS
+
+  0. Definitions.
+
+  "This License" refers to version 3 of the GNU General Public License.
+
+  "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+  "The Program" refers to any copyrightable work licensed under this
+License.  Each licensee is addressed as "you".  "Licensees" and
+"recipients" may be individuals or organizations.
+
+  To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy.  The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+  A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+  To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy.  Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+  To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies.  Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+  An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License.  If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+  1. Source Code.
+
+  The "source code" for a work means the preferred form of the work
+for making modifications to it.  "Object code" means any non-source
+form of a work.
+
+  A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+  The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form.  A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+  The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities.  However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work.  For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+  The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+  The Corresponding Source for a work in source code form is that
+same work.
+
+  2. Basic Permissions.
+
+  All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met.  This License explicitly affirms your unlimited
+permission to run the unmodified Program.  The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work.  This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+  You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force.  You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright.  Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+  Conveying under any other circumstances is permitted solely under
+the conditions stated below.  Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+  No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+  When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+  4. Conveying Verbatim Copies.
+
+  You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+  You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+  5. Conveying Modified Source Versions.
+
+  You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+    a) The work must carry prominent notices stating that you modified
+    it, and giving a relevant date.
+
+    b) The work must carry prominent notices stating that it is
+    released under this License and any conditions added under section
+    7.  This requirement modifies the requirement in section 4 to
+    "keep intact all notices".
+
+    c) You must license the entire work, as a whole, under this
+    License to anyone who comes into possession of a copy.  This
+    License will therefore apply, along with any applicable section 7
+    additional terms, to the whole of the work, and all its parts,
+    regardless of how they are packaged.  This License gives no
+    permission to license the work in any other way, but it does not
+    invalidate such permission if you have separately received it.
+
+    d) If the work has interactive user interfaces, each must display
+    Appropriate Legal Notices; however, if the Program has interactive
+    interfaces that do not display Appropriate Legal Notices, your
+    work need not make them do so.
+
+  A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit.  Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+  6. Conveying Non-Source Forms.
+
+  You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+    a) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by the
+    Corresponding Source fixed on a durable physical medium
+    customarily used for software interchange.
+
+    b) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by a
+    written offer, valid for at least three years and valid for as
+    long as you offer spare parts or customer support for that product
+    model, to give anyone who possesses the object code either (1) a
+    copy of the Corresponding Source for all the software in the
+    product that is covered by this License, on a durable physical
+    medium customarily used for software interchange, for a price no
+    more than your reasonable cost of physically performing this
+    conveying of source, or (2) access to copy the
+    Corresponding Source from a network server at no charge.
+
+    c) Convey individual copies of the object code with a copy of the
+    written offer to provide the Corresponding Source.  This
+    alternative is allowed only occasionally and noncommercially, and
+    only if you received the object code with such an offer, in accord
+    with subsection 6b.
+
+    d) Convey the object code by offering access from a designated
+    place (gratis or for a charge), and offer equivalent access to the
+    Corresponding Source in the same way through the same place at no
+    further charge.  You need not require recipients to copy the
+    Corresponding Source along with the object code.  If the place to
+    copy the object code is a network server, the Corresponding Source
+    may be on a different server (operated by you or a third party)
+    that supports equivalent copying facilities, provided you maintain
+    clear directions next to the object code saying where to find the
+    Corresponding Source.  Regardless of what server hosts the
+    Corresponding Source, you remain obligated to ensure that it is
+    available for as long as needed to satisfy these requirements.
+
+    e) Convey the object code using peer-to-peer transmission, provided
+    you inform other peers where the object code and Corresponding
+    Source of the work are being offered to the general public at no
+    charge under subsection 6d.
+
+  A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+  A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling.  In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage.  For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product.  A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+  "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source.  The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+  If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information.  But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+  The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed.  Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+  Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+  7. Additional Terms.
+
+  "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law.  If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+  When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it.  (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.)  You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+  Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+    a) Disclaiming warranty or limiting liability differently from the
+    terms of sections 15 and 16 of this License; or
+
+    b) Requiring preservation of specified reasonable legal notices or
+    author attributions in that material or in the Appropriate Legal
+    Notices displayed by works containing it; or
+
+    c) Prohibiting misrepresentation of the origin of that material, or
+    requiring that modified versions of such material be marked in
+    reasonable ways as different from the original version; or
+
+    d) Limiting the use for publicity purposes of names of licensors or
+    authors of the material; or
+
+    e) Declining to grant rights under trademark law for use of some
+    trade names, trademarks, or service marks; or
+
+    f) Requiring indemnification of licensors and authors of that
+    material by anyone who conveys the material (or modified versions of
+    it) with contractual assumptions of liability to the recipient, for
+    any liability that these contractual assumptions directly impose on
+    those licensors and authors.
+
+  All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10.  If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term.  If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+  If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+  Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+  8. Termination.
+
+  You may not propagate or modify a covered work except as expressly
+provided under this License.  Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+  However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+  Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+  Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License.  If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+  9. Acceptance Not Required for Having Copies.
+
+  You are not required to accept this License in order to receive or
+run a copy of the Program.  Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance.  However,
+nothing other than this License grants you permission to propagate or
+modify any covered work.  These actions infringe copyright if you do
+not accept this License.  Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+  10. Automatic Licensing of Downstream Recipients.
+
+  Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License.  You are not responsible
+for enforcing compliance by third parties with this License.
+
+  An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations.  If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+  You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License.  For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+  11. Patents.
+
+  A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based.  The
+work thus licensed is called the contributor's "contributor version".
+
+  A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version.  For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+  Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+  In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement).  To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+  If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients.  "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+  If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+  A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License.  You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+  Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+  12. No Surrender of Others' Freedom.
+
+  If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all.  For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+  13. Use with the GNU Affero General Public License.
+
+  Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work.  The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+  14. Revised Versions of this License.
+
+  The Free Software Foundation may publish revised and/or new versions of
+the GNU General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+  Each version is given a distinguishing version number.  If the
+Program specifies that a certain numbered version of the GNU General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation.  If the Program does not specify a version number of the
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+  If the Program specifies that a proxy can decide which future
+versions of the GNU General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+  Later license versions may give you additional or different
+permissions.  However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+  15. Disclaimer of Warranty.
+
+  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+  16. Limitation of Liability.
+
+  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+  17. Interpretation of Sections 15 and 16.
+
+  If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+  If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+
+    <program>  Copyright (C) <year>  <name of author>
+    This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, your program's commands
+might be different; for a GUI interface, you would use an "about box".
+
+  You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU GPL, see
+<https://www.gnu.org/licenses/>.
+
+  The GNU General Public License does not permit incorporating your program
+into proprietary programs.  If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.  But first, please read
+<https://www.gnu.org/licenses/why-not-lgpl.html>.

Makefile

@@ -1,14 +1,21 @@
-db:
-	docker compose -f dev.docker-compose.yml up -d --wait
-
-dev: db
-	npx prisma migrate deploy
-	npx prisma generate
-	npm run dev
-
-release:
-	npm run release
+dev:
+	@docker compose down
+	@docker compose -f dev.compose.yml pull
+	@docker compose -f dev.compose.yml up -d --wait
+	@node ace migration:fresh
+	@pnpm run dev
 
 prod:
-	-docker network create mylinks_app
-	docker compose up -d --build --wait
+	@docker compose -f dev.compose.yml down
+	@docker compose pull
+	@docker compose up -d --build --wait
+
+seed:
+	@node ace db:seed
+
+down:
+	@-docker compose down
+	@-docker compose -f dev.compose.yml down
+
+release:
+	@pnpm run release

README.md

@@ -1,39 +1,97 @@
-# MyLinks
+![](./docs//imgs/ml_dashboard_dark.png)
 
-MyLinks is a tool that lets you manage your favorite links in an intuitive interface.
-Free and open source software, focused on privacy and self-hosting.
+<div align="center">
+  <h1>MyLinks</h1>
+  <p>Another bookmark manager that lets you manage and share<br>your favorite links in an intuitive interface</p>
+  <p>
+    <a href="https://github.com/my-links/my-links/issues"><img src="https://img.shields.io/github/issues/my-links/my-links.svg" alt="GitHub Issues"></a>
+    <a href="https://github.com/my-links/my-links/blob/main/LICENSE"><img src="https://img.shields.io/github/license/my-links/my-links.svg" alt="License"></a>
+    <a href="https://trello.com/b/CwxkMeZp/mylinks"><img src="https://img.shields.io/badge/roadmap-Trello-blue" alt="Project Roadmap"></a>
+  </p>
+</div>
 
-# Setup
+## Table of Contents
+- [Main Features](#main-features)
+- [Getting Started](#getting-started)
+  - [Setup](#setup)
+  - [Development](#development)
+    - [Using Docker](#docker)
+    - [Using PNPM](#pnpm)
+  - [Production](#start-as-prod)
+- [Configuration](#configuration)
+  - [Generate app_key](#generate_app_key)
+  - [GitHub Actions](#github-actions)
+- [Contributing](#contributing)
+- [License](#license)
 
-Copy `example.env` file as `.env` and edit the properties.
+## Main Features 
 
-```
+- **Organize bookmarks with collections**: Keep your links tidy and easily accessible by grouping them into customizable collections.
+- **Intuitive link management**: Add, edit, and manage your bookmarks effortlessly with a user-friendly interface.
+- **Powerful search functionality**: Quickly locate any bookmark using the robust search feature, enhancing your productivity.
+- **Privacy-focused and open-source**: Enjoy a secure, transparent experience with an open-source platform that prioritizes your privacy.
+- **Browser extension (coming soon)**: Seamlessly integrate MyLinks into your browsing experience with the upcoming official browser extension.
+- **Shareable collections**: Easily share your curated collections with others, facilitating collaboration and information sharing.
+- **Community-driven development**: Contribute to MyLinks by suggesting improvements and features, helping to shape the tool to better meet user needs.
+
+## Getting Started
+
+### Setup
+
+Copy the `example.env` file to `.env` and edit the properties:
+
+```bash
 cp example.env .env
 ```
 
-## Dev
+### Development
 
-Leave the `DATABASE_URL` property filled
-
-```
-cd docker
-make start-dev
-cd ..
-npx prisma db push
-npm run dev
-```
-
-## Prod
-
-If you want to use your own database leave, the `DATABASE_URL` property filled in `docker/docker-compose.yml` with your database credentials, otherwise you'll have to delete it.
+#### Docker
 
 ```shell
-cd docker
-make build
-make start-prod
+make dev
 ```
 
-## GitHub Actions
+#### PNPM
+
+```shell
+# reset database and (force) apply all migrations
+node ace migration:fresh
+# start dev server
+pnpm run dev
+```
+
+### Start as prod
+
+#### Docker
+
+```shell
+make prod
+```
+
+#### PNPM
+
+```shell
+# create production build
+pnpm run build
+# go to the build folder
+cd build
+# clone your .env
+cp ../.env .
+# then start the production build
+pnpm run start
+```
+
+## Configuration
+
+### Generate app_key
+
+```shell
+# generate a random app key
+openssl rand -base64 32
+```
+
+### GitHub Actions
 
 Env var to define :
 
@@ -64,3 +122,15 @@ ssh-copy-id -i ./id_rsa.pub user@host
 ```
 
 > Source: https://github.com/appleboy/ssh-action#setting-up-a-ssh-key
+
+## Contributing
+We welcome contributions! Please visit our Trello board for project management and roadmap details. You can contribute by:
+
+- Creating issues for bugs, features, or discussions.
+- Submitting pull requests (PRs) with bug fixes, new features, or documentation updates.
+
+For detailed contribution guidelines, refer to the CONTRIBUTING.md file.
+
+## License
+
+This project is licensed under the [GPLv3 License](./LICENCE). 

ace.js

@@ -0,0 +1,27 @@
+/*
+|--------------------------------------------------------------------------
+| JavaScript entrypoint for running ace commands
+|--------------------------------------------------------------------------
+|
+| DO NOT MODIFY THIS FILE AS IT WILL BE OVERRIDDEN DURING THE BUILD
+| PROCESS.
+|
+| See docs.adonisjs.com/guides/typescript-build-process#creating-production-build
+|
+| Since, we cannot run TypeScript source code using "node" binary, we need
+| a JavaScript entrypoint to run ace commands.
+|
+| This file registers the "ts-node/esm" hook with the Node.js module system
+| and then imports the "bin/console.ts" file.
+|
+*/
+
+/**
+ * Register hook to process TypeScript files using ts-node
+ */
+import 'ts-node-maintained/register/esm';
+
+/**
+ * Import ace console entrypoint
+ */
+await import('./bin/console.js');

adonisrc.ts

@@ -0,0 +1,110 @@
+import { defineConfig } from '@adonisjs/core/app';
+
+export default defineConfig({
+	/*
+  |--------------------------------------------------------------------------
+  | Commands
+  |--------------------------------------------------------------------------
+  |
+  | List of ace commands to register from packages. The application commands
+  | will be scanned automatically from the "./commands" directory.
+  |
+  */
+	commands: [
+		() => import('@adonisjs/core/commands'),
+		() => import('@adonisjs/lucid/commands'),
+		() => import('@izzyjs/route/commands'),
+	],
+
+	/*
+  |--------------------------------------------------------------------------
+  | Service providers
+  |--------------------------------------------------------------------------
+  |
+  | List of service providers to import and register when booting the
+  | application
+  |
+  */
+	providers: [
+		() => import('@adonisjs/core/providers/app_provider'),
+		() => import('@adonisjs/core/providers/hash_provider'),
+		{
+			file: () => import('@adonisjs/core/providers/repl_provider'),
+			environment: ['repl', 'test'],
+		},
+		() => import('@adonisjs/core/providers/vinejs_provider'),
+		() => import('@adonisjs/core/providers/edge_provider'),
+		() => import('@adonisjs/session/session_provider'),
+		() => import('@adonisjs/vite/vite_provider'),
+		() => import('@adonisjs/shield/shield_provider'),
+		() => import('@adonisjs/static/static_provider'),
+		() => import('@adonisjs/cors/cors_provider'),
+		() => import('@adonisjs/lucid/database_provider'),
+		() => import('@adonisjs/auth/auth_provider'),
+		() => import('@adonisjs/inertia/inertia_provider'),
+		() => import('@adonisjs/ally/ally_provider'),
+		() => import('@izzyjs/route/izzy_provider'),
+		() => import('#providers/route_provider'),
+	],
+
+	/*
+  |--------------------------------------------------------------------------
+  | Preloads
+  |--------------------------------------------------------------------------
+  |
+  | List of modules to import before starting the application.
+  |
+  */
+	preloads: [() => import('#start/routes'), () => import('#start/kernel')],
+
+	/*
+  |--------------------------------------------------------------------------
+  | Tests
+  |--------------------------------------------------------------------------
+  |
+  | List of test suites to organize tests by their type. Feel free to remove
+  | and add additional suites.
+  |
+  */
+	tests: {
+		suites: [
+			{
+				files: ['tests/unit/**/*.spec(.ts|.js)'],
+				name: 'unit',
+				timeout: 2000,
+			},
+			{
+				files: ['tests/functional/**/*.spec(.ts|.js)'],
+				name: 'functional',
+				timeout: 30000,
+			},
+		],
+		forceExit: false,
+	},
+
+	/*
+  |--------------------------------------------------------------------------
+  | Metafiles
+  |--------------------------------------------------------------------------
+  |
+  | A collection of files you want to copy to the build folder when creating
+  | the production build.
+  |
+  */
+	metaFiles: [
+		{
+			pattern: 'resources/views/**/*.edge',
+			reloadServer: false,
+		},
+		{
+			pattern: 'public/**',
+			reloadServer: false,
+		},
+	],
+
+	assetsBundler: false,
+	unstable_assembler: {
+		onBuildStarting: [() => import('@adonisjs/vite/build_hook')],
+		onDevServerStarted: [() => import('@izzyjs/route/dev_hook')],
+	},
+});

app/constants/keys.ts

@@ -0,0 +1,19 @@
+const OPEN_SEARCH_KEY = 's';
+const ESCAPE_KEY = 'escape';
+
+const OPEN_CREATE_LINK_KEY = 'l';
+const OPEN_CREATE_COLLECTION_KEY = 'c';
+
+const ARROW_UP = 'ArrowUp';
+const ARROW_DOWN = 'ArrowDown';
+
+const KEYS = {
+	ARROW_DOWN,
+	ARROW_UP,
+	ESCAPE_KEY,
+	OPEN_CREATE_COLLECTION_KEY,
+	OPEN_CREATE_LINK_KEY,
+	OPEN_SEARCH_KEY,
+};
+
+export default KEYS;

app/constants/paths.ts

@@ -0,0 +1,8 @@
+const PATHS = {
+	AUTHOR: 'https://www.sonny.dev/?utm_source=mylinks',
+	REPO_GITHUB: 'https://github.com/Sonny93/my-links',
+	EXTENSION:
+		'https://chromewebstore.google.com/detail/mylinks/agkmlplihacolkakgeccnbhphnepphma',
+} as const;
+
+export default PATHS;

app/constants/session.ts

@@ -0,0 +1,2 @@
+export const PREFER_DARK_THEME = 'prefer_dark_theme';
+export const DARK_THEME_DEFAULT_VALUE = true;

app/controllers/admin_controller.ts

@@ -0,0 +1,46 @@
+import CollectionsController from '#controllers/collections_controller';
+import LinksController from '#controllers/links_controller';
+import UsersController from '#controllers/users_controller';
+import User from '#models/user';
+import { inject } from '@adonisjs/core';
+import type { HttpContext } from '@adonisjs/core/http';
+
+class UserWithRelationCountDto {
+	constructor(private user: User) {}
+
+	toJson = () => ({
+		id: this.user.id,
+		email: this.user.email,
+		fullname: this.user.name,
+		avatarUrl: this.user.avatarUrl,
+		isAdmin: this.user.isAdmin,
+		createdAt: this.user.createdAt.toString(),
+		updatedAt: this.user.updatedAt.toString(),
+		lastSeenAt:
+			this.user.lastSeenAt?.toString() ?? this.user.updatedAt.toString(),
+		linksCount: Number(this.user.$extras.totalLinks),
+		collectionsCount: Number(this.user.$extras.totalCollections),
+	});
+}
+
+@inject()
+export default class AdminController {
+	constructor(
+		protected usersController: UsersController,
+		protected linksController: LinksController,
+		protected collectionsController: CollectionsController
+	) {}
+
+	async index({ inertia }: HttpContext) {
+		const users = await this.usersController.getAllUsersWithTotalRelations();
+		const linksCount = await this.linksController.getTotalLinksCount();
+		const collectionsCount =
+			await this.collectionsController.getTotalCollectionsCount();
+
+		return inertia.render('admin/dashboard', {
+			users: users.map((user) => new UserWithRelationCountDto(user).toJson()),
+			totalLinks: linksCount,
+			totalCollections: collectionsCount,
+		});
+	}
+}

app/controllers/apps_controller.ts

@@ -0,0 +1,13 @@
+import { PREFER_DARK_THEME } from '#constants/session';
+import { updateUserThemeValidator } from '#validators/user';
+import type { HttpContext } from '@adonisjs/core/http';
+
+export default class AppsController {
+	async updateUserTheme({ request, session, response }: HttpContext) {
+		const { preferDarkTheme } = await request.validateUsing(
+			updateUserThemeValidator
+		);
+		session.put(PREFER_DARK_THEME, preferDarkTheme);
+		return response.ok({ message: 'ok' });
+	}
+}

app/controllers/collections_controller.ts

@@ -0,0 +1,143 @@
+import Collection from '#models/collection';
+import User from '#models/user';
+import {
+	createCollectionValidator,
+	deleteCollectionValidator,
+	updateCollectionValidator,
+} from '#validators/collection';
+import type { HttpContext } from '@adonisjs/core/http';
+import db from '@adonisjs/lucid/services/db';
+
+export default class CollectionsController {
+	// Dashboard
+	async index({ auth, inertia, request, response }: HttpContext) {
+		const collections = await this.getCollectionsByAuthorId(auth.user!.id);
+		if (collections.length === 0) {
+			return response.redirectToNamedRoute('collection.create-form');
+		}
+
+		const activeCollectionId = Number(request.qs()?.collectionId ?? '');
+		const activeCollection = collections.find(
+			(c) => c.id === activeCollectionId
+		);
+
+		if (!activeCollection && !!activeCollectionId) {
+			return response.redirectToNamedRoute('dashboard');
+		}
+
+		// TODO: Create DTOs
+		return inertia.render('dashboard', {
+			collections: collections.map((collection) => collection.serialize()),
+			activeCollection:
+				activeCollection?.serialize() || collections[0].serialize(),
+		});
+	}
+
+	// Create collection form
+	async showCreatePage({ inertia, auth }: HttpContext) {
+		const collections = await this.getCollectionsByAuthorId(auth.user!.id);
+		return inertia.render('collections/create', {
+			disableHomeLink: collections.length === 0,
+		});
+	}
+
+	// Method called when creating a collection
+	async store({ request, response, auth }: HttpContext) {
+		const payload = await request.validateUsing(createCollectionValidator);
+		const collection = await Collection.create({
+			...payload,
+			authorId: auth.user?.id!,
+		});
+		return this.redirectToCollectionId(response, collection.id);
+	}
+
+	async showEditPage({ auth, request, inertia, response }: HttpContext) {
+		const collectionId = request.qs()?.collectionId;
+		if (!collectionId) {
+			return response.redirectToNamedRoute('dashboard');
+		}
+
+		const collection = await this.getCollectionById(
+			collectionId,
+			auth.user!.id
+		);
+		return inertia.render('collections/edit', {
+			collection,
+		});
+	}
+
+	async update({ request, auth, response }: HttpContext) {
+		const { params, ...payload } = await request.validateUsing(
+			updateCollectionValidator
+		);
+
+		// Cant use validator (vinejs) custom rule 'cause its too generic,
+		// because we have to find a collection by identifier and
+		// check whether the current user is the author.
+		// https://vinejs.dev/docs/extend/custom_rules
+		await this.getCollectionById(params.id, auth.user!.id);
+
+		await Collection.updateOrCreate(
+			{
+				id: params.id,
+			},
+			payload
+		);
+		return this.redirectToCollectionId(response, params.id);
+	}
+
+	async showDeletePage({ auth, request, inertia, response }: HttpContext) {
+		const collectionId = request.qs()?.collectionId;
+		if (!collectionId) {
+			return response.redirectToNamedRoute('dashboard');
+		}
+
+		const collection = await this.getCollectionById(
+			collectionId,
+			auth.user!.id
+		);
+		return inertia.render('collections/delete', {
+			collection,
+		});
+	}
+
+	async delete({ request, auth, response }: HttpContext) {
+		const { params } = await request.validateUsing(deleteCollectionValidator);
+		const collection = await this.getCollectionById(params.id, auth.user!.id);
+		await collection.delete();
+		return response.redirectToNamedRoute('dashboard');
+	}
+
+	async getTotalCollectionsCount() {
+		const totalCount = await db.from('collections').count('* as total');
+		return Number(totalCount[0].total);
+	}
+
+	/**
+	 * Get collection by id.
+	 *
+	 * /!\ Only return private collection (create by the current user)
+	 */
+	async getCollectionById(id: Collection['id'], userId: User['id']) {
+		return await Collection.query()
+			.where('id', id)
+			.andWhere('author_id', userId)
+			.firstOrFail();
+	}
+
+	async getCollectionsByAuthorId(authorId: User['id']) {
+		return await Collection.query()
+			.where('author_id', authorId)
+			.orderBy('created_at')
+			.preload('links');
+	}
+
+	redirectToCollectionId(
+		response: HttpContext['response'],
+		collectionId: Collection['id']
+	) {
+		return response.redirectToNamedRoute('dashboard', {
+			qs: { collectionId },
+		});
+	}
+}

app/controllers/favicons_controller.ts

@@ -0,0 +1,160 @@
+import FaviconNotFoundException from '#exceptions/favicon_not_found_exception';
+import { cache } from '#lib/cache';
+import type { HttpContext } from '@adonisjs/core/http';
+import logger from '@adonisjs/core/services/logger';
+import { parse } from 'node-html-parser';
+
+interface Favicon {
+	buffer: Buffer;
+	url: string;
+	type: string;
+	size: number;
+}
+
+export default class FaviconsController {
+	private userAgent =
+		'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/119.0.0.0 Safari/537.36 Edg/119.0.0.0';
+	private relList = [
+		'icon',
+		'shortcut icon',
+		'apple-touch-icon',
+		'apple-touch-icon-precomposed',
+		'apple-touch-startup-image',
+		'mask-icon',
+		'fluid-icon',
+	];
+
+	async index(ctx: HttpContext) {
+		const url = ctx.request.qs()?.url;
+		if (!url) {
+			throw new Error('Missing URL');
+		}
+
+		const cacheNs = cache.namespace('favicon');
+		const favicon = await cacheNs.getOrSet({
+			key: url,
+			ttl: '1h',
+			factory: () => this.tryGetFavicon(url),
+		});
+		return this.sendImage(ctx, favicon);
+	}
+
+	private async tryGetFavicon(url: string): Promise<Favicon> {
+		const faviconUrl = this.buildFaviconUrl(url, '/favicon.ico');
+		try {
+			return await this.fetchFavicon(faviconUrl);
+		} catch {
+			logger.debug(`Unable to retrieve favicon from ${faviconUrl}`);
+		}
+
+		const documentText = await this.fetchDocumentText(url);
+		const faviconPath = this.extractFaviconPath(documentText);
+
+		if (!faviconPath) {
+			throw new FaviconNotFoundException(`No favicon path found in ${url}`);
+		}
+
+		if (faviconPath.startsWith('http')) {
+			try {
+				return await this.fetchFavicon(faviconPath);
+			} catch {
+				logger.debug(`Unable to retrieve favicon from ${faviconPath}`);
+			}
+		}
+
+		return this.fetchFaviconFromPath(url, faviconPath);
+	}
+
+	private async fetchFavicon(url: string): Promise<Favicon> {
+		const response = await this.fetchWithUserAgent(url);
+		if (!response.ok) {
+			throw new FaviconNotFoundException(`Request to favicon ${url} failed`);
+		}
+
+		const blob = await response.blob();
+		if (!this.isImage(blob.type) || blob.size === 0) {
+			throw new FaviconNotFoundException(`Invalid image at ${url}`);
+		}
+
+		return {
+			buffer: Buffer.from(await blob.arrayBuffer()),
+			url: response.url,
+			type: blob.type,
+			size: blob.size,
+		};
+	}
+
+	private async fetchDocumentText(url: string): Promise<string> {
+		const response = await this.fetchWithUserAgent(url);
+		if (!response.ok) {
+			throw new FaviconNotFoundException(`Request to ${url} failed`);
+		}
+
+		return await response.text();
+	}
+
+	private extractFaviconPath(html: string): string | undefined {
+		const document = parse(html);
+		const link = document
+			.getElementsByTagName('link')
+			.find((element) => this.relList.includes(element.getAttribute('rel')!));
+		return link?.getAttribute('href');
+	}
+
+	private async fetchFaviconFromPath(
+		baseUrl: string,
+		path: string
+	): Promise<Favicon> {
+		if (this.isBase64Image(path)) {
+			const buffer = this.convertBase64ToBuffer(path);
+			return {
+				buffer,
+				type: 'image/x-icon',
+				size: buffer.length,
+				url: path,
+			};
+		}
+
+		const faviconUrl = this.buildFaviconUrl(baseUrl, path);
+		return this.fetchFavicon(faviconUrl);
+	}
+
+	private buildFaviconUrl(base: string, path: string): string {
+		const { origin } = new URL(base);
+		if (path.startsWith('/')) {
+			return origin + path;
+		}
+
+		const basePath = this.urlWithoutSearchParams(base);
+		const baseUrl = basePath.endsWith('/') ? basePath.slice(0, -1) : basePath;
+		return `${baseUrl}/${path}`;
+	}
+
+	private urlWithoutSearchParams(url: string): string {
+		const { protocol, host, pathname } = new URL(url);
+		return `${protocol}//${host}${pathname}`;
+	}
+
+	private isImage(type: string): boolean {
+		return type.startsWith('image/');
+	}
+
+	private isBase64Image(data: string): boolean {
+		return data.startsWith('data:image/');
+	}
+
+	private convertBase64ToBuffer(base64: string): Buffer {
+		return Buffer.from(base64.split(',')[1], 'base64');
+	}
+
+	private async fetchWithUserAgent(url: string): Promise<Response> {
+		const headers = new Headers({ 'User-Agent': this.userAgent });
+		return fetch(url, { headers });
+	}
+
+	private sendImage(ctx: HttpContext, { buffer, type, size }: Favicon) {
+		ctx.response.header('Content-Type', type);
+		ctx.response.header('Content-Length', size.toString());
+		ctx.response.send(buffer, true);
+	}
+}

app/controllers/links_controller.ts

@@ -0,0 +1,131 @@
+import CollectionsController from '#controllers/collections_controller';
+import Link from '#models/link';
+import {
+	createLinkValidator,
+	deleteLinkValidator,
+	updateLinkFavoriteStatusValidator,
+	updateLinkValidator,
+} from '#validators/link';
+import { inject } from '@adonisjs/core';
+import type { HttpContext } from '@adonisjs/core/http';
+import db from '@adonisjs/lucid/services/db';
+
+@inject()
+export default class LinksController {
+	constructor(protected collectionsController: CollectionsController) {}
+
+	async showCreatePage({ auth, inertia }: HttpContext) {
+		const collections =
+			await this.collectionsController.getCollectionsByAuthorId(auth.user!.id);
+		return inertia.render('links/create', { collections });
+	}
+
+	async store({ auth, request, response }: HttpContext) {
+		const { collectionId, ...payload } =
+			await request.validateUsing(createLinkValidator);
+
+		await this.collectionsController.getCollectionById(
+			collectionId,
+			auth.user!.id
+		);
+		await Link.create({
+			...payload,
+			collectionId,
+			authorId: auth.user?.id!,
+		});
+		return this.collectionsController.redirectToCollectionId(
+			response,
+			collectionId
+		);
+	}
+
+	async showEditPage({ auth, inertia, request, response }: HttpContext) {
+		const linkId = request.qs()?.linkId;
+		if (!linkId) {
+			return response.redirectToNamedRoute('dashboard');
+		}
+
+		const userId = auth.user!.id;
+		const collections =
+			await this.collectionsController.getCollectionsByAuthorId(userId);
+		const link = await this.getLinkById(linkId, userId);
+
+		return inertia.render('links/edit', { collections, link });
+	}
+
+	async update({ request, auth, response }: HttpContext) {
+		const { params, ...payload } =
+			await request.validateUsing(updateLinkValidator);
+
+		// Throw if invalid link id provided
+		await this.getLinkById(params.id, auth.user!.id);
+
+		await Link.updateOrCreate(
+			{
+				id: params.id,
+			},
+			payload
+		);
+
+		return response.redirectToNamedRoute('dashboard', {
+			qs: { collectionId: payload.collectionId },
+		});
+	}
+
+	async toggleFavorite({ request, auth, response }: HttpContext) {
+		const { params, favorite } = await request.validateUsing(
+			updateLinkFavoriteStatusValidator
+		);
+
+		// Throw if invalid link id provided
+		await this.getLinkById(params.id, auth.user!.id);
+
+		await Link.updateOrCreate(
+			{
+				id: params.id,
+			},
+			{ favorite }
+		);
+
+		return response.json({ status: 'ok' });
+	}
+
+	async showDeletePage({ auth, inertia, request, response }: HttpContext) {
+		const linkId = request.qs()?.linkId;
+		if (!linkId) {
+			return response.redirectToNamedRoute('dashboard');
+		}
+
+		const link = await this.getLinkById(linkId, auth.user!.id);
+		await link.load('collection');
+		return inertia.render('links/delete', { link });
+	}
+
+	async delete({ request, auth, response }: HttpContext) {
+		const { params } = await request.validateUsing(deleteLinkValidator);
+
+		const link = await this.getLinkById(params.id, auth.user!.id);
+		await link.delete();
+
+		return response.redirectToNamedRoute('dashboard', {
+			qs: { collectionId: link.id },
+		});
+	}
+
+	async getTotalLinksCount() {
+		const totalCount = await db.from('links').count('* as total');
+		return Number(totalCount[0].total);
+	}
+
+	/**
+	 * Get link by id.
+	 *
+	 * /!\ Only return private link (create by the current user)
+	 */
+	private async getLinkById(id: Link['id'], userId: Link['id']) {
+		return await Link.query()
+			.where('id', id)
+			.andWhere('author_id', userId)
+			.firstOrFail();
+	}
+}

app/controllers/searches_controller.ts

@@ -0,0 +1,18 @@
+import type { HttpContext } from '@adonisjs/core/http';
+import db from '@adonisjs/lucid/services/db';
+
+export default class SearchesController {
+	async search({ request, auth }: HttpContext) {
+		const term = request.qs()?.term;
+		if (!term) {
+			console.warn('qs term null');
+			return { error: 'missing "term" query param' };
+		}
+
+		const { rows } = await db.rawQuery('SELECT * FROM search_text(?, ?)', [
+			term,
+			auth.user!.id,
+		]);
+		return { results: rows };
+	}
+}

app/controllers/shared_collections_controller.ts

@@ -0,0 +1,61 @@
+import { Visibility } from '#enums/visibility';
+import Collection from '#models/collection';
+import Link from '#models/link';
+import User from '#models/user';
+import { getSharedCollectionValidator } from '#validators/shared_collection';
+import type { HttpContext } from '@adonisjs/core/http';
+
+class LinkWithoutFavoriteDto {
+	constructor(private link: Link) {}
+
+	toJson = () => ({
+		id: this.link.id,
+		name: this.link.name,
+		description: this.link.description,
+		url: this.link.url,
+		collectionId: this.link.collectionId,
+		createdAt: this.link.createdAt.toString(),
+		updatedAt: this.link.updatedAt.toString(),
+	});
+}
+
+class UserWithoutEmailDto {
+	constructor(private user: User) {}
+
+	toJson = () => ({
+		id: this.user.id,
+		fullname: this.user.name,
+		avatarUrl: this.user.avatarUrl,
+		isAdmin: this.user.isAdmin,
+		createdAt: this.user.createdAt.toString(),
+		updatedAt: this.user.updatedAt.toString(),
+	});
+}
+
+export default class SharedCollectionsController {
+	async index({ request, inertia }: HttpContext) {
+		const { params } = await request.validateUsing(
+			getSharedCollectionValidator
+		);
+
+		const collection = await this.getSharedCollectionById(params.id);
+		return inertia.render('shared', { collection });
+	}
+
+	private async getSharedCollectionById(id: Collection['id']) {
+		const collection = await Collection.query()
+			.where('id', id)
+			.andWhere('visibility', Visibility.PUBLIC)
+			.preload('links')
+			.preload('author')
+			.firstOrFail();
+
+		return {
+			...collection.serialize(),
+			links: collection.links.map((link) =>
+				new LinkWithoutFavoriteDto(link).toJson()
+			),
+			author: new UserWithoutEmailDto(collection.author).toJson(),
+		};
+	}
+}

app/controllers/users_controller.ts

@@ -0,0 +1,78 @@
+import User from '#models/user';
+import type { HttpContext } from '@adonisjs/core/http';
+import logger from '@adonisjs/core/services/logger';
+import db from '@adonisjs/lucid/services/db';
+import { RouteName } from '@izzyjs/route/types';
+
+export default class UsersController {
+	private redirectTo: RouteName = 'auth';
+
+	login({ inertia }: HttpContext) {
+		return inertia.render('login');
+	}
+
+	google = ({ ally }: HttpContext) => ally.use('google').redirect();
+
+	async callbackAuth({ ally, auth, response, session }: HttpContext) {
+		const google = ally.use('google');
+		if (google.accessDenied()) {
+			// TODO: translate error messages + show them in UI
+			session.flash('flash', 'Access was denied');
+			return response.redirectToNamedRoute(this.redirectTo);
+		}
+
+		if (google.stateMisMatch()) {
+			session.flash('flash', 'Request expired. Retry again');
+			return response.redirectToNamedRoute(this.redirectTo);
+		}
+
+		if (google.hasError()) {
+			session.flash('flash', google.getError() || 'Something went wrong');
+			return response.redirectToNamedRoute(this.redirectTo);
+		}
+
+		const userCount = await db.from('users').count('* as total');
+		const {
+			email,
+			id: providerId,
+			name,
+			nickName,
+			avatarUrl,
+			token,
+		} = await google.user();
+		const user = await User.updateOrCreate(
+			{
+				email,
+			},
+			{
+				email,
+				providerId,
+				name,
+				nickName,
+				avatarUrl,
+				token,
+				providerType: 'google',
+				isAdmin: userCount[0].total === '0' ? true : undefined,
+			}
+		);
+
+		await auth.use('web').login(user);
+		session.flash('flash', 'Successfully authenticated');
+		logger.info(`[${user.email}] auth success`);
+
+		response.redirectToNamedRoute('dashboard');
+	}
+
+	async logout({ auth, response, session }: HttpContext) {
+		await auth.use('web').logout();
+		session.flash('flash', 'Successfully disconnected');
+		logger.info(`[${auth.user?.email}] disconnected successfully`);
+		response.redirect('/');
+	}
+
+	async getAllUsersWithTotalRelations() {
+		return User.query()
+			.withCount('collections', (q) => q.as('totalCollections'))
+			.withCount('links', (q) => q.as('totalLinks'));
+	}
+}

app/enums/visibility.ts

@@ -0,0 +1,4 @@
+export enum Visibility {
+	PUBLIC = 'PUBLIC',
+	PRIVATE = 'PRIVATE',
+}

app/exceptions/favicon_not_found_exception.ts

@@ -0,0 +1,20 @@
+import { Exception } from '@adonisjs/core/exceptions';
+import { HttpContext } from '@adonisjs/core/http';
+import logger from '@adonisjs/core/services/logger';
+import { createReadStream } from 'node:fs';
+import { resolve } from 'node:path';
+
+export default class FaviconNotFoundException extends Exception {
+	static status = 404;
+	static code = 'E_FAVICON_NOT_FOUND';
+
+	async handle(error: this, ctx: HttpContext) {
+		const readStream = createReadStream(
+			resolve(process.cwd(), './public/empty-image.png')
+		);
+
+		ctx.response.header('Content-Type', 'image/png');
+		ctx.response.stream(readStream);
+		logger.debug(error.message);
+	}
+}

app/exceptions/handler.ts

@@ -0,0 +1,54 @@
+import { ExceptionHandler, HttpContext } from '@adonisjs/core/http';
+import app from '@adonisjs/core/services/app';
+import type {
+	StatusPageRange,
+	StatusPageRenderer,
+} from '@adonisjs/core/types/http';
+import { errors } from '@adonisjs/lucid';
+
+export default class HttpExceptionHandler extends ExceptionHandler {
+	/**
+	 * In debug mode, the exception handler will display verbose errors
+	 * with pretty printed stack traces.
+	 */
+	protected debug = !app.inProduction;
+
+	/**
+	 * Status pages are used to display a custom HTML pages for certain error
+	 * codes. You might want to enable them in production only, but feel
+	 * free to enable them in development as well.
+	 */
+	protected renderStatusPages = app.inProduction;
+
+	/**
+	 * Status pages is a collection of error code range and a callback
+	 * to return the HTML contents to send as a response.
+	 */
+	protected statusPages: Record<StatusPageRange, StatusPageRenderer> = {
+		'404': (error, { inertia }) =>
+			inertia.render('errors/not_found', { error }),
+		'500..599': (error, { inertia }) =>
+			inertia.render('errors/server_error', { error }),
+	};
+
+	/**
+	 * The method is used for handling errors and returning
+	 * response to the client
+	 */
+	async handle(error: unknown, ctx: HttpContext) {
+		if (error instanceof errors.E_ROW_NOT_FOUND) {
+			return ctx.response.redirectToNamedRoute('dashboard');
+		}
+		return super.handle(error, ctx);
+	}
+
+	/**
+	 * The method is used to report error to the logging service or
+	 * the a third party error monitoring service.
+	 *
+	 * @note You should not attempt to send a response from this method.
+	 */
+	async report(error: unknown, ctx: HttpContext) {
+		return super.report(error, ctx);
+	}
+}

app/lib/cache.ts

@@ -0,0 +1,10 @@
+import { BentoCache, bentostore } from 'bentocache';
+import { memoryDriver } from 'bentocache/drivers/memory';
+
+export const cache = new BentoCache({
+	default: 'cache',
+
+	stores: {
+		cache: bentostore().useL1Layer(memoryDriver({ maxSize: 10_000 })),
+	},
+});

app/middleware/admin_middleware.ts

@@ -0,0 +1,11 @@
+import type { HttpContext } from '@adonisjs/core/http';
+import type { NextFn } from '@adonisjs/core/types/http';
+
+export default class AdminMiddleware {
+	async handle(ctx: HttpContext, next: NextFn) {
+		if (!ctx.auth.user?.isAdmin) {
+			return ctx.response.redirectToNamedRoute('dashboard');
+		}
+		return next();
+	}
+}

app/middleware/auth_middleware.ts

@@ -0,0 +1,28 @@
+import type { Authenticators } from '@adonisjs/auth/types';
+import type { HttpContext } from '@adonisjs/core/http';
+import type { NextFn } from '@adonisjs/core/types/http';
+import { route } from '@izzyjs/route/client';
+
+/**
+ * Auth middleware is used authenticate HTTP requests and deny
+ * access to unauthenticated users.
+ */
+export default class AuthMiddleware {
+	/**
+	 * The URL to redirect to, when authentication fails
+	 */
+	redirectTo = route('auth').path;
+
+	async handle(
+		ctx: HttpContext,
+		next: NextFn,
+		options: {
+			guards?: (keyof Authenticators)[];
+		} = {}
+	) {
+		await ctx.auth.authenticateUsing(options.guards, {
+			loginRoute: this.redirectTo,
+		});
+		return next();
+	}
+}

app/middleware/container_bindings_middleware.ts

@@ -0,0 +1,19 @@
+import { Logger } from '@adonisjs/core/logger';
+import { HttpContext } from '@adonisjs/core/http';
+import { NextFn } from '@adonisjs/core/types/http';
+
+/**
+ * The container bindings middleware binds classes to their request
+ * specific value using the container resolver.
+ *
+ * - We bind "HttpContext" class to the "ctx" object
+ * - And bind "Logger" class to the "ctx.logger" object
+ */
+export default class ContainerBindingsMiddleware {
+	handle(ctx: HttpContext, next: NextFn) {
+		ctx.containerResolver.bindValue(HttpContext, ctx);
+		ctx.containerResolver.bindValue(Logger, ctx.logger);
+
+		return next();
+	}
+}

app/middleware/guest_middleware.ts

@@ -0,0 +1,31 @@
+import type { HttpContext } from '@adonisjs/core/http';
+import type { NextFn } from '@adonisjs/core/types/http';
+import type { Authenticators } from '@adonisjs/auth/types';
+
+/**
+ * Guest middleware is used to deny access to routes that should
+ * be accessed by unauthenticated users.
+ *
+ * For example, the login page should not be accessible if the user
+ * is already logged-in
+ */
+export default class GuestMiddleware {
+	/**
+	 * The URL to redirect to when user is logged-in
+	 */
+	redirectTo = '/';
+
+	async handle(
+		ctx: HttpContext,
+		next: NextFn,
+		options: { guards?: (keyof Authenticators)[] } = {}
+	) {
+		for (let guard of options.guards || [ctx.auth.defaultGuard]) {
+			if (await ctx.auth.use(guard).check()) {
+				return ctx.response.redirect(this.redirectTo, true);
+			}
+		}
+
+		return next();
+	}
+}

app/middleware/log_request.ts

@@ -0,0 +1,17 @@
+import { HttpContext } from '@adonisjs/core/http';
+import logger from '@adonisjs/core/services/logger';
+
+export default class LogRequest {
+	async handle({ request }: HttpContext, next: () => Promise<void>) {
+		if (
+			!request.url().startsWith('/node_modules') &&
+			!request.url().startsWith('/inertia') &&
+			!request.url().startsWith('/@vite') &&
+			!request.url().startsWith('/@react-refresh') &&
+			!request.url().includes('.ts')
+		) {
+			logger.debug(`[${request.method()}]: ${request.url()}`);
+		}
+		await next();
+	}
+}

app/middleware/silent_auth_middleware.ts

@@ -0,0 +1,9 @@
+import type { HttpContext } from '@adonisjs/core/http';
+import type { NextFn } from '@adonisjs/core/types/http';
+
+export default class SilentAuthMiddleware {
+	async handle(ctx: HttpContext, next: NextFn) {
+		await ctx.auth.check();
+		return next();
+	}
+}

app/middleware/update_user_last_seen_middleware.ts

@@ -0,0 +1,16 @@
+import type { HttpContext } from '@adonisjs/core/http';
+import type { NextFn } from '@adonisjs/core/types/http';
+import { DateTime } from 'luxon';
+
+export default class UpdateUserLastSeenMiddleware {
+	async handle(ctx: HttpContext, next: NextFn) {
+		const user = ctx.auth.user;
+		if (user) {
+			user.lastSeenAt = DateTime.local();
+			await user.save();
+		}
+
+		const output = await next();
+		return output;
+	}
+}

app/models/app_base_model.ts

@@ -0,0 +1,25 @@
+import {
+	BaseModel,
+	CamelCaseNamingStrategy,
+	column,
+} from '@adonisjs/lucid/orm';
+import { DateTime } from 'luxon';
+
+export default class AppBaseModel extends BaseModel {
+	static namingStrategy = new CamelCaseNamingStrategy();
+	serializeExtras = true;
+
+	@column({ isPrimary: true })
+	declare id: number;
+
+	@column.dateTime({
+		autoCreate: true,
+	})
+	declare createdAt: DateTime;
+
+	@column.dateTime({
+		autoCreate: true,
+		autoUpdate: true,
+	})
+	declare updatedAt: DateTime;
+}

app/models/collection.ts

@@ -0,0 +1,29 @@
+import AppBaseModel from '#models/app_base_model';
+import Link from '#models/link';
+import User from '#models/user';
+import { belongsTo, column, hasMany } from '@adonisjs/lucid/orm';
+import type { BelongsTo, HasMany } from '@adonisjs/lucid/types/relations';
+import { Visibility } from '#enums/visibility';
+
+export default class Collection extends AppBaseModel {
+	@column()
+	declare name: string;
+
+	@column()
+	declare description: string | null;
+
+	@column()
+	declare visibility: Visibility;
+
+	@column()
+	declare nextId: number;
+
+	@column()
+	declare authorId: number;
+
+	@belongsTo(() => User, { foreignKey: 'authorId' })
+	declare author: BelongsTo<typeof User>;
+
+	@hasMany(() => Link)
+	declare links: HasMany<typeof Link>;
+}

app/models/link.ts

@@ -0,0 +1,31 @@
+import AppBaseModel from '#models/app_base_model';
+import Collection from '#models/collection';
+import User from '#models/user';
+import { belongsTo, column } from '@adonisjs/lucid/orm';
+import type { BelongsTo } from '@adonisjs/lucid/types/relations';
+
+export default class Link extends AppBaseModel {
+	@column()
+	declare name: string;
+
+	@column()
+	declare description: string | null;
+
+	@column()
+	declare url: string;
+
+	@column()
+	declare favorite: boolean;
+
+	@column()
+	declare collectionId: number;
+
+	@belongsTo(() => Collection, { foreignKey: 'collectionId' })
+	declare collection: BelongsTo<typeof Collection>;
+
+	@column()
+	declare authorId: number;
+
+	@belongsTo(() => User, { foreignKey: 'authorId' })
+	declare author: BelongsTo<typeof User>;
+}

app/models/user.ts

@@ -0,0 +1,54 @@
+import Collection from '#models/collection';
+import Link from '#models/link';
+import type { GoogleToken } from '@adonisjs/ally/types';
+import { column, computed, hasMany } from '@adonisjs/lucid/orm';
+import type { HasMany } from '@adonisjs/lucid/types/relations';
+import AppBaseModel from './app_base_model.js';
+import { DateTime } from 'luxon';
+
+export default class User extends AppBaseModel {
+	@column()
+	declare email: string;
+
+	@column()
+	declare name: string;
+
+	@column()
+	declare nickName: string; // public username
+
+	@column()
+	declare avatarUrl: string;
+
+	@column()
+	declare isAdmin: boolean;
+
+	@column({ serializeAs: null })
+	declare token?: GoogleToken;
+
+	@column({ serializeAs: null })
+	declare providerId: number;
+
+	@column({ serializeAs: null })
+	declare providerType: 'google';
+
+	@hasMany(() => Collection, {
+		foreignKey: 'authorId',
+	})
+	declare collections: HasMany<typeof Collection>;
+
+	@hasMany(() => Link, {
+		foreignKey: 'authorId',
+	})
+	declare links: HasMany<typeof Link>;
+
+	@computed()
+	get fullname() {
+		return this.nickName || this.name;
+	}
+
+	@column.dateTime({
+		autoCreate: true,
+		autoUpdate: true,
+	})
+	declare lastSeenAt: DateTime;
+}

app/validators/collection.ts

@@ -0,0 +1,37 @@
+import { Visibility } from '#enums/visibility';
+import vine, { SimpleMessagesProvider } from '@vinejs/vine';
+
+const params = vine.object({
+	id: vine.number(),
+});
+
+export const createCollectionValidator = vine.compile(
+	vine.object({
+		name: vine.string().trim().minLength(1).maxLength(254),
+		description: vine.string().trim().maxLength(254).nullable(),
+		visibility: vine.enum(Visibility),
+		nextId: vine.number().optional(),
+	})
+);
+
+export const updateCollectionValidator = vine.compile(
+	vine.object({
+		name: vine.string().trim().minLength(1).maxLength(254),
+		description: vine.string().trim().maxLength(254).nullable(),
+		visibility: vine.enum(Visibility),
+		nextId: vine.number().optional(),
+
+		params,
+	})
+);
+
+export const deleteCollectionValidator = vine.compile(
+	vine.object({
+		params,
+	})
+);
+
+createCollectionValidator.messagesProvider = new SimpleMessagesProvider({
+	name: 'Collection name is required',
+	'visibility.required': 'Collection visibiliy is required',
+});

app/validators/link.ts

@@ -0,0 +1,43 @@
+import vine from '@vinejs/vine';
+
+const params = vine.object({
+	id: vine.number(),
+});
+
+export const createLinkValidator = vine.compile(
+	vine.object({
+		name: vine.string().trim().minLength(1).maxLength(254),
+		description: vine.string().trim().maxLength(300).optional(),
+		url: vine.string().trim(),
+		favorite: vine.boolean(),
+		collectionId: vine.number(),
+	})
+);
+
+export const updateLinkValidator = vine.compile(
+	vine.object({
+		name: vine.string().trim().minLength(1).maxLength(254),
+		description: vine.string().trim().maxLength(300).optional(),
+		url: vine.string().trim(),
+		favorite: vine.boolean(),
+		collectionId: vine.number(),
+
+		params,
+	})
+);
+
+export const deleteLinkValidator = vine.compile(
+	vine.object({
+		params,
+	})
+);
+
+export const updateLinkFavoriteStatusValidator = vine.compile(
+	vine.object({
+		favorite: vine.boolean(),
+
+		params: vine.object({
+			id: vine.number(),
+		}),
+	})
+);

app/validators/shared_collection.ts

@@ -0,0 +1,11 @@
+import vine from '@vinejs/vine';
+
+const params = vine.object({
+	id: vine.number(),
+});
+
+export const getSharedCollectionValidator = vine.compile(
+	vine.object({
+		params,
+	})
+);

app/validators/user.ts

@@ -0,0 +1,7 @@
+import vine from '@vinejs/vine';
+
+export const updateUserThemeValidator = vine.compile(
+	vine.object({
+		preferDarkTheme: vine.boolean(),
+	})
+);

bin/console.ts

@@ -0,0 +1,47 @@
+/*
+|--------------------------------------------------------------------------
+| Ace entry point
+|--------------------------------------------------------------------------
+|
+| The "console.ts" file is the entrypoint for booting the AdonisJS
+| command-line framework and executing commands.
+|
+| Commands do not boot the application, unless the currently running command
+| has "options.startApp" flag set to true.
+|
+*/
+
+import 'reflect-metadata';
+import { Ignitor, prettyPrintError } from '@adonisjs/core';
+
+/**
+ * URL to the application root. AdonisJS need it to resolve
+ * paths to file and directories for scaffolding commands
+ */
+const APP_ROOT = new URL('../', import.meta.url);
+
+/**
+ * The importer is used to import files in context of the
+ * application.
+ */
+const IMPORTER = (filePath: string) => {
+	if (filePath.startsWith('./') || filePath.startsWith('../')) {
+		return import(new URL(filePath, APP_ROOT).href);
+	}
+	return import(filePath);
+};
+
+new Ignitor(APP_ROOT, { importer: IMPORTER })
+	.tap((app) => {
+		app.booting(async () => {
+			await import('#start/env');
+		});
+		app.listen('SIGTERM', () => app.terminate());
+		app.listenIf(app.managedByPm2, 'SIGINT', () => app.terminate());
+	})
+	.ace()
+	.handle(process.argv.splice(2))
+	.catch((error) => {
+		process.exitCode = 1;
+		prettyPrintError(error);
+	});

bin/server.ts

@@ -0,0 +1,45 @@
+/*
+|--------------------------------------------------------------------------
+| HTTP server entrypoint
+|--------------------------------------------------------------------------
+|
+| The "server.ts" file is the entrypoint for starting the AdonisJS HTTP
+| server. Either you can run this file directly or use the "serve"
+| command to run this file and monitor file changes
+|
+*/
+
+import 'reflect-metadata';
+import { Ignitor, prettyPrintError } from '@adonisjs/core';
+
+/**
+ * URL to the application root. AdonisJS need it to resolve
+ * paths to file and directories for scaffolding commands
+ */
+const APP_ROOT = new URL('../', import.meta.url);
+
+/**
+ * The importer is used to import files in context of the
+ * application.
+ */
+const IMPORTER = (filePath: string) => {
+	if (filePath.startsWith('./') || filePath.startsWith('../')) {
+		return import(new URL(filePath, APP_ROOT).href);
+	}
+	return import(filePath);
+};
+
+new Ignitor(APP_ROOT, { importer: IMPORTER })
+	.tap((app) => {
+		app.booting(async () => {
+			await import('#start/env');
+		});
+		app.listen('SIGTERM', () => app.terminate());
+		app.listenIf(app.managedByPm2, 'SIGINT', () => app.terminate());
+	})
+	.httpServer()
+	.start()
+	.catch((error) => {
+		process.exitCode = 1;
+		prettyPrintError(error);
+	});

bin/test.ts

@@ -0,0 +1,62 @@
+/*
+|--------------------------------------------------------------------------
+| Test runner entrypoint
+|--------------------------------------------------------------------------
+|
+| The "test.ts" file is the entrypoint for running tests using Japa.
+|
+| Either you can run this file directly or use the "test"
+| command to run this file and monitor file changes.
+|
+*/
+
+process.env.NODE_ENV = 'test';
+
+import 'reflect-metadata';
+import { Ignitor, prettyPrintError } from '@adonisjs/core';
+import { configure, processCLIArgs, run } from '@japa/runner';
+
+/**
+ * URL to the application root. AdonisJS need it to resolve
+ * paths to file and directories for scaffolding commands
+ */
+const APP_ROOT = new URL('../', import.meta.url);
+
+/**
+ * The importer is used to import files in context of the
+ * application.
+ */
+const IMPORTER = (filePath: string) => {
+	if (filePath.startsWith('./') || filePath.startsWith('../')) {
+		return import(new URL(filePath, APP_ROOT).href);
+	}
+	return import(filePath);
+};
+
+new Ignitor(APP_ROOT, { importer: IMPORTER })
+	.tap((app) => {
+		app.booting(async () => {
+			await import('#start/env');
+		});
+		app.listen('SIGTERM', () => app.terminate());
+		app.listenIf(app.managedByPm2, 'SIGINT', () => app.terminate());
+	})
+	.testRunner()
+	.configure(async (app) => {
+		const { runnerHooks, ...config } = await import('../tests/bootstrap.js');
+
+		processCLIArgs(process.argv.splice(2));
+		configure({
+			...app.rcFile.tests,
+			...config,
+			...{
+				setup: runnerHooks.setup,
+				teardown: runnerHooks.teardown.concat([() => app.terminate()]),
+			},
+		});
+	})
+	.run(() => run())
+	.catch((error) => {
+		process.exitCode = 1;
+		prettyPrintError(error);
+	});

compose.yml

@@ -0,0 +1,79 @@
+name: my-links
+services:
+  postgres:
+    container_name: postgres
+    image: postgres:16
+    restart: always
+    environment:
+      - POSTGRES_DB=${DB_DATABASE}
+      - POSTGRES_USER=${DB_USER}
+      - POSTGRES_PASSWORD=${DB_PASSWORD}
+    healthcheck:
+      test: ['CMD-SHELL', 'pg_isready', '-U', '${DB_USER}']
+    volumes:
+      - postgres-volume:/var/lib/postgresql/data
+    ports:
+      - '${DB_PORT}:5432'
+
+  pgadmin:
+    container_name: pgadmin
+    image: dpage/pgadmin4:8
+    restart: always
+    entrypoint: /bin/sh -c "chmod 0600 /pgpass; /entrypoint.sh;"
+    healthcheck:
+      test: ['CMD', 'wget', '-O', '-', 'http://localhost:80/misc/ping']
+      interval: 2s
+      timeout: 10s
+      retries: 30
+    env_file: .env
+    environment:
+      - PGADMIN_DEFAULT_EMAIL=myemail@gmail.com
+      - PGADMIN_DEFAULT_PASSWORD=a12345678
+      - PGADMIN_CONFIG_SERVER_MODE=False
+      - PGADMIN_CONFIG_MASTER_PASSWORD_REQUIRED=False
+    depends_on:
+      - postgres
+    ports:
+      - '5050:80'
+    user: root
+    configs:
+      - source: servers.json
+        target: /pgadmin4/servers.json
+      - source: pgpass
+        target: /pgpass
+
+  my-links:
+    container_name: my-links
+    restart: always
+    build:
+      context: .
+    environment:
+      - DB_HOST=postgres
+      - HOST=0.0.0.0
+      - NODE_ENV=production
+    env_file:
+      - .env
+    depends_on:
+      postgres:
+        condition: service_healthy
+    ports:
+      - ${PORT}:3333
+
+volumes:
+  postgres-volume:
+
+configs:
+  pgpass:
+    content: postgres:${DB_PORT}:*:${DB_USER}:${DB_PASSWORD}
+  servers.json:
+    content: |
+      {"Servers": {"1": {
+        "Group": "Servers",
+        "Name": "project",
+        "Host": "postgres",
+        "Port": ${DB_PORT},
+        "MaintenanceDB": "${DB_DATABASE}",
+        "Username": "${DB_USER}",
+        "PassFile": "/pgpass",
+        "SSLMode": "prefer"
+      }}}

config.ts

@@ -1,8 +0,0 @@
-const config = {
-  url: process.env.NEXT_PUBLIC_SITE_URL,
-  name: 'MyLinks',
-  description:
-    'MyLinks is a free and open source software, that lets you manage your bookmarks in an intuitive interface',
-};
-
-export default config;

config/ally.ts

@@ -0,0 +1,19 @@
+import env from '#start/env';
+import { defineConfig, services } from '@adonisjs/ally';
+
+const allyConfig = defineConfig({
+	google: services.google({
+		clientId: env.get('GOOGLE_CLIENT_ID'),
+		clientSecret: env.get('GOOGLE_CLIENT_SECRET'),
+		callbackUrl: env.get('GOOGLE_CLIENT_CALLBACK_URL'),
+		prompt: 'select_account',
+		display: 'page',
+		scopes: ['userinfo.email', 'userinfo.profile'],
+	}),
+});
+
+export default allyConfig;
+
+declare module '@adonisjs/ally/types' {
+	interface SocialProviders extends InferSocialProviders<typeof allyConfig> {}
+}

config/app.ts

@@ -0,0 +1,40 @@
+import env from '#start/env';
+import app from '@adonisjs/core/services/app';
+import { Secret } from '@adonisjs/core/helpers';
+import { defineConfig } from '@adonisjs/core/http';
+
+/**
+ * The app key is used for encrypting cookies, generating signed URLs,
+ * and by the "encryption" module.
+ *
+ * The encryption module will fail to decrypt data if the key is lost or
+ * changed. Therefore it is recommended to keep the app key secure.
+ */
+export const appKey = new Secret(env.get('APP_KEY'));
+
+/**
+ * The configuration settings used by the HTTP server
+ */
+export const http = defineConfig({
+	generateRequestId: true,
+	allowMethodSpoofing: false,
+
+	/**
+	 * Enabling async local storage will let you access HTTP context
+	 * from anywhere inside your application.
+	 */
+	useAsyncLocalStorage: false,
+
+	/**
+	 * Manage cookies configuration. The settings for the session id cookie are
+	 * defined inside the "config/session.ts" file.
+	 */
+	cookie: {
+		domain: '',
+		path: '/',
+		maxAge: '2h',
+		httpOnly: true,
+		secure: app.inProduction,
+		sameSite: 'lax',
+	},
+});

config/auth.ts

@@ -0,0 +1,28 @@
+import { defineConfig } from '@adonisjs/auth';
+import { InferAuthEvents, Authenticators } from '@adonisjs/auth/types';
+import { sessionGuard, sessionUserProvider } from '@adonisjs/auth/session';
+
+const authConfig = defineConfig({
+	default: 'web',
+	guards: {
+		web: sessionGuard({
+			useRememberMeTokens: false,
+			provider: sessionUserProvider({
+				model: () => import('#models/user'),
+			}),
+		}),
+	},
+});
+
+export default authConfig;
+
+/**
+ * Inferring types from the configured auth
+ * guards.
+ */
+declare module '@adonisjs/auth/types' {
+	interface Authenticators extends InferAuthenticators<typeof authConfig> {}
+}
+declare module '@adonisjs/core/types' {
+	interface EventsList extends InferAuthEvents<Authenticators> {}
+}

config/bodyparser.ts

@@ -0,0 +1,55 @@
+import { defineConfig } from '@adonisjs/core/bodyparser';
+
+const bodyParserConfig = defineConfig({
+	/**
+	 * The bodyparser middleware will parse the request body
+	 * for the following HTTP methods.
+	 */
+	allowedMethods: ['POST', 'PUT', 'PATCH', 'DELETE'],
+
+	/**
+	 * Config for the "application/x-www-form-urlencoded"
+	 * content-type parser
+	 */
+	form: {
+		convertEmptyStringsToNull: true,
+		types: ['application/x-www-form-urlencoded'],
+	},
+
+	/**
+	 * Config for the JSON parser
+	 */
+	json: {
+		convertEmptyStringsToNull: true,
+		types: [
+			'application/json',
+			'application/json-patch+json',
+			'application/vnd.api+json',
+			'application/csp-report',
+		],
+	},
+
+	/**
+	 * Config for the "multipart/form-data" content-type parser.
+	 * File uploads are handled by the multipart parser.
+	 */
+	multipart: {
+		/**
+		 * Enabling auto process allows bodyparser middleware to
+		 * move all uploaded files inside the tmp folder of your
+		 * operating system
+		 */
+		autoProcess: true,
+		convertEmptyStringsToNull: true,
+		processManually: [],
+
+		/**
+		 * Maximum limit of data to parse including all files
+		 * and fields
+		 */
+		limit: '20mb',
+		types: ['multipart/form-data'],
+	},
+});
+
+export default bodyParserConfig;

config/cors.ts

@@ -0,0 +1,19 @@
+import { defineConfig } from '@adonisjs/cors';
+
+/**
+ * Configuration options to tweak the CORS policy. The following
+ * options are documented on the official documentation website.
+ *
+ * https://docs.adonisjs.com/guides/security/cors
+ */
+const corsConfig = defineConfig({
+	enabled: true,
+	origin: [],
+	methods: ['GET', 'HEAD', 'POST', 'PUT', 'DELETE'],
+	headers: true,
+	exposeHeaders: [],
+	credentials: true,
+	maxAge: 90,
+});
+
+export default corsConfig;

config/database.ts

@@ -0,0 +1,27 @@
+import env from '#start/env';
+import { defineConfig } from '@adonisjs/lucid';
+
+const dbConfig = defineConfig({
+	connection: 'postgres',
+	connections: {
+		postgres: {
+			client: 'pg',
+			connection: {
+				host: env.get('DB_HOST'),
+				port: env.get('DB_PORT'),
+				user: env.get('DB_USER'),
+				password: env.get('DB_PASSWORD'),
+				database: env.get('DB_DATABASE'),
+			},
+			migrations: {
+				naturalSort: true,
+				paths: ['database/migrations'],
+			},
+			seeders: {
+				paths: ['./database/seeders/main'],
+			},
+		},
+	},
+});
+
+export default dbConfig;

config/hash.ts

@@ -0,0 +1,24 @@
+import { defineConfig, drivers } from '@adonisjs/core/hash';
+
+const hashConfig = defineConfig({
+	default: 'scrypt',
+
+	list: {
+		scrypt: drivers.scrypt({
+			cost: 16384,
+			blockSize: 8,
+			parallelization: 1,
+			maxMemory: 33554432,
+		}),
+	},
+});
+
+export default hashConfig;
+
+/**
+ * Inferring types for the list of hashers you have configured
+ * in your application.
+ */
+declare module '@adonisjs/core/types' {
+	export interface HashersList extends InferHashers<typeof hashConfig> {}
+}

config/inertia.ts

@@ -0,0 +1,36 @@
+import {
+	DARK_THEME_DEFAULT_VALUE,
+	PREFER_DARK_THEME,
+} from '#constants/session';
+import { defineConfig } from '@adonisjs/inertia';
+
+export default defineConfig({
+	/**
+	 * Path to the Edge view that will be used as the root view for Inertia responses
+	 */
+	rootView: 'inertia_layout',
+
+	/**
+	 * Data that should be shared with all rendered pages
+	 */
+	sharedData: {
+		errors: (ctx) => ctx.session?.flashMessages.get('errors'),
+		preferDarkTheme: (ctx) =>
+			ctx.session?.get(PREFER_DARK_THEME, DARK_THEME_DEFAULT_VALUE),
+		auth: async (ctx) => {
+			await ctx.auth?.check();
+			return {
+				user: ctx.auth?.user || null,
+				isAuthenticated: ctx.auth?.isAuthenticated || false,
+			};
+		},
+	},
+
+	/**
+	 * Options for the server-side rendering
+	 */
+	ssr: {
+		enabled: true,
+		entrypoint: 'inertia/app/ssr.tsx',
+	},
+});

config/logger.ts

@@ -0,0 +1,35 @@
+import env from '#start/env';
+import app from '@adonisjs/core/services/app';
+import { defineConfig, targets } from '@adonisjs/core/logger';
+
+const loggerConfig = defineConfig({
+	default: 'app',
+
+	/**
+	 * The loggers object can be used to define multiple loggers.
+	 * By default, we configure only one logger (named "app").
+	 */
+	loggers: {
+		app: {
+			enabled: true,
+			name: env.get('APP_NAME'),
+			level: env.get('LOG_LEVEL'),
+			transport: {
+				targets: targets()
+					.pushIf(!app.inProduction, targets.pretty())
+					.pushIf(app.inProduction, targets.file({ destination: 1 }))
+					.toArray(),
+			},
+		},
+	},
+});
+
+export default loggerConfig;
+
+/**
+ * Inferring types for the list of loggers you have configured
+ * in your application.
+ */
+declare module '@adonisjs/core/types' {
+	export interface LoggersList extends InferLoggers<typeof loggerConfig> {}
+}

config/session.ts

@@ -0,0 +1,49 @@
+import env from '#start/env';
+import { defineConfig, stores } from '@adonisjs/session';
+
+const sessionConfig = defineConfig({
+	enabled: true,
+	cookieName: 'adonis-session',
+
+	/**
+	 * When set to true, the session id cookie will be deleted
+	 * once the user closes the browser.
+	 */
+	clearWithBrowser: false,
+
+	/**
+	 * Define how long to keep the session data alive without
+	 * any activity.
+	 */
+	age: '7d',
+
+	/**
+	 * Configuration for session cookie and the
+	 * cookie store
+	 */
+	cookie: {
+		path: '/',
+		httpOnly: true,
+		secure: true,
+
+		// TODO: set this to lax and found a solution to keep auth when using extension
+		sameSite: 'none',
+	},
+
+	/**
+	 * The store to use. Make sure to validate the environment
+	 * variable in order to infer the store name without any
+	 * errors.
+	 */
+	store: env.get('SESSION_DRIVER'),
+
+	/**
+	 * List of configured stores. Refer documentation to see
+	 * list of available stores and their config.
+	 */
+	stores: {
+		cookie: stores.cookie(),
+	},
+});
+
+export default sessionConfig;

config/shield.ts

@@ -0,0 +1,50 @@
+import { defineConfig } from '@adonisjs/shield';
+
+const shieldConfig = defineConfig({
+	/**
+	 * Configure CSP policies for your app. Refer documentation
+	 * to learn more
+	 */
+	csp: {
+		enabled: false,
+		directives: {},
+		reportOnly: false,
+	},
+
+	/**
+	 * Configure CSRF protection options. Refer documentation
+	 * to learn more
+	 */
+	csrf: {
+		enabled: false,
+		exceptRoutes: [],
+		enableXsrfCookie: true,
+		methods: ['POST', 'PUT', 'PATCH', 'DELETE'],
+	},
+
+	/**
+	 * Control how your website should be embedded inside
+	 * iFrames
+	 */
+	xFrame: {
+		enabled: false,
+	},
+
+	/**
+	 * Force browser to always use HTTPS
+	 */
+	hsts: {
+		enabled: true,
+		maxAge: '180 days',
+	},
+
+	/**
+	 * Disable browsers from sniffing the content type of a
+	 * response and always rely on the "content-type" header.
+	 */
+	contentTypeSniffing: {
+		enabled: true,
+	},
+});
+
+export default shieldConfig;

config/static.ts

@@ -0,0 +1,17 @@
+import { defineConfig } from '@adonisjs/static';
+
+/**
+ * Configuration options to tweak the static files middleware.
+ * The complete set of options are documented on the
+ * official documentation website.
+ *
+ * https://docs.adonisjs.com/guides/static-assets
+ */
+const staticServerConfig = defineConfig({
+	enabled: true,
+	etag: true,
+	lastModified: true,
+	dotFiles: 'ignore',
+});
+
+export default staticServerConfig;

config/vite.ts

@@ -0,0 +1,28 @@
+import { defineConfig } from '@adonisjs/vite';
+
+const viteBackendConfig = defineConfig({
+	/**
+	 * The output of vite will be written inside this
+	 * directory. The path should be relative from
+	 * the application root.
+	 */
+	buildDirectory: 'public/assets',
+
+	/**
+	 * The path to the manifest file generated by the
+	 * "vite build" command.
+	 */
+	manifestFile: 'public/assets/.vite/manifest.json',
+
+	/**
+	 * Feel free to change the value of the "assetsUrl" to
+	 * point to a CDN in production.
+	 */
+	assetsUrl: '/assets',
+
+	scriptAttributes: {
+		defer: true,
+	},
+});
+
+export default viteBackendConfig;

database/default_table_fields.ts

@@ -0,0 +1,8 @@
+import { Knex } from 'knex';
+
+export function defaultTableFields(table: Knex.CreateTableBuilder) {
+	table.increments('id').primary().first().unique().notNullable();
+
+	table.timestamp('created_at').notNullable();
+	table.timestamp('updated_at').nullable();
+}

database/migrations/1714218548323_create_users_table.ts

@@ -0,0 +1,33 @@
+import { defaultTableFields } from '#database/default_table_fields';
+import { BaseSchema } from '@adonisjs/lucid/schema';
+
+export default class CreateUsersTable extends BaseSchema {
+	static tableName = 'users';
+
+	async up() {
+		const exists = await this.schema.hasTable(CreateUsersTable.tableName);
+		if (exists) {
+			return console.warn(
+				`Table ${CreateUsersTable.tableName} already exists.`
+			);
+		}
+
+		this.schema.createTable(CreateUsersTable.tableName, (table) => {
+			table.string('email', 254).notNullable().unique();
+			table.string('name', 254).notNullable();
+			table.string('nick_name', 254).nullable();
+			table.text('avatar_url').notNullable();
+			table.boolean('is_admin').defaultTo(0).notNullable();
+
+			table.json('token').nullable();
+			table.string('provider_id').notNullable();
+			table.enum('provider_type', ['google']).notNullable().defaultTo('google');
+
+			defaultTableFields(table);
+		});
+	}
+
+	async down() {
+		this.schema.dropTable(CreateUsersTable.tableName);
+	}
+}

database/migrations/1714253983443_create_collections_table.ts

@@ -0,0 +1,48 @@
+import { defaultTableFields } from '#database/default_table_fields';
+import { Visibility } from '#enums/visibility';
+import { BaseSchema } from '@adonisjs/lucid/schema';
+
+export default class CreateCollectionTable extends BaseSchema {
+	static tableName = 'collections';
+	private visibilityEnumName = 'collection_visibility';
+
+	async up() {
+		this.schema.raw(`DROP TYPE IF EXISTS ${this.visibilityEnumName}`);
+		const exists = await this.schema.hasTable(CreateCollectionTable.tableName);
+		if (exists) {
+			return console.warn(
+				`Table ${CreateCollectionTable.tableName} already exists.`
+			);
+		}
+
+		this.schema.createTable(CreateCollectionTable.tableName, (table) => {
+			table.string('name', 254).notNullable();
+			table.string('description', 254).nullable();
+			table
+				.enum('visibility', Object.values(Visibility), {
+					useNative: true,
+					enumName: this.visibilityEnumName,
+					existingType: false,
+				})
+				.nullable()
+				.defaultTo(Visibility.PRIVATE);
+			table
+				.integer('next_id')
+				.references('id')
+				.inTable('collections')
+				.defaultTo(null);
+			table
+				.integer('author_id')
+				.references('id')
+				.inTable('users')
+				.onDelete('CASCADE');
+
+			defaultTableFields(table);
+		});
+	}
+
+	async down() {
+		this.schema.raw(`DROP TYPE IF EXISTS ${this.visibilityEnumName}`);
+		this.schema.dropTable(CreateCollectionTable.tableName);
+	}
+}

database/migrations/1714254076754_create_links_table.ts

@@ -0,0 +1,37 @@
+import { defaultTableFields } from '#database/default_table_fields';
+import { BaseSchema } from '@adonisjs/lucid/schema';
+
+export default class CreateLinksTable extends BaseSchema {
+	static tableName = 'links';
+
+	async up() {
+		const exists = await this.schema.hasTable(CreateLinksTable.tableName);
+		if (exists) {
+			return console.warn(`Table ${CreateLinksTable.tableName} already
+			exists.`);
+		}
+
+		this.schema.createTable(CreateLinksTable.tableName, (table) => {
+			table.string('name', 254).notNullable();
+			table.string('description', 254).nullable();
+			table.text('url').notNullable();
+			table.boolean('favorite').notNullable().defaultTo(0);
+			table
+				.integer('collection_id')
+				.references('id')
+				.inTable('collections')
+				.onDelete('CASCADE');
+			table
+				.integer('author_id')
+				.references('id')
+				.inTable('users')
+				.onDelete('CASCADE');
+
+			defaultTableFields(table);
+		});
+	}
+
+	async down() {
+		this.schema.dropTable(CreateLinksTable.tableName);
+	}
+}

database/migrations/1716561885061_create_full_text_searches_table.ts

@@ -0,0 +1,53 @@
+import { BaseSchema } from '@adonisjs/lucid/schema';
+
+export default class extends BaseSchema {
+	async up() {
+		this.schema.raw(`
+      CREATE EXTENSION IF NOT EXISTS unaccent;
+      CREATE EXTENSION IF NOT EXISTS pg_trgm;
+    `);
+		this.schema.raw(`
+      CREATE INDEX ON links USING gin(to_tsvector('english', name));
+      CREATE INDEX ON collections USING gin(to_tsvector('english', name));
+      CREATE INDEX ON links USING gin(to_tsvector('french', name));
+      CREATE INDEX ON collections USING gin(to_tsvector('french', name));
+    `);
+		this.schema.raw(`
+      CREATE OR REPLACE FUNCTION search_text(search_query TEXT, p_author_id INTEGER)
+      RETURNS TABLE (
+          id INTEGER,
+          type TEXT,
+          name VARCHAR(254),
+          url TEXT,
+          collection_id INTEGER,
+          matched_part TEXT,
+          rank DOUBLE PRECISION
+      )
+      AS $$
+      BEGIN
+          RETURN QUERY
+          SELECT links.id, 'link' AS type, links.name, links.url, collections.id AS collection_id,
+                  ts_headline('english', unaccent(links.name), plainto_tsquery('english', unaccent(search_query))) AS matched_part,
+                  ts_rank_cd(to_tsvector('english', unaccent(links.name)), plainto_tsquery('english', unaccent(search_query)))::DOUBLE PRECISION AS rank
+          FROM links
+          LEFT JOIN collections ON links.collection_id = collections.id
+          WHERE unaccent(links.name) ILIKE '%' || unaccent(search_query) || '%'
+              AND (p_author_id IS NULL OR links.author_id = p_author_id)
+          UNION ALL
+          SELECT collections.id, 'collection' AS type, collections.name, NULL AS url, NULL AS collection_id,
+                  ts_headline('english', unaccent(collections.name), plainto_tsquery('english', unaccent(search_query))) AS matched_part,
+                  ts_rank_cd(to_tsvector('english', unaccent(collections.name)), plainto_tsquery('english', unaccent(search_query)))::DOUBLE PRECISION AS rank
+          FROM collections
+          WHERE unaccent(collections.name) ILIKE '%' || unaccent(search_query) || '%'
+              AND (p_author_id IS NULL OR collections.author_id = p_author_id)
+          ORDER BY rank DESC NULLS LAST, matched_part DESC NULLS LAST;
+      END;
+      $$
+      LANGUAGE plpgsql;
+    `);
+	}
+
+	async down() {
+		this.schema.raw('DROP FUNCTION IF EXISTS search_text');
+	}
+}

database/migrations/1728257868871_update_user_last_seens_table.ts

@@ -0,0 +1,15 @@
+import { BaseSchema } from '@adonisjs/lucid/schema';
+
+export default class extends BaseSchema {
+	protected tableName = 'users';
+
+	async up() {
+		this.schema.alterTable(this.tableName, (table) => {
+			table.timestamp('last_seen_at');
+		});
+	}
+
+	async down() {
+		this.schema.dropTable(this.tableName);
+	}
+}

database/seeders/collection_seeder.ts

@@ -0,0 +1,40 @@
+import { Visibility } from '#enums/visibility';
+import Collection from '#models/collection';
+import User from '#models/user';
+import { BaseSeeder } from '@adonisjs/lucid/seeders';
+import { faker } from '@faker-js/faker';
+
+export default class extends BaseSeeder {
+	static environment = ['development', 'testing'];
+
+	async run() {
+		const users = await getUserIds();
+
+		const collections = faker.helpers.multiple(
+			() => createRandomCollection(users),
+			{
+				count: 50,
+			}
+		);
+		await Collection.createMany(collections);
+	}
+}
+
+export async function getUserIds() {
+	const users = await User.all();
+	return users.map(({ id }) => id);
+}
+
+let collectionId = 0;
+function createRandomCollection(userIds: User['id'][]) {
+	const authorId = faker.helpers.arrayElements(userIds, 1).at(0);
+	collectionId++;
+	return {
+		id: collectionId,
+		name: faker.string.alphanumeric({ length: { min: 5, max: 25 } }),
+		description: faker.string.alphanumeric({ length: { min: 0, max: 254 } }),
+		visibility: Visibility.PRIVATE,
+		nextId: collectionId + 1,
+		authorId,
+	};
+}

database/seeders/link_seeder.ts

@@ -0,0 +1,46 @@
+import { getUserIds } from '#database/seeders/collection_seeder';
+import Collection from '#models/collection';
+import Link from '#models/link';
+import User from '#models/user';
+import { BaseSeeder } from '@adonisjs/lucid/seeders';
+import { faker } from '@faker-js/faker';
+
+export default class extends BaseSeeder {
+	static environment = ['development', 'testing'];
+
+	async run() {
+		const users = await getUserIds();
+
+		const links = await Promise.all(
+			faker.helpers.multiple(async () => createRandomLink(users), {
+				count: 500,
+			})
+		);
+		await Link.createMany(links.filter((a) => typeof a !== 'undefined') as any);
+	}
+}
+
+async function getCollectionIds(authorId: User['id']) {
+	const collection = await Collection.findManyBy('author_id', authorId);
+	return collection.map(({ id }) => id);
+}
+
+async function createRandomLink(userIds: User['id'][]) {
+	const authorId = faker.helpers.arrayElements(userIds, 1).at(0)!;
+	const collections = await getCollectionIds(authorId);
+
+	const collectionId = faker.helpers.arrayElements(collections, 1).at(0);
+	if (!collectionId) {
+		return undefined;
+	}
+
+	return {
+		id: faker.string.uuid(),
+		name: faker.string.alphanumeric({ length: { min: 5, max: 25 } }),
+		description: faker.string.alphanumeric({ length: { min: 0, max: 254 } }),
+		url: faker.internet.url(),
+		favorite: faker.number.int({ min: 0, max: 1 }),
+		authorId,
+		collectionId,
+	};
+}

database/seeders/main/index_seeder.ts

@@ -0,0 +1,33 @@
+import app from '@adonisjs/core/services/app';
+import logger from '@adonisjs/core/services/logger';
+import { BaseSeeder } from '@adonisjs/lucid/seeders';
+
+export default class IndexSeeder extends BaseSeeder {
+	private async seed(Seeder: { default: typeof BaseSeeder }) {
+		/**
+		 * Do not run when not in a environment specified in Seeder
+		 */
+		if (
+			!Seeder.default.environment ||
+			(!Seeder.default.environment.includes('development') && app.inDev) ||
+			(!Seeder.default.environment.includes('testing') && app.inTest) ||
+			(!Seeder.default.environment.includes('production') && app.inProduction)
+		) {
+			return;
+		}
+
+		await new Seeder.default(this.client).run();
+	}
+
+	async run() {
+		logger.info('Start user seed');
+		await this.seed(await import('#database/seeders/user_seeder'));
+		logger.info('User seed done');
+		logger.info('Collection user seed');
+		await this.seed(await import('#database/seeders/collection_seeder'));
+		logger.info('Collection seed done');
+		logger.info('Link user seed');
+		await this.seed(await import('#database/seeders/link_seeder'));
+		logger.info('Link seed done');
+	}
+}

database/seeders/user_seeder.ts

@@ -0,0 +1,29 @@
+import User from '#models/user';
+import { GoogleToken } from '@adonisjs/ally/types';
+import { BaseSeeder } from '@adonisjs/lucid/seeders';
+import { faker } from '@faker-js/faker';
+
+export default class extends BaseSeeder {
+	static environment = ['development', 'testing'];
+
+	async run() {
+		const users = faker.helpers.multiple(createRandomUser, {
+			count: 25,
+		});
+		await User.createMany(users);
+	}
+}
+
+export function createRandomUser() {
+	return {
+		id: faker.number.int(),
+		email: faker.internet.email(),
+		name: faker.internet.userName(),
+		nickName: faker.internet.displayName(),
+		avatarUrl: faker.image.avatar(),
+		isAdmin: false,
+		providerId: faker.number.int(),
+		providerType: 'google' as const,
+		token: {} as GoogleToken,
+	};
+}

dev.compose.yml

@@ -0,0 +1,62 @@
+name: my-links-dev
+services:
+  postgres:
+    container_name: postgres
+    image: postgres:16
+    restart: always
+    environment:
+      - POSTGRES_DB=${DB_DATABASE}
+      - POSTGRES_USER=${DB_USER}
+      - POSTGRES_PASSWORD=${DB_PASSWORD}
+    healthcheck:
+      test: ["CMD-SHELL", "pg_isready", "-U", "${DB_USER}"]
+    volumes:
+      - postgres-volume:/var/lib/postgresql/data
+    ports:
+      - "${DB_PORT}:5432"
+
+  pgadmin:
+    container_name: pgadmin
+    image: dpage/pgadmin4:8
+    restart: always
+    entrypoint: /bin/sh -c "chmod 0600 /pgpass; /entrypoint.sh;"
+    healthcheck:
+      test: ["CMD", "wget", "-O", "-", "http://localhost:80/misc/ping"]
+      interval: 2s
+      timeout: 10s
+      retries: 30
+    env_file: .env
+    environment:
+      - PGADMIN_DEFAULT_EMAIL=myemail@gmail.com
+      - PGADMIN_DEFAULT_PASSWORD=a12345678
+      - PGADMIN_CONFIG_SERVER_MODE=False
+      - PGADMIN_CONFIG_MASTER_PASSWORD_REQUIRED=False
+    depends_on:
+      - postgres
+    ports:
+      - "5050:80"
+    user: root
+    configs:
+      - source: servers.json
+        target: /pgadmin4/servers.json
+      - source: pgpass
+        target: /pgpass
+
+volumes:
+  postgres-volume:
+
+configs:
+  pgpass:
+    content: postgres:${DB_PORT}:*:${DB_USER}:${DB_PASSWORD}
+  servers.json:
+    content: |
+      {"Servers": {"1": {
+        "Group": "Servers",
+        "Name": "project",
+        "Host": "postgres",
+        "Port": ${DB_PORT},
+        "MaintenanceDB": "${DB_DATABASE}",
+        "Username": "${DB_USER}",
+        "PassFile": "/pgpass",
+        "SSLMode": "prefer"
+      }}}

dev.docker-compose.yml

@@ -1,27 +0,0 @@
-services:
-  mysqldb:
-    image: mysql:latest
-    restart: always
-    env_file:
-      - .env
-    ports:
-      - '3306:3306'
-    healthcheck:
-      test: mysqladmin ping -h 127.0.0.1 -u $$MYSQL_USER --password=$$MYSQL_PASSWORD
-      start_period: 5s
-      interval: 5s
-      timeout: 5s
-      retries: 55
-
-  phpmyadmin:
-    image: phpmyadmin:5
-    restart: always
-    environment:
-      - PMA_HOST=mysqldb
-      - PMA_PORT=3306
-    env_file:
-      - .env
-    ports:
-      - '8080:80'
-    depends_on:
-      - mysqldb

docker-compose.yml

@@ -1,44 +0,0 @@
-networks:
-  mylinks_app:
-    external: true
-
-services:
-  mylinks:
-    restart: always
-    container_name: MyLinks
-    build:
-      context: .
-    ports:
-      - '127.0.0.1:3000:3000'
-    env_file:
-      - .env
-    environment:
-      - DATABASE_URL=mysql://${MYSQL_USER}:${MYSQL_PASSWORD}@mylinks_db:3306/${MYSQL_DATABASE}
-    networks:
-      - mylinks_app
-    healthcheck:
-      test:
-        [
-          'CMD-SHELL',
-          'wget --spider --tries=1 --no-verbose http://0.0.0.0:3000',
-        ]
-    depends_on:
-      mylinks_db:
-        condition: service_started
-
-  mylinks_db:
-    container_name: MyLinksDB
-    image: mysql:latest
-    restart: always
-    volumes:
-      - ./docker-config/mysql-dev-init.sql:/docker-entrypoint-initdb.d/init.sql
-    env_file:
-      - .env
-    healthcheck:
-      test: mysqladmin ping -h 127.0.0.1 -u $$MYSQL_USER --password=$$MYSQL_PASSWORD
-      start_period: 5s
-      interval: 5s
-      timeout: 5s
-      retries: 55
-    networks:
-      - mylinks_app

docker-config/mysql-dev-init.sql

@@ -1,3 +0,0 @@
-CREATE DATABASE IF NOT EXISTS mylinks;
-
-GRANT ALL PRIVILEGES ON DATABASE * TO mluser;

eslint.config.js

@@ -0,0 +1,4 @@
+import { configApp } from '@adonisjs/eslint-config';
+export default configApp({
+  files: ['**/*.ts', '**/*.tsx', '**/*.js', '**/*.jsx'],
+});

example.env

@@ -1,17 +0,0 @@
-MYSQL_USER="root"
-MYSQL_PASSWORD="root"
-MYSQL_ROOT_PASSWORD="root"
-MYSQL_DATABASE="mylinks"
-
-# Or if you need external Database
-# DATABASE_IP="localhost"
-# DATABASE_PORT="3306"
-# DATABASE_URL="mysql://${MYSQL_USER}:${MYSQL_PASSWORD}@${DATABASE_IP}:${DATABASE_PORT}/${MYSQL_DATABASE}"
-
-NEXTAUTH_URL="http://localhost:3000"
-NEXT_PUBLIC_SITE_URL="http://localhost:3000"
-
-NEXTAUTH_SECRET=""
-
-GOOGLE_CLIENT_ID=""
-GOOGLE_CLIENT_SECRET=""

inertia/app/app.tsx

@@ -0,0 +1,25 @@
+import { resolvePageComponent } from '@adonisjs/inertia/helpers';
+import { createInertiaApp } from '@inertiajs/react';
+import 'dayjs/locale/en';
+import 'dayjs/locale/fr';
+import { hydrateRoot } from 'react-dom/client';
+import '../i18n/index';
+
+const appName = import.meta.env.VITE_APP_NAME || 'MyLinks';
+
+createInertiaApp({
+	progress: { color: '#5474B4' },
+
+	title: (title) => `${appName}${title && ` - ${title}`}`,
+
+	resolve: (name) => {
+		return resolvePageComponent(
+			`../pages/${name}.tsx`,
+			import.meta.glob('../pages/**/*.tsx')
+		);
+	},
+
+	setup({ el, App, props }) {
+		hydrateRoot(el, <App {...props} />);
+	},
+});

inertia/app/ssr.tsx

@@ -0,0 +1,14 @@
+import { createInertiaApp } from '@inertiajs/react';
+import ReactDOMServer from 'react-dom/server';
+
+export default function render(page: any) {
+	return createInertiaApp({
+		page,
+		render: ReactDOMServer.renderToString,
+		resolve: (name) => {
+			const pages = import.meta.glob('../pages/**/*.tsx', { eager: true });
+			return pages[`../pages/${name}.tsx`];
+		},
+		setup: ({ App, props }) => <App {...props} />,
+	});
+}

inertia/components/admin/users/th.tsx

@@ -0,0 +1,28 @@
+import { Center, Group, rem, Table, Text, UnstyledButton } from '@mantine/core';
+import { PropsWithChildren } from 'react';
+import { TbChevronDown, TbChevronUp, TbSelector } from 'react-icons/tb';
+import classes from './users_table.module.css';
+
+interface ThProps extends PropsWithChildren {
+	reversed: boolean;
+	sorted: boolean;
+	onSort(): void;
+}
+
+export function Th({ children, reversed, sorted, onSort }: ThProps) {
+	const Icon = sorted ? (reversed ? TbChevronUp : TbChevronDown) : TbSelector;
+	return (
+		<Table.Th className={classes.th}>
+			<UnstyledButton onClick={onSort} className={classes.control}>
+				<Group justify="space-between">
+					<Text fw={500} fz="sm">
+						{children}
+					</Text>
+					<Center className={classes.icon}>
+						<Icon style={{ width: rem(16), height: rem(16) }} />
+					</Center>
+				</Group>
+			</UnstyledButton>
+		</Table.Th>
+	);
+}

inertia/components/admin/users/users_table.module.css

@@ -0,0 +1,21 @@
+.th {
+	padding: 0;
+}
+
+.control {
+	width: 100%;
+	padding: var(--mantine-spacing-xs) var(--mantine-spacing-md);
+
+	@mixin hover {
+		background-color: light-dark(
+			var(--mantine-color-gray-0),
+			var(--mantine-color-dark-6)
+		);
+	}
+}
+
+.icon {
+	width: rem(21px);
+	height: rem(21px);
+	border-radius: rem(21px);
+}

inertia/components/admin/users/users_table.tsx

@@ -0,0 +1,160 @@
+import {
+	ScrollArea,
+	Table,
+	Text,
+	TextInput,
+	Tooltip,
+	rem,
+} from '@mantine/core';
+import dayjs from 'dayjs';
+import relativeTime from 'dayjs/plugin/relativeTime';
+import { useState } from 'react';
+import { useTranslation } from 'react-i18next';
+import { TbSearch } from 'react-icons/tb';
+import { Th } from '~/components/admin/users/th';
+import { sortData } from '~/components/admin/users/utils';
+import { UserBadgeRole } from '~/components/common/user_badge_role';
+import { DATE_FORMAT } from '~/constants';
+import { User } from '~/types/app';
+
+dayjs.extend(relativeTime);
+
+export type UserWithCounts = User & {
+	linksCount: number;
+	collectionsCount: number;
+};
+export type UsersWithCounts = UserWithCounts[];
+
+export interface UsersTableProps {
+	users: UsersWithCounts;
+	totalCollections: number;
+	totalLinks: number;
+}
+
+export function UsersTable({
+	users,
+	totalCollections,
+	totalLinks,
+}: UsersTableProps) {
+	const { t } = useTranslation();
+	const [search, setSearch] = useState('');
+	const [sortedData, setSortedData] = useState(users);
+	const [sortBy, setSortBy] = useState<keyof UserWithCounts | null>(null);
+	const [reverseSortDirection, setReverseSortDirection] = useState(false);
+
+	const setSorting = (field: keyof UserWithCounts) => {
+		const reversed = field === sortBy ? !reverseSortDirection : false;
+		setReverseSortDirection(reversed);
+		setSortBy(field);
+		setSortedData(sortData(users, { sortBy: field, reversed, search }));
+	};
+
+	const handleSearchChange = (event: React.ChangeEvent<HTMLInputElement>) => {
+		const { value } = event.currentTarget;
+		setSearch(value);
+		setSortedData(
+			sortData(users, {
+				sortBy: sortBy,
+				reversed: reverseSortDirection,
+				search: value,
+			})
+		);
+	};
+
+	const renderDateCell = (date: string) => (
+		<Tooltip label={dayjs(date).format(DATE_FORMAT).toString()}>
+			<Text>{dayjs(date).fromNow()}</Text>
+		</Tooltip>
+	);
+
+	const rows = sortedData.map((user) => (
+		<Table.Tr key={user.id}>
+			<Table.Td>{user.fullname}</Table.Td>
+			<Table.Td>
+				<UserBadgeRole user={user} />
+			</Table.Td>
+			<Table.Td>{user.collectionsCount}</Table.Td>
+			<Table.Td>{user.linksCount}</Table.Td>
+			<Table.Td>{renderDateCell(user.createdAt)}</Table.Td>
+			<Table.Td>{renderDateCell(user.lastSeenAt)}</Table.Td>
+		</Table.Tr>
+	));
+
+	return (
+		<ScrollArea>
+			<TextInput
+				placeholder="Search by any field"
+				mb="md"
+				leftSection={<TbSearch style={{ width: rem(16), height: rem(16) }} />}
+				value={search}
+				onChange={handleSearchChange}
+			/>
+			<Table
+				horizontalSpacing="md"
+				verticalSpacing="xs"
+				miw={700}
+				layout="fixed"
+			>
+				<Table.Tbody>
+					<Table.Tr>
+						<Th
+							sorted={sortBy === 'fullname'}
+							reversed={reverseSortDirection}
+							onSort={() => setSorting('fullname')}
+						>
+							{t('common:name')}
+						</Th>
+						<Th
+							sorted={sortBy === 'isAdmin'}
+							reversed={reverseSortDirection}
+							onSort={() => setSorting('isAdmin')}
+						>
+							{t('admin:role')}
+						</Th>
+						<Th
+							sorted={sortBy === 'collectionsCount'}
+							reversed={reverseSortDirection}
+							onSort={() => setSorting('collectionsCount')}
+						>
+							{t('common:collection.collections')} ({totalCollections})
+						</Th>
+						<Th
+							sorted={sortBy === 'linksCount'}
+							reversed={reverseSortDirection}
+							onSort={() => setSorting('linksCount')}
+						>
+							{t('common:link.links')} ({totalLinks})
+						</Th>
+						<Th
+							sorted={sortBy === 'createdAt'}
+							reversed={reverseSortDirection}
+							onSort={() => setSorting('createdAt')}
+						>
+							{t('admin:created_at')}
+						</Th>
+						<Th
+							sorted={sortBy === 'lastSeenAt'}
+							reversed={reverseSortDirection}
+							onSort={() => setSorting('lastSeenAt')}
+						>
+							{t('admin:last_seen_at')}
+						</Th>
+					</Table.Tr>
+				</Table.Tbody>
+				<Table.Tbody>
+					{rows.length > 0 ? (
+						rows
+					) : (
+						<Table.Tr>
+							<Table.Td colSpan={4}>
+								<Text fw={500} ta="center">
+									Nothing found
+								</Text>
+							</Table.Td>
+						</Table.Tr>
+					)}
+				</Table.Tbody>
+			</Table>
+		</ScrollArea>
+	);
+}

inertia/components/admin/users/utils.ts

@@ -0,0 +1,39 @@
+import {
+	UsersWithCounts,
+	UserWithCounts,
+} from '~/components/admin/users/users_table';
+
+export function filterData(data: UsersWithCounts, search: string) {
+	const query = search.toLowerCase().trim();
+	return data.filter((item) =>
+		['email', 'name', 'nickName', 'fullname'].some((key) => {
+			const value = item[key as keyof UserWithCounts];
+			return typeof value === 'string' && value.toLowerCase().includes(query);
+		})
+	);
+}
+
+export function sortData(
+	data: UsersWithCounts,
+	payload: {
+		sortBy: keyof UserWithCounts | null;
+		reversed: boolean;
+		search: string;
+	}
+) {
+	const { sortBy } = payload;
+
+	if (!sortBy) {
+		return filterData(data, payload.search);
+	}
+
+	return filterData(
+		[...data].sort((a, b) => {
+			if (payload.reversed) {
+				return b[sortBy] > a[sortBy] ? 1 : -1;
+			}
+			return a[sortBy] > b[sortBy] ? 1 : -1;
+		}),
+		payload.search
+	);
+}

inertia/components/common/external_link.tsx

@@ -0,0 +1,18 @@
+import { AnchorHTMLAttributes, CSSProperties, ReactNode } from 'react';
+
+export default function ExternalLink({
+	children,
+	title,
+	...props
+}: AnchorHTMLAttributes<HTMLAnchorElement> & {
+	children: ReactNode;
+	style?: CSSProperties;
+	title?: string;
+	className?: string;
+}) {
+	return (
+		<a target="_blank" rel="noreferrer" title={title} {...props}>
+			{children}
+		</a>
+	);
+}

inertia/components/common/external_link_styled.tsx

@@ -0,0 +1,26 @@
+import { Anchor } from '@mantine/core';
+import { AnchorHTMLAttributes, CSSProperties, ReactNode } from 'react';
+
+export function ExternalLinkStyled({
+	children,
+	title,
+	...props
+}: AnchorHTMLAttributes<HTMLAnchorElement> & {
+	children: ReactNode;
+	style?: CSSProperties;
+	title?: string;
+	className?: string;
+}) {
+	return (
+		<Anchor<'a'>
+			component="a"
+			underline="never"
+			target="_blank"
+			rel="noreferrer"
+			title={title}
+			{...props}
+		>
+			{children}
+		</Anchor>
+	);
+}