https://github.com/tcriss/tweets-api
A simple nestJS api to make requests from a databases
https://github.com/tcriss/tweets-api
learning-by-doing nestjs nodejs practice-project typescript
Last synced: 3 months ago
JSON representation
A simple nestJS api to make requests from a databases
- Host: GitHub
- URL: https://github.com/tcriss/tweets-api
- Owner: Tcriss
- Created: 2024-02-17T15:16:44.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-02-17T15:21:48.000Z (over 1 year ago)
- Last Synced: 2025-01-21T01:15:55.736Z (5 months ago)
- Topics: learning-by-doing, nestjs, nodejs, practice-project, typescript
- Language: TypeScript
- Homepage:
- Size: 94.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Description
This is an api to test my knowledge made with NestJS, one of the best frameworks of all nodeJS environment. I made this api following the instructions from this [beginners course](https://youtube.com/playlist?list=PLzHaXzj_WAym4WR3gBYuy1iew5T3NgL0v&si=HTJQUEmvNsGAQe-I), credits for [Marluan Espiritusanto](https://www.youtube.com/@marluanespiritusanto8458/videos)
It's a simple example of a connection with a database to make requests to a server using tweets and users as an example.
## Installation
```bash
$ npm install
```
## Building the database from docker
```bash
$ docker compose up -d
```
## Running the app
```bash
# development
$ npm run start
# watch mode
$ npm run start:dev
# production mode
$ npm run start:prod
```
## Test
```bash
# unit tests
$ npm run test
# e2e tests
$ npm run test:e2e
# test coverage
$ npm run test:cov
```
## About NestJS
[circleci-image]: https://img.shields.io/circleci/build/github/nestjs/nest/master?token=abc123def456
[circleci-url]: https://circleci.com/gh/nestjs/nest
A progressive Node.js framework for building efficient and scalable server-side applications.
[Nest](https://github.com/nestjs/nest) framework TypeScript starter repository.
Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please [read more here](https://docs.nestjs.com/support).