mirror of
https://github.com/Kovah/LinkAce.git
synced 2025-03-14 19:59:38 +01:00
Update meta files like readme and contribution docs
This commit is contained in:
Kovah
parent
e102234329
commit
9179a10f2b
15
.github/FUNDING.yml
vendored
15
.github/FUNDING.yml
vendored
@ -1,12 +1,5 @@
|
||||
# These are supported funding model platforms
|
||||
|
||||
github: kovah # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
|
||||
patreon: Kovah # Replace with a single Patreon username
|
||||
open_collective: linkace # Replace with a single Open Collective username
|
||||
ko_fi: # Replace with a single Ko-fi username
|
||||
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
|
||||
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
|
||||
liberapay: kovah # Replace with a single Liberapay username
|
||||
issuehunt: # Replace with a single IssueHunt username
|
||||
otechie: # Replace with a single Otechie username
|
||||
custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']
|
||||
github: kovah
|
||||
patreon: Kovah
|
||||
open_collective: linkace
|
||||
liberapay: kovah
|
||||
|
||||
@ -4,14 +4,14 @@ If you want to contribute to the project please open a [ticket](https://github.c
|
||||
describe what you want to do or what your idea is. Maybe there already is an existing ticket for your or a very similar
|
||||
topic.
|
||||
|
||||
I may decline contributions for features that may not fit into the application, so make sure to talk to me before
|
||||
I may decline contributions for features that may not fit into the application, so please make sure to talk to me before
|
||||
starting to code.
|
||||
|
||||
|
||||
## Contribution Guidelines
|
||||
|
||||
* Always use the `dev` branch to work on the application. The dev branch will contain the latest version of the app
|
||||
while the `master` branch may contains the stable version (which may be outdated in terms of development).
|
||||
while the `main` branch contains the stable version (which may be outdated in terms of development).
|
||||
* Consider using a separate branch if you are working on a larger feature.
|
||||
* Reference the issue number in your commits please.
|
||||
* When opening a pull request, link to your ticket and describe what you did to solve the problem.
|
||||
@ -24,8 +24,8 @@ starting to code.
|
||||
|
||||
### Minimum Requirements
|
||||
|
||||
* [Docker](https://www.docker.com/products/docker-desktop) _or_ PHP 7.3
|
||||
* [Node](https://nodejs.org/en/) (14 LTS)
|
||||
* [Docker](https://www.docker.com/products/docker-desktop) _or_ PHP 7.4
|
||||
* [Node](https://nodejs.org/en/) (16 LTS)
|
||||
|
||||
### 1. Basic Setup
|
||||
|
||||
@ -44,7 +44,7 @@ docker exec -it linkace-php composer install
|
||||
docker exec -it linkace-php php artisan key:generate
|
||||
```
|
||||
|
||||
Last step: compile all assets. Node 10 LTS is the minimum version required and recommended to use. You may use either NPM or Yarn for installing the asset dependencies.
|
||||
Last step: compile all assets. Node 16 LTS is the minimum version required and recommended to use. You may use either NPM or Yarn for installing the asset dependencies.
|
||||
|
||||
```bash
|
||||
npm install
|
||||
@ -57,7 +57,7 @@ npm run dev
|
||||
I recommend using the Artisan command line tool in the PHP container only, to make sure that the same environment is used. To do so, use the following example command:
|
||||
|
||||
```bash
|
||||
docker exec linkace-php bash -c "php artisan migrate"
|
||||
docker exec -it linkace-php php artisan migrate
|
||||
```
|
||||
|
||||
#### 3. Registering a new user
|
||||
@ -65,7 +65,7 @@ docker exec linkace-php bash -c "php artisan migrate"
|
||||
Currently, you can do this by using the command line:
|
||||
|
||||
```bash
|
||||
docker exec -it linkace-php bash -c "php artisan registeruser [user name] [user email]"
|
||||
docker exec -it linkace-php php artisan registeruser [user name] [user email]
|
||||
```
|
||||
|
||||
|
||||
@ -81,8 +81,8 @@ docker exec -it linkace-php composer run test
|
||||
|
||||
## LinkAce Base Docker image
|
||||
|
||||
The Base image for LinkAce contains several packages and PHP extensions needed by LinkAce. It shortens the build time of the release images. This step is not needed by any developer working on LinkAce and ist just a documentation for maintainers.
|
||||
The Base image for LinkAce contains several packages and PHP extensions needed by LinkAce. It shortens the build time of the release images. This step is not needed by any developer working on LinkAce and is just a documentation for maintainers.
|
||||
|
||||
```
|
||||
```bash
|
||||
docker buildx build --push --platform "linux/amd64,linux/arm64,linux/arm/v7" -t linkace/base-image:php-8.1-alpine -f resources/docker/dockerfiles/release-base.Dockerfile .
|
||||
```
|
||||
|
||||
28
README.md
28
README.md
@ -2,9 +2,7 @@
|
||||
<img src="https://www.linkace.org/images/linkace-social.jpg" title="Linkace">
|
||||
</p>
|
||||
|
||||
|
||||
|
||||
<p align="center"><b>Your self-hosted bookmark archive. Free and open source.</b></p>
|
||||
<p align="center"><b>Your self-hosted bookmark archive.</b></p>
|
||||
|
||||
<p align="center">
|
||||
<a href="https://twitter.com/LinkAceApp"><img src="https://img.shields.io/twitter/url?label=%40LinkAceApp&style=social&url=https%3A%2F%2Ftwitter.com%2FLinkAceApp" alt="Follow LinkAce on Twitter"></a>
|
||||
@ -18,8 +16,8 @@
|
||||
### Contents
|
||||
|
||||
* [About LinkAce](#about-linkace)
|
||||
* [Support](#bulb-support-for-linkace)
|
||||
* [Setup](#gear-setup)
|
||||
* [Support](#bulb-support-for-linkace)
|
||||
* [Contribution](#construction-contribution)
|
||||
|
||||
|
||||
@ -60,6 +58,17 @@ More screenshots of the app and further details about the features can be found
|
||||
|
||||
|
||||
|
||||
### :gear: Setup
|
||||
|
||||
LinkAce provides multiple ways of installing it on your server. The complete documentation for all installation methods can be found [**in the wiki**](https://www.linkace.org/docs/v1/setup/).
|
||||
|
||||
* [Setup with Docker](https://www.linkace.org/docs/v1/setup/setup-with-docker/) (_recommended_)
|
||||
* [Setup without Docker](https://www.linkace.org/docs/v1/setup/setup-without-docker/)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### :bulb: Support for LinkAce
|
||||
|
||||
I built LinkAce to solve my own problem, and I now offer my solution and code without charging any money. I spent a lot of my free time building this application, so I won't offer any *free* personal support, customization or installation help. If you need help please visit the [community discussions](https://github.com/Kovah/LinkAce/discussions) and post your issue there.
|
||||
@ -75,17 +84,6 @@ Additionally, you may visit the [community discussions](https://github.com/Kovah
|
||||
|
||||
|
||||
|
||||
### :gear: Setup
|
||||
|
||||
LinkAce provides multiple ways of installing it on your server. The complete documentation for all installation methods can be found [**in the wiki**](https://www.linkace.org/docs/v1/setup/).
|
||||
|
||||
* [Setup with Docker](https://www.linkace.org/docs/v1/setup/setup-with-docker/) (_recommended_)
|
||||
* [Setup without Docker](https://www.linkace.org/docs/v1/setup/setup-without-docker/)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### :construction: Contribution
|
||||
|
||||
[](https://crowdin.com/project/linkace) [ ](https://codeclimate.com/github/Kovah/LinkAce) [](https://github.com/Kovah/LinkAce/actions?query=workflow%3ATesting+branch%3Adev)
|
||||
|
||||
@ -2,15 +2,16 @@
|
||||
|
||||
## Supported Versions
|
||||
|
||||
As LinkAce is currently being developed, there is no support for the current releases. All releases are marked
|
||||
as pre-releases, and a development disclaimer is present in the README. Usage of the app in this state is entirely
|
||||
on your own risk.
|
||||
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.
|
||||
|
||||
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.
|
||||
|
||||
| Version | Supported |
|
||||
| ------- | ------------------ |
|
||||
| 0.x | :x: |
|
||||
| 1.x | :white_check_mark: |
|
||||
|
||||
|
||||
### Support for PHP versions
|
||||
|
||||
The PHP version supported by LinkAce is the oldest version of PHP that is still **officially supported** in terms of
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user