CIPPIC CMS documentation

This is the developer documentation for the back end of CIPPIC's website.

For more information and support please contact [email protected].

Architecture and hosting

We're using Strapi for our headless CMS, and it's self-hosted on Digital Ocean.

Plugins

The only external plugin we're using is strapi-plugin-fuzzy-search to generate our search results. It's configured at config/plugins.js.

Content-Type Builder

To configure the content structure, you use Strapi's Content-Type Buider. The Content-Type Builder can only be edited in development mode, so you will need to set up a local development environment.

The changes you make in the Content-Type Builder will generate the necessary files and migrations. You can also make content-type changes directly in the code, but it's generally easier and safer to do most changes through the UI. You will only need to touch the code if you're adding in a custom hook or controller, or configuring a plugin.

Local development

Prerequisites:

• Node 18
• npm or yarn
• postgres
• empty postgres database with an admin user

1. Clone the repo

git clone [email protected]:nomadic-labs/cippic-api.git

2. Install the dependencies

cd cippic-api && yarn

3. Create a root .env file and populate the following variables.

HOST=
PORT=
APP_KEYS=
API_TOKEN_SALT=
ADMIN_JWT_SECRET=
TRANSFER_TOKEN_SALT=
# Database
DATABASE_CLIENT=
DATABASE_HOST=
DATABASE_PORT=
DATABASE_NAME=
DATABASE_USERNAME=
DATABASE_PASSWORD=
DATABASE_SSL=false
JWT_SECRET=

4. Start the local server

yarn dev

5. (If making style changes) Start sass --watch

yarn sass

Refer to the Strapi docs for more information.

---

🚀 Getting started with Strapi

Strapi comes with a full featured Command Line Interface (CLI) which lets you scaffold and manage your project in seconds.

develop

Start your Strapi application with autoReload enabled. Learn more

npm run develop
# or
yarn develop

start

Start your Strapi application with autoReload disabled. Learn more

npm run start
# or
yarn start

build

Build your admin panel. Learn more

npm run build
# or
yarn build

📚 Learn more

• Resource center - Strapi resource center.
• Strapi documentation - Official Strapi documentation.
• Strapi tutorials - List of tutorials made by the core team and the community.
• Strapi blog - Official Strapi blog containing articles made by the Strapi team and the community.
• Changelog - Find out about the Strapi product updates, new features and general improvements.

Feel free to check out the Strapi GitHub repository. Your feedback and contributions are welcome!

✨ Community

• Discord - Come chat with the Strapi community including the core team.
• Forum - Place to discuss, ask questions and find answers, show your Strapi project and get feedback or just talk with other Community members.
• Awesome Strapi - A curated list of awesome things related to Strapi.