From c9fcb1ee55ab1cabb3babc35fe9c6b8a04e5c4c9 Mon Sep 17 00:00:00 2001 From: ArpitBlagan <114584343+ArpitBlagan@users.noreply.github.com> Date: Thu, 25 Jul 2024 17:03:02 +0530 Subject: [PATCH 1/4] Update README.md --- README.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ca3caa1..9eefb35 100644 --- a/README.md +++ b/README.md @@ -36,6 +36,7 @@ Quickflow is an open-source alternative to Notion that aims to provide a superio Ensure that you have Node.js version 18.x.x or higher installed. + ### Cloning the Repository ```shell @@ -112,11 +113,17 @@ EDGE_STORE_ACCESS_KEY= EDGE_STORE_SECRET_KEY= ``` -### Starting the Development Server +### Starting the Development Server Locally Without Docker ```shell npm run dev ``` +### starting the Developement Server With Docker + +``` + docker build -t TAG_NAME . + docker run -p 3000:3000 --env-file .env.local TAG_NAME +``` ## Deployment @@ -148,4 +155,4 @@ Special thanks to Antonio for his invaluable tutorial, which served as the found ## License -[MIT License](LICENSE) \ No newline at end of file +[MIT License](LICENSE) From 324d8984bbaa9ab659e3cc35f960ba1625675167 Mon Sep 17 00:00:00 2001 From: ArpitBlagan <114584343+ArpitBlagan@users.noreply.github.com> Date: Thu, 25 Jul 2024 17:03:35 +0530 Subject: [PATCH 2/4] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 9eefb35..cc7df70 100644 --- a/README.md +++ b/README.md @@ -118,7 +118,7 @@ EDGE_STORE_SECRET_KEY= ```shell npm run dev ``` -### starting the Developement Server With Docker +### Starting the Developement Server With Docker ``` docker build -t TAG_NAME . From a40d26fff6ef656bd3a00144e7602be2ffd1d7ec Mon Sep 17 00:00:00 2001 From: Arpit Blagan Date: Thu, 25 Jul 2024 17:04:04 +0530 Subject: [PATCH 3/4] added dockerfile --- .dockerignore | 5 +++++ .env.example | 8 ++++++++ Dockerfile | 13 +++++++++++++ 3 files changed, 26 insertions(+) create mode 100644 .dockerignore create mode 100644 .env.example create mode 100644 Dockerfile diff --git a/.dockerignore b/.dockerignore new file mode 100644 index 0000000..11420c7 --- /dev/null +++ b/.dockerignore @@ -0,0 +1,5 @@ +node_modules +.git +.gitignore +.env.example +.env \ No newline at end of file diff --git a/.env.example b/.env.example new file mode 100644 index 0000000..78241ff --- /dev/null +++ b/.env.example @@ -0,0 +1,8 @@ +CONVEX_DEPLOYMENT='' +NEXT_PUBLIC_CONVEX_URL='' + +NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY='' +CLERK_SECRET_KEY='' + +EDGE_STORE_ACCESS_KEY='' +EDGE_STORE_SECRET_KEY='' \ No newline at end of file diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..ee75f17 --- /dev/null +++ b/Dockerfile @@ -0,0 +1,13 @@ +FROM node:20-alpine + +WORKDIR /app/user/ + +COPY package*.json ./ + +RUN npm install + +COPY . . + +EXPOSE 3000 + +CMD ["npm", "run", "dev"] \ No newline at end of file From 33b9b08355c3d814611fe9a53bacb0a9f43b9839 Mon Sep 17 00:00:00 2001 From: Arpit Blagan Date: Thu, 25 Jul 2024 17:06:13 +0530 Subject: [PATCH 4/4] added dockerfile: --- .dockerignore | 5 +++-- .env.example => .env.local.example | 0 2 files changed, 3 insertions(+), 2 deletions(-) rename .env.example => .env.local.example (100%) diff --git a/.dockerignore b/.dockerignore index 11420c7..63cb234 100644 --- a/.dockerignore +++ b/.dockerignore @@ -1,5 +1,6 @@ node_modules .git .gitignore -.env.example -.env \ No newline at end of file +.env.local.example +.env +.env.local \ No newline at end of file diff --git a/.env.example b/.env.local.example similarity index 100% rename from .env.example rename to .env.local.example