Skip to content

Commit e543ce8

Browse files
authored
Revise README for rocketdeploy.dev company website
Updated README.md to reflect the new company website for rocketdeploy.dev, including project structure, tech stack, commands, and licensing information.
1 parent f70fd98 commit e543ce8

File tree

1 file changed

+90
-25
lines changed

1 file changed

+90
-25
lines changed

README.md

Lines changed: 90 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,108 @@
1-
# Astro Starter Kit: Minimal
1+
# rocketdeploy.dev — company website
22

3-
```sh
4-
npm create astro@latest -- --template minimal
5-
```
3+
This repository contains the source code of the **rocketdeploy** company website
4+
https://rocketdeploy.dev
5+
6+
The site is built with **Astro** and serves as:
7+
- a public presentation of how we work,
8+
- a collection of case studies and architecture write-ups,
9+
- a lightweight, fast, and production-oriented website.
10+
11+
---
12+
13+
## Why this repository is public
14+
15+
This repository is intentionally **public**.
16+
17+
We believe that:
18+
- the way a system is built matters,
19+
- clarity, structure, and delivery mindset are part of the product,
20+
- showing *how* we build is as important as *what* we build.
621

7-
> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
22+
Making the website source public allows others to:
23+
- see how the site is structured,
24+
- understand how we approach content, routing, and performance,
25+
- verify that what we describe in case studies reflects real work.
826

9-
## 🚀 Project Structure
27+
This repository is **not** intended as a reusable website template or a starter kit.
28+
It reflects our internal decisions and trade-offs.
1029

11-
Inside of your Astro project, you'll see the following folders and files:
30+
---
31+
32+
## Tech stack
33+
34+
- **Astro** — static site generation
35+
- **MD / MDX** — content and case studies
36+
- **GitHub Pages** — hosting
37+
- Minimal JavaScript, performance-first approach
38+
39+
The site is designed to be:
40+
- fast,
41+
- readable,
42+
- easy to maintain,
43+
- focused on content rather than framework complexity.
44+
45+
---
46+
47+
## Project structure (simplified)
1248

1349
```text
1450
/
15-
├── public/
51+
├── public/ # static assets
1652
├── src/
17-
│ └── pages/
18-
│ └── index.astro
53+
│ ├── components/ # reusable UI components
54+
│ ├── content/ # case studies, content collections (MD/MDX)
55+
│ ├── layouts/ # page layouts
56+
│ ├── pages/ # routes
57+
│ └── styles/ # global styles
58+
├── astro.config.mjs
1959
└── package.json
2060
```
2161

22-
Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name.
62+
Astro exposes routes based on files in `src/pages`.
63+
Long-form content (case studies, articles) lives in content collections.
64+
65+
---
2366

24-
There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components.
67+
## Content & case studies
2568

26-
Any static assets, like images, can be placed in the `public/` directory.
69+
Case studies published on the website are:
70+
- based on real production systems,
71+
- anonymized where necessary,
72+
- focused on architecture, delivery, and decision-making,
73+
- sometimes linked to deeper architecture showcases on GitHub.
74+
75+
Example:
76+
- https://rocketdeploy.dev/en/case-studies/ops-layer-for-woocommerce
77+
78+
---
79+
80+
## Development
81+
82+
```sh
83+
npm install
84+
npm run dev
85+
```
86+
87+
Build:
88+
```sh
89+
npm run build
90+
```
91+
92+
Preview:
93+
```sh
94+
npm run preview
95+
```
2796

28-
## 🧞 Commands
97+
---
2998

30-
All commands are run from the root of the project, from a terminal:
99+
## License
31100

32-
| Command | Action |
33-
| :------------------------ | :----------------------------------------------- |
34-
| `npm install` | Installs dependencies |
35-
| `npm run dev` | Starts local dev server at `localhost:4321` |
36-
| `npm run build` | Build your production site to `./dist/` |
37-
| `npm run preview` | Preview your build locally, before deploying |
38-
| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
39-
| `npm run astro -- --help` | Get help using the Astro CLI |
101+
This repository is public for transparency and reference purposes.
40102

41-
## 👀 Want to learn more?
103+
Unless stated otherwise:
104+
- content and branding are **not** licensed for reuse,
105+
- code is provided as-is, without guarantees.
42106

43-
Feel free to check [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat).
107+
If you are interested in collaboration or similar work:
108+
👉 https://rocketdeploy.dev/en/contact

0 commit comments

Comments
 (0)