https://github.com/cuongndc9/node-rest-boilerplate
🌌🚀 A Node.js boilerplate with RESTful, Prisma, PostgreSQL and awesome tools.
https://github.com/cuongndc9/node-rest-boilerplate
103cuong docker graphql node-boilerplate postgresql prisma
Last synced: 8 months ago
JSON representation
🌌🚀 A Node.js boilerplate with RESTful, Prisma, PostgreSQL and awesome tools.
- Host: GitHub
- URL: https://github.com/cuongndc9/node-rest-boilerplate
- Owner: cuongndc9
- License: mit
- Created: 2019-09-28T04:27:09.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-12-27T15:29:30.000Z (over 1 year ago)
- Last Synced: 2025-06-20T14:12:18.386Z (12 months ago)
- Topics: 103cuong, docker, graphql, node-boilerplate, postgresql, prisma
- Language: JavaScript
- Homepage:
- Size: 224 KB
- Stars: 4
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# node-rest-boilerplate
[](https://hitsofcode.com/view/github/cuongndc9/node-rest-boilerplate)
[](https://github.com/cuongndc9/node-rest-boilerplate/blob/master/LICENSE)
> 🌏🚀 A Node.js boilerplate with RESTful, Prisma, PostgreSQL and awesome tools.
## Features
- Using ESNext
- Setup Babel, ESLint, Prettier, Ava and Husky.
- Having Basic authentication and authorization.
- Setup a basic RESTful API.
- Using Prisma and PostgreSQL.
## Prepare
- [Node](https://nodejs.org/en/)
- [Yarn](https://yarnpkg.com/en/)
- [Docker](https://phoenixnap.com/kb/how-to-install-docker-on-ubuntu-18-04)
- [Docker Compose](https://docs.docker.com/compose/install/)
## How to use?
### Step 1: Clone this project and remove `.git` folder
```sh
$ git clone https://github.com/cuongndc9/node-rest-boilerplate.git
$ cd node-rest-boilerplate && rm -rf .git
```
### Step 2: Create .env file
Please follow .env.example file.
### Step 3: Launch Prisma and the connected database
```sh
$ sudo docker-compose up -d
```
### Step 4: Deploy the Prisma datamodel and generate Prisma client
```sh
$ yarn prisma:deploy
```
### Step 5: Install dependencies and run the project
```sh
$ yarn
$ yarn start:dev
```
🙌 Awesome
## License
MIT © [cuongndc9](https://github.com/cuongndc9)