https://github.com/gitegob/classifieds-api
Classifieds API for sellers and customers in NestJS
https://github.com/gitegob/classifieds-api
Last synced: 2 months ago
JSON representation
Classifieds API for sellers and customers in NestJS
- Host: GitHub
- URL: https://github.com/gitegob/classifieds-api
- Owner: gitegob
- Created: 2023-02-25T15:28:39.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-02-26T10:15:34.000Z (about 2 years ago)
- Last Synced: 2025-01-24T20:19:51.871Z (4 months ago)
- Language: TypeScript
- Homepage:
- Size: 383 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Classifieds API
## Description
An API where sellers can add products to be viewed by other customers.
## Features
- A seller must authenticate first
- A seller wants to create a new products
- Product model should include the name, price, short description, image/logo, and the manufacturing date
- A seller must select a category (Must be predefined as well)
- Customer wants to be able to view a list of all products image, name, price and manufacturing date.
- The list should show only the first 10 items
- The list should be sorted alphabetically.
- The customer should be able to select a product and view details.
## Installation
```bash
$ yarn install
```
## Running the app
### Prerequisites
- Create a `.env` file and add the contents of the `.env.sample` file replacing the value of `POSTGRES_HOST` to `localhost`
- Make sure that you have a database running named `classifieds`, if not create it.
```bash
# development
$ yarn start
# watch mode
$ yarn start:dev
# production mode
$ yarn start:prod
```
## Running in docker
### Prerequisites
- Create a `.env` file and add the contents of the `.env.sample` file.
```bash
$ docker build -t classifieds-api .
$ docker-compose up
```
## Stay in touch
- Author - [Brian Gitego](mailto:[email protected])