Updated README.

Author: moonstar-x

.env.example

@@ -4,4 +4,7 @@ APP_KEYS="toBeModified1,toBeModified2"
 API_TOKEN_SALT=tobemodified
 ADMIN_JWT_SECRET=tobemodified
 TRANSFER_TOKEN_SALT=tobemodified
+
+DATABASE_CLIENT=sqlite
+DATABASE_FILENAME=.tmp/data.db
 JWT_SECRET=tobemodified

README.md

@@ -1,61 +1,71 @@
-# 🚀 Getting started with Strapi
+# Web - CMS
 
-Strapi comes with a full featured [Command Line Interface](https://docs.strapi.io/dev-docs/cli) (CLI) which lets you scaffold and manage your project in seconds.
+This repository contains the code for the CMS or Content Management System to serve manageable content to be rendered by the [web-frontend](https://github.com/starpep-web/web-frontend).
 
-### `develop`
+## Requirements
 
-Start your Strapi application with autoReload enabled. [Learn more](https://docs.strapi.io/dev-docs/cli#strapi-develop)
+In order to develop for this repository you need:
 
-```
-npm run develop
-# or
-yarn develop
-```
+* [Node.js v20.18.0](https://nodejs.org/en) (but any `v20` should work fine)
+* [Docker](https://www.docker.com/products/docker-desktop/)
 
-### `start`
+## Development
 
-Start your Strapi application with autoReload disabled. [Learn more](https://docs.strapi.io/dev-docs/cli#strapi-start)
+First, clone this repository:
 
+```bash
+git clone https://github.com/starpep-web/web-cms
 ```
-npm run start
-# or
-yarn start
+
+Install the dependencies:
+
+```bash
+npm install
 ```
 
-### `build`
+Create an `.env` file with the following contents:
 
-Build your admin panel. [Learn more](https://docs.strapi.io/dev-docs/cli#strapi-build)
+```text
+HOST=0.0.0.0
+PORT=1337
+APP_KEYS="toBeModified1,toBeModified2"
+API_TOKEN_SALT=tobemodified
+ADMIN_JWT_SECRET=tobemodified
+TRANSFER_TOKEN_SALT=tobemodified
 
+DATABASE_CLIENT=sqlite
+DATABASE_FILENAME=.tmp/data.db
+JWT_SECRET=tobemodified
 ```
-npm run build
-# or
-yarn build
+
+Run the `develop` script:
+
+```bash
+npm run develop
 ```
 
-## ⚙️ Deployment
+And done, the service should be reachable at `http://localhost:1337/admin`.
 
-Strapi gives you many possible deployment options for your project including [Strapi Cloud](https://cloud.strapi.io). Browse the [deployment section of the documentation](https://docs.strapi.io/dev-docs/deployment) to find the best solution for your use case.
+### First Time Setup
 
-```
-yarn strapi deploy
-```
+The first time you start the Strapi development server you will be prompted to create an account. Once you have one set up, you should head over to `Settings` > `API Tokens` and create a new `Read-only` token with no expiration. This token should be used to connect Strapi to [web-frontend](https://github.com/starpep-web/web-frontend). For more information, check out the instructions for that repo to understand where to use the generated API key. 
 
-## 📚 Learn more
+## Building
 
-- [Resource center](https://strapi.io/resource-center) - Strapi resource center.
-- [Strapi documentation](https://docs.strapi.io) - Official Strapi documentation.
-- [Strapi tutorials](https://strapi.io/tutorials) - List of tutorials made by the core team and the community.
-- [Strapi blog](https://strapi.io/blog) - Official Strapi blog containing articles made by the Strapi team and the community.
-- [Changelog](https://strapi.io/changelog) - Find out about the Strapi product updates, new features and general improvements.
+If you're developing this on your local machine, consider building the Docker image with the following command:
 
-Feel free to check out the [Strapi GitHub repository](https://github.com/strapi/strapi). Your feedback and contributions are welcome!
+```bash
+docker build -t local-starpep/web-cms:latest .
+```
+
+You can create a new container to try it out with the following command:
 
-## ✨ Community
+```bash
+docker run -it --rm -p 1337:1337 local-starpep/web-cms:latest
+```
 
-- [Discord](https://discord.strapi.io) - Come chat with the Strapi community including the core team.
-- [Forum](https://forum.strapi.io/) - Place to discuss, ask questions and find answers, show your Strapi project and get feedback or just talk with other Community members.
-- [Awesome Strapi](https://github.com/strapi/awesome-strapi) - A curated list of awesome things related to Strapi.
+And done, the service should be reachable at `http://localhost:1337/admin`.
 
----
+## Production
 
-<sub>🤫 Psst! [Strapi is hiring](https://strapi.io/careers).</sub>
+Consider checking this [docker-compose.yml](https://github.com/starpep-web/env-production/blob/main/docker-compose.yml) for an example on how to run this image in production.