mirror of
https://github.com/Sonny93/my-links.git
synced 2025-12-08 22:53:25 +00:00
Compare commits
99 Commits
2.0.1
...
c46cc1a8fb
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
c46cc1a8fb | ||
|
|
2f820bb877 | ||
|
|
01298661a5 | ||
|
|
2de2556a20 | ||
|
|
6005374340 | ||
|
|
eac0c135d6 | ||
|
|
aef2db6071 | ||
|
|
c989772b04 | ||
|
|
1938f6ea23 | ||
|
|
e8aca90870 | ||
|
|
fe849d7d69 | ||
|
|
cc63ce37c3 | ||
|
|
01efb11f70 | ||
|
|
466c8dec3a | ||
|
|
b2b388b77e | ||
|
|
a073fac47b | ||
|
|
4c2e9ddc82 | ||
|
|
ea8350bb61 | ||
|
|
9463a711f6 | ||
|
|
d68fcd9fc8 | ||
|
|
a984b53686 | ||
|
|
1346bc33f6 | ||
|
|
3ecbe78671 | ||
|
|
1ad7c2d56c | ||
|
|
276abc4009 | ||
|
|
9250e5f0b4 | ||
|
|
81f4cd7f87 | ||
|
|
a3651e8370 | ||
|
|
83c1966946 | ||
|
|
798ff0fbe4 | ||
|
|
d3de34bd41 | ||
|
|
9781363282 | ||
|
|
174a21288a | ||
|
|
6eb88871e8 | ||
|
|
34d2abcc13 | ||
|
|
69d0487777 | ||
|
|
9a215f3e41 | ||
|
|
5c37fe9c31 | ||
|
|
861906d29b | ||
|
|
8bd87b5bba | ||
|
|
db578dbe51 | ||
|
|
41f82a8070 | ||
|
|
7fba156168 | ||
|
|
8b24354c0e | ||
|
|
8953b9a64e | ||
|
|
6f807e51e8 | ||
|
|
40069905fa | ||
|
|
d01bfaeec2 | ||
|
|
343160f324 | ||
|
|
cc1e7b91c0 | ||
|
|
c7c70b1767 | ||
|
|
d796e4d38a | ||
|
|
01a21ddef8 | ||
|
|
bcad333783 | ||
|
|
13bff28876 | ||
|
|
757788bf9b | ||
|
|
907dda300e | ||
|
|
edc7972a2f | ||
|
|
d66e92adbc | ||
|
|
6d568b133f | ||
|
|
0ce3e3d39d | ||
|
|
e77b7cc176 | ||
|
|
1a102ebc5f | ||
|
|
1da9f0baf4 | ||
|
|
bce00c7855 | ||
|
|
5c4ee3a1cd | ||
|
|
8d474f74eb | ||
|
|
5453b7f965 | ||
|
|
71ce65e2aa | ||
|
|
05c867f44f | ||
|
|
57373ff0b6 | ||
|
|
2fda4aabdd | ||
|
|
bc376a72ee | ||
|
|
d360a9044c | ||
|
|
8b4e5740d7 | ||
|
|
c8fb5af44d | ||
|
|
24cea2b0b2 | ||
|
|
eea9732100 | ||
|
|
f425decf2c | ||
|
|
8b57f6dd47 | ||
|
|
dda6fc299a | ||
|
|
b0e3bfa0f6 | ||
|
|
9d4eb08bc9 | ||
|
|
f8e7e7cd64 | ||
|
|
cda3a89f32 | ||
|
|
ed4dbca329 | ||
|
|
f8a92b7219 | ||
|
|
161db362b3 | ||
|
|
a5e542a33f | ||
|
|
f0ec6d6b3d | ||
|
|
442a1003bb | ||
|
|
2c499a7789 | ||
|
|
5baa9e1c35 | ||
|
|
fd896db872 | ||
|
|
a45d534fa0 | ||
|
|
5d083327a8 | ||
|
|
136fcfac5d | ||
|
|
efcb1d0ef9 | ||
|
|
8b9e74bfe1 |
@@ -3,7 +3,7 @@
|
||||
root = true
|
||||
|
||||
[*]
|
||||
indent_style = space
|
||||
indent_style = tab
|
||||
indent_size = 2
|
||||
end_of_line = lf
|
||||
charset = utf-8
|
||||
@@ -17,8 +17,5 @@ insert_final_newline = unset
|
||||
indent_style = unset
|
||||
insert_final_newline = unset
|
||||
|
||||
[MakeFile]
|
||||
indent_style = space
|
||||
|
||||
[*.md]
|
||||
trim_trailing_whitespace = false
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
# node ace generate:key
|
||||
APP_KEY=UfdS996001I_koCN1OiZiSh-DJZTyvGc
|
||||
APP_KEY=soY8ZAtItT_fCkNUADfgffZUUo675lOj
|
||||
TZ=UTC
|
||||
PORT=3333
|
||||
HOST=localhost
|
||||
|
||||
30
.github/workflows/cd.yml
vendored
30
.github/workflows/cd.yml
vendored
@@ -36,18 +36,18 @@ jobs:
|
||||
tags: ${{ steps.docker_meta.outputs.tags }}
|
||||
labels: ${{ steps.docker_meta.outputs.labels }}
|
||||
|
||||
# execute_commands_via_ssh:
|
||||
# name: Pull latest docker image and start up the application with Docker Compose
|
||||
# runs-on: ubuntu-latest
|
||||
# needs: push_image_to_docker_hub
|
||||
# steps:
|
||||
# - name: Executing remote ssh commands
|
||||
# uses: appleboy/ssh-action@master
|
||||
# with:
|
||||
# host: ${{ secrets.SSH_HOST }}
|
||||
# port: ${{ secrets.SSH_PORT }}
|
||||
# username: ${{ secrets.SSH_USERNAME }}
|
||||
# key: ${{ secrets.SSH_KEY }}
|
||||
# script: |
|
||||
# cd /infra/my-links
|
||||
# sh startup.sh
|
||||
execute_commands_via_ssh:
|
||||
name: Pull latest docker image and start up the application with Docker Compose
|
||||
runs-on: ubuntu-latest
|
||||
needs: push_image_to_docker_hub
|
||||
steps:
|
||||
- name: Executing remote ssh commands
|
||||
uses: appleboy/ssh-action@master
|
||||
with:
|
||||
host: ${{ secrets.SSH_HOST }}
|
||||
port: ${{ secrets.SSH_PORT }}
|
||||
username: ${{ secrets.SSH_USERNAME }}
|
||||
key: ${{ secrets.SSH_KEY }}
|
||||
script: |
|
||||
cd /infra/my-links
|
||||
sh startup.sh
|
||||
|
||||
@@ -1,4 +1 @@
|
||||
#!/usr/bin/env sh
|
||||
. "$(dirname -- "$0")/_/husky.sh"
|
||||
|
||||
npx lint-staged
|
||||
|
||||
3
.vscode/extensions.json
vendored
Normal file
3
.vscode/extensions.json
vendored
Normal file
@@ -0,0 +1,3 @@
|
||||
{
|
||||
"recommendations": ["vunguyentuan.vscode-css-variables"]
|
||||
}
|
||||
19
.vscode/settings.json
vendored
19
.vscode/settings.json
vendored
@@ -1,3 +1,20 @@
|
||||
{
|
||||
"typescript.preferences.importModuleSpecifier": "non-relative"
|
||||
"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"
|
||||
]
|
||||
}
|
||||
|
||||
61
CONTRIBUTING
Normal file
61
CONTRIBUTING
Normal file
@@ -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!
|
||||
10
Dockerfile
10
Dockerfile
@@ -1,6 +1,6 @@
|
||||
# Source : https://github.com/adonisjs-community/adonis-packages/blob/main/Dockerfile
|
||||
|
||||
FROM node:20-alpine3.18 AS base
|
||||
FROM node:22.11-alpine3.20 AS base
|
||||
|
||||
RUN apk --no-cache add curl
|
||||
RUN corepack enable
|
||||
@@ -8,14 +8,14 @@ RUN corepack enable
|
||||
# All deps stage
|
||||
FROM base AS deps
|
||||
WORKDIR /app
|
||||
ADD package.json package-lock.json ./
|
||||
RUN npm install --ignore-scripts
|
||||
ADD package.json pnpm-lock.yaml ./
|
||||
RUN pnpm install --ignore-scripts
|
||||
|
||||
# Production only deps stage
|
||||
FROM base AS production-deps
|
||||
WORKDIR /app
|
||||
ADD package.json package-lock.json ./
|
||||
RUN npm install --ignore-scripts
|
||||
ADD package.json pnpm-lock.yaml ./
|
||||
RUN pnpm install --ignore-scripts --prod
|
||||
|
||||
# Build stage
|
||||
FROM base AS build
|
||||
|
||||
674
LICENSE
Normal file
674
LICENSE
Normal file
@@ -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>.
|
||||
22
Makefile
22
Makefile
@@ -1,19 +1,21 @@
|
||||
dev:
|
||||
docker compose down
|
||||
docker compose -f dev.docker-compose.yml up -d --wait
|
||||
node ace migration:fresh
|
||||
npm run 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 compose -f dev.docker-compose.yml down
|
||||
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
|
||||
@node ace db:seed
|
||||
|
||||
down:
|
||||
-docker compose down
|
||||
-docker compose -f dev.docker-compose.yml down
|
||||
@-docker compose down
|
||||
@-docker compose -f dev.compose.yml down
|
||||
|
||||
release:
|
||||
npm run release
|
||||
@pnpm run release
|
||||
|
||||
81
README.md
81
README.md
@@ -1,62 +1,97 @@
|
||||
# MyLinks
|
||||

