https://github.com/truesparrowsystems/sirji-nodejs-demo
Node.js Express Demo Repository for Sirji
https://github.com/truesparrowsystems/sirji-nodejs-demo
Last synced: 7 months ago
JSON representation
Node.js Express Demo Repository for Sirji
- Host: GitHub
- URL: https://github.com/truesparrowsystems/sirji-nodejs-demo
- Owner: TrueSparrowSystems
- License: mit
- Created: 2024-06-05T06:45:38.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2024-10-19T13:56:43.000Z (over 1 year ago)
- Last Synced: 2025-01-02T08:19:35.023Z (over 1 year ago)
- Language: JavaScript
- Size: 220 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Todo App Backend API
This is a simple backend API for a Todo application built with Express.js. It includes basic CRUD operations for managing todos with in-memory persistence.
Purpose of this repo is to give Demos for Sirji.
## Getting Started
### Prerequisites
Ensure you have Node.js and npm installed on your system. You can download them from [here](https://nodejs.org/).
### Cloning the Repository
To clone the repository, run the following command:
```bash
git clone git@github.com:TrueSparrowSystems/sirji-nodejs-demo.git
cd sirji-nodejs-demo
```
### Installing Dependencies
Navigate to the project directory and install the required dependencies:
```bash
npm install
```
### Running the Server
To start the server, use the following command:
```bash
npm start
```
The server will start running on http://localhost:3000.
## API Documentation
The API documentation is available in the OpenAPI format. You can view the OpenAPI specification in the [`docs/openapi.yaml`](./docs/openapi.yaml) file.
## Mermaid Sequence Diagrams
- [Get All Todos](docs/sequenceDiagrams/getAllTodos.mermaid)
- [Get Todo by ID](docs/sequenceDiagrams/getTodoById.mermaid)
- [Create Todo](docs/sequenceDiagrams/createTodo.mermaid)
- [Update Todo](docs/sequenceDiagrams/updateTodo.mermaid)
- [Delete Todo](docs/sequenceDiagrams/deleteTodo.mermaid)
## Postman Collection
The Postman Collection is available [here](./docs/postman_collection.json)