Merge pull request #34 from neatht/v9/master

🚀 Version 9

.github/workflows/test-react.yml

@@ -0,0 +1,30 @@
+name: Test React
+
+on: [push, pull_request]
+
+jobs:
+
+  build:
+
+    runs-on: ubuntu-latest
+
+
+    steps:
+      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
+      - uses: actions/checkout@v2
+
+      - name: Install modules
+        working-directory: ./client
+        run: yarn
+
+      - name: Run lint
+        working-directory: ./client
+        run: yarn lint
+
+      - name: Run format check
+        working-directory: ./client
+        run: yarn format-check
+
+      - name: Run tests
+        working-directory: ./client
+        run: yarn test

README.md

@@ -1,23 +1,48 @@
-# camel_Case
+<h1 align="center">🌏 Glowbal</h1>
 
-## Team details
+<div align="center">
+    <strong>An ePortfolio web app built on React and Express</strong>
+</div>
 
-| Name              | Email                               | Student Number |
-|:------------------|:------------------------------------|---------------:|
-| Nathan Harvey     | [email protected]     | 997261         |
-| Sean Gayler       | [email protected] |                |
-| Kevin Kim         | [email protected]        | 997107         |
-| Edward Hinrichsen | [email protected] |                |
-| Taylor Johnston   | [email protected]    | 759667         |
+<br/>
 
+<div align="center">
+    <a href="https://www.notion.so/camel_Case-0a5b3335242b4dbcb35522caebb87548">
+        <img src="https://img.shields.io/badge/documentation-Notion-000000?style=for-the-badge&logo=Notion"/>
+    </a>
+    <a href="https://glowbal.us.to">
+        <img src="https://img.shields.io/badge/Live_Link-AWS-232F3E?style=for-the-badge&logo=Amazon-AWS"/>
+    </a>
+</div>
 
-## Getting Started
+<div align="center">
+    <p>
+        <a href="#tada-getting-started">Getting Started</a> •
+        <a href="#memo-documentation">Documentation</a> •
+        <a href="#raising_hand-contributors">Contributors</a>
+    </p>
+</div>
 
-### Local Installation
+
+## :tada: Getting Started
+
+### :house: Local Installation
 
 These instructions will help you get a copy of the project up and running for development and testing. This project runs on an Express backend and React frontend with TypeScript. You will need `npm` and `yarn` installed to start.
 
-#### API Server: Express
+#### :lock: SSL certificate
+Before building either servers, you will need an SSL certificate. 
+In the root directory, start by creating a certificate:
+```
+openssl req -x509 -newkey rsa:4096 -keyout server.key -out server.cert -days 365
+```
+To specify the certificates, in both `client` and `api`, add the following lines to the `.env`:
+```
+SSL_CRT_FILE=../server.cert
+SSL_KEY_FILE=../server.key
+```
+
+#### 🖥 API Server: Express
 
 First start by installing and running the Express backend in the `api` directory.
 
@@ -40,13 +65,13 @@ Alternatively, you can run the server with hot loading with `nodemon`
 nodemon
 ```
 
-#### Client: React
+#### ⚛️ Client: React
 
 First start by installing and running the React frontend in the `client` directory.
 
 ```
 cd client
-yarn add
+yarn install
 ```
 
 In the `client` directory, you can start the React app by running:
@@ -61,3 +86,32 @@ Once you are done, the app should automatically launch, however, the app can be
 localhost:3000
 ```
 
+## :memo: Documentation
+
+### :art: Components: Storybook
+
+The frontend React components are documented using [Storybook](https://storybook.js.org)
+
+To start Storybook, in the `client` folder, run:
+
+```
+yarn storybook
+```
+
+In should open automatically, however the app can be found at:
+
+```
+localhost:6006
+```
+
+## :raising_hand: Contributors
+
+<table>
+  <tr valign="top">
+    <td align="center"><a href="https://github.com/seangayler"><img src="https://avatars1.githubusercontent.com/seangayler" width="100px;" alt="Sean Gayler"/><br /><sub><b>Sean Gayler</b></sub></a></td>
+    <td align="center"><a href="https://github.com/neatht"><img src="https://avatars1.githubusercontent.com/neatht" width="100px;" alt="Nathan Harvey"/><br /><sub><b>Nathan Harvey</b></sub></a></td>
+    <td align="center"><a href="https://github.com/edhinrichsen"><img src="https://avatars1.githubusercontent.com/edhinrichsen" width="100px;" alt="Edward Hinrichsen"/><br /><sub><b>Edward Hinrichsen</b></sub></a></td>
+    <td align="center"><a href="https://github.com/taylor-johnston"><img src="https://avatars1.githubusercontent.com/taylor-johnston" width="100px;" alt="Taylor Johnston"/><br /><sub><b>Taylor Johnston</b></sub></a></td>
+    <td align="center"><a href="https://github.com/kwhk"><img src="https://avatars1.githubusercontent.com/kwhk" width="100px;" alt="Nathan Harvey"/><br /><sub><b>Kevin Kim</b></sub></a></td>
+  </tr>
+</table>

api/.gitignore

@@ -1,5 +1,7 @@
 node_modules/
 
+dist/
+
 .DS_Store
 
 .env
@@ -9,6 +11,11 @@ node_modules/
 .env.production
 .env.production.local
 
+dist/
+
 npm-debug.log*
 yarn-debug.log*
-yarn-error.log*
+yarn-error.log*
+
+server.cert
+server.key