https://github.com/maddyguthridge/minifolio
Showcase your best work
https://github.com/maddyguthridge/minifolio
cms content-management-system portfolio
Last synced: 2 months ago
JSON representation
Showcase your best work
- Host: GitHub
- URL: https://github.com/maddyguthridge/minifolio
- Owner: MaddyGuthridge
- License: gpl-3.0
- Created: 2024-05-17T12:37:52.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2026-04-16T10:04:33.000Z (3 months ago)
- Last Synced: 2026-04-16T12:12:43.805Z (3 months ago)
- Topics: cms, content-management-system, portfolio
- Language: TypeScript
- Homepage: https://minifolio.maddyguthridge.com
- Size: 6.02 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 30
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# Minifolio - showcase your best work
Minifolio is a portfolio content management system designed with flexibility and simplicity in mind.
Learn more about it, by checking out [the documentation](https://minifolio.maddyguthridge.com),
which is hosted using Minifolio itself.
## Developing
Running Minifolio requires a `.env` file, which you can create by running
`cp .env.example .env`. Make sure to edit your `.env` file to set its variables
as required.
Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:
```bash
npm run dev
# or start the server and open the app in a new browser tab
npm run dev -- --open
```
### Testing
* Tests can be run with `npm t`. The dev server will be automatically started
and stopped.
* Type checking can be run with `npm run check`.
* Linting can be run with `npm run lint`. Automatic fixes can be applied using
`npm run lint:fix`.
### Building
To create a production version of the app:
```bash
npm run build
```
To run the production server:
```bash
npm run production
```
Or you can just use Docker: see instructions for the various docker configs in
the `docker/` directory.