Skip to content

Commit

Permalink
Merge pull request #148 from Extendy/releases/v1.0.0-dev
Browse files Browse the repository at this point in the history
Releases/v1.0.0 dev
  • Loading branch information
mshannaq authored Mar 3, 2024
2 parents f6aa069 + 3af442a commit b25c4cf
Show file tree
Hide file tree
Showing 6 changed files with 18 additions and 13 deletions.
8 changes: 2 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,5 @@
# SmartyURL

> [!IMPORTANT]
> **NOT READY!! The application is currently under development and not yet ready for use. We will remove this notice once it becomes available for use.**

SmartyURL, a powerful & open-source URL management tool, empowers businesses and individuals they need self-hosted tool to customize, track, shorten URLs, and manage their URLs for marketing, analytics, and reporting.

You can utilize SmartyURL to generate redirect links to the final URL, considering various variables like the visitor's geographical location or user device information.
Expand All @@ -25,9 +21,9 @@ In addition to shortening URLs (based on domain that you use), SmartyURL also of

## Installation

Currently, as SmartyURL is in its early stages, you can only install it using Composer. Once we release the first official version of SmartyURL, we will offer detailed installation instructions for other methods.
Currently, as SmartyURL is in its early stages, you can only install it using Composer. In future releases, we may support other installation methods.

see [Developers Guide](http://extendy.github.io/SmartyURL/developers) for more information about how to install SmartyURL.
See [Developers Guide](http://extendy.github.io/SmartyURL/developers) for more information about how to install SmartyURL.

Certainly, please refer to the [documentation](http://extendy.github.io/SmartyURL) for detailed instructions How configure, and effectively use SmartyURL for comprehensive guidance.

Expand Down
2 changes: 1 addition & 1 deletion app/Config/Smarty.php
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ class Smarty extends BaseConfig
{
public $smarty_name = 'SmartyURL';
public $smarty_online_repo = 'https://smartyurl.extendy.net';
public $smarty_version = '0.0.0-dev-dnd.8';
public $smarty_version = '1.0.0-dev';

/**
* @var string contain the file name of jquery supported version eg jquery-3.7.1 without js
Expand Down
Binary file modified datastore/IP2Location/IP2LOCATION-LITE-DB1.IPV6.BIN
100644 → 100755
Binary file not shown.
9 changes: 5 additions & 4 deletions docs/developers.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ If creating a subdomain is not possible, SmartyURL can be installed in a subfold

## Installation

Currently, as SmartyURL is in its early stages, you can only install it using `Composer`. Once we release the first official version of SmartyURL, we may offer other installation methods.
Currently, as SmartyURL is in its early stages, you can only install it using `Composer`. In future releases, we may support other installation methods..

### Install SmartyURL using `Composer`:

Expand All @@ -40,7 +40,7 @@ This is the best way for now, to install SmartyURL you have to use `composer` co
Login to your web hosting account where you want to install SmartyURL using SSH and run the following commands:

```cli
composer create-project extendy/smartyurl:dev-main myapp
composer create-project extendy/smartyurl myapp
cd myapp
composer install
```
Expand Down Expand Up @@ -125,8 +125,9 @@ Auth.allowRegistration = false

By default user registration using the portal is **disabled** because SmartyURL is Closed by Default. See [Why SmartyURL is Closed by Default](users.md/#why-smartyurl-is-closed-by-default) to know why.

## Using `git` for SmartyUrl developers only
While it is not advisable for developers to attempt installation using git. but sure you can do that. you need some experice usng git to install code and run the commands in [After installing the files](developers.md/#after-installing-the-files)
## Using `git` for SmartyUrl developers only (Not recommended)

While it is Not recommended for developers to attempt installation using git. but sure you can do that. you need some experice usng git to install code and run the commands in [After installing the files](developers.md/#after-installing-the-files)

!!! note
If you planning to install SmartyURL with `git`, you gain the flexibility to easily update SmartyURL in the future using `git fetch` and `git pull`. However, **noting that** using `git` may provide bleeding-edge releases, which might not be as stable or thoroughly tested or may contains breaking changes.
Expand Down
6 changes: 5 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,8 @@ Every open-source project depends on its contributors to be a success. Thanks to

Also We would like to acknowledge the following resources and contributors for their valuable assistance and support in the development of this project:

- [MassarCloud Company](https://massarcloud.sa): We would like to express our gratitude to [MassarCloud LLC](https://massarcloud.sa) for their valuable support in providing hosting services during the development of this project.
| | |
| ------------- | ------------- |
| <img width="150" src="https://d1z6v8w317q2lf.cloudfront.net/misc/cdn1/img/massarcloud_logo_rectangle_336x106px.png" alt="PhpStorm logo."> | [MassarCloud Company](https://massarcloud.sa): We would like to express our gratitude to [MassarCloud LLC](https://massarcloud.sa) for their valuable support in providing hosting services during the development of this project. |
| <img width="100" src="https://resources.jetbrains.com/storage/products/company/brand/logos/PhpStorm_icon.svg" alt="PhpStorm logo."> | [JetBrains s.r.o](https://jb.gg/OpenSourceSupport) We would like to express our gratitude to JetBrains s.r.o for their valuable support in providing Open Source development license. |
| | |
6 changes: 5 additions & 1 deletion docs/installation.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
# SmartyURL Installation

Since SmartyURL is still in its early stages, you can find installation instructions in the [Developer's Guide](developers.md). Once we release the first version of SmartyURL, we will provide detailed installation instructions.
Currently, as SmartyURL is in its early stages, you can find installation instructions in the [Developer's Guide](developers.md).
In future releases, we may add other installtion docs.



0 comments on commit b25c4cf

Please sign in to comment.