Git Product home page Git Product logo

uzbekdev1 / apptext Goto Github PK

View Code? Open in Web Editor NEW

This project forked from martijnboland/apptext

0.0 0.0 0.0 3.39 MB

AppText is a content management system for applications. Application developers can use it to replace static resources in applications with dynamic content and delegate content management to non-developers.

Home Page: https://apptext.io

License: Apache License 2.0

C# 71.48% HTML 2.96% CSS 0.82% JavaScript 1.88% TypeScript 21.69% Dockerfile 0.25% SCSS 0.92%

apptext's Introduction

AppText

AppText is a Content Management System for Applications. A hybrid between a headless Content Management System and a Translation Management System.

AppText is built with ASP.NET Core and React. It is installed via NuGet packages.

.NET Core Build Nuget (with prereleases)

Who should use it?

AppText is intended for .NET application developers who want an easy way of managing content for their applications and being able to delegate content management to non-developers.

Getting started

A complete getting started guide can be found on the AppText web site. You can also check out the examples.

Development and contributing

Prerequisites

AppText is a .NET Core app and uses React for the Admin app. You should be able to run it on any platform that supports .NET Core (Windows, MacOS, Linux). To build it, you'll need the .NET Core 3.1 SDK and a reasonably recent version of node.js, for example, the latest LTS version.

Get the source code

git clone https://github.com/martijnboland/apptext.git

Navigate to the folder where you cloned the sources. You'll see a /src folder and in that folder the following components:

  • AppText - the core logic with the REST and Graphql api's and a file-based storage engine;
  • AppText.AdminApp - the management application;
  • AppText.Localization - enables .NET Core apps to use AppText dynamic resources with the standard .NET Core localization API;
  • AppText.Storage.LiteDB - storage engine based on LiteDB;
  • AppText.Translations - module that adds a global 'Translation' content type and provides a REST endpoint to retrieve content as JSON, .NET resx or GNU gettext PO files.
  • HostAppExample - ASP.NET Core template app with authentication that hosts AppText as embedded application. This one is also configured by default to use the LiteDB storage engine.

Build and run API and Admin app

Follow the steps below to build and run the AppText API and Admin App.

Open a terminal window and navigate to the /src/AppText.Admin/ClientApp folder, then build the React Admin app with

npm install
npm run build

Open a second terminal, navigate to the /src/AppText.AdminApp folder and execute

dotnet run

The admin interface will become available at https://localhost:5101/apptext. It is set up that it will initialize itself as app in the AppText storage at startup.

When developing the Admin app, you can run the webpack development server (with Hot Module Reloading) from the /src/AppText.Admin/ClientApp folder with

npm start

The Admin app will then be available at http://localhost:8080.

Build and run the Host App example

An alternative way of running AppText from source is by building AppText and AppText.Admin first, but then running the HostAppExample. This showcases how AppText can be integrated in any existing ASP.NET Core web application.

Open a terminal, navigate to the /src/AppText.AdminApp/ClientApp folder and execute

npm install
npm run prod

Then navigate back to the sources root folder (where AppText.sln is located) and execute

dotnet build

Finally go to the src/HostAppExample folder and execute

dotnet run

The host app is available at https://localhost:5001 and the AppText admin app is at https://localhost:5001/apptext. Note that you have to create an account first and log in before you can access the admin app.

apptext's People

Contributors

dependabot[bot] avatar martijnboland avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.