Skip to content

Added Docker file of quick setup. #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Added Docker file of quick setup. #10

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c9fcb1e
Update README.md
ArpitBlagan Jul 25, 2024
324d898
Update README.md
ArpitBlagan Jul 25, 2024
a40d26f
added dockerfile
Jul 25, 2024
0fa38ed
Merge branch 'main' of https://github.com/ArpitBlagan/quickflow into …
Jul 25, 2024
33b9b08
added dockerfile:
Jul 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .dockerignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
node_modules
.git
.gitignore
.env.local.example
.env
.env.local
8 changes: 8 additions & 0 deletions .env.local.example
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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=''
13 changes: 13 additions & 0 deletions Dockerfile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
FROM node:20-alpine

WORKDIR /app/user/

COPY package*.json ./

RUN npm install

COPY . .

EXPOSE 3000

CMD ["npm", "run", "dev"]
11 changes: 9 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -148,4 +155,4 @@ Special thanks to Antonio for his invaluable tutorial, which served as the found

## License

[MIT License](LICENSE)
[MIT License](LICENSE)