README.md

Alien Typer Shit: Frontend

User-facing web app. this code produces a simple react js web app with SSR in TS.

Key ingredients

• TypeScript to ensure the highest code quality

• Next.js to bundle source files and render web pages both on the server and the client (SSR)

• React-router-dom For routing

• React Context for static react state

• Redux for static react state

• Apollo GraphQL client to get data from the backend

• Styled components to produce well-structured and collision-free CSS

• ESLint and Prettier to ensure that source files are error-free and easy to read

• Docker to make the production version of the microservice straightforward to deploy

• GitLab CI to automatically check code quality and generate a new docker image on every push

Running a local copy

1. Ensure you have the latest git, Node.js and Yarn installed on your machine

   git --version
   ## ≥ 2.14
   
   node --version
   ## ≥ 10.0
   
   yarn --version
   ## ≥ 1.10

2. Clone the repo

   cd PATH/TO/MISC/PROJECTS
   git clone https://github.com/vugga/ats-fe.git
   cd ats-fe

3. Install npm dependencies using Yarn

   yarn

4. Copy .env.dist to .env. You can have a look at src/config.ts for hints on what is expected.

1. Start the server in development mode

   yarn dev

   Modifying any of the files will refresh the app, thanks to Next.js hot module reloading. To stop running the server, press ctrl+c.

2. If you want to test a production copy of the microservice, build and run it like this:

   yarn build
   yarn start