ValeriaVG/nomocms

View on GitHub
README.md

Summary

Maintainability
Test Coverage
# ![NoMoCMS](./logo.svg) 

(Being Renamed to AuCMS)

> ⚠️ Important: Master branch is not yet stable as project is undergoing massive refactoring ⚠️

[![Maintainability](https://api.codeclimate.com/v1/badges/fba64515ad8b4aa8c338/maintainability)](https://codeclimate.com/github/ValeriaVG/nomocms/maintainability)
[![Test Coverage](https://api.codeclimate.com/v1/badges/fba64515ad8b4aa8c338/test_coverage)](https://codeclimate.com/github/ValeriaVG/nomocms/test_coverage)

Content management system for blazingly fast websites powered by Svelte.

NoMoCMS is currently in active development. It's not ready for production use until it reaches v1.0.

Current stage: alpha

<!-- ## How to deploy

[![Deploy to DO](https://www.deploytodo.com/do-btn-blue.svg)](https://cloud.digitalocean.com/apps/new?repo=https://github.com/ValeriaVG/nomocms/tree/main&refcode=6ad1223ed047) -->

## First-time & Emergency access

You can set up a superuser account though the following environment variables:

- `SUPERUSER_EMAIL`, by default is set to `clark.kent@daily.planet`
- `SUPERUSER_PASSWORD`, by default is set to `clark&lois`

> WARNING: consider changing the default superuser credentials

## Development

To run on local machine you'll need:

- NodeJS (tested on v16.9.1) with NPM 7+
- PostgreSQL (or run `docker-compose up -d`)

Project uses [NPM workspaces](https://docs.npmjs.com/cli/v7/using-npm/workspaces):

To start in the development mode:

```
npm run start -w api
npm run start -w dashboard
```

To build :

```
npm run build # build api & dashboard
# OR specify a workspace
npm run build -w api
npm run build -w dashboard
```

To run tests:

```
npm run test # to run all
npm run test -w api # to run only the api tests
npm run test -w modules/account # to run only the modules/account tests
```

## Disclaimer

Node.js is a trademark of Joyent, Inc. and is used with its permission. We are not endorsed by or
affiliated with Joyent.