Skip to content

MaddyGuthridge/Minifolio

Repository files navigation

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, 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:

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:

npm run build

To run the production server:

npm run production

Or you can just use Docker: see instructions for the various docker configs in the docker/ directory.

About

Showcase your best work

Topics

Resources

License

Security policy

Stars

Watchers

Forks

Contributors 2

  •  
  •