tweteroo-nestjs-API

Tweteroo NestJS API

The Tweteroo NestJS API is a simple social media API that allows users to create accounts, post tweets, and view other users’ tweets. This project was developed with the aim of creating a scalable and robust web application using the NestJS framework.

ℹ️ About

Tweteroo was developed with the following main features:

User registration and account creation.
Posting tweets.
View tweets from other users.
Pagination support to view more tweets.

Motivation: The idea behind Tweteroo was to create a simple social media API that could be used as a foundation for more complex projects. The focus was to understand and implement NestJS principles to create a scalable back-end application.

Next steps:

Implement user authentication.
Add support for likes and retweets.
Develop a friendly user interface.

🛠️ Technologies Used

⚙️ How to Run

Follow these steps to download and configure the project locally:

Clone the GitHub repository: git clone https://github.com/natividadesusana/tweteroo-nestjs-API.git
Access the project directory: cd tweteroo-nestjs-api
Install dependencies: npm install
Configure the MongoDB database in the src/config/database.config.ts file.
Start the server: npm run start

The API will be available at http://localhost:3000. Be sure to follow the MongoDB configuration instructions and set the appropriate environment variables if necessary.

🖇 Contributing

Feel free to contribute to the development of this project. Just follow the steps below:

Create a fork of this repository.
Create a branch for your new feature: git checkout -b my-new-feature.
Make the necessary changes and commit them: git commit -m ‘I added a new feature’.
Push changes to your fork: git push origin my-new-feature.
Create a pull request on this repository.

Happy coding! 🚀

A progressive Node.js framework for building efficient and scalable server-side applications.

<p align="center"> <a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/v/@nestjs/core.svg" alt="NPM Version" /></a> <a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/l/@nestjs/core.svg" alt="Package License" /></a> <a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/dm/@nestjs/common.svg" alt="NPM Downloads" /></a> <a href="https://circleci.com/gh/nestjs/nest" target="_blank"><img src="https://img.shields.io/circleci/build/github/nestjs/nest/master" alt="CircleCI" /></a> <a href="https://coveralls.io/github/nestjs/nest?branch=master" target="_blank"><img src="https://coveralls.io/repos/github/nestjs/nest/badge.svg?branch=master#9" alt="Coverage" /></a> <a href="https://discord.gg/G7Qnnhy" target="_blank"><img src="https://img.shields.io/badge/discord-online-brightgreen.svg" alt="Discord"/></a> <a href="https://opencollective.com/nest#backer" target="_blank"><img src="https://opencollective.com/nest/backers/badge.svg" alt="Backers on Open Collective" /></a> <a href="https://opencollective.com/nest#sponsor" target="_blank"><img src="https://opencollective.com/nest/sponsors/badge.svg" alt="Sponsors on Open Collective" /></a>   <a href="https://paypal.me/kamilmysliwiec" target="_blank"><img src="https://img.shields.io/badge/Donate-PayPal-ff3f59.svg"/></a>
<a href="https://opencollective.com/nest#sponsor"  target="_blank"><img src="https://img.shields.io/badge/Support%20us-Open%20Collective-41B883.svg" alt="Support us"></a>   <a href="https://twitter.com/nestframework" target="_blank"><img src="https://img.shields.io/twitter/follow/nestframework.svg?style=social&label=Follow"></a>

</p>

Description

Nest framework TypeScript starter repository.

Installation

$ npm install

Running the app

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

Test

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov

Support

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.

License

Nest is MIT licensed.