Skip to content

docs(README): Fixed items to help devs get started #19

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

Closed
wants to merge 4 commits into from
Closed

docs(README): Fixed items to help devs get started #19

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
441c0aa
fix(.gitignore): Ignore .env.development
timothystewart6 Feb 19, 2025
73b4fe2
fix(.env): Fix example to match documentation
timothystewart6 Feb 19, 2025
281b0ab
docs(README): Fixed docker command to expose port
timothystewart6 Feb 19, 2025
1b6792d
docs(README): Fixed .env.development since that's what npm run dev needs
timothystewart6 Feb 19, 2025
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
2 changes: 1 addition & 1 deletion .env.example
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
DATABASE_URL="postgresql://jetkvm:jetkvm@localhost:5432/jetkvm?schema=public"
DATABASE_URL="postgresql://jetkvm:mysecretpassword@localhost:5432/jetkvm?schema=public"

GOOGLE_CLIENT_ID=XXX # Google OIDC Client ID
GOOGLE_CLIENT_SECRET=XXX # Google OIDC Client Secret
Expand Down
3 changes: 2 additions & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
node_modules
.idea
.env
.env
.env.development
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@ The best place to search for answers is our [Documentation](https://jetkvm.com/d

If you've found an issue and want to report it, please check our [Issues](https://github.com/jetkvm/cloud-api/issues) page. Make sure the description contains information about the firmware version you're using, your platform, and a clear explanation of the steps to reproduce the issue.


## Development

This project is built with Node.JS, Prisma and Express.
Expand All @@ -37,10 +36,11 @@ docker run --name jetkvm-cloud-db \
-e POSTGRES_USER=jetkvm \
-e POSTGRES_PASSWORD=mysecretpassword \
-e POSTGRES_DB=jetkvm \
-p 5432:5432 \
-d postgres

# Copy the .env.example file to .env and populate it with the correct values
cp .env.example .env
# Copy the .env.example file to a new file .env.development and populate it with the correct values
cp .env.example .env.development

# Install dependencies
npm install
Expand Down