|
||||
|
||||
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
|
||||
```
|
||||
|
||||
## Development
|
||||
### Development
|
||||
|
||||
### Docker
|
||||
#### Docker
|
||||
|
||||
```shell
|
||||
make dev
|
||||
```
|
||||
|
||||
### NPM
|
||||
#### PNPM
|
||||
|
||||
```shell
|
||||
# reset database and (force) apply all migrations
|
||||
node ace migration:fresh
|
||||
# start dev server
|
||||
npm run dev
|
||||
pnpm run dev
|
||||
```
|
||||
|
||||
## Start as prod
|
||||
### Start as prod
|
||||
|
||||
### Docker
|
||||
#### Docker
|
||||
|
||||
```shell
|
||||
make prod
|
||||
```
|
||||
|
||||
### NPM
|
||||
#### PNPM
|
||||
|
||||
```shell
|
||||
# create production build
|
||||
npm run build
|
||||
pnpm run build
|
||||
# go to the build folder
|
||||
cd build
|
||||
# clone your .env
|
||||
cp ../.env .
|
||||
# then start the production build
|
||||
npm run start
|
||||
pnpm run start
|
||||
```
|
||||
|
||||
## Generate app_key
|
||||
## Configuration
|
||||
|
||||
### Generate app_key
|
||||
|
||||
```shell
|
||||
# generate a random app key
|
||||
openssl rand -base64 32
|
||||
```
|
||||
|
||||
## GitHub Actions
|
||||
### GitHub Actions
|
||||
|
||||
Env var to define :
|
||||
|
||||
@@ -87,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).
|
||||
|
||||
3
ace.js
3
ace.js
@@ -19,8 +19,7 @@
|
||||
/**
|
||||
* Register hook to process TypeScript files using ts-node
|
||||
*/
|
||||
import { register } from 'node:module';
|
||||
register('ts-node/esm', import.meta.url);
|
||||
import 'ts-node-maintained/register/esm';
|
||||
|
||||
/**
|
||||
* Import ace console entrypoint
|
||||
|
||||
124
adonisrc.ts
124
adonisrc.ts
@@ -1,7 +1,7 @@
|
||||
import { defineConfig } from '@adonisjs/core/app';
|
||||
|
||||
export default defineConfig({
|
||||
/*
|
||||
/*
|
||||
|--------------------------------------------------------------------------
|
||||
| Commands
|
||||
|--------------------------------------------------------------------------
|
||||
@@ -10,13 +10,13 @@ export default defineConfig({
|
||||
| will be scanned automatically from the "./commands" directory.
|
||||
|
|
||||
*/
|
||||
commands: [
|
||||
() => import('@adonisjs/core/commands'),
|
||||
() => import('@adonisjs/lucid/commands'),
|
||||
() => import('@izzyjs/route/commands'),
|
||||
],
|
||||
commands: [
|
||||
() => import('@adonisjs/core/commands'),
|
||||
() => import('@adonisjs/lucid/commands'),
|
||||
() => import('@izzyjs/route/commands'),
|
||||
],
|
||||
|
||||
/*
|
||||
/*
|
||||
|--------------------------------------------------------------------------
|
||||
| Service providers
|
||||
|--------------------------------------------------------------------------
|
||||
@@ -25,29 +25,29 @@ export default defineConfig({
|
||||
| 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'),
|
||||
],
|
||||
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
|
||||
|--------------------------------------------------------------------------
|
||||
@@ -55,9 +55,9 @@ export default defineConfig({
|
||||
| List of modules to import before starting the application.
|
||||
|
|
||||
*/
|
||||
preloads: [() => import('#start/routes'), () => import('#start/kernel')],
|
||||
preloads: [() => import('#start/routes'), () => import('#start/kernel')],
|
||||
|
||||
/*
|
||||
/*
|
||||
|--------------------------------------------------------------------------
|
||||
| Tests
|
||||
|--------------------------------------------------------------------------
|
||||
@@ -66,23 +66,23 @@ export default defineConfig({
|
||||
| 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,
|
||||
},
|
||||
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
|
||||
|--------------------------------------------------------------------------
|
||||
@@ -91,20 +91,20 @@ export default defineConfig({
|
||||
| the production build.
|
||||
|
|
||||
*/
|
||||
metaFiles: [
|
||||
{
|
||||
pattern: 'resources/views/**/*.edge',
|
||||
reloadServer: false,
|
||||
},
|
||||
{
|
||||
pattern: 'public/**',
|
||||
reloadServer: false,
|
||||
},
|
||||
],
|
||||
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')],
|
||||
},
|
||||
assetsBundler: false,
|
||||
unstable_assembler: {
|
||||
onBuildStarting: [() => import('@adonisjs/vite/build_hook')],
|
||||
onDevServerStarted: [() => import('@izzyjs/route/dev_hook')],
|
||||
},
|
||||
});
|
||||
|
||||
46
app/admin/controllers/admin_controller.ts
Normal file
46
app/admin/controllers/admin_controller.ts
Normal file
@@ -0,0 +1,46 @@
|
||||
import AuthController from '#auth/controllers/auth_controller';
|
||||
import CollectionsController from '#collections/controllers/collections_controller';
|
||||
import LinksController from '#links/controllers/links_controller';
|
||||
import User from '#user/models/user';
|
||||
import { inject } from '@adonisjs/core';
|
||||
import { 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: AuthController,
|
||||
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,
|
||||
});
|
||||
}
|
||||
}
|
||||
11
app/admin/middlewares/is_admin_middleware.ts
Normal file
11
app/admin/middlewares/is_admin_middleware.ts
Normal file
@@ -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();
|
||||
}
|
||||
}
|
||||
14
app/admin/routes/admin_routes.ts
Normal file
14
app/admin/routes/admin_routes.ts
Normal file
@@ -0,0 +1,14 @@
|
||||
import { middleware } from '#start/kernel';
|
||||
import router from '@adonisjs/core/services/router';
|
||||
|
||||
const AdminController = () => import('#admin/controllers/admin_controller');
|
||||
|
||||
/**
|
||||
* Routes for admin dashboard
|
||||
*/
|
||||
router
|
||||
.group(() => {
|
||||
router.get('/', [AdminController, 'index']).as('admin.dashboard');
|
||||
})
|
||||
.middleware([middleware.auth(), middleware.admin()])
|
||||
.prefix('/admin');
|
||||
1
app/admin/routes/routes.ts
Normal file
1
app/admin/routes/routes.ts
Normal file
@@ -0,0 +1 @@
|
||||
import './admin_routes.js';
|
||||
78
app/auth/controllers/auth_controller.ts
Normal file
78
app/auth/controllers/auth_controller.ts
Normal file
@@ -0,0 +1,78 @@
|
||||
import User from '#user/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 AuthController {
|
||||
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'));
|
||||
}
|
||||
}
|
||||
@@ -8,21 +8,21 @@ import { route } from '@izzyjs/route/client';
|
||||
* access to unauthenticated users.
|
||||
*/
|
||||
export default class AuthMiddleware {
|
||||
/**
|
||||
* The URL to redirect to, when authentication fails
|
||||
*/
|
||||
redirectTo = route('auth.login').url;
|
||||
/**
|
||||
* 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();
|
||||
}
|
||||
async handle(
|
||||
ctx: HttpContext,
|
||||
next: NextFn,
|
||||
options: {
|
||||
guards?: (keyof Authenticators)[];
|
||||
} = {}
|
||||
) {
|
||||
await ctx.auth.authenticateUsing(options.guards, {
|
||||
loginRoute: this.redirectTo,
|
||||
});
|
||||
return next();
|
||||
}
|
||||
}
|
||||
@@ -10,22 +10,22 @@ import type { Authenticators } from '@adonisjs/auth/types';
|
||||
* is already logged-in
|
||||
*/
|
||||
export default class GuestMiddleware {
|
||||
/**
|
||||
* The URL to redirect to when user is logged-in
|
||||
*/
|
||||
redirectTo = '/';
|
||||
/**
|
||||
* 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);
|
||||
}
|
||||
}
|
||||
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();
|
||||
}
|
||||
return next();
|
||||
}
|
||||
}
|
||||
9
app/auth/middlewares/silent_auth_middleware.ts
Normal file
9
app/auth/middlewares/silent_auth_middleware.ts
Normal file
@@ -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();
|
||||
}
|
||||
}
|
||||
27
app/auth/routes/auth_routes.ts
Normal file
27
app/auth/routes/auth_routes.ts
Normal file
@@ -0,0 +1,27 @@
|
||||
import { middleware } from '#start/kernel';
|
||||
import router from '@adonisjs/core/services/router';
|
||||
const AuthController = () => import('#auth/controllers/auth_controller');
|
||||
|
||||
const ROUTES_PREFIX = '/auth';
|
||||
|
||||
/**
|
||||
* Auth routes for unauthicated users
|
||||
*/
|
||||
router
|
||||
.group(() => {
|
||||
router.get('/google', [AuthController, 'google']).as('auth');
|
||||
router
|
||||
.get('/callback', [AuthController, 'callbackAuth'])
|
||||
.as('auth.callback');
|
||||
})
|
||||
.prefix(ROUTES_PREFIX);
|
||||
|
||||
/**
|
||||
* Routes for authenticated users
|
||||
*/
|
||||
router
|
||||
.group(() => {
|
||||
router.get('/logout', [AuthController, 'logout']).as('auth.logout');
|
||||
})
|
||||
.middleware([middleware.auth()])
|
||||
.prefix(ROUTES_PREFIX);
|
||||
1
app/auth/routes/routes.ts
Normal file
1
app/auth/routes/routes.ts
Normal file
@@ -0,0 +1 @@
|
||||
import './auth_routes.js';
|
||||
141
app/collections/controllers/collections_controller.ts
Normal file
141
app/collections/controllers/collections_controller.ts
Normal file
@@ -0,0 +1,141 @@
|
||||
import Collection from '#collections/models/collection';
|
||||
import { createCollectionValidator } from '#collections/validators/create_collection_validator';
|
||||
import { deleteCollectionValidator } from '#collections/validators/delete_collection_validator';
|
||||
import { updateCollectionValidator } from '#collections/validators/update_collection_validator';
|
||||
import User from '#user/models/user';
|
||||
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 },
|
||||
});
|
||||
}
|
||||
}
|
||||
4
app/collections/enums/visibility.ts
Normal file
4
app/collections/enums/visibility.ts
Normal file
@@ -0,0 +1,4 @@
|
||||
export enum Visibility {
|
||||
PUBLIC = 'PUBLIC',
|
||||
PRIVATE = 'PRIVATE',
|
||||
}
|
||||
29
app/collections/models/collection.ts
Normal file
29
app/collections/models/collection.ts
Normal file
@@ -0,0 +1,29 @@
|
||||
import { Visibility } from '#collections/enums/visibility';
|
||||
import AppBaseModel from '#core/models/app_base_model';
|
||||
import Link from '#links/models/link';
|
||||
import User from '#user/models/user';
|
||||
import { belongsTo, column, hasMany } from '@adonisjs/lucid/orm';
|
||||
import type { BelongsTo, HasMany } from '@adonisjs/lucid/types/relations';
|
||||
|
||||
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>;
|
||||
}
|
||||
35
app/collections/routes/collections_routes.ts
Normal file
35
app/collections/routes/collections_routes.ts
Normal file
@@ -0,0 +1,35 @@
|
||||
import { middleware } from '#start/kernel';
|
||||
import router from '@adonisjs/core/services/router';
|
||||
const CollectionsController = () =>
|
||||
import('#collections/controllers/collections_controller');
|
||||
|
||||
router
|
||||
.group(() => {
|
||||
router.get('/dashboard', [CollectionsController, 'index']).as('dashboard');
|
||||
|
||||
router
|
||||
.group(() => {
|
||||
router
|
||||
.get('/create', [CollectionsController, 'showCreatePage'])
|
||||
.as('collection.create-form');
|
||||
router
|
||||
.post('/', [CollectionsController, 'store'])
|
||||
.as('collection.create');
|
||||
|
||||
router
|
||||
.get('/edit', [CollectionsController, 'showEditPage'])
|
||||
.as('collection.edit-form');
|
||||
router
|
||||
.put('/:id', [CollectionsController, 'update'])
|
||||
.as('collection.edit');
|
||||
|
||||
router
|
||||
.get('/delete', [CollectionsController, 'showDeletePage'])
|
||||
.as('collection.delete-form');
|
||||
router
|
||||
.delete('/:id', [CollectionsController, 'delete'])
|
||||
.as('collection.delete');
|
||||
})
|
||||
.prefix('/collections');
|
||||
})
|
||||
.middleware([middleware.auth()]);
|
||||
1
app/collections/routes/routes.ts
Normal file
1
app/collections/routes/routes.ts
Normal file
@@ -0,0 +1 @@
|
||||
import './collections_routes.js';
|
||||
16
app/collections/validators/create_collection_validator.ts
Normal file
16
app/collections/validators/create_collection_validator.ts
Normal file
@@ -0,0 +1,16 @@
|
||||
import { Visibility } from '#collections/enums/visibility';
|
||||
import vine, { SimpleMessagesProvider } from '@vinejs/vine';
|
||||
|
||||
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(),
|
||||
})
|
||||
);
|
||||
|
||||
createCollectionValidator.messagesProvider = new SimpleMessagesProvider({
|
||||
name: 'Collection name is required',
|
||||
'visibility.required': 'Collection visibiliy is required',
|
||||
});
|
||||
@@ -0,0 +1,8 @@
|
||||
import { params } from '#core/validators/params_object';
|
||||
import vine from '@vinejs/vine';
|
||||
|
||||
export const deleteCollectionValidator = vine.compile(
|
||||
vine.object({
|
||||
params,
|
||||
})
|
||||
);
|
||||
14
app/collections/validators/update_collection_validator.ts
Normal file
14
app/collections/validators/update_collection_validator.ts
Normal file
@@ -0,0 +1,14 @@
|
||||
import { Visibility } from '#collections/enums/visibility';
|
||||
import { params } from '#core/validators/params_object';
|
||||
import vine from '@vinejs/vine';
|
||||
|
||||
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,
|
||||
})
|
||||
);
|
||||
@@ -1,8 +0,0 @@
|
||||
const PATHS = {
|
||||
AUTHOR: 'https://www.sonny.dev/',
|
||||
REPO_GITHUB: 'https://github.com/Sonny93/my-links',
|
||||
EXTENSION:
|
||||
'https://chromewebstore.google.com/detail/mylinks/agkmlplihacolkakgeccnbhphnepphma',
|
||||
} as const;
|
||||
|
||||
export default PATHS;
|
||||
@@ -1,2 +0,0 @@
|
||||
export const PREFER_DARK_THEME = 'prefer_dark_theme';
|
||||
export const DARK_THEME_DEFAULT_VALUE = true;
|
||||
@@ -1,46 +0,0 @@
|
||||
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,
|
||||
updatedAt: this.user.updatedAt,
|
||||
count: {
|
||||
link: Number(this.user.$extras.totalLinks),
|
||||
collection: 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,
|
||||
});
|
||||
}
|
||||
}
|
||||
@@ -1,13 +0,0 @@
|
||||
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' });
|
||||
}
|
||||
}
|
||||
@@ -1,141 +0,0 @@
|
||||
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');
|
||||
}
|
||||
|
||||
return inertia.render('dashboard', {
|
||||
collections,
|
||||
activeCollection: activeCollection || collections[0],
|
||||
});
|
||||
}
|
||||
|
||||
// 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 },
|
||||
});
|
||||
}
|
||||
}
|
||||
@@ -1,160 +0,0 @@
|
||||
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);
|
||||
}
|
||||
}
|
||||
@@ -1,131 +0,0 @@
|
||||
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();
|
||||
}
|
||||
}
|
||||
@@ -1,18 +0,0 @@
|
||||
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 };
|
||||
}
|
||||
}
|
||||
@@ -1,24 +0,0 @@
|
||||
import { Visibility } from '#enums/visibility';
|
||||
import Collection from '#models/collection';
|
||||
import { getSharedCollectionValidator } from '#validators/shared_collection';
|
||||
import type { HttpContext } from '@adonisjs/core/http';
|
||||
|
||||
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']) {
|
||||
return await Collection.query()
|
||||
.where('id', id)
|
||||
.andWhere('visibility', Visibility.PUBLIC)
|
||||
.preload('links')
|
||||
.preload('author')
|
||||
.firstOrFail();
|
||||
}
|
||||
}
|
||||
@@ -1,78 +0,0 @@
|
||||
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';
|
||||
|
||||
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.redirectToNamedRoute(this.redirectTo);
|
||||
}
|
||||
|
||||
async getAllUsersWithTotalRelations() {
|
||||
return User.query()
|
||||
.withCount('collections', (q) => q.as('totalCollections'))
|
||||
.withCount('links', (q) => q.as('totalLinks'));
|
||||
}
|
||||
}
|
||||
@@ -8,12 +8,12 @@ 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,
|
||||
ARROW_DOWN,
|
||||
ARROW_UP,
|
||||
ESCAPE_KEY,
|
||||
OPEN_CREATE_COLLECTION_KEY,
|
||||
OPEN_CREATE_LINK_KEY,
|
||||
OPEN_SEARCH_KEY,
|
||||
};
|
||||
|
||||
export default KEYS;
|
||||
8
app/core/constants/paths.ts
Normal file
8
app/core/constants/paths.ts
Normal file
@@ -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;
|
||||
54
app/core/exceptions/handler.ts
Normal file
54
app/core/exceptions/handler.ts
Normal file
@@ -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);
|
||||
}
|
||||
}
|
||||
@@ -2,9 +2,9 @@ import { BentoCache, bentostore } from 'bentocache';
|
||||
import { memoryDriver } from 'bentocache/drivers/memory';
|
||||
|
||||
export const cache = new BentoCache({
|
||||
default: 'cache',
|
||||
default: 'cache',
|
||||
|
||||
stores: {
|
||||
cache: bentostore().useL1Layer(memoryDriver({ maxSize: 10_000 })),
|
||||
},
|
||||
stores: {
|
||||
cache: bentostore().useL1Layer(memoryDriver({ maxSize: 10_000 })),
|
||||
},
|
||||
});
|
||||
@@ -10,10 +10,10 @@ import { NextFn } from '@adonisjs/core/types/http';
|
||||
* - 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);
|
||||
handle(ctx: HttpContext, next: NextFn) {
|
||||
ctx.containerResolver.bindValue(HttpContext, ctx);
|
||||
ctx.containerResolver.bindValue(Logger, ctx.logger);
|
||||
|
||||
return next();
|
||||
}
|
||||
return next();
|
||||
}
|
||||
}
|
||||
17
app/core/middlewares/log_request.ts
Normal file
17
app/core/middlewares/log_request.ts
Normal file
@@ -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();
|
||||
}
|
||||
}
|
||||
25
app/core/models/app_base_model.ts
Normal file
25
app/core/models/app_base_model.ts
Normal file
@@ -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;
|
||||
}
|
||||
5
app/core/validators/params_object.ts
Normal file
5
app/core/validators/params_object.ts
Normal file
@@ -0,0 +1,5 @@
|
||||
import vine from '@vinejs/vine';
|
||||
|
||||
export const params = vine.object({
|
||||
id: vine.number(),
|
||||
});
|
||||
@@ -1,4 +0,0 @@
|
||||
export enum Visibility {
|
||||
PUBLIC = 'PUBLIC',
|
||||
PRIVATE = 'PRIVATE',
|
||||
}
|
||||
@@ -1,20 +0,0 @@
|
||||
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);
|
||||
}
|
||||
}
|
||||
@@ -1,54 +0,0 @@
|
||||
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);
|
||||
}
|
||||
}
|
||||
34
app/favicons/controllers/favicons_controller.ts
Normal file
34
app/favicons/controllers/favicons_controller.ts
Normal file
@@ -0,0 +1,34 @@
|
||||
import { CacheService } from '#favicons/services/cache_service';
|
||||
import { FaviconService } from '#favicons/services/favicons_service';
|
||||
import { Favicon } from '#favicons/types/favicon_type';
|
||||
import { inject } from '@adonisjs/core';
|
||||
import type { HttpContext } from '@adonisjs/core/http';
|
||||
|
||||
@inject()
|
||||
export default class FaviconsController {
|
||||
private faviconService: FaviconService;
|
||||
private cacheService: CacheService;
|
||||
|
||||
constructor(faviconService: FaviconService, cacheService: CacheService) {
|
||||
this.faviconService = faviconService;
|
||||
this.cacheService = cacheService;
|
||||
}
|
||||
|
||||
async index(ctx: HttpContext) {
|
||||
const url = ctx.request.qs()?.url;
|
||||
if (!url) {
|
||||
throw new Error('Missing URL');
|
||||
}
|
||||
|
||||
const favicon = await this.cacheService.getOrSetFavicon(url, () =>
|
||||
this.faviconService.getFavicon(url)
|
||||
);
|
||||
return this.sendImage(ctx, favicon);
|
||||
}
|
||||
|
||||
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);
|
||||
}
|
||||
}
|
||||
20
app/favicons/exceptions/favicon_not_found_exception.ts
Normal file
20
app/favicons/exceptions/favicon_not_found_exception.ts
Normal file
@@ -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);
|
||||
}
|
||||
}
|
||||
10
app/favicons/routes/favicons_routes.ts
Normal file
10
app/favicons/routes/favicons_routes.ts
Normal file
@@ -0,0 +1,10 @@
|
||||
import router from '@adonisjs/core/services/router';
|
||||
const FaviconsController = () =>
|
||||
import('#favicons/controllers/favicons_controller');
|
||||
|
||||
/**
|
||||
* Favicon routes
|
||||
*/
|
||||
router.group(() => {
|
||||
router.get('/favicon', [FaviconsController, 'index']).as('favicon');
|
||||
});
|
||||
1
app/favicons/routes/routes.ts
Normal file
1
app/favicons/routes/routes.ts
Normal file
@@ -0,0 +1 @@
|
||||
import './favicons_routes.js';
|
||||
17
app/favicons/services/cache_service.ts
Normal file
17
app/favicons/services/cache_service.ts
Normal file
@@ -0,0 +1,17 @@
|
||||
import { cache } from '#core/lib/cache';
|
||||
import { Favicon } from '#favicons/types/favicon_type';
|
||||
|
||||
export class CacheService {
|
||||
private cacheNs = cache.namespace('favicon');
|
||||
|
||||
async getOrSetFavicon(
|
||||
url: string,
|
||||
factory: () => Promise<Favicon>
|
||||
): Promise<Favicon> {
|
||||
return this.cacheNs.getOrSet({
|
||||
key: url,
|
||||
ttl: '1h',
|
||||
factory,
|
||||
});
|
||||
}
|
||||
}
|
||||
124
app/favicons/services/favicons_service.ts
Normal file
124
app/favicons/services/favicons_service.ts
Normal file
@@ -0,0 +1,124 @@
|
||||
import FaviconNotFoundException from '#favicons/exceptions/favicon_not_found_exception';
|
||||
import { Favicon } from '#favicons/types/favicon_type';
|
||||
import logger from '@adonisjs/core/services/logger';
|
||||
import { parse } from 'node-html-parser';
|
||||
|
||||
export class FaviconService {
|
||||
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 getFavicon(url: string): Promise<Favicon> {
|
||||
try {
|
||||
return await this.fetchFavicon(this.buildFaviconUrl(url, '/favicon.ico'));
|
||||
} catch {
|
||||
logger.debug(`Unable to retrieve favicon from ${url}/favicon.ico`);
|
||||
}
|
||||
|
||||
const documentText = await this.fetchDocumentText(url);
|
||||
const faviconPath = this.extractFaviconPath(documentText);
|
||||
|
||||
if (!faviconPath) {
|
||||
throw new FaviconNotFoundException(`No favicon path found in ${url}`);
|
||||
}
|
||||
|
||||
return await 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;
|
||||
const finalUrl = `${baseUrl}/${path}`;
|
||||
logger.debug(`Built favicon URL: ${finalUrl}`);
|
||||
return finalUrl;
|
||||
}
|
||||
|
||||
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 });
|
||||
}
|
||||
}
|
||||
6
app/favicons/types/favicon_type.ts
Normal file
6
app/favicons/types/favicon_type.ts
Normal file
@@ -0,0 +1,6 @@
|
||||
export type Favicon = {
|
||||
buffer: Buffer;
|
||||
url: string;
|
||||
type: string;
|
||||
size: number;
|
||||
};
|
||||
3
app/home/routes/home_routes.ts
Normal file
3
app/home/routes/home_routes.ts
Normal file
@@ -0,0 +1,3 @@
|
||||
import router from '@adonisjs/core/services/router';
|
||||
|
||||
router.on('/').renderInertia('home').as('home');
|
||||
1
app/home/routes/routes.ts
Normal file
1
app/home/routes/routes.ts
Normal file
@@ -0,0 +1 @@
|
||||
import './home_routes.js';
|
||||
4
app/legal/routes/legal_routes.ts
Normal file
4
app/legal/routes/legal_routes.ts
Normal file
@@ -0,0 +1,4 @@
|
||||
import router from '@adonisjs/core/services/router';
|
||||
|
||||
router.on('/terms').renderInertia('terms').as('terms');
|
||||
router.on('/privacy').renderInertia('privacy').as('privacy');
|
||||
1
app/legal/routes/routes.ts
Normal file
1
app/legal/routes/routes.ts
Normal file
@@ -0,0 +1 @@
|
||||
import './legal_routes.js';
|
||||
129
app/links/controllers/links_controller.ts
Normal file
129
app/links/controllers/links_controller.ts
Normal file
@@ -0,0 +1,129 @@
|
||||
import CollectionsController from '#collections/controllers/collections_controller';
|
||||
import Link from '#links/models/link';
|
||||
import { createLinkValidator } from '#links/validators/create_link_validator';
|
||||
import { deleteLinkValidator } from '#links/validators/delete_link_validator';
|
||||
import { updateLinkFavoriteStatusValidator } from '#links/validators/update_favorite_link_validator';
|
||||
import { updateLinkValidator } from '#links/validators/update_link_validator';
|
||||
import { inject } from '@adonisjs/core';
|
||||
import { 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();
|
||||
}
|
||||
}
|
||||
31
app/links/models/link.ts
Normal file
31
app/links/models/link.ts
Normal file
@@ -0,0 +1,31 @@
|
||||
import Collection from '#collections/models/collection';
|
||||
import AppBaseModel from '#core/models/app_base_model';
|
||||
import User from '#user/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>;
|
||||
}
|
||||
28
app/links/routes/links_routes.ts
Normal file
28
app/links/routes/links_routes.ts
Normal file
@@ -0,0 +1,28 @@
|
||||
import { middleware } from '#start/kernel';
|
||||
import router from '@adonisjs/core/services/router';
|
||||
const LinksController = () => import('#links/controllers/links_controller');
|
||||
|
||||
/**
|
||||
* Routes for authenticated users
|
||||
*/
|
||||
router
|
||||
.group(() => {
|
||||
router
|
||||
.get('/create', [LinksController, 'showCreatePage'])
|
||||
.as('link.create-form');
|
||||
router.post('/', [LinksController, 'store']).as('link.create');
|
||||
|
||||
router.get('/edit', [LinksController, 'showEditPage']).as('link.edit-form');
|
||||
router.put('/:id', [LinksController, 'update']).as('link.edit');
|
||||
|
||||
router
|
||||
.put('/:id/favorite', [LinksController, 'toggleFavorite'])
|
||||
.as('link.toggle-favorite');
|
||||
|
||||
router
|
||||
.get('/delete', [LinksController, 'showDeletePage'])
|
||||
.as('link.delete-form');
|
||||
router.delete('/:id', [LinksController, 'delete']).as('link.delete');
|
||||
})
|
||||
.middleware([middleware.auth()])
|
||||
.prefix('/links');
|
||||
1
app/links/routes/routes.ts
Normal file
1
app/links/routes/routes.ts
Normal file
@@ -0,0 +1 @@
|
||||
import './links_routes.js';
|
||||
11
app/links/validators/create_link_validator.ts
Normal file
11
app/links/validators/create_link_validator.ts
Normal file
@@ -0,0 +1,11 @@
|
||||
import vine from '@vinejs/vine';
|
||||
|
||||
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(),
|
||||
})
|
||||
);
|
||||
8
app/links/validators/delete_link_validator.ts
Normal file
8
app/links/validators/delete_link_validator.ts
Normal file
@@ -0,0 +1,8 @@
|
||||
import { params } from '#core/validators/params_object';
|
||||
import vine from '@vinejs/vine';
|
||||
|
||||
export const deleteLinkValidator = vine.compile(
|
||||
vine.object({
|
||||
params,
|
||||
})
|
||||
);
|
||||
10
app/links/validators/update_favorite_link_validator.ts
Normal file
10
app/links/validators/update_favorite_link_validator.ts
Normal file
@@ -0,0 +1,10 @@
|
||||
import { params } from '#core/validators/params_object';
|
||||
import vine from '@vinejs/vine';
|
||||
|
||||
export const updateLinkFavoriteStatusValidator = vine.compile(
|
||||
vine.object({
|
||||
favorite: vine.boolean(),
|
||||
|
||||
params,
|
||||
})
|
||||
);
|
||||
14
app/links/validators/update_link_validator.ts
Normal file
14
app/links/validators/update_link_validator.ts
Normal file
@@ -0,0 +1,14 @@
|
||||
import { params } from '#core/validators/params_object';
|
||||
import vine from '@vinejs/vine';
|
||||
|
||||
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,
|
||||
})
|
||||
);
|
||||
@@ -1,11 +0,0 @@
|
||||
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();
|
||||
}
|
||||
}
|
||||
@@ -1,17 +0,0 @@
|
||||
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();
|
||||
}
|
||||
}
|
||||
@@ -1,25 +0,0 @@
|
||||
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;
|
||||
}
|
||||
@@ -1,29 +0,0 @@
|
||||
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>;
|
||||
}
|
||||
@@ -1,31 +0,0 @@
|
||||
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>;
|
||||
}
|
||||
@@ -1,47 +0,0 @@
|
||||
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';
|
||||
|
||||
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;
|
||||
}
|
||||
}
|
||||
18
app/search/controllers/search_controller.ts
Normal file
18
app/search/controllers/search_controller.ts
Normal file
@@ -0,0 +1,18 @@
|
||||
import type { HttpContext } from '@adonisjs/core/http';
|
||||
import db from '@adonisjs/lucid/services/db';
|
||||
|
||||
export default class SearchController {
|
||||
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 };
|
||||
}
|
||||
}
|
||||
1
app/search/routes/routes.ts
Normal file
1
app/search/routes/routes.ts
Normal file
@@ -0,0 +1 @@
|
||||
import './search_routes.js';
|
||||
14
app/search/routes/search_routes.ts
Normal file
14
app/search/routes/search_routes.ts
Normal file
@@ -0,0 +1,14 @@
|
||||
import { middleware } from '#start/kernel';
|
||||
import router from '@adonisjs/core/services/router';
|
||||
|
||||
const SearchesController = () =>
|
||||
import('#search/controllers/search_controller');
|
||||
|
||||
/**
|
||||
* Search routes
|
||||
*/
|
||||
router
|
||||
.group(() => {
|
||||
router.get('/search', [SearchesController, 'search']).as('search');
|
||||
})
|
||||
.middleware([middleware.auth()]);
|
||||
@@ -0,0 +1,61 @@
|
||||
import { Visibility } from '#collections/enums/visibility';
|
||||
import Collection from '#collections/models/collection';
|
||||
import Link from '#links/models/link';
|
||||
import User from '#user/models/user';
|
||||
import type { HttpContext } from '@adonisjs/core/http';
|
||||
import { getSharedCollectionValidator } from '../validators/shared_collection.js';
|
||||
|
||||
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(),
|
||||
};
|
||||
}
|
||||
}
|
||||
1
app/shared_collections/routes/routes.ts
Normal file
1
app/shared_collections/routes/routes.ts
Normal file
@@ -0,0 +1 @@
|
||||
import './shared_collections_routes.js';
|
||||
@@ -1,6 +1,6 @@
|
||||
import router from '@adonisjs/core/services/router';
|
||||
|
||||
const SharedCollectionsController = () =>
|
||||
import('#controllers/shared_collections_controller');
|
||||
import('#shared_collections/controllers/shared_collections_controller');
|
||||
|
||||
router.get('/shared/:id', [SharedCollectionsController, 'index']).as('shared');
|
||||
@@ -1,11 +1,8 @@
|
||||
import { params } from '#core/validators/params_object';
|
||||
import vine from '@vinejs/vine';
|
||||
|
||||
const params = vine.object({
|
||||
id: vine.number(),
|
||||
});
|
||||
|
||||
export const getSharedCollectionValidator = vine.compile(
|
||||
vine.object({
|
||||
params,
|
||||
})
|
||||
vine.object({
|
||||
params,
|
||||
})
|
||||
);
|
||||
3
app/user/constants/theme.ts
Normal file
3
app/user/constants/theme.ts
Normal file
@@ -0,0 +1,3 @@
|
||||
export const KEY_USER_THEME = 'user_theme';
|
||||
export const THEMES = ['dark', 'light'] as const;
|
||||
export const DEFAULT_USER_THEME = THEMES.at(0);
|
||||
11
app/user/controllers/theme_controller.ts
Normal file
11
app/user/controllers/theme_controller.ts
Normal file
@@ -0,0 +1,11 @@
|
||||
import { KEY_USER_THEME } from '#user/constants/theme';
|
||||
import { updateThemeValidator } from '#user/validators/update_theme_validator';
|
||||
import type { HttpContext } from '@adonisjs/core/http';
|
||||
|
||||
export default class ThemeController {
|
||||
async index({ request, session, response }: HttpContext) {
|
||||
const { theme } = await request.validateUsing(updateThemeValidator);
|
||||
session.put(KEY_USER_THEME, theme);
|
||||
return response.ok({ message: 'ok' });
|
||||
}
|
||||
}
|
||||
16
app/user/middlewares/update_user_last_seen_middleware.ts
Normal file
16
app/user/middlewares/update_user_last_seen_middleware.ts
Normal file
@@ -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;
|
||||
}
|
||||
}
|
||||
54
app/user/models/user.ts
Normal file
54
app/user/models/user.ts
Normal file
@@ -0,0 +1,54 @@
|
||||
import Collection from '#collections/models/collection';
|
||||
import AppBaseModel from '#core/models/app_base_model';
|
||||
import Link from '#links/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 { 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;
|
||||
}
|
||||
1
app/user/routes/routes.ts
Normal file
1
app/user/routes/routes.ts
Normal file
@@ -0,0 +1 @@
|
||||
import './user_theme_route.js';
|
||||
5
app/user/routes/user_theme_route.ts
Normal file
5
app/user/routes/user_theme_route.ts
Normal file
@@ -0,0 +1,5 @@
|
||||
import router from '@adonisjs/core/services/router';
|
||||
|
||||
const ThemeController = () => import('#user/controllers/theme_controller');
|
||||
|
||||
router.post('/user/theme', [ThemeController, 'index']).as('user.theme');
|
||||
8
app/user/validators/update_theme_validator.ts
Normal file
8
app/user/validators/update_theme_validator.ts
Normal file
@@ -0,0 +1,8 @@
|
||||
import { THEMES } from '#user/constants/theme';
|
||||
import vine from '@vinejs/vine';
|
||||
|
||||
export const updateThemeValidator = vine.compile(
|
||||
vine.object({
|
||||
theme: vine.enum(THEMES),
|
||||
})
|
||||
);
|
||||
@@ -1,37 +0,0 @@
|
||||
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',
|
||||
});
|
||||
@@ -1,43 +0,0 @@
|
||||
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(),
|
||||
}),
|
||||
})
|
||||
);
|
||||
@@ -1,7 +0,0 @@
|
||||
import vine from '@vinejs/vine';
|
||||
|
||||
export const updateUserThemeValidator = vine.compile(
|
||||
vine.object({
|
||||
preferDarkTheme: vine.boolean(),
|
||||
})
|
||||
);
|
||||
@@ -25,23 +25,23 @@ const APP_ROOT = new URL('../', import.meta.url);
|
||||
* application.
|
||||
*/
|
||||
const IMPORTER = (filePath: string) => {
|
||||
if (filePath.startsWith('./') || filePath.startsWith('../')) {
|
||||
return import(new URL(filePath, APP_ROOT).href);
|
||||
}
|
||||
return import(filePath);
|
||||
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);
|
||||
});
|
||||
.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);
|
||||
});
|
||||
|
||||
@@ -23,23 +23,23 @@ const APP_ROOT = new URL('../', import.meta.url);
|
||||
* application.
|
||||
*/
|
||||
const IMPORTER = (filePath: string) => {
|
||||
if (filePath.startsWith('./') || filePath.startsWith('../')) {
|
||||
return import(new URL(filePath, APP_ROOT).href);
|
||||
}
|
||||
return import(filePath);
|
||||
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);
|
||||
});
|
||||
.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);
|
||||
});
|
||||
|
||||
58
bin/test.ts
58
bin/test.ts
@@ -27,36 +27,36 @@ const APP_ROOT = new URL('../', import.meta.url);
|
||||
* application.
|
||||
*/
|
||||
const IMPORTER = (filePath: string) => {
|
||||
if (filePath.startsWith('./') || filePath.startsWith('../')) {
|
||||
return import(new URL(filePath, APP_ROOT).href);
|
||||
}
|
||||
return import(filePath);
|
||||
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');
|
||||
.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);
|
||||
});
|
||||
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);
|
||||
});
|
||||
|
||||
@@ -9,7 +9,7 @@ services:
|
||||
- POSTGRES_USER=${DB_USER}
|
||||
- POSTGRES_PASSWORD=${DB_PASSWORD}
|
||||
healthcheck:
|
||||
test: ['CMD-SHELL', 'pg_isready']
|
||||
test: ['CMD-SHELL', 'pg_isready', '-U', '${DB_USER}']
|
||||
volumes:
|
||||
- postgres-volume:/var/lib/postgresql/data
|
||||
ports:
|
||||
@@ -17,22 +17,30 @@ services:
|
||||
|
||||
pgadmin:
|
||||
container_name: pgadmin
|
||||
image: dpage/pgadmin4:8.6
|
||||
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
|
||||
volumes:
|
||||
- ./docker-config/servers_pgadmin.json:/pgadmin4/servers.json
|
||||
ports:
|
||||
- '5050:80'
|
||||
user: root
|
||||
configs:
|
||||
- source: servers.json
|
||||
target: /pgadmin4/servers.json
|
||||
- source: pgpass
|
||||
target: /pgpass
|
||||
|
||||
my-links:
|
||||
container_name: my-links
|
||||
@@ -53,4 +61,19 @@ services:
|
||||
|
||||
volumes:
|
||||
postgres-volume:
|
||||
name: postgres-prod-my-links
|
||||
|
||||
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"
|
||||
}}}
|
||||
@@ -2,18 +2,18 @@ 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'],
|
||||
}),
|
||||
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> {}
|
||||
interface SocialProviders extends InferSocialProviders<typeof allyConfig> {}
|
||||
}
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user