ohshi60 / gbcode-challenge

Repository containing my solution for the code challenge by the lovely people at goodiebox

README

This is a simple fullstack webapp using React, Firebase-auth, Typescript and Express

Installation

I will assume you are running a unix system

Requires Node.JS to run You also need gitinstalled

First clone the repo git clone https://github.com/Ohshi60/GBCode-Challenge.git appName && cd appName

Firebase setup

You will need to have a firebase account, and create a Firebase Project - Create an App for your Project - Select Sign in Providers and make sure to enable email/password - You will need the firebase-config for the front-end - Create an service account and download the provided jsonfile

Building frontend

• IMPORTANT you will need to create a .env.local file containing the keys to your firebase-config: I suggest you rename the provided .env.example and fill in the values mv .env.example .env.local
• Move into the front-end folder cd user-frontend
  • Install the dependencies with npm install or yarn install

Building the backend

• IMPORTANT Remember the service account file from the firebase-setup? You will need to move it into user-backend/src/config/serviceAccountKey.json
• Move into the backend folder cd ../user-backend
• Install the dependencies with npm install or yarn install

Running in development mode

• Backend

  • yarn run dev
  • you should see Server started at port 3001 in your terminal

• Frontend

  • yarn run start
  • ìf all goes well you should your react app in the browser

Building for production

• Backend

  • Compile src with yarn run tsc
  • Run yarn run postbuild
  • You can now run the application with yarn run start

• Frontend

  • Compile src with yarn run build
  • Follow instructions in terminal
  • Mine was yarn global add serve serve -s build

Misc

yarn run lint-fix can be run on both front and backend

TODO'S

• USE TYPES I know it defeats the purpose of typescript when i cast things as any
• Export build folder from frontend to backend, and setup express to use static
• Validation - look into a form library such as Formik
• UI is a mess, more time with Chakra
• Backend is creating a user on getUser, this is not very restful :(
• Setup some form of error handling
• Setup deployment
• Set up testing