Skip to content

Latest commit

 

History

History
79 lines (45 loc) · 1.66 KB

README.md

File metadata and controls

79 lines (45 loc) · 1.66 KB
Raw

Smatflow Portal

Getting started

This should be private and only admins and developers have permission to edit it. Here are the tools you must have to get started (Test or Development).

  • NodeJS
  • NPM
  • PNPM (install with: npm install -g pnpm)
  • Docker

Description

This is the Smatflow offical site repository.

Installation

Clone the repository:

git clone https://github.com/Icloudeng/directus-portal.git

Install packages

  • pnpm install

Database

For a quick start consider using docker and docker compose

  • docker compose -f docker-compose.db.yaml up

Copy CMS env file

  • cp apps/cms/.env.sample apps/cms/.env

Build Packages

  • pnpm build

Setup CMS

  • pnpm run -r setup

Server

  • pnpm dev --filter=web --filter=cms --filter=@packages/contracts

Starts development servers for (cms: http://localhost:8055/ and web: http://localhost:3000/)

Admin Account

Monorepos

The project was designed on a monorepo architecture, actually there are two apps as project packages:

  • apps/cms: CMS part powered by Directus
  • apps/web: Web Part made with NextJs
  • apps/docs: DOCS Part made with Docusaurus

Configuration

The default configuration can work without needing to modify it, but in cases where you need customization regarding the project configuration, you can edit the following files:

  • apps/cms/.env CMS configuration file
  • apps/web/.env Web configuration (Here you need to create a new configuration file called .env.local where you put your customization, instead of modifying the actual file)

Authors and acknowledgment

@smatflow

License

....