Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mhp24/ferremax-api
https://github.com/mhp24/ferremax-api
Last synced: 18 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/mhp24/ferremax-api
- Owner: MHP24
- Created: 2024-05-16T16:29:47.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-05-22T20:52:16.000Z (9 months ago)
- Last Synced: 2024-05-22T23:29:15.181Z (9 months ago)
- Language: TypeScript
- Size: 199 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Ferremax API
## Table of contents
- [About this project](#about-this-project)
- [Setup and installation](#setup-and-installation)
- [Production demo](#production-demo)
- [Quick stage demo](#quick-stage-demo)
- [API Spec & Documentation](#api-spec-documentation)
- [Testing](#testing)
## About this project 📕
This is a project based in a [template](https://github.com/MHP24/nestjs-template) created by [MHP24](https://github.com/MHP24) that includes a development setup and environment multi OS support ready-to-use outside the box, and has the config ready for:
- ESLint
- Prettier integration
- Docker hot reload feature (Windows supported)
- Husky integration
- Commit lint (Conventional commits standard)
- Joi .env validation schema
Before using this template, ensure you have [Node.js](https://nodejs.org/en) installed (version 20.12.0 for this template) and [Docker (optional)](https://www.docker.com/) installed and running.
### Steps
1 . Install dependencies using [yarn __(required)__](https://yarnpkg.com/) as package manager:
```bash
yarn
```
2 . Replace __.env.template__ file variables and rename it as __.env__ file
#### __Environment variables specification__
|__Variable__|__Type__|__Description__|
|---|---|---|
PORT | Integer (positive) | Port where app runs |
DB_URL | String | URL connection string for the PostgreSQL database __used by PrismaORM__ |
JWT_SECRET | String | Secret key for signing JWTs |
JWT_REFRESH_SECRET | String | Secret key for signing refresh JWTs |
JWT_EXPIRE_TEXT | String | Expiration time for JWTs in a readable format (e.g. "12h") |
JWT_REFRESH_EXPIRE_TEXT | String | Expiration time for refresh JWTs in a readable format (e.g. "1d")
JWT_EXPIRE_SECONDS | Integer (positive) | Expiration time for JWTs in seconds |
DB_NAME | String | Name of the PostgreSQL database (can be provided for docker container) |
DB_HOST | String | Host address of the PostgreSQL database (can be provided for docker container) |
DB_PORT | Integer (positive) | Port on which the PostgreSQL database (can be provided for docker container) |
DB_USER | String | Username for the PostgreSQL database (can be provided for docker container) |
DB_PASSWORD | String | Password for the PostgreSQL database (can be provided for docker container) |
STATIC_FILE_PATH | String | Path for static files directory (Outside src) |
3 . __Database setup__ using PrismaORM (needs PostgreSQL database available, feel free to use docker-compose.dev.yml)
```bash
yarn prisma:init
```
4 . __Start development mode:__ Start the development server:
```bash
yarn start:dev
```
5 . __Populate database using seed endpoint__
```bash
POST to: http://127.0.0.1:PORT/api/v1/seed
```
## Production demo 📟
Demo available at: https://ferremax-api.mg-hp.com/api/v1/docs
To start a quick demo you must to have [Docker](https://www.docker.com/) installed and running.
### Steps
1 . __Configure .env file__: Follow instructions from [Setup and installation](#setup-and-installation) -> Step 2
2 . __Start Docker stage compose file__
```bash
docker compose -f docker-compose.stage-local.yml up
```
If your app is running correctly you will find the specification at: http://127.0.0.1:PORT/api/v1/docs
## Testing 🧪
You have 2 options for testing environment:
1 . __Docker__:
To start the testing environment with Docker, use the following command:
```bash
docker compose -f docker-compose.testing.yml up --build
```
2 . __Node (Jest)__:
To run tests with Jest in a Node environment, use the following command:
```bash
yarn test
```