Skip to content

Commit 75cf92d

Browse files
authored
Update README.md
1 parent 047e9a4 commit 75cf92d

1 file changed

Lines changed: 40 additions & 1 deletion

File tree

README.md

Lines changed: 40 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,40 @@
1-
# Admin_Service
1+
# Fastify Structured App
2+
3+
This is a structured Fastify application.
4+
5+
## Folder Structure
6+
7+
├── app
8+
│ ├── handlers
9+
│ ├── middlewares
10+
│ ├── models
11+
│ ├── routers
12+
│ ├── services
13+
│ ├── main.js
14+
├── node_modules
15+
├── .env
16+
├── .gitignore
17+
├── docker-compose.yml
18+
├── Dockerfile
19+
├── .env.example
20+
├── package.json
21+
└── readme.md
22+
23+
# Set up environment variables:
24+
Create a .env file in the root directory and copy the content from .env.example:
25+
26+
cp .env.example .env
27+
28+
# Running the App
29+
30+
start.bat (or sh) to start services
31+
32+
# Run Tests
33+
Execute the test suite using Jest:
34+
```sh
35+
npm run test
36+
```
37+
38+
# API Documentation
39+
Swagger documentation is available at
40+
https://BASE_URL/docs.

0 commit comments

Comments
 (0)