https://github.com/juancarlosjr97/next-typescript-prisma-postgresql
Next TypeScript Prisma PostgreSQL
https://github.com/juancarlosjr97/next-typescript-prisma-postgresql
Last synced: 2 months ago
JSON representation
Next TypeScript Prisma PostgreSQL
- Host: GitHub
- URL: https://github.com/juancarlosjr97/next-typescript-prisma-postgresql
- Owner: juancarlosjr97
- License: mit
- Created: 2023-02-12T21:50:26.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-02-12T22:14:03.000Z (over 2 years ago)
- Last Synced: 2025-01-28T22:37:42.460Z (4 months ago)
- Language: TypeScript
- Size: 234 KB
- Stars: 1
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Next TypeScript Prisma PostgreSQL Project
[](https://github.com/juancarlosjr97/next-typescript-prisma-postgresql/actions/workflows/development.yml)
This project is to demonstrate how to setup a project using [Next.js](https://nextjs.org/learn/foundations/about-nextjs) with TypeScript as a web application with Prisma as the ORM using PostgreSQL v15 as the data source as a Full Stack Web App.
## Prerequisites
The following services are require for development:
- [GIT](https://git-scm.com/)
- [nvm](https://github.com/nvm-sh/nvm)
- [Docker](https://docs.docker.com/get-docker/)
## Project Setup
### Dependencies
1. Fork the project and clone your GitHub project
```bash
git clone https://github.com/${USER_NAME}/quick-id-verification
```
2. Install node and npm version of the project
```bash
nvm use
npm install -g npm@${NPM_VERSION}
```
3. Install project dependencies
```bash
npm ci
```
4. Copy `.env`
```bash
cp .env-local .env
```
### Start Database
1. Start the database using Docker
```bash
npm run docker
```
2. Import migration to Database
```bash
npm run prisma:deploy
```
The command will import the migrations created to the database.
### Start the Next app
1. Start the Next app
```bash
npm run dev
```
The app will be running on the port `3000` and accessible in `http://localhost:3000`
## Test
To run tests is required to have the web app running.
1. Run unit and E2E tests
```bash
npm run test
```
2. Run coverage check
```bash
npm run test:coverage:check
```
## Development with Codespaces
The app has a predefined Codespaces configuration available at `.devcontainer/devcontainer.json` as this web app has been developed using Codespaces.
Follow this [guide](https://docs.github.com/en/codespaces/getting-started/quickstart) on how to get started with Codespaces.
## Acknowledgment
The project has been inspired on a [Prisma example](https://github.com/prisma/prisma-examples/tree/latest/typescript/rest-nextjs-api-routes).
## License
This project is licensed under the MIT License. See the [LICENSE](./LICENSE) file.