Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/prisma-cms/boilerplate

Boilerplate for @prisma-cms
https://github.com/prisma-cms/boilerplate

api api-first api-first-cms apollo apollo-client graphql headless-cms material-ui node-cms node-js prisma prisma-cms react

Last synced: about 5 hours ago
JSON representation

Boilerplate for @prisma-cms

Host: GitHub
URL: https://github.com/prisma-cms/boilerplate
Owner: prisma-cms
Created: 2018-10-03T15:09:54.000Z (about 6 years ago)
Default Branch: master
Last Pushed: 2020-12-02T17:41:56.000Z (almost 4 years ago)
Last Synced: 2024-10-31T17:42:48.887Z (15 days ago)
Topics: api, api-first, api-first-cms, apollo, apollo-client, graphql, headless-cms, material-ui, node-cms, node-js, prisma, prisma-cms, react
Language: JavaScript
Homepage: http://prisma-cms.com
Size: 267 KB
Stars: 23
Watchers: 4
Forks: 4
Open Issues: 0
Metadata Files:
- Readme: readme.md
- Changelog: changelog.md

Awesome Lists containing this project

README

*🙌 Sorry for my english...*

## Installation

### Base requirements
#### Linux server
*i used ubuntu-18 on [digitalocean.com](https://m.do.co/c/b6a1f9d7298e)* (referral link) with 2GB tarif plan for $10/month

```shell
sudo apt update
sudo apt upgrade -y
```

Install common programs
```shell
sudo apt install -y mc git build-essential
```

Create user

```shell
# Create user (not required if you use another user)
sudo useradd USERNAME -d /home/USERNAME -G sudo -s /bin/bash
sudo mkdir /home/USERNAME
cd /home/USERNAME

# for bash hightlighting
wget https://gist.githubusercontent.com/Fi1osof/2f8ea23f5411c5c7a0e0025f04941aee/raw/.bashrc

sudo chown USERNAME: /home/USERNAME -R

# set password
passwd USERNAME
```

### Install node-js and npm
```shell
curl -sL https://deb.nodesource.com/setup_10.x | sudo -E bash -
sudo apt-get install -y nodejs
```
Check node-js `node -v`

### Install yarn
```shell
curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | sudo apt-key add -
echo "deb https://dl.yarnpkg.com/debian/ stable main" | sudo tee /etc/apt/sources.list.d/yarn.list
sudo apt-get update && sudo apt-get install yarn
```
Check yarn `yarn -v`

### Install prisma
```shell
sudo npm i -g prisma npm-run-all nodemon pm2 cross-env
```
Check prisma `prisma -v`

### Reset homedir permissions
```shell
sudo chown $(whoami): ~ -R
```

### Create /var/www if not exists
```shell
sudo mkdir /var/www
sudo chown $(whoami): /var/www -R
```

### Install @prisma-cms/boilerplate
```shell
cd /var/www
git clone https://github.com/prisma-cms/boilerplate
cd boilerplate
yarn --ignore-engines
```

## Deploy schema

### Install prisma local

#### Install docker
```shell
sudo apt-get install software-properties-common python-software-properties
sudo apt-key adv --keyserver hkp://p80.pool.sks-keyservers.net:80 --recv-keys 58118E89F3A912897C070ADBF76221572C52609D
sudo apt-add-repository 'deb https://apt.dockerproject.org/repo ubuntu-xenial main'
sudo apt-get update
sudo apt-get install -y docker-engine
```
Check docker installed
`docker -v`

#### Install docker-compose
```shell
sudo curl -L https://github.com/docker/compose/releases/download/1.18.0/docker-compose-`uname -s`-`uname -m` -o /usr/local/bin/docker-compose
sudo chmod +x /usr/local/bin/docker-compose
```
Check docker-compose `docker-compose -v`

#### Start prisma docker images
*Note: before do this, you can edit src/server/schema/prisma/docker-compose.yml for change prisma port and password.*
```
sudo docker-compose -f ./src/server/scripts/docker/prisma/docker-compose.yml up -d
```

#### Start PhpMyAdmin (optionaly)
```
sudo docker run -d --link prisma_mysql_1:db --network prisma_default -p 8080:80 phpmyadmin/phpmyadmin
```

### Deploy

```shell
endpoint=http://localhost:4466/my-project/my-stage yarn deploy
```

Explaining yarn deploy

*Note: you sould not execute this commands separately from `yarn deploy`, but may, if undestand what they are doing.*

This command run several commands:
1. `yarn build-schema-prisma` - generate raw graphql schema (for backend)
2. `yarn deploy-schema` - deploy generated schema into prisma server.

If you deploy schema for update exists database and wont force deploy while prisma reject deleting data, you may use `yarn deploy-schema -f` OR `yarn deploy-force` (for run complete procedure).
3. `yarn get-schema -p prisma` - get schema from prisma server
4. `yarn build-schema-api` - generate API schema (for frontend)
5. `yarn generate-fragments-api` - generate JS fragments for apollo client.

## Run server API
```shell
APP_SECRET={MY_ULTRA_SECRET_KEY} endpoint={endpoint} yarn start-server
```
Current endpoint after deploy you may see by this command (look for uncommented endpoint):
```shell
cat src/schema/generated/prisma.graphql |grep "# source: "
```

For example:
```shell
APP_SECRET=MY_SECRET endpoint=http://localhost:4466/prisma/dev yarn start-server
```

Open http://localhost:4000 (or http://server_address:4000)

Here you may write graphql requests.

## Run frontend server
```shell
# start server on PORT 3000
yarn start

```

Open http://localhost:3000

Different starts

```shell
# specify your own port
PORT=3223 yarn start

# or run on default web-port (admin permissions required)
sudo PORT=80 yarn start

# or run https (admin permissions required, used self-signed certificate)
sudo HTTPS=true PORT=443 yarn start
```

## Build scripts and run Server-Side-Rendering server (SSR)

### Build scripts
```shell
PUBLIC_URL=/ yarn build
```

### Run SSR server
```shell
yarn start-ssr
```

## After install
You'll need create your own site from scratch. See demo video: https://www.youtube.com/watch?v=YxoMhYPv96U&list=PLc0oMsU0oNwNF6e-Tnrn3eXhg3wQGGCvJ

## Known Issues
#### Cannot find module '../build/Release/sharp.node'
```shell
rm yarn.lock -f
npm rebuild
```

#### Crash server if used more that one sharp version
Check that installed one sharp modules
```shell
find -regex .*/node_modules/sharp$
```
Should be only one modules ./node_modules/sharp

## ToDo:
1. Write using nginx docs
2. Write server customization docs
3. Write frontend customization docs
4. Examples

## Support project
We are looking for sponsors.

Also you may support by ETH [0x4c791666351Ec3b223acF96C9d9BE431679E5C04](https://etherscan.io/address/0x4c791666351Ec3b223acF96C9d9BE431679E5C04) or paypal.com (send for [email protected])

Feel free ask any questions on https://prisma-cms.com