https://github.com/selfhostedpro/medicat-website
https://github.com/selfhostedpro/medicat-website
Last synced: 10 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/selfhostedpro/medicat-website
- Owner: SelfhostedPro
- License: gpl-3.0
- Created: 2023-07-24T23:42:33.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-09-15T04:06:55.000Z (almost 3 years ago)
- Last Synced: 2025-05-07T08:28:35.170Z (over 1 year ago)
- Language: Astro
- Size: 8.87 MB
- Stars: 3
- Watchers: 3
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Medicat Website
### 1. Clone the repo
```bash
git clone https://github.com/SelfhostedPro/medicat-website.git
```
### 2. Install Dependencies
```bash
pnpm install
```
### 3. Build Site
```bash
pnpm build
```
### 4. Move to folder (apache2 is /var/www/html/)
## Adding Download Sources
Download sources (under the alternative downloads section) are created from this file:
`/assets/data/altDownloads.json`
You can copy and paste an existing one and once the site redeploys it will be updated with the new download source visible.
## Documentation
You can add documentation at the following source:
`/content/docs/`
The website page for `localhost:3000/docs` is automatically generated based on these files. It will create a new topic if you create a new folder or subfolder and will automatically create links to those files.
Please copy an existing file and then modify the metadata at the top as that's the easiest way to get started.
## Project Structure
Inside of your Astro project, you'll see the following folders and files:
```
/
├── public/
│ └── ...
├── src/
│ ├── components/
│ │ └── ...
│ ├── layouts/
│ │ └── ...
│ └── pages/
│ └── ...
└── package.json
```
Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name.
Any static assets, like images, can be placed in the `public/` directory.
## TailwindCSS
TailwindCSS is already configured in this repo, so you can start using it without any installation.