README.md

START Nuremberg's Job Board - Frontend

Welcome to the frontend repository for START Nuremberg's Job Board. This project is designed to provide an intuitive and user-friendly interface for job seekers and employers within the START Nuremberg community.

Table of Contents

• Introduction
• Tech Stack
• Getting Started
  • Prerequisites
  • Installation
• Backend Repository
• Contributing
• License

Introduction

START Nuremberg's Job Board is a platform aimed at connecting job seekers with potential employers. The frontend of this application is built using React, TypeScript, and TailwindCSS to ensure a modern and responsive user experience.

Deployment

You can see the current build in Azure

Tech Stack

• React: A JavaScript library for building user interfaces.
• TypeScript: A superset of JavaScript that adds static types.
• TailwindCSS: A utility-first CSS framework for rapidly building custom designs.

Getting Started

To get a local copy up and running, follow these simple steps.

Prerequisites

Make sure you have the following installed:

• Node.js (v14.x or later)
• npm or Yarn

Installation

1. Clone the repository:

  git clone git@github.com:STARTNuremberg/Job_Board_Frontend.git

2. Install the dependencies:

  npm install OR yarn install

3. run the application:

  npm run dev OR yarn start

To enjoy full functionality we recommend running the backend docker container.

Backend Repository

The backend for this project can be found here.