Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/quang-pham-dev/rich-challenge
rich-challange built with NestJS - GraphQL - Postgres
https://github.com/quang-pham-dev/rich-challenge
authentication authorization graphql graphql-playground nestjs
Last synced: 15 days ago
JSON representation
rich-challange built with NestJS - GraphQL - Postgres
- Host: GitHub
- URL: https://github.com/quang-pham-dev/rich-challenge
- Owner: quang-pham-dev
- Created: 2024-09-16T04:16:42.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-09-16T06:25:44.000Z (4 months ago)
- Last Synced: 2024-10-31T11:05:37.838Z (2 months ago)
- Topics: authentication, authorization, graphql, graphql-playground, nestjs
- Language: TypeScript
- Homepage:
- Size: 304 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Rich Challenge
## Table of Contents
- [Rich Challenge](#rich-challenge)
- [Table of Contents](#table-of-contents)
- [Getting Started - Local Development](#getting-started---local-development)
- [Prerequisites](#prerequisites)
- [Clone the Repository](#clone-the-repository)
- [Available Scripts](#available-scripts)
- [`yarn start:dev`](#yarn-startdev)
- [`yarn test`](#yarn-test)
- [`yarn build`](#yarn-build)
- [GraphQL Playground](#graphql-playground)
- [Environment Variables:](#environment-variables)
## Getting Started - Local Development
### Prerequisites
Make sure you have the following installed on your system:
- Node.js 20 or later
- npm (comes with Node.js) or yarn
- Docker
### Clone the Repository
1. Open your terminal.
2. Run the following command to clone the repository:
```
git clone https://github.com/quang-pham-dev/rich-challenge.git
```
3. Navigate to the project directory:
```
cd rich-challenge
```
## Available Scripts
In the project root directory, you can run:
### `yarn start:dev`
Runs the app in development mode.
By default, it is accessible at http://localhost:8080
### `yarn test`
Runs tests.
### `yarn build`
Builds the app for production in the `dist` folder.
Your app is ready to be deployed!
## GraphQL Playground
To access the GraphQL Playground:
1. Ensure the application is running (use `yarn start:dev` for development mode).
2. Open your web browser and navigate to `http://localhost:8080/graphql`.
3. You should now see the GraphQL Playground interface where you can explore the API, write queries, and test mutations.
Note: Make sure the `GRAPHQL_PLAYGROUND` environment variable is set to `true` to enable the playground in your environment.
## Environment Variables:
| Environment | Description | Value |
| ---------------------- | ---------------------------------------- | ------------------------------------------------------- |
| PORT | The port that the server is listening to | 8080 |
| DATABASE_URL | Database connection URL | postgresql://user:password@localhost:5432/your_database |
| JWT_ACCESS_SECRET | JWT access token secret | your_access_secret |
| JWT_ACCESS_EXPIRATION | JWT access token expiration | 15m |
| JWT_REFRESH_SECRET | JWT refresh token secret | your_refresh_secret |
| JWT_REFRESH_EXPIRATION | JWT refresh token expiration | 7d |
| GRAPHQL_PLAYGROUND | Enable GraphQL playground | true |
| GRAPHQL_INTROSPECTION | Enable GraphQL introspection | true |