https://github.com/saltyshiomix/nestpress
A production ready personal blogging system on top of NestJS and NEXT.js
https://github.com/saltyshiomix/nestpress
material-ui nestjs nextjs react typescript
Last synced: about 1 year ago
JSON representation
A production ready personal blogging system on top of NestJS and NEXT.js
- Host: GitHub
- URL: https://github.com/saltyshiomix/nestpress
- Owner: saltyshiomix
- License: mit
- Archived: true
- Created: 2019-09-13T03:32:38.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2020-08-20T16:24:17.000Z (almost 6 years ago)
- Last Synced: 2025-04-02T17:53:00.267Z (over 1 year ago)
- Topics: material-ui, nestjs, nextjs, react, typescript
- Language: TypeScript
- Homepage: https://npm.im/@nestpress/next
- Size: 485 KB
- Stars: 42
- Watchers: 2
- Forks: 9
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
A production ready personal blogging system on top of NestJS and NEXT.js
## Roadmaps
- [x] Cross Platform
- [x] Dark Theme
- [x] Authentication
- [ ] Blogging
- [ ] Testing
## Usage
### Database Setup
#### For Mac Users
```bash
# install postgresql
$ brew install postgresql
# if you want to start postgresql in startup, try do this
$ brew services start postgresql
# create user "nestpressuser" with password "nestpresspass"
$ createuser -P nestpressuser
# create database "nestpressdb" owened by "nestpressuser"
$ createdb nestpressdb -O nestpressuser
```
#### For Windows Users
##### PostgreSQL
- Download an installer at
- Run the installer with a flag `--install_runtimes 0` like this:
```cmd
> postgresql-11.2-1-windows-x64.exe --install_runtimes 0
```
##### pgAdmin
- Download a latest installer at
- Run the pgAdmin and login with a root user
- Right click `Login/Group Roles` and `Create > Login/Group Role`
- `General` Panel:
- `Name`: `nestpressuser`
- `Definition` Panel:
- `Password`: `nestpresspass`
- `Priviledges` Panel:
- Check all `Yes`
- Right click `Databases` and `Create > Database`
- `General` Tab:
- `Database`: `nestpressdb`
- `Owner`: `nestpressuser`
### Application Setup
```bash
# install
$ git clone https://github.com/saltyshiomix/nestpress.git
$ cd nestpress
$ yarn
# prepare `.env` and edit it for your own environments
$ cp .env.example .env
```
The `.env` file is like this:
```
DB_HOST=localhost
DB_PORT=5432
DB_USERNAME=nestpressuser
DB_PASSWORD=nestpresspass
DB_DATABASE=nestpressdb
DB_SYNCHRONIZE=true
APP_ADMIN_EMAIL=test@test.com
APP_ADMIN_PASSWORD=test
APP_PROTOCOL=http
APP_HOST=localhost
APP_PORT=4000
APP_SESSION_SECRET=nestpress
```
### Development Mode
```bash
$ yarn dev (or `npm run dev`)
```
### Production Mode
```bash
$ yarn build (or `npm run build`)
$ yarn start (or `npm start`)
```
## Packages
| package | version |
| --- | --- |
| [@nestpress/next](https://github.com/saltyshiomix/nestpress/blob/master/packages/next/README.md) |   |
| [@nestpress/postgres-express-session](https://github.com/saltyshiomix/nestpress/blob/master/packages/postgres-express-session/README.md) |   |
## Fundamental Examples
- [basic](https://github.com/saltyshiomix/nestpress/tree/master/examples/basic)
- [basic-auth](https://github.com/saltyshiomix/nestpress/tree/master/examples/basic-auth)
- [use-favicon](https://github.com/saltyshiomix/nestpress/tree/master/examples/use-favicon)
- [with-express](https://github.com/saltyshiomix/nestpress/tree/master/examples/with-express)
- [with-express-material-ui](https://github.com/saltyshiomix/nestpress/tree/master/examples/with-express-material-ui)
- [with-nodemon](https://github.com/saltyshiomix/nestpress/tree/master/examples/with-nodemon)