diff --git a/README.md b/README.md index e4a4a4cad8..0655cfb158 100644 --- a/README.md +++ b/README.md @@ -45,7 +45,7 @@ Here is what you need to be able to run Calendso. * PostgreSQL * Yarn _(recommended)_ -You will also need Google API credentials. You can get this from the [Google API Console](https://console.cloud.google.com/apis/dashboard). Simply create a new project, set the OAuth to use the calendar.events read and write permissions, and then set the callback URL to `/api/integrations/googlecalendar/callback`. +You will also need Google API credentials. You can get this from the [Google API Console](https://console.cloud.google.com/apis/dashboard). Simply create a new project, set the OAuth to use the calendar.events read and write permissions, and then set the callback URL to `/api/integrations/googlecalendar/callback`. ### Development Setup @@ -57,13 +57,13 @@ You will also need Google API credentials. You can get this from the [Google API ```sh yarn install ``` -3. Copy .env.example to .env -4. Configure environment variables in the .env file. Replace \, \, \, \ with their applicable values +3. Copy `.env.example` to `.env` +4. Configure environment variables in the .env file. Replace ``, ``, ``, `` with their applicable values ``` DATABASE_URL='postgresql://:@:' GOOGLE_API_CREDENTIALS='secret' ``` -5. Set up the database using the Prisma schema +5. Set up the database using the Prisma schema (found in `prisma/schema.prisma`) ```sh npx prisma db push --preview-feature ``` @@ -71,10 +71,14 @@ You will also need Google API credentials. You can get this from the [Google API ```sh yarn dev ``` -7. Open the prisma schema (found in `prisma/schema.prisma`) 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. +7. Open [Prisma Studio](https://www.prisma.io/studio) to look at or modify the database content: + ``` + npx prisma studio + ``` +9. Click on the `User` model to add a new user record. +10. 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. +11. Open a browser to [http://localhost:3000](http://localhost:3000) and login with your just created, first user. + ## Roadmap @@ -87,9 +91,10 @@ Contributions are what make the open source community such an amazing place to b 1. Fork the project 2. Create your feature branch (`git checkout -b feature/AmazingFeature`) -3. Commit your changes (`git commit -m 'Add some AmazingFeature'`) -4. Push to the branch (`git push origin feature/AmazingFeature`) -5. Open a pull request +3. Make your changes +4. Commit your changes (`git commit -m 'Add some AmazingFeature'`) +5. Push to the branch (`git push origin feature/AmazingFeature`) +6. Open a pull request ## License @@ -98,6 +103,7 @@ Distributed under the MIT License. See `LICENSE` for more information. ## Acknowledgements + Special thanks to these amazing projects which help power Calendso: * [Next.js](https://nextjs.org/) * [Day.js](https://day.js.org/)