Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/contentjet/contentjet-api
Headless API-first content management system
https://github.com/contentjet/contentjet-api
api api-first-cms cms headless headless-cms koa2 node objectionjs rest-api
Last synced: 3 days ago
JSON representation
Headless API-first content management system
- Host: GitHub
- URL: https://github.com/contentjet/contentjet-api
- Owner: contentjet
- License: mit
- Created: 2017-11-05T11:34:20.000Z (about 7 years ago)
- Default Branch: develop
- Last Pushed: 2023-01-11T00:52:12.000Z (almost 2 years ago)
- Last Synced: 2024-10-31T08:52:19.653Z (10 days ago)
- Topics: api, api-first-cms, cms, headless, headless-cms, koa2, node, objectionjs, rest-api
- Language: TypeScript
- Homepage: https://contentjet.github.io/
- Size: 2.01 MB
- Stars: 96
- Watchers: 6
- Forks: 6
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# contentjet-api
A Node based back end for contentjet, a powerful headless API-first CMS. Built with [Koa](http://koajs.com/), [Objection](http://vincit.github.io/objection.js/) and [PostgreSQL](https://www.postgresql.org/).
Contentjet is composed of 2 discrete applications, the backend API contentjet-api (this repository) and the frontend HTML user interface [contentjet-ui][contentjet-ui].
For more information and hosting documentation please visit **[contentjet.github.io][contentjet]**.
## Development
### Requirements
* Node 8+
* NPM 5+
* PostgreSQL 9.5+
### 1. Installation
```
npm install
```
### 2. Configuration
The app is configurable through the use of environment variables. Environment variables can either be exported directly or you may optionally create a `.env` file in the root of the repository and specify them there. Note any _exported_ variables will take precedence over those defined in `.env`. See [dotenv](https://github.com/motdotla/dotenv) for more details.
For a complete list of all options refer to `src/config/index.ts`. While _most_ options have default fallbacks you will need to provide values for the following:
#### Secret key
Secret key is used in the hashing of passwords and tokens. You must supply a random string to this value and be sure to keep it secret!
```
SECRET_KEY=yoursupersecretkey
```
#### Database
Database connection settings. Note only PostgreSQL 9.5+ is supported.
```
POSTGRES_HOST=localhost
POSTGRES_PORT=5432
POSTGRES_DB=contentjet-api
POSTGRES_USER=postgres
POSTGRES_PASSWORD=password
```
#### URLs
The application needs to know where it's hosted.
FRONTEND_URL is the url hosting [contentjet-ui][contentjet-ui].
```
FRONTEND_URL=https://example.com
```
BACKEND_URL is the url hosting _this_ application ([contentjet-api][contentjet-api]).
```
BACKEND_URL=https://api.example.com
```
#### Mail
You MUST provide the following SMTP settings for email sending.
```
[email protected]
SMTP_HOST=your-smtp-host
SMTP_PORT=your-smtp-host-port
SMTP_USER=your-smtp-user
SMTP_PASSWORD=your-smtp-password
```
### 3. Database migration
Run the following command to create the required tables in your database.
```
npm run migrate
```
### 4. Create application administrator
You must create at least one administrator user.
```
npm run create-admin-user
```
### 5. Run
Start the server.
```
npm run dev
```
[contentjet-ui]: https://github.com/contentjet/contentjet-ui
[contentjet-api]: https://github.com/contentjet/contentjet-api
[contentjet]: https://contentjet.github.io