https://github.com/rohit1kumar/rohit-kumar-answersai-backend

AnswersAi Task
https://github.com/rohit1kumar/rohit-kumar-answersai-backend

Last synced: over 1 year ago
JSON representation

AnswersAi Task

• Host: GitHub
• URL: https://github.com/rohit1kumar/rohit-kumar-answersai-backend
• Owner: rohit1kumar
• Created: 2024-11-06T15:08:15.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-11-08T05:47:45.000Z (over 1 year ago)
• Last Synced: 2025-01-22T10:23:14.242Z (over 1 year ago)
• Language: JavaScript
• Homepage:
• Size: 151 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# AnswersAi

### Tech Stack

- Node.js

- Express.js

- Postgres

- Sequelize ORM

- Docker

### How to setup and run the project

1. Clone the repo & update the `.env` file

   ```bash

   git clone https://github.com/rohit1kumar/Rohit-Kumar-AnswersAi-Backend.git

   cd Rohit-Kumar-AnswersAi-Backend

   cp .env.example .env

   ```

2. (Optional) Use Docker:

   ```bash

   docker-compose up --build

   ```

3. (if not using Docker) Install dependencies & run:

   ```bash

   npm install

   npm run dev

   ```

4. The server should be running on `http://localhost:8000`

5. Test health check:

   ```bash

   curl http://localhost:8000/healthz

   ```

### API Documentation

Import the Postman Collection from [docs](./docs/postman_collection.json)

### Database Schema

![Database Schema](./docs/erd_diagram.jpg)

### Infra Diagram

![Infra Diagram](./docs/infra.jpg)

*note: Generated by Claude*