Skip to content

Commit ed8ceb4

Browse files
committed
docs: add instalation and deployement docs
1 parent 405f1d0 commit ed8ceb4

File tree

1 file changed

+33
-3
lines changed

1 file changed

+33
-3
lines changed

README.md

Lines changed: 33 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,20 +32,50 @@ This project is a boilerplate for building RESTful APIs using AdonisJS with Post
3232
node ace generate:key
3333
```
3434

35-
3. Run docker to build the app
35+
3. Run docker to build the database you can delete the app if you want
3636

3737
```bash
3838
docker compose up -d
3939
```
4040

4141
4. Run migrations:
42+
4243
```bash
4344
node ace migration:run
4445
```
4546

46-
## Running the application
47+
5. Start the application
48+
```bash
49+
pnpm run dev
50+
```
51+
The server will start on http://localhost:3333
52+
53+
### Deployment
54+
55+
1. Clone your repository in your server:
56+
57+
```bash
58+
git clone git@github.com:agus-darmawan/adonis-api-pg-starter.git
59+
```
60+
61+
2. Copy the .env.example to .env and configure your environment variables:
4762

48-
The server will start on http://localhost:${PORT}
63+
```bash
64+
cp .env.example .
65+
node ace generate:key
66+
```
67+
68+
3. Run docker to build the app
69+
70+
```bash
71+
docker compose up -d
72+
```
73+
74+
4. Run migrations:
75+
```bash
76+
node ace migration:run
77+
```
78+
The server will start on http://YOUR_SERVER_IP:YOUR_ENV_PORT
4979

5080
## API Documentation
5181

0 commit comments

Comments
 (0)