Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nish1013/news-microservice
https://github.com/nish1013/news-microservice
Last synced: 29 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/nish1013/news-microservice
- Owner: nish1013
- Created: 2023-07-19T14:21:39.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-07-19T15:08:38.000Z (over 1 year ago)
- Last Synced: 2023-07-19T16:24:08.000Z (over 1 year ago)
- Language: TypeScript
- Size: 13.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# news-microservice
# News Management Node.js App using TypeScript and Dependency Injection
This is a simple News Management Node.js application developed using TypeScript and tsyringe. The app demonstrates the use of dependency injection with tsyringe to manage dependencies and provide a NewsService to handle news-related operations.
## Libs
1. [tsyringe](https://github.com/microsoft/tsyringe)
2. [reflect-metadata](https://github.com/rbuckton/reflect-metadata)
## Database
- [MongoDB](https://mongodb.com)
For Dev we use a MongoDB Free tier cluster
https://cloud.mongodb.com/
## Getting Started
To run the application locally, follow the steps below:
### Prerequisites
- Node.js and npm should be installed on your machine.
- Define following ENVIRONMENT variables.
- ```DB_CONN_STRING```
- ```DB_NAME```
- ```COLLECTION_NAME```
### Installation
1. Clone this repository to your local machine.
2. Install the required dependencies using npm:
```bash
npm install
```
### Running the App
1. Build the TypeScript code using:
```bash
npm run build
```
2. Start the application:
```bash
npm start
```
The app should now be running locally at http://localhost:3000.
## Usage
The application provides simple APIs for managing news articles. The news data is loaded from a sample JSON file stored in the `data` folder.
### Endpoints
- `GET /news`: Get all news articles.
- `GET /news/:id`: Get a specific news article by ID.
- `POST /news`: Create a new news article. (Note: TODO)
- `PUT /news/:id`: Update a news article by ID. (Note: TODO)
- `DELETE /news/:id`: Delete a news article by ID. (Note: TODO)
## References
1. [Mongodb with Typescript](https://www.mongodb.com/compatibility/using-typescript-with-mongodb-tutorial)
## Contributing
Contributions are welcome! Feel free to submit issues, suggest improvements, or open pull requests.
## License
This project is licensed under the [MIT License](LICENSE).