From d9565b80c0f3404a67c6fcd123929b9f220efaec Mon Sep 17 00:00:00 2001 From: Peter Crosthwaite Date: Tue, 13 Apr 2021 21:16:18 +1000 Subject: [PATCH] Added an example environment file for new users to use Updated the README with some additional info to help get new users up and going. --- .env.example | 2 ++ README.md | 14 +++++++++----- 2 files changed, 11 insertions(+), 5 deletions(-) create mode 100644 .env.example diff --git a/.env.example b/.env.example new file mode 100644 index 0000000000..bf86b7a70c --- /dev/null +++ b/.env.example @@ -0,0 +1,2 @@ +DATABASE_URL='postgresql://:@:' +GOOGLE_API_CREDENTIALS='secret' \ No newline at end of file diff --git a/README.md b/README.md index 2cbf5efe15..7c632b6cf0 100644 --- a/README.md +++ b/README.md @@ -55,20 +55,24 @@ Here is what you need to be able to run Calendso. ```sh yarn install ``` -3. Configure environment variables +3. Copy .env.example to .env +4. Configure environment variables in the .env file. Replace \, \, \, \ with their applicable values ``` - DATABASE_URL='postgresql://' + DATABASE_URL='postgresql://:@:' GOOGLE_API_CREDENTIALS='secret' ``` -4. Set up the database using the Prisma schema +5. Set up the database using the Prisma schema ```sh npx prisma db push --preview-feature ``` -5. Run (in development mode) +6. Run (in development mode) ```sh yarn dev ``` - +7. Open the prisma schema with [Prisma Studio](https://www.prisma.io/studio) +8. Click on the user model to allow add a new user record. +9. Fill out the fields \(remembering to encrypt your password with [BCrypt](https://bcrypt-generator.com/)\) and click Save 1 Record to create your first user. +10. Open a browser to [http://localhost:3000](http://localhost:3000) and login with your first user. ## Roadmap