Skip to content

Commit b878fcb

Browse files
2 parents f561dab + b900778 commit b878fcb

File tree

1 file changed

+19
-1
lines changed

1 file changed

+19
-1
lines changed

README.md

+19-1
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,19 @@
1+
# Codebuilder Webapp
2+
3+
[![Deploy Production Docker Container](https://github.com/codebuilderinc/codebuilder-frontend/actions/workflows/deploy-docker.yml/badge.svg)](https://github.com/codebuilderinc/codebuilder-frontend/actions/workflows/deploy-docker.yml)
4+
5+
16
This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app).
27

38
## Getting Started
49

5-
First, run the development server:
10+
First, setup your mysql database and edit the .env.example file.
11+
12+
```bash
13+
cp .env.example .env.local
14+
```
15+
16+
Run the development server:
617

718
```bash
819
npm run dev
@@ -14,6 +25,13 @@ pnpm dev
1425
bun dev
1526
```
1627

28+
Build the production Docker container:
29+
```bash
30+
docker run -d --network host -p 3000:3000 --env-file .env --name codebuilder-webapp codebuilder-webapp:latest
31+
```
32+
33+
Note: The production website will automatically build & deploy through a GH action anytime a push is made to main.
34+
1735
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
1836

1937
You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.

0 commit comments

Comments
 (0)