diff --git a/.dockerignore b/.dockerignore new file mode 100644 index 0000000..63cb234 --- /dev/null +++ b/.dockerignore @@ -0,0 +1,6 @@ +node_modules +.git +.gitignore +.env.local.example +.env +.env.local \ No newline at end of file diff --git a/.env.local.example b/.env.local.example new file mode 100644 index 0000000..78241ff --- /dev/null +++ b/.env.local.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 diff --git a/README.md b/README.md index ca3caa1..cc7df70 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)