Skip to content
This repository has been archived by the owner on Nov 23, 2024. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
valdisiljuconoks authored Nov 23, 2024
1 parent e2b48d7 commit 1791653
Showing 1 changed file with 2 additions and 70 deletions.
72 changes: 2 additions & 70 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,71 +1,3 @@
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=valdisiljuconoks_localization-provider-opti&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=valdisiljuconoks_localization-provider-opti)
# ARCHIVED

# Supporting Localization Provider

If you find this library useful, cup of coffee would be awesome! You can support further development of the library via [Paypal](https://paypal.me/valdisiljuconoks).

# Localization Provider v8.0 IS OUT!

Read more about v8.0 release [here](https://github.com/valdisiljuconoks/LocalizationProvider/?tab=readme-ov-file#localization-provider-v80-is-out).

# What is the LocalizationProvider project?

LocalizationProvider project is Optimizely localization provider on steroids.

Giving you the main following features:
* Database-driven localization provider for Optimizely website projects
* Easy resource registrations via code (code-first approach)
* Supports hierarchical resource organization (with the help of child classes)
* Administration UI for editors to change or add new translations for required languages

## Source Code Repos
The whole package of libraries is split into multiple git repos (with submodule linkage in between). Below is list of all related repositories:
* [Main Repository](https://github.com/valdisiljuconoks/LocalizationProvider/)
* [.NET Runtime Repository](https://github.com/valdisiljuconoks/localization-provider-core)
* [Optimizely Integration Repository](https://github.com/valdisiljuconoks/localization-provider-epi)

## Getting Started
* [Getting Started](docs/getting-started-epi.md)

## Working with DbLocalizationProvider
* For more info about generic localization provider features read more [here](https://github.com/valdisiljuconoks/LocalizationProvider/blob/master/README.md)

## Integrating with Optimizely
* [Working with Resources (Optimizely)](docs/working-with-resources-epi.md)
* [Optimizely Frontend Localization](docs/jsresourcehandler-epi.md)
* [Optimizely Xml File Migration](docs/xml-migration-epi.md)

<!-- * [Admin UI (Optimizely)](docs/adminui-epi.md) -->

# How to Contribute

It's super cool if you read this section and are interested how to help the library. Forking and playing around sample application is the fastest way to understand how the localization provider is working and how to get started.

Forking and cloning the repo is the first step you do. Keep in mind that the provider is split into couple of repositories to keep things separated. Additional repos are pulled in as submodules. If you Git client does not support automatic checkout of the submodules, just execute this command at the root of the checkout directory:

```
git clone --recurse-submodules [email protected]:valdisiljuconoks/localization-provider-epi.git
```

**NB!** As Optimizely repository contains 2 level (`lib/netcore` and `lib/netcore/lib/localization-provider`) submodules `--recursive-submodules` sometimes fails to detect 2nd level module. Then you can just step into `netcore` submodule folder and execute pull command there:

```
git submodule foreach git pull origin master
```

# Other Versions

## v7.0 is OUT

Please read more in [this blog post](https://tech-fellow.eu/2022/01/23/dblocalizationprovider-for-optimizely/)!

## Migrating from v5.x?

Please visit [blog post](https://tech-fellow.eu/2020/02/22/localization-provider-major-6/) to get more information about new features added in v6 and also how to migrate.

# More Info

* [Part 1: Resources and Models](https://tech-fellow.eu/2016/03/16/db-localization-provider-part-1-resources-and-models/)
* [Part 2: Configuration and Extensions](https://tech-fellow.eu/2016/04/22/db-localization-provider-part-2-configuration-and-extensions/)
* [Part 3: Import and Export](https://tech-fellow.eu/2017/02/23/localization-provider-import-and-export-merge/)
* [Part 4: Resource Refactoring and Migrations](https://tech-fellow.eu/2017/10/10/localizationprovider-tree-view-export-and-migrations/)
Source code has been moved to [https://github.com/valdisiljuconoks/LocalizationProvider](https://github.com/valdisiljuconoks/LocalizationProvider)

0 comments on commit 1791653

Please sign in to comment.