https://github.com/tomtapia/product-ms-demo
Product microservices demo.
https://github.com/tomtapia/product-ms-demo
Last synced: 10 months ago
JSON representation
Product microservices demo.
- Host: GitHub
- URL: https://github.com/tomtapia/product-ms-demo
- Owner: tomtapia
- License: mit
- Created: 2024-03-23T20:49:28.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-23T20:51:30.000Z (almost 2 years ago)
- Last Synced: 2025-01-29T04:20:32.923Z (11 months ago)
- Language: TypeScript
- Size: 107 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# API Test Project
The API Test project is built using NestJS. It focuses on CI/CD integration and is thoroughly documented using Swagger. This application serves as an example for efficient and scalable server-side applications.
## Table of Contents
1. [How to Install and Run the Project](#how-to-install-and-run-the-project)
2. [Credits](#credits)
3. [License](#license)
4. [Badges](#badges)
5. [How to Contribute](#how-to-contribute)
6. [Tests](#tests)
## How to Install and Run the Project
To set up the project, use the following steps:
```bash
$ npm install
```
To run the application:
```bash
# development
$ npm run start
# watch mode
$ npm run start:dev
# production mode
$ npm run start:prod
```
## Tests
```bash
# unit tests
$ npm run test
# e2e tests
$ npm run test:e2e
# test coverage
$ npm run test:cov
```
## Credits
- [@tomtapia](https://github.com/tomtapia)
## License
This project is licensed under the MIT License. The license permits use, modification, and distribution with few restrictions. The key points are:
- Free use, modification, and distribution.
- The software is provided "as is", without warranty.
- Proper attribution must be given.
For the full license text, please see the [LICENSE](LICENSE) file in this repository.
## Badges
Here are some informative badges indicating various statuses of the project:
[](https://coveralls.io/github/nestjs/nest?branch=master)
## How to Contribute
We welcome contributions from the community. If you'd like to contribute, please follow these steps:
1. Fork the repository.
2. Create a new branch (`git checkout -b new-feature`).
3. Make your changes.
4. Run tests to ensure everything is working.
5. Commit your changes (`git commit -am 'Add some feature'`).
6. Push to the branch (`git push origin new-feature`).
7. Create a new Pull Request.
Don't forget to give your PR a meaningful name and describe all applied changes and additions.
## Stay in Touch
For further inquiries or to stay up-to-date with the project:
- Connect on [LinkedIn](https://www.linkedin.com/in/ttapia/)
I appreciate your interest and contribution to the project! Let's build something awesome together!