Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pruvious/pruvious
A reliable CMS for your Nuxt app.
https://github.com/pruvious/pruvious
cms framework nuxt nuxt-module vue
Last synced: 28 days ago
JSON representation
A reliable CMS for your Nuxt app.
- Host: GitHub
- URL: https://github.com/pruvious/pruvious
- Owner: pruvious
- License: mit
- Created: 2023-05-25T15:39:12.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-11T12:27:57.000Z (about 1 month ago)
- Last Synced: 2024-10-11T15:21:26.523Z (about 1 month ago)
- Topics: cms, framework, nuxt, nuxt-module, vue
- Language: TypeScript
- Homepage: https://pruvious.com
- Size: 2.93 MB
- Stars: 454
- Watchers: 6
- Forks: 14
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://pruvious.com)
# Pruvious
**Website:** [https://pruvious.com](https://pruvious.com/)\
**Documentation:** [https://pruvious.com/docs](https://pruvious.com/docs)
## Getting started
Pruvious is a free and open-source CMS that seamlessly integrates with the [Nuxt](https://nuxt.com) framework, allowing you to utilize Nuxt as you normally would without worrying about compatibility issues.
### Installation
To start a new project, use the `pruvious init` command. This command will install Nuxt and Pruvious, and configure all the necessary settings.
```shell
# pnpm
pnpm dlx pruvious@latest init
# npm
npx pruvious@latest init
```
Replace `` with the path (relative or absolute) to an empty directory where you want to initialize the project.
### Getting started
Visit the Pruvious [documentation](https://pruvious.com/docs) for detailed information on its features and usage. Alternatively, you can explore our [tutorial](https://pruvious.com/tutorial) for a practical demonstration of building a website from scratch using Pruvious.
## Playground
Explore and experiment with Pruvious in a Nuxt test environment located in the `playground` folder. Within this environment, you can create new collections, fields, blocks, and more to test various configurations and functionalities. The `playground` is automatically loaded when you run `pnpm dev`.
## Testing
### SQLite
```shell
pnpm test
```
### PostgreSQL
```shell
pnpm test:pg
```
To perform this test, you need to connect to a local PostgreSQL database named `pruvious_test` running on the default port `5432`.
Use the username `pruvious` and password `12345678` to establish the connection.
Connection URI: `postgresql://pruvious:[email protected]:5432/pruvious_test`
#### Set up PostgreSQL database
1. Install PostgreSQL (e.g., `brew install postgresql@16` and then `brew services start postgresql@16`).
2. Run `psql -d postgres`.
3. Create the database and user
```sql
CREATE DATABASE pruvious_test;
CREATE USER pruvious WITH PASSWORD '12345678';
ALTER DATABASE pruvious_test OWNER TO pruvious;
```
### Redis
```shell
pnpm test:redis
```
The tests are performed on the Redis database `1`, using a local connection on the default port `6379`.
Connection URI: `redis://127.0.0.1:6379/1`
#### Setting up Redis
For MacOS, install Redis by running the commands `brew install redis` and `brew services start redis`.
### S3
```shell
pnpm test:s3
```
To perform this test, you need an S3-like local object storage server.
We recommend using [Minio](https://github.com/minio/minio).
On MacOS, you can install Minio by running `brew install minio/stable/minio`, and then start the server with `minio server ~/minio`.
After that, open the Minio admin dashboard at [http://127.0.0.1:9000](http://127.0.0.1:9000) and create a new public bucket called `pruvious`.
In the region settings, set the server location to `pruvious`.
Finally, create a new access key named `pruvious` with `pruvious` as its secret key.