Merge pull request #29 from duizendnegen/feature/pws/cleanup

Add tests, make readme up to date

.github/workflows/branches.yml

@@ -0,0 +1,21 @@
+name: Test
+
+on:
+  push:
+    branches-ignore:
+      - 'main'
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Use Node.js 16.x
+        uses: actions/setup-node@v1
+        with:
+          node-version: 16.x
+      - name: Install dependencies
+        run: npm install
+      - name: Run tests
+        run: npm test

.github/workflows/main.yml

@@ -1,31 +1,32 @@
-name: Build & deploy
+name: Test, build & deploy
 
 on:
   push:
     branches:
-      - main
+      - 'main'
 
 jobs:
-  deploy:
+  install:
     runs-on: ubuntu-latest
     environment: production
     steps:
       - name: Checkout
         uses: actions/checkout@v2
-      - name: Configure AWS credentials
-        uses: aws-actions/configure-aws-credentials@v1
-        with:
-          aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
-          aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
-          aws-region: eu-central-1
-      - name: Use Node.js 12.x
+      - name: Use Node.js 16.x
         uses: actions/setup-node@v1
         with:
-          node-version: 12.x
+          node-version: 16.x
       - name: Install dependencies
         run: npm install
+      - name: Run tests
       - name: Build
         run: npm run build
+      - name: Configure AWS credentials
+        uses: aws-actions/configure-aws-credentials@v1
+        with:
+          aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
+          aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+          aws-region: eu-central-1
       - name: Deploy
         run: aws s3 sync ./build ${{ secrets.AWS_S3_BUCKET }}
       - name: Invalidate CloudFront Cache

README.md

@@ -1,46 +1,14 @@
-# Getting Started with Create React App
+# Sunburst Smorgasbord
 
-This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
+This is a tool to help you discuss and explore the relationships you'd like with your loved ones.
 
-## Available Scripts
+## Running the project
 
-In the project directory, you can run:
+Install requirements using `npm install`\
+Run `npm start` to build the project locally and view it in the browser at [http://localhost:3000](http://localhost:3000).\
+Tests can be ran using `npm test`.
 
-### `npm start`
+## Contributing to the project
 
-Runs the app in the development mode.\
-Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
-
-The page will reload if you make edits.\
-You will also see any lint errors in the console.
-
-### `npm test`
-
-Launches the test runner in the interactive watch mode.\
-See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
-
-### `npm run build`
-
-Builds the app for production to the `build` folder.\
-It correctly bundles React in production mode and optimizes the build for the best performance.
-
-The build is minified and the filenames include the hashes.\
-Your app is ready to be deployed!
-
-See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
-
-### `npm run eject`
-
-**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
-
-If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
-
-Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
-
-You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
-
-## Learn More
-
-You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
-
-To learn React, check out the [React documentation](https://reactjs.org/).
+We're open for pull requests - best discuss your suggestion first by opening an issue.
+New translations can be submitted by adding a new file in `public/locales/{language}/translation.json` and adding a new language button to [the application footer](https://github.com/duizendnegen/sunburst-smorgasbord/blob/main/src/App.tsx). See [the English translation file](https://github.com/duizendnegen/sunburst-smorgasbord/blob/main/public/locales/en/translation.json) for an example.