Skip to content

Commit 37f0362

Browse files
author
Levi Sørum
committed
Update readme
1 parent ad3a355 commit 37f0362

File tree

1 file changed

+17
-48
lines changed

1 file changed

+17
-48
lines changed

README.md

Lines changed: 17 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -1,61 +1,30 @@
1-
# 🚀 Getting started with Strapi
1+
# balve-strapi
22

3-
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.
3+
Headless CMS for [Garmeres](https://garmeres.com), built on [Strapi 5](https://strapi.io). Provides content APIs consumed by the website.
44

5-
### `develop`
5+
- **Database:** SQLite, replicated to S3 via [Litestream](https://litestream.io)
6+
- **Media uploads:** Hetzner Object Storage (S3-compatible)
7+
- **Runtime:** Node 20, deployed as a container on Kubernetes
68

7-
Start your Strapi application with autoReload enabled. [Learn more](https://docs.strapi.io/dev-docs/cli#strapi-develop)
9+
## Local development
810

9-
```
11+
```bash
12+
cp .env.example .env
13+
# Fill in S3_ACCESS_KEY_ID and S3_SECRET_ACCESS_KEY
14+
npm install
1015
npm run develop
11-
# or
12-
yarn develop
13-
```
14-
15-
### `start`
16-
17-
Start your Strapi application with autoReload disabled. [Learn more](https://docs.strapi.io/dev-docs/cli#strapi-start)
18-
19-
```
20-
npm run start
21-
# or
22-
yarn start
23-
```
24-
25-
### `build`
26-
27-
Build your admin panel. [Learn more](https://docs.strapi.io/dev-docs/cli#strapi-build)
28-
29-
```
30-
npm run build
31-
# or
32-
yarn build
33-
```
34-
35-
## ⚙️ Deployment
36-
37-
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.
38-
39-
```
40-
yarn strapi deploy
4116
```
4217

43-
## 📚 Learn more
18+
Admin panel: http://localhost:1337/admin
4419

45-
- [Resource center](https://strapi.io/resource-center) - Strapi resource center.
46-
- [Strapi documentation](https://docs.strapi.io) - Official Strapi documentation.
47-
- [Strapi tutorials](https://strapi.io/tutorials) - List of tutorials made by the core team and the community.
48-
- [Strapi blog](https://strapi.io/blog) - Official Strapi blog containing articles made by the Strapi team and the community.
49-
- [Changelog](https://strapi.io/changelog) - Find out about the Strapi product updates, new features and general improvements.
20+
## Environment variables
5021

51-
Feel free to check out the [Strapi GitHub repository](https://github.com/strapi/strapi). Your feedback and contributions are welcome!
22+
See [.env.example](.env.example). The S3 variables are required for media uploads to work.
5223

53-
## ✨ Community
24+
## Docker
5425

55-
- [Discord](https://discord.strapi.io) - Come chat with the Strapi community including the core team.
56-
- [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.
57-
- [Awesome Strapi](https://github.com/strapi/awesome-strapi) - A curated list of awesome things related to Strapi.
26+
The image is automatically built and pushed to `ghcr.io/garmeres/balve-strapi:latest` on every push to `main`.
5827

59-
---
28+
## Deployment
6029

61-
<sub>🤫 Psst! [Strapi is hiring](https://strapi.io/careers).</sub>
30+
Deployed to Kubernetes via Helm chart in [balve-k8s](https://github.com/garmeres/balve-k8s). ArgoCD handles continuous delivery.

0 commit comments

Comments
 (0)