diff --git a/.env.example b/.env.example index 1c32893e5b2fe..2763a431adc55 100644 --- a/.env.example +++ b/.env.example @@ -9,3 +9,6 @@ GATSBY_ALGOLIA_INDEX_PREFIX=test-sentry- # ALGOLIA_ADMIN_KEY= # ALGOLIA_INDEX=0 # SENTRY_AUTH_TOKEN= +DATABASE_URL=postgresql://postgres:postgres@localhost:5432/changelog +NEXTAUTH_URL=http://localhost:3000 +NEXTAUTH_SECRET=secret diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000000000..35aa77cd17742 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,35 @@ +
+ + + +
+ +## Setting up an Environment + +We use Next.js, `yarn` and `volta` to manage the environment. + +``` +cp .env.example .env.development +yarn +yarn dev +``` + +With that, the repo is fully set up and you are ready to open local docs under http://localhost:3000 + +### Database + +There is a compose file to start a local postgres db: + +``` +docker-compose up -d +``` + +If you already run a local postgres, it will create a `changelog` table. + +The inital setup or the clean the database call: + +``` +yarn prisma migrate reset +``` + +To add new entries, visit `/changelog/_admin` you need to have a Google Account in the Sentry org to login.