Simple CMS API

Description

This is Simple CMS service

Tech Stacks

• Node.js >= v20.14.0: https://github.com/nodejs/node
• MySQL: https://github.com/mysql/mysql-server
• MongoDB: https://github.com/mongodb/mongo
• Docker: https://github.com/docker

Framework & Library

• NestJS: https://github.com/nestjs/nest
• Prisma (ORM): https://github.com/prisma/prisma
• Class Validator (Validation): https://github.com/typestack/class-validator
• Swagger (API Docs): https://github.com/nestjs/swagger

API Documentation

API Spec use OpenAPI Swagger, you can see the documentation in /api

Installation

$ yarn install

Running the app

# copy and set env
$ cp -p .example.env .env

# development
$ yarn run start

# watch mode
$ yarn run start:dev

# production mode
$ yarn run start:prod

Test

# unit tests
$ yarn run test

# e2e tests
$ yarn run test:e2e

# test coverage
$ yarn run test:cov

Docker

Development

Please use compose.yaml for development.

$ docker compose -f compose.yaml up -d

Run Migration

$ docker exec -it simplecms-api-1 yarn dbpush

Run Seeder

$ docker exec -it simplecms-api-1 yarn prisma:seed

After seeding, you can use demo user:

admin@simplecms.com
admin123

writer@simplecms.com
writer123

UI

Setting env

$ cd ui
$ cp -p .env.example .env

If compose run properly, edit API_URL from http://localhost:3001 to http://api:3001

Open the UI on port 3000

If it's not running from the compose, open folder ui and run npm run dev or yarn dev