https://github.com/devflowinc/trieve-website-v2
https://github.com/devflowinc/trieve-website-v2
Last synced: 6 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/devflowinc/trieve-website-v2
- Owner: devflowinc
- Created: 2025-02-13T19:45:07.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2025-05-06T12:51:23.000Z (7 months ago)
- Last Synced: 2025-06-22T05:17:06.781Z (6 months ago)
- Language: Roff
- Size: 13.3 MB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Trieve Website
This is the source code for the Trieve website. It is built using [Astro](https://astro.build/), [Tailwind CSS](https://tailwindcss.com/), [TypeScript](https://www.typescriptlang.org/) and [Keystatic CMS](https://keystatics.com/).
## 🚀 Project Structure
Inside of the project, you'll see the following folders and files:
```text
/
├── public/ - Static files
├── src/
│ ├── assets/ - Images, fonts, etc. (also assets uploaded through Keystatic)
│ ├── components/ - Reusable Astro components
│ ├── content/ - Markdown files for content (managed by Keystatic)
│ ├── layouts/ - Layout Astro components
│ ├── lib/ - Utility functions (e.g. fetching data)
│ │ └── keystatic/ - Keystatic API client, collection types and definitions
│ ├── pages/ - Astro pages
│ ├── styles/ - Global styles
│ └── content.config.ts - Configuration for Astro content components
├── astro.config.mjs - Astro configuration
├── keystatic.config.ts - Keystatic configuration
└── package.json
```
To learn more about the folder structure of an Astro project, refer to [our guide on project structure](https://docs.astro.build/en/basics/project-structure/).
## 🧞 Commands
All commands are run from the root of the project, from a terminal:
| Command | Action |
| :------------------------ | :----------------------------------------------- |
| `npm install` | Installs dependencies |
| `npm run dev` | Starts local dev server at `localhost:4321` |
| `npm run build` | Build your production site to `./dist/` |
| `npm run preview` | Preview your build locally, before deploying |
| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
| `npm run astro -- --help` | Get help using the Astro CLI |
## 📦 Keystatic
This project uses Keystatic as a headless CMS. You can manage website content in the Keystatic dashboard and preview changes in real-time.
When you run `npm run dev`, the Astro dev server will automatically launch a Keystatic server.
Visit `http://localhost:4321/keystatic` to access the Keystatic dashboard.
To learn more about Keystatic, refer to the [Keystatic documentation](https://keystatic.com/docs/introduction/).
## 👀 Want to learn more?
Feel free to check [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat).