https://github.com/fu-ry17/agencify-assessment
https://github.com/fu-ry17/agencify-assessment
docker docker-compose expressjs nodejs reactjs typescript
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/fu-ry17/agencify-assessment
- Owner: fu-ry17
- Created: 2023-12-02T13:13:43.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-12-03T13:59:39.000Z (over 2 years ago)
- Last Synced: 2025-01-16T07:30:22.975Z (over 1 year ago)
- Topics: docker, docker-compose, expressjs, nodejs, reactjs, typescript
- Language: TypeScript
- Homepage:
- Size: 128 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: ReadMe.Md
Awesome Lists containing this project
README
# Assessment
## Tech Stack
### Frontend
- **React.js**
### Backend
- **Node.js**
- **Express**
### Database
- **SQLite**
### Source Code
[GitHub Repository](https://github.com/fu-ry17/agencify-assessment)
## Installation (Both Server & Frontend)
1 . To set up the server and frontend, follow the steps below:
1. **Navigate to the frontend/backend directory:**
```bash
cd frontend/backend
```
2. **Install dependencies:**
```bash
pnpm install
```
3. **Start the server (both backend and frontend):**
```bash
pnpm dev
```
2 . Using Docker (run this in the root directory)
```bash
docker-compose -f docker-compose.dev.yml up --build -d
```
``` bash
docker ps -a # check all the running containers and the ports
```
3 . Running Tests
```bash
cd server
pnpm test
```
## API Endpoints
### Health Check
- **Endpoint:**
- `/api/health-check`
- **Description:**
- Returns a simple health check response.
- **Response:**
```json
{ "msg": "Hello health check route" }
```
### Customers
- **Endpoint:**
- `/api/customers`
- **Description:**
- Returns a list of all customers.
- **Response Example:**
```json
[
{
"id": 31,
"name": "JACKSON NELLY",
"phone": "(256) 7750694430",
"country": "Uganda",
"state": "valid"
},
]
